Reference documentation and code samples for the Google Shopping Merchant Products V1beta Client class ListProductsRequest.
Request message for the ListProducts method.
Generated from protobuf message google.shopping.merchant.products.v1beta.ListProductsRequest
Namespace
Google \ Shopping \ Merchant \ Products \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The account to list processed products for. Format: accounts/{account} |
↳ page_size |
int
The maximum number of products 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 products will be returned. |
↳ page_token |
string
A page token, received from a previous |
getParent
Required. The account to list processed products for.
Format: accounts/{account}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The account to list processed products for.
Format: accounts/{account}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of products 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 products will be returned.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The maximum number of products 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 products will be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
A page token, received from a previous ListProducts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListProducts must
match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
A page token, received from a previous ListProducts call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListProducts 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 products for. Format: accounts/{account} Please see Google\Shopping\Merchant\Products\V1beta\ProductsServiceClient::accountName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Merchant\Products\V1beta\ListProductsRequest |
|