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

Request message for the ListOnlineReturnPolicies method.

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

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 merchant account for which to list return policies. Format: accounts/{account}
↳ page_size	int Optional. The maximum number of OnlineReturnPolicy resources to return. The service returns fewer than this value if the number of return policies for the given merchant is less that than the pageSize. The default value is 10. The maximum value is 100; 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 ListOnlineReturnPolicies call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListOnlineReturnPolicies must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

getParent

Required. The merchant account for which to list return policies.

Format: accounts/{account}

Returns
Type	Description
string

setParent

Required. The merchant account for which to list return policies.

Format: accounts/{account}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of OnlineReturnPolicy resources to return.

The service returns fewer than this value if the number of return policies for the given merchant is less that than the pageSize. The default value is 10. The maximum value is 100; 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 OnlineReturnPolicy resources to return.

The service returns fewer than this value if the number of return policies for the given merchant is less that than the pageSize. The default value is 10. The maximum value is 100; 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 ListOnlineReturnPolicies call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListOnlineReturnPolicies 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 ListOnlineReturnPolicies call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListOnlineReturnPolicies 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 merchant account for which to list return policies. Format: accounts/{account} Please see Google\Shopping\Merchant\Accounts\V1beta\OnlineReturnPolicyServiceClient::accountName() for help formatting this field.

Returns
Type	Description
Google\Shopping\Merchant\Accounts\V1beta\ListOnlineReturnPoliciesRequest