Google Analytics Admin V1alpha Client - Class ListAudiencesRequest (0.24.2)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class ListAudiencesRequest.

Request message for ListAudiences RPC.

Generated from protobuf message google.analytics.admin.v1alpha.ListAudiencesRequest

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Example format: properties/1234

↳ page_size int

The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

↳ page_token string

A page token, received from a previous ListAudiences call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAudiences must match the call that provided the page token.

getParent

Required. Example format: properties/1234

Returns
Type Description
string

setParent

Required. Example format: properties/1234

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of resources to return.

If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

Returns
Type Description
int

setPageSize

The maximum number of resources to return.

If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous ListAudiences call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAudiences must match the call that provided the page token.

Returns
Type Description
string

setPageToken

A page token, received from a previous ListAudiences call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAudiences 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. Example format: properties/1234 Please see AnalyticsAdminServiceClient::propertyName() for help formatting this field.

Returns
Type Description
ListAudiencesRequest