class Google::Apis::RetailV2::GoogleCloudRetailV2Product
Product captures all metadata information of items to be recommended or searched.
Attributes
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*. For example, key0LikeThis or KEY_1_LIKE_THIS. Corresponds to the JSON property `attributes` @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
An intended audience of the Product for whom it's sold. Corresponds to the JSON property `audience` @return [Google::Apis::RetailV2::GoogleCloudRetailV2Audience]
The online availability of the Product. Default to Availability.IN_STOCK. Google
Merchant Center Property [availability](support.google.com/ merchants/answer/6324448). Schema.org Property [Offer.availability](https:// schema.org/availability). Corresponds to the JSON property `availability` @return [String]
The available quantity of the item. Corresponds to the JSON property `availableQuantity` @return [Fixnum]
The timestamp when this Product becomes available for SearchService.Search. Corresponds to the JSON property `availableTime` @return [String]
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]( support.google.com/merchants/answer/6324351). Schema.org property [ Product.brand](schema.org/brand). Corresponds to the JSON property `brands` @return [Array<String>]
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] (schema.org/category). [ mc_google_product_category]: support.google.com/merchants/answer/ 6324436 Corresponds to the JSON property `categories` @return [Array<String>]
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. Corresponds to the JSON property `collectionMemberIds` @return [Array<String>]
The color information of a Product. Corresponds to the JSON property `colorInfo` @return [Google::Apis::RetailV2::GoogleCloudRetailV2ColorInfo]
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](support.google.com/merchants/answer/ 6324469). Schema.org property [Offer.itemCondition](schema.org/ itemCondition). Corresponds to the JSON property `conditions` @return [Array<String>]
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](support.google.com/ merchants/answer/6324468). schema.org property [Product.description](https:// schema.org/description). Corresponds to the JSON property `description` @return [String]
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](support.google.com/merchants/answer/6324499). Corresponds to the JSON property `expireTime` @return [String]
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. Corresponds to the JSON property `fulfillmentInfo` @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2FulfillmentInfo>]
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]( support.google.com/merchants/answer/6324461). Schema.org property [ Product.isbn](schema.org/isbn) or [Product.gtin8](schema.org/ gtin8) or [Product.gtin12](schema.org/gtin12) or [Product.gtin13]( schema.org/gtin13) or [Product.gtin14](schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property `gtin` @return [String]
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](support.google.com/merchants/answer/6324405). Schema.org Property [Product.sku](schema.org/sku). Corresponds to the JSON property `id` @return [String]
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](support.google.com/merchants/answer/6324350). Schema.org property [Product.image](schema.org/image). Corresponds to the JSON property `images` @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Image>]
Language of the title/description and other string attributes. Use language tags defined by BCP 47. 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 Products 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. Corresponds to the JSON property `languageCode` @return [String]
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](support.google.com/ merchants/answer/6324410). Schema.org property [Product.material](https:// schema.org/material). Corresponds to the JSON property `materials` @return [Array<String>]
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”. Corresponds to the JSON property `name` @return [String]
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](support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](schema.org/pattern). Corresponds to the JSON property `patterns` @return [Array<String>]
The price information of a Product. Corresponds to the JSON property `priceInfo` @return [Google::Apis::RetailV2::GoogleCloudRetailV2PriceInfo]
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. Google
Merchant Center Property [item_group_id](support.google.com/ merchants/answer/6324507). Schema.org Property [Product.inProductGroupWithID]( schema.org/inProductGroupWithID). This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). Corresponds to the JSON property `primaryProductId` @return [String]
The promotions applied to the product. A maximum of 10 values are allowed per Product. Corresponds to the JSON property `promotions` @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Promotion>]
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. Corresponds to the JSON property `publishTime` @return [String]
The rating of a Product. Corresponds to the JSON property `rating` @return [Google::Apis::RetailV2::GoogleCloudRetailV2Rating]
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
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. Corresponds to the JSON property `retrievableFields` @return [String]
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](support.google.com/ merchants/answer/6324492), [size_type](support.google.com/merchants/ answer/6324497) and [size_system](support.google.com/merchants/answer/ 6324502). Schema.org property [Product.size](schema.org/size). Corresponds to the JSON property `sizes` @return [Array<String>]
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](support.google.com/ merchants/answer/6324415). Schema.org property [Product.name](schema. org/name). Corresponds to the JSON property `title` @return [String]
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. Corresponds to the JSON property `ttl` @return [String]
Immutable. The type of the product. Default to Catalog.product_level_config. ingestion_product_type if unset. Corresponds to the JSON property `type` @return [String]
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]( support.google.com/merchants/answer/6324416). Schema.org property [ Offer.url](schema.org/url). Corresponds to the JSON property `uri` @return [String]
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. Corresponds to the JSON property `variants` @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Product>]
Public Class Methods
# File lib/google/apis/retail_v2/classes.rb, line 1825 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/retail_v2/classes.rb, line 1830 def update!(**args) @attributes = args[:attributes] if args.key?(:attributes) @audience = args[:audience] if args.key?(:audience) @availability = args[:availability] if args.key?(:availability) @available_quantity = args[:available_quantity] if args.key?(:available_quantity) @available_time = args[:available_time] if args.key?(:available_time) @brands = args[:brands] if args.key?(:brands) @categories = args[:categories] if args.key?(:categories) @collection_member_ids = args[:collection_member_ids] if args.key?(:collection_member_ids) @color_info = args[:color_info] if args.key?(:color_info) @conditions = args[:conditions] if args.key?(:conditions) @description = args[:description] if args.key?(:description) @expire_time = args[:expire_time] if args.key?(:expire_time) @fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info) @gtin = args[:gtin] if args.key?(:gtin) @id = args[:id] if args.key?(:id) @images = args[:images] if args.key?(:images) @language_code = args[:language_code] if args.key?(:language_code) @materials = args[:materials] if args.key?(:materials) @name = args[:name] if args.key?(:name) @patterns = args[:patterns] if args.key?(:patterns) @price_info = args[:price_info] if args.key?(:price_info) @primary_product_id = args[:primary_product_id] if args.key?(:primary_product_id) @promotions = args[:promotions] if args.key?(:promotions) @publish_time = args[:publish_time] if args.key?(:publish_time) @rating = args[:rating] if args.key?(:rating) @retrievable_fields = args[:retrievable_fields] if args.key?(:retrievable_fields) @sizes = args[:sizes] if args.key?(:sizes) @tags = args[:tags] if args.key?(:tags) @title = args[:title] if args.key?(:title) @ttl = args[:ttl] if args.key?(:ttl) @type = args[:type] if args.key?(:type) @uri = args[:uri] if args.key?(:uri) @variants = args[:variants] if args.key?(:variants) end