Google Shopping Merchant Inventories V1 Client - Class ListLocalInventoriesRequest (1.2.0)

Reference documentation and code samples for the Google Shopping Merchant Inventories V1 Client class ListLocalInventoriesRequest.

Request message for the ListLocalInventories method.

Generated from protobuf message google.shopping.merchant.inventories.v1.ListLocalInventoriesRequest

Namespace

Google \ Shopping \ Merchant \ Inventories \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The name of the parent product to list local inventories for. Format: accounts/{account}/products/{product}
↳ page_size int

The maximum number of LocalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the pageSize will default to the maximum
↳ page_token string

A page token, received from a previous ListLocalInventories call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLocalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

getParent

Required. The name of the parent product to list local inventories for.

Format: accounts/{account}/products/{product}

Returns
Type Description
string

setParent

Required. The name of the parent product to list local inventories for.

Format: accounts/{account}/products/{product}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of LocalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 25000; If a value higher than the maximum is specified, then the pageSize will default to the maximum

Returns
Type Description
int

setPageSize

The maximum number of LocalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 25000; 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

A page token, received from a previous ListLocalInventories call.

Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLocalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

Returns
Type Description
string

setPageToken

A page token, received from a previous ListLocalInventories call.

Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLocalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The name of the parent product to list local inventories for. Format: accounts/{account}/products/{product} Please see LocalInventoryServiceClient::productName() for help formatting this field.
Returns
Type Description
ListLocalInventoriesRequest