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

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

Request message for the ListRegions method.

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

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 account to list regions for. Format: accounts/{account}

↳ page_size int

Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

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

getParent

Required. The account to list regions for.

Format: accounts/{account}

Returns
Type Description
string

setParent

Required. The account to list regions for.

Format: accounts/{account}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of regions to return. The service may return fewer than this value.

If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of regions to return. The service may return fewer than this value.

If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

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

Returns
Type Description
string

setPageToken

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

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRegions 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 account to list regions for. Format: accounts/{account} Please see RegionsServiceClient::accountName() for help formatting this field.

Returns
Type Description
ListRegionsRequest