Google Analytics Data V1alpha Client - Class QueryAudienceListResponse (0.21.1)

Version latest

• 0.21.1 (latest)
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.4
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.2
• 0.10.1
• 0.9.5

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

A list of users in an audience list.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ audience_list	AudienceList Configuration data about AudienceList being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceList correspond to the columns in the AudienceRows.
↳ audience_rows	array<AudienceRow> Rows for each user in an audience list. The number of rows in this response will be less than or equal to request's page size.
↳ 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.

getAudienceList

Configuration data about AudienceList being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceList correspond to the columns in the AudienceRows.

Returns
Type	Description
AudienceList|null

hasAudienceList

clearAudienceList

setAudienceList

Configuration data about AudienceList being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceList correspond to the columns in the AudienceRows.

Parameter
Name	Description
var	AudienceList

Returns
Type	Description
$this

getAudienceRows

Rows for each user in an audience list. The number of rows in this response will be less than or equal to request's page size.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setAudienceRows

Rows for each user in an audience list. The number of rows in this response will be less than or equal to request's page size.

Parameter
Name	Description
var	array<AudienceRow>

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