Google Shopping Merchant Accounts V1beta Client - Class ListAccountsRequest (0.3.1)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1beta Client class ListAccountsRequest.

Request message for the ListAccounts method.

Generated from protobuf message google.shopping.merchant.accounts.v1beta.ListAccountsRequest

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ page_size int

Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.

↳ page_token string

Optional. 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.

↳ filter string

Optional. Returns only accounts that match the filter. For more details, see the filter syntax reference.

getPageSize

Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned.

The maximum value is 500; values above 500 are coerced to 500.

Returns
Type Description
int

setPageSize

Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned.

The maximum value is 500; values above 500 are coerced to 500.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. 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

Optional. 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

getFilter

Optional. Returns only accounts that match the filter.

For more details, see the filter syntax reference.

Returns
Type Description
string

setFilter

Optional. Returns only accounts that match the filter.

For more details, see the filter syntax reference.

Parameter
Name Description
var string
Returns
Type Description
$this