Google Shopping Merchant Promotions V1beta Client - Class ListPromotionsRequest (0.1.0)

Version 0.1.0

• 0.1.2 (latest)
• 0.1.1

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 Promotions V1beta Client class ListPromotionsRequest.

Request message for the ListPromotions method.

Generated from protobuf message google.shopping.merchant.promotions.v1beta.ListPromotionsRequest

Namespace

Google \ Shopping \ Merchant \ Promotions \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The account to list processed promotions for. Format: accounts/{account}
↳ page_size	int Output only. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of promotions will be returned.
↳ page_token	string Output only. A page token, received from a previous ListPromotions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPromotions must match the call that provided the page token.

getParent

Required. The account to list processed promotions for.

Format: accounts/{account}

Returns
Type	Description
string

setParent

Required. The account to list processed promotions for.

Format: accounts/{account}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Output only. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of promotions will be returned.

Returns
Type	Description
int

setPageSize

Output only. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of promotions will be returned.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Output only. A page token, received from a previous ListPromotions call.

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

Returns
Type	Description
string

setPageToken

Output only. A page token, received from a previous ListPromotions call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPromotions 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 processed promotions for. Format: accounts/{account}

Returns
Type	Description
Google\Shopping\Merchant\Promotions\V1beta\ListPromotionsRequest