Google Analytics Data V1alpha Client - Class SheetExportAudienceListResponse (0.16.3)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class SheetExportAudienceListResponse.

The created Google Sheet with the list of users in an audience list.

Generated from protobuf message google.analytics.data.v1alpha.SheetExportAudienceListResponse

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ spreadsheet_uri string

A uri for you to visit in your browser to view the Google Sheet.

↳ spreadsheet_id string

An ID that identifies the created Google Sheet resource.

↳ row_count int

The total number of rows in the AudienceList result. rowCount is independent of the number of rows returned in the response, the limit request parameter, and the offset request parameter. For example if a query returns 175 rows and includes limit of 50 in the API request, the response will contain rowCount of 175 but only 50 rows. To learn more about this pagination parameter, see Pagination.

↳ audience_list Google\Analytics\Data\V1alpha\AudienceList

Configuration data about AudienceList being exported. Returned to help interpret the AudienceList in the Google Sheet of this response. For example, the AudienceList may have more rows than are present in the Google Sheet, and in that case, you may want to send an additional sheet export request with a different offset value to retrieve the next page of rows in an additional Google Sheet.

getSpreadsheetUri

A uri for you to visit in your browser to view the Google Sheet.

Returns
Type Description
string

hasSpreadsheetUri

clearSpreadsheetUri

setSpreadsheetUri

A uri for you to visit in your browser to view the Google Sheet.

Parameter
Name Description
var string
Returns
Type Description
$this

getSpreadsheetId

An ID that identifies the created Google Sheet resource.

Returns
Type Description
string

hasSpreadsheetId

clearSpreadsheetId

setSpreadsheetId

An ID that identifies the created Google Sheet resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getRowCount

The total number of rows in the AudienceList result. rowCount is independent of the number of rows returned in the response, the limit request parameter, and the offset request parameter. For example if a query returns 175 rows and includes limit of 50 in the API request, the response will contain rowCount of 175 but only 50 rows.

To learn more about this pagination parameter, see Pagination.

Returns
Type Description
int

hasRowCount

clearRowCount

setRowCount

The total number of rows in the AudienceList result. rowCount is independent of the number of rows returned in the response, the limit request parameter, and the offset request parameter. For example if a query returns 175 rows and includes limit of 50 in the API request, the response will contain rowCount of 175 but only 50 rows.

To learn more about this pagination parameter, see Pagination.

Parameter
Name Description
var int
Returns
Type Description
$this

getAudienceList

Configuration data about AudienceList being exported. Returned to help interpret the AudienceList in the Google Sheet of this response.

For example, the AudienceList may have more rows than are present in the Google Sheet, and in that case, you may want to send an additional sheet export request with a different offset value to retrieve the next page of rows in an additional Google Sheet.

Returns
Type Description
Google\Analytics\Data\V1alpha\AudienceList|null

hasAudienceList

clearAudienceList

setAudienceList

Configuration data about AudienceList being exported. Returned to help interpret the AudienceList in the Google Sheet of this response.

For example, the AudienceList may have more rows than are present in the Google Sheet, and in that case, you may want to send an additional sheet export request with a different offset value to retrieve the next page of rows in an additional Google Sheet.

Parameter
Name Description
var Google\Analytics\Data\V1alpha\AudienceList
Returns
Type Description
$this