Product
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
Product captures all metadata information of items to be recommended or searched.
Attributes
Name
Description
expire_time
google.protobuf.timestamp_pb2.Timestamp
The timestamp when this product becomes unavailable for SearchService.Search . 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 . Google Merchant Center property
expiration_date
__.ttl
google.protobuf.duration_pb2.Duration
Input only. The TTL (time to live) of the product. If it is set, 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 .
name
str
Immutable. Full resource name of the product, such as
projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id
.
The branch ID must be "default_branch".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.
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 Product s, this field can only be empty or set to the same value as id . For VARIANT Product s, 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. Google Merchant Center Property
item_group_id
__.
Schema.org Property Product.inProductGroupWithID
__.
This field must be enabled before it can be used. `Learn
more `__.collection_member_ids
Sequence[str]
The id of the collection members when type is Type.COLLECTION . 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. Google Merchant Center property
gtin
__.
Schema.org property Product.isbn
__ or Product.gtin8
__ or Product.gtin12
__ or Product.gtin13
__ or Product.gtin14
__.
If the value is not a valid GTIN, an INVALID_ARGUMENT error
is returned.categories
Sequence[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, please 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. 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. Google Merchant Center property
title
__.
Schema.org property Product.name
__.brands
Sequence[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. 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. 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][https://www.rfc-editor.org/rfc/bcp/bcp47.txt]. For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Product s to provide text in multiple languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset.
attributes
Sequence[ google.cloud.retail_v2.types.Product.AttributesEntry
]
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.tags
Sequence[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 . Google Merchant Center property
custom_label_0–4
__.price_info
google.cloud.retail_v2.types.PriceInfo
Product price and cost information. Google Merchant Center property
price
__.rating
available_time
google.protobuf.timestamp_pb2.Timestamp
The timestamp when this Product becomes available for SearchService.Search .
availability
google.cloud.retail_v2.types.Product.Availability
The online availability of the Product . Default to Availability.IN_STOCK . 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
Sequence[ 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. Google Merchant Center property
link
__.
Schema.org property Offer.url
__.images
Sequence[ google.cloud.retail_v2.types.Image
]
Product images for the product.Highly recommended to put the main image to the first. A maximum of 300 images are allowed. 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. Google Merchant Center property
color
__.
Schema.org property Product.color
__.sizes
Sequence[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. Google Merchant Center property
size
__, size_type
__
and size_system
__.
Schema.org property Product.size
__.materials
Sequence[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 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property
material
__.
Schema.org property Product.material
__.patterns
Sequence[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. Google Merchant Center property
pattern
__.
Schema.org property Product.pattern
__.conditions
Sequence[str]
The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 5 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. Google Merchant Center property
condition
__.
Schema.org property Offer.itemCondition
__.promotions
Sequence[ google.cloud.retail_v2.types.Promotion
]
The promotions applied to the product. A maximum of 10 values are allowed per Product .
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 Product s are returned in SearchResponse . Supported fields for all type s: - 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 Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse may increase response payload size and serving latency.
variants
Sequence[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 Product s. Note: This field is OUTPUT_ONLY for ProductService.GetProduct . Do not set this field in API requests.
Classes
AttributesEntry
AttributesEntry
(
mapping
=
None
,
*
,
ignore_unknown_fields
=
False
,
**
kwargs
)
The abstract base class for a message.
Parameters
Name
Description
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.
Type
Type
(
value
)
The type of this product.
