Google Shopping Merchant Accounts V1beta Client - Class ListGbpAccountsRequest (0.9.0)

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

Request message for the ListGbpAccounts method.

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

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account}.

↳ page_size int

Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

↳ page_token string

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

getParent

Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account}.

Returns
Type Description
string

setParent

Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

Returns
Type Description
int

setPageSize

Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

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

Returns
Type Description
string

setPageToken

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

Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListGbpAccounts 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. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account}. Please see GbpAccountsServiceClient::accountName() for help formatting this field.

Returns
Type Description
ListGbpAccountsRequest