List
|
|||||
|
|
||||
Lists products in an unspecified order.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- Apply machine learning models to understand and label images
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
parent Required |
STRING |
The project OR ProductSet from which Products should be listed. Format:
|
pageToken |
STRING |
The next_page_token returned from a previous List request, if any |
pageSize |
INTEGER |
The maximum number of items to return. Default 10, maximum 100 |
= Parameter name
= Format
|
parent STRING Required The project OR ProductSet from which Products should be listed. Format:
|
|
pageToken STRING The next_page_token returned from a previous List request, if any |
|
pageSize INTEGER The maximum number of items to return. Default 10, maximum 100 |
Output
This building block provides 9 output parameters
| Name | Format | Description |
|---|---|---|
products[] |
OBJECT |
A Product contains ReferenceImages |
products[].name |
STRING |
The resource name of the product. Format is:
This field is ignored when creating a product |
products[].displayName |
STRING |
The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long |
products[].description |
STRING |
User-provided metadata to be stored with this product. Must be at most 4096 characters long |
products[].productCategory |
STRING |
The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable |
products[].productLabels[] |
OBJECT |
A product label represented as a key-value pair |
products[].productLabels[].value |
STRING |
The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes |
products[].productLabels[].key |
STRING |
The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes |
nextPageToken |
STRING |
Token to retrieve the next page of results, or empty if there are no more results in the list |
= Parameter name
= Format
|
products[] OBJECT A Product contains ReferenceImages |
|
products[].name STRING The resource name of the product. Format is:
This field is ignored when creating a product |
|
products[].displayName STRING The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long |
|
products[].description STRING User-provided metadata to be stored with this product. Must be at most 4096 characters long |
|
products[].productCategory STRING The category for the product identified by the reference image. This should be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. This field is immutable |
|
products[].productLabels[] OBJECT A product label represented as a key-value pair |
|
products[].productLabels[].value STRING The value of the label attached to the product. Cannot be empty and cannot exceed 128 bytes |
|
products[].productLabels[].key STRING The key of the label attached to the product. Cannot be empty and cannot exceed 128 bytes |
|
nextPageToken STRING Token to retrieve the next page of results, or empty if there are no more results in the list |