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

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

Request message for the FindLfpProviders method.

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

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 LFP providers are found. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}.

↳ page_size int

Optional. The maximum number of LfpProvider resources to return. The service returns fewer than this value if the number of lfp providers 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 FindLfpProviders call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to FindLfpProviders must match the call that provided the page token.

getParent

Required. The name of the parent resource under which the LFP providers are found. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}.

Returns
Type Description
string

setParent

Required. The name of the parent resource under which the LFP providers are found. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of LfpProvider resources to return. The service returns fewer than this value if the number of lfp providers 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 LfpProvider resources to return. The service returns fewer than this value if the number of lfp providers 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 FindLfpProviders call.

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

Returns
Type Description
string

setPageToken

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

Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to FindLfpProviders 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 LFP providers are found. Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}. Please see LfpProvidersServiceClient::omnichannelSettingName() for help formatting this field.

Returns
Type Description
FindLfpProvidersRequest