Google Shopping Merchant Accounts V1beta Client - Class ListSubAccountsRequest (0.1.0)

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 Shopping Merchant Accounts V1beta Client class ListSubAccountsRequest.

Request message for the ListSubAccounts method.

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

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ provider	string Required. The parent account. Format: accounts/{account}
↳ 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.

getProvider

Required. The parent account.

Format: accounts/{account}

Returns
Type	Description
string

setProvider

Required. The parent account.

Format: accounts/{account}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

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

static::build

Parameter
Name	Description
provider	string Required. The parent account. Format: accounts/{account} Please see Google\Shopping\Merchant\Accounts\V1beta\AccountsServiceClient::accountName() for help formatting this field.

Returns
Type	Description
Google\Shopping\Merchant\Accounts\V1beta\ListSubAccountsRequest