Class Product (3.1.2)

Product(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Product contains ReferenceImages.


name str
The resource name of the product. Format is: ``projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID``. This field is ignored when creating a product.
display_name str
The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.
description str
User-provided metadata to be stored with this product. Must be at most 4096 characters long.
product_category str
Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.
product_labels Sequence[]
Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.


builtins.object > proto.message.Message > Product



KeyValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A product label represented as a key-value pair.