Google Analytics Admin V1alpha Client - Class ListAccountsRequest (0.24.2)

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

Request message for ListAccounts RPC.

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

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ page_size int

The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. 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 ListAccounts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccounts must match the call that provided the page token.

↳ show_deleted bool

Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

getPageSize

The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages.

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. The service may return fewer than this value, even if there are additional pages.

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 ListAccounts call.

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

Returns
Type Description
string

setPageToken

A page token, received from a previous ListAccounts call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getShowDeleted

Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

Returns
Type Description
bool

setShowDeleted

Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

Parameter
Name Description
var bool
Returns
Type Description
$this