Google Shopping Merchant Lfp V1beta Client - Class ListLfpStoresRequest (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 Lfp V1beta Client class ListLfpStoresRequest.

Request message for the ListLfpStores method.

Generated from protobuf message google.shopping.merchant.lfp.v1beta.ListLfpStoresRequest

Namespace

Google \ Shopping \ Merchant \ Lfp \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The LFP partner. Format: accounts/{account}
↳ target_account	int|string Required. The Merchant Center id of the merchant to list stores for.
↳ page_size	int Optional. The maximum number of LfpStore resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the pageSize. The default value is 250. 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 ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

getParent

Required. The LFP partner.

Format: accounts/{account}

Returns
Type	Description
string

setParent

Required. The LFP partner.

Format: accounts/{account}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTargetAccount

Required. The Merchant Center id of the merchant to list stores for.

Returns
Type	Description
int|string

setTargetAccount

Required. The Merchant Center id of the merchant to list stores for.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of LfpStore resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the pageSize. The default value is 250. 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 LfpStore resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the pageSize. The default value is 250. 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 ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest 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

Optional. A page token, received from a previous ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest 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 LFP partner. Format: accounts/{account} Please see Google\Shopping\Merchant\Lfp\V1beta\LfpStoreServiceClient::accountName() for help formatting this field.

Returns
Type	Description
Google\Shopping\Merchant\Lfp\V1beta\ListLfpStoresRequest