Reference documentation and code samples for the Google Shopping Merchant Promotions V1 Client class ListPromotionsRequest.
Request message for the ListPromotions method.
Generated from protobuf message google.shopping.merchant.promotions.v1.ListPromotionsRequest
Namespace
Google \ Shopping \ Merchant \ Promotions \ V1Methods
__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: |
↳ page_size |
int
Optional. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of promotions will be returned. |
↳ page_token |
string
Optional. A page token, received from a previous |
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
Optional. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of promotions will be returned.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of promotions to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of promotions will be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. 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
Optional. 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: |
| Returns | |
|---|---|
| Type | Description |
ListPromotionsRequest |
|