Class Product (1.16.3)

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

Product captures all metadata information of items to be recommended or searched.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
expire_time google.protobuf.timestamp_pb2.Timestamp
The timestamp when this product becomes unavailable for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, the Product is not available for SearchService.Search after expire_time. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. expire_time must be later than available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property expiration_date __. This field is a member of oneof_ expiration.
ttl google.protobuf.duration_pb2.Duration
Input only. The TTL (time to live) of the product. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and expire_time is set as current timestamp plus ttl. The derived expire_time is returned in the output and ttl is left blank when retrieving the Product. If it is set, the product is not available for SearchService.Search after current timestamp plus ttl. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. This field is a member of oneof_ expiration.
name str
Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id.
id str
Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property id __. Schema.org property Product.sku __.
type_ google.cloud.retail_v2.types.Product.Type
Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.
primary_product_id str
Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property item_group_id __. Schema.org property Product.inProductGroupWithID __.
collection_member_ids MutableSequence[str]
The id of the collection members when type is Type.COLLECTION. Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.
gtin str
The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property gtin __. Schema.org property Product.isbn __, Product.gtin8 __, Product.gtin12 __, Product.gtin13 __, or Product.gtin14 __. If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
categories MutableSequence[str]
Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: :: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property google_product_category __. Schema.org property [Product.category] (https://schema.org/category).
title str
Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property title __. Schema.org property Product.name __.
brands MutableSequence[str]
The brands of the product. A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property brand __. Schema.org property Product.brand __.
description str
Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property description __. Schema.org property Product.description __.
language_code str
Language of the title/description and other string attributes. Use language tags defined by `BCP 47
attributes MutableMapping[str, google.cloud.retail_v2.types.CustomAttribute]
Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: { "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: - Max entries count: 200. - The key must be a UTF-8 encoded string with a length limit of 128 characters. - For indexable attribute, the key must match the pattern: ``a-zA-Z0-9][a-zA-Z0-9_]*``. For example, key0LikeThis or KEY_1_LIKE_THIS. - For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. - For number attributes, at most 400 values are allowed.
tags MutableSequence[str]
Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property custom_label_0–4 __.
price_info google.cloud.retail_v2.types.PriceInfo
Product price and cost information. Corresponding properties: Google Merchant Center property price __.
rating google.cloud.retail_v2.types.Rating
The rating of this product.
available_time google.protobuf.timestamp_pb2.Timestamp
The timestamp when this Product becomes available for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT.
availability google.cloud.retail_v2.types.Product.Availability
The online availability of the Product. Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property availability __. Schema.org property Offer.availability __.
available_quantity google.protobuf.wrappers_pb2.Int32Value
The available quantity of the item.
fulfillment_info MutableSequence[google.cloud.retail_v2.types.FulfillmentInfo]
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is returned.
uri str
Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property link __. Schema.org property Offer.url __.
images MutableSequence[google.cloud.retail_v2.types.Image]
Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property image_link __. Schema.org property Product.image __.
audience google.cloud.retail_v2.types.Audience
The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.
color_info google.cloud.retail_v2.types.ColorInfo
The color of the product. Corresponding properties: Google Merchant Center property color __. Schema.org property Product.color __.
sizes MutableSequence[str]
The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property size __, size_type __, and size_system __. Schema.org property Product.size __.
materials MutableSequence[str]
The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property material __. Schema.org property Product.material __.
patterns MutableSequence[str]
The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property pattern __. Schema.org property Product.pattern __.
conditions MutableSequence[str]
The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property condition __. Schema.org property Offer.itemCondition __.
promotions MutableSequence[google.cloud.retail_v2.types.Promotion]
The promotions applied to the product. A maximum of 10 values are allowed per Product. Only Promotion.promotion_id will be used, other fields will be ignored if set.
publish_time google.protobuf.timestamp_pb2.Timestamp
The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time, given it purely describes product freshness regardless of when it is available on search and recommendation.
retrievable_fields google.protobuf.field_mask_pb2.FieldMask
Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: - audience - availability - brands - color_info - conditions - gtin - materials - name - patterns - price_info - rating - sizes - title - uri Supported fields only for Type.PRIMARY and Type.COLLECTION: - categories - description - images Supported fields only for Type.VARIANT: - Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: - name For Type.VARIANT, the following fields are always returned in by default: - name - color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead.
variants MutableSequence[google.cloud.retail_v2.types.Product]
Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by primary_product_id for all the product variants. Only populated for Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.
local_inventories MutableSequence[google.cloud.retail_v2.types.LocalInventory]
Output only. A list of local inventories specific to different places. This field can be managed by ProductService.AddLocalInventories and ProductService.RemoveLocalInventories APIs if fine-grained, high-volume updates are necessary.

Classes

AttributesEntry

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

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Availability

Availability(value)

Product availability. If this field is unspecified, the product is assumed to be in stock.

Values: AVAILABILITY_UNSPECIFIED (0): Default product availability. Default to Availability.IN_STOCK if unset. IN_STOCK (1): Product in stock. OUT_OF_STOCK (2): Product out of stock. PREORDER (3): Product that is in pre-order state. BACKORDER (4): Product that is back-ordered (i.e. temporarily out of stock).

Type

Type(value)

The type of this product.

Values: TYPE_UNSPECIFIED (0): Default value. Default to Catalog.product_level_config.ingestion_product_type if unset. PRIMARY (1): The primary type.

    As the primary unit for predicting, indexing and search
    serving, a
    <xref uid="google.cloud.retail.v2.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref> is grouped with
    multiple
    <xref uid="google.cloud.retail.v2.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s.
VARIANT (2):
    The variant type.

    <xref uid="google.cloud.retail.v2.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s usually share
    some common attributes on the same
    <xref uid="google.cloud.retail.v2.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s, but they have
    variant attributes like different colors, sizes and prices,
    etc.
COLLECTION (3):
    The collection type. Collection products are bundled
    <xref uid="google.cloud.retail.v2.Product.Type.PRIMARY">Type.PRIMARY</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s or
    <xref uid="google.cloud.retail.v2.Product.Type.VARIANT">Type.VARIANT</xref>
    <xref uid="google.cloud.retail.v2.Product">Product</xref>s that are sold
    together, such as a jewelry set with necklaces, earrings and
    rings, etc.