Reference documentation and code samples for the Google Cloud Retail V2 Client class ListProductsRequest.
Request message for ProductService.ListProducts method.
Generated from protobuf message google.cloud.retail.v2.ListProductsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent branch resource name, such as |
↳ page_size |
int
Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
↳ page_token |
string
A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. |
↳ filter |
string
A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: |
↳ read_mask |
Google\Protobuf\FieldMask
The fields of Product to return in the responses. If not set or empty, the following fields are returned: * Product.name * Product.id * Product.title * Product.uri * Product.images * Product.price_info * Product.brands If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
getParent
Required. The parent branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0. Use
default_branch as the branch ID, to list products under the default
branch.
If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0. Use
default_branch as the branch ID, to list products under the default
branch.
If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
Generated from protobuf field int32 page_size = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
Generated from protobuf field int32 page_size = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field string page_token = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field string page_token = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
A filter to apply on the list results. Supported features:
List all the products under the parent branch if filter is unset.
List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example:
primary_product_id = "some_product_id"- List Products bundled in a
Product.Type.COLLECTION
Product.
For example:
collection_product_id = "some_product_id" - List Products with a partibular type.
For example:
type = "PRIMARY"type = "VARIANT"type = "COLLECTION"If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.
Generated from protobuf field string filter = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
A filter to apply on the list results. Supported features:
List all the products under the parent branch if filter is unset.
List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example:
primary_product_id = "some_product_id"- List Products bundled in a
Product.Type.COLLECTION
Product.
For example:
collection_product_id = "some_product_id" - List Products with a partibular type.
For example:
type = "PRIMARY"type = "VARIANT"type = "COLLECTION"If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.
Generated from protobuf field string filter = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadMask
The fields of Product to return in the responses. If not set or empty, the following fields are returned:
- Product.name
- Product.id
- Product.title
- Product.uri
- Product.images
- Product.price_info
- Product.brands If "*" is provided, all fields are returned.
Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasReadMask
clearReadMask
setReadMask
The fields of Product to return in the responses. If not set or empty, the following fields are returned:
- Product.name
- Product.id
- Product.title
- Product.uri
- Product.images
- Product.price_info
- Product.brands If "*" is provided, all fields are returned.
Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |