Reference documentation and code samples for the Google Analytics Data V1alpha Client class QueryAudienceListRequest.
A request to list users in an audience list.
Generated from protobuf message google.analytics.data.v1alpha.QueryAudienceListRequest
Namespace
Google \ Analytics \ Data \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the audience list to retrieve users from. Format: |
↳ offset |
int|string
Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first |
↳ limit |
int|string
Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. |
getName
Required. The name of the audience list to retrieve users from.
Format: properties/{property}/audienceLists/{audience_list}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The name of the audience list to retrieve users from.
Format: properties/{property}/audienceLists/{audience_list}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOffset
Optional. The row count of the start row. The first row is counted as row 0.
When paging, the first request does not specify offset; or equivalently,
sets offset to 0; the first request returns the first limit of rows. The
second request sets offset to the limit of the first request; the second
request returns the second limit of rows.
To learn more about this pagination parameter, see
Pagination.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setOffset
Optional. The row count of the start row. The first row is counted as row 0.
When paging, the first request does not specify offset; or equivalently,
sets offset to 0; the first request returns the first limit of rows. The
second request sets offset to the limit of the first request; the second
request returns the second limit of rows.
To learn more about this pagination parameter, see
Pagination.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLimit
Optional. The number of rows to return. If unspecified, 10,000 rows are
returned. The API returns a maximum of 250,000 rows per request, no matter
how many you ask for. limit must be positive.
The API can also return fewer rows than the requested limit, if there
aren't as many dimension values as the limit.
To learn more about this pagination parameter, see
Pagination.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setLimit
Optional. The number of rows to return. If unspecified, 10,000 rows are
returned. The API returns a maximum of 250,000 rows per request, no matter
how many you ask for. limit must be positive.
The API can also return fewer rows than the requested limit, if there
aren't as many dimension values as the limit.
To learn more about this pagination parameter, see
Pagination.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. The name of the audience list to retrieve users from.
Format: |
| Returns | |
|---|---|
| Type | Description |
QueryAudienceListRequest |
|