Google Analytics Data V1alpha Client - Class ListAudienceListsRequest (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 ListAudienceListsRequest.

A request to list all audience lists for a property.

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

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. All audience lists for this property will be listed in the response. Format: properties/{property}
↳ page_size	int Optional. The maximum number of audience lists to return. The service may return fewer than this value. If unspecified, at most 200 audience lists will be returned. The maximum value is 1000 (higher values will be coerced to the maximum).
↳ page_token	string Optional. A page token, received from a previous ListAudienceLists call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAudienceLists must match the call that provided the page token.

getParent

Required. All audience lists for this property will be listed in the response. Format: properties/{property}

Returns
Type	Description
string

setParent

Required. All audience lists for this property will be listed in the response. Format: properties/{property}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of audience lists to return. The service may return fewer than this value. If unspecified, at most 200 audience lists will be returned. The maximum value is 1000 (higher values will be coerced to the maximum).

Returns
Type	Description
int

setPageSize

Optional. The maximum number of audience lists to return. The service may return fewer than this value. If unspecified, at most 200 audience lists will be returned. The maximum value is 1000 (higher values will be coerced to the maximum).

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. A page token, received from a previous ListAudienceLists call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAudienceLists must match the call that provided the page token.

Returns
Type	Description
string

setPageToken

Optional. A page token, received from a previous ListAudienceLists call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAudienceLists must match the call that provided the page token.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. All audience lists for this property will be listed in the response. Format: properties/{property} Please see AlphaAnalyticsDataClient::propertyName() for help formatting this field.

Returns
Type	Description
ListAudienceListsRequest