Retail V2 API - Class Google::Cloud::Retail::V2::Product (v1.0.1)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::Product.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#attributes

def attributes() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::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.

#attributes=

def attributes=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}

Parameter

value (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::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.

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::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.

#audience

def audience() -> ::Google::Cloud::Retail::V2::Audience

Returns

(::Google::Cloud::Retail::V2::Audience) — The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.

#audience=

def audience=(value) -> ::Google::Cloud::Retail::V2::Audience

Parameter

value (::Google::Cloud::Retail::V2::Audience) — The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.

Returns

(::Google::Cloud::Retail::V2::Audience) — The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.

#availability

def availability() -> ::Google::Cloud::Retail::V2::Product::Availability

Returns

(::Google::Cloud::Retail::V2::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.

#availability=

def availability=(value) -> ::Google::Cloud::Retail::V2::Product::Availability

Parameter

value (::Google::Cloud::Retail::V2::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.

Returns

(::Google::Cloud::Retail::V2::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

def available_quantity() -> ::Google::Protobuf::Int32Value

Returns

(::Google::Protobuf::Int32Value) — The available quantity of the item.

#available_quantity=

def available_quantity=(value) -> ::Google::Protobuf::Int32Value

Parameter

value (::Google::Protobuf::Int32Value) — The available quantity of the item.

Returns

(::Google::Protobuf::Int32Value) — The available quantity of the item.

#available_time

def available_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::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.

#available_time=

def available_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::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.

Returns

(::Google::Protobuf::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.

#brands

def brands() -> ::Array<::String>

Returns

(::Array<::String>) — The brands of the product.

A maximum of 30 brands are allowed unless overridden through the Google Cloud console. 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.

#brands=

def brands=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — The brands of the product.

A maximum of 30 brands are allowed unless overridden through the Google Cloud console. 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.

Returns

(::Array<::String>) — The brands of the product.

A maximum of 30 brands are allowed unless overridden through the Google Cloud console. 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.

#categories

def categories() -> ::Array<::String>

Returns

(::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, 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 unless overridden through the Google Cloud console. 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.

#categories=

def categories=(value) -> ::Array<::String>

Parameter

value (::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, 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 unless overridden through the Google Cloud console. 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.

Returns

(::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, 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 unless overridden through the Google Cloud console. 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.

#collection_member_ids

def collection_member_ids() -> ::Array<::String>

Returns

(::Array<::String>) — 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.

#collection_member_ids=

def collection_member_ids=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — 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.

Returns

(::Array<::String>) — 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.

#color_info

def color_info() -> ::Google::Cloud::Retail::V2::ColorInfo

Returns

(::Google::Cloud::Retail::V2::ColorInfo) — The color of the product.

Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.

#color_info=

def color_info=(value) -> ::Google::Cloud::Retail::V2::ColorInfo

Parameter

value (::Google::Cloud::Retail::V2::ColorInfo) — The color of the product.

Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.

Returns

(::Google::Cloud::Retail::V2::ColorInfo) — The color of the product.

Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.

#conditions

def conditions() -> ::Array<::String>

Returns

(::Array<::String>) — 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.

#conditions=

def conditions=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — 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.

Returns

(::Array<::String>) — 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.

#description

def description() -> ::String

Returns

(::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.

Corresponding properties: Google Merchant Center property description. Schema.org property Product.description.

#description=

def description=(value) -> ::String

Parameter

value (::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.

Corresponding properties: Google Merchant Center property description. Schema.org property Product.description.

Returns

(::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.

Corresponding properties: Google Merchant Center property description. Schema.org property Product.description.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Note that this field is applied in the following ways:
- If the Product is already expired when it is uploaded, this product is not indexed for search.
- If the Product is not expired when it is uploaded, only the Type.PRIMARY's and Type.COLLECTION's expireTime is respected, and Type.VARIANT's expireTime is not used.
In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness.

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.

#expire_time=

def expire_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Note that this field is applied in the following ways:
- If the Product is already expired when it is uploaded, this product is not indexed for search.
- If the Product is not expired when it is uploaded, only the Type.PRIMARY's and Type.COLLECTION's expireTime is respected, and Type.VARIANT's expireTime is not used.
In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness.

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.

Returns

(::Google::Protobuf::Timestamp) — Note that this field is applied in the following ways:
- If the Product is already expired when it is uploaded, this product is not indexed for search.
- If the Product is not expired when it is uploaded, only the Type.PRIMARY's and Type.COLLECTION's expireTime is respected, and Type.VARIANT's expireTime is not used.
In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness.

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.

#fulfillment_info

def fulfillment_info() -> ::Array<::Google::Cloud::Retail::V2::FulfillmentInfo>

Returns

(::Array<::Google::Cloud::Retail::V2::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.

#fulfillment_info=

def fulfillment_info=(value) -> ::Array<::Google::Cloud::Retail::V2::FulfillmentInfo>

Parameter

value (::Array<::Google::Cloud::Retail::V2::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.

Returns

(::Array<::Google::Cloud::Retail::V2::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.

#gtin

def gtin() -> ::String

Returns

(::String) — 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.

#gtin=

def gtin=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#id

def id() -> ::String

Returns

(::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.

Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku.

#id=

def id=(value) -> ::String

Parameter

value (::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.

Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku.

Returns

(::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.

Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku.

#images

def images() -> ::Array<::Google::Cloud::Retail::V2::Image>

Returns

(::Array<::Google::Cloud::Retail::V2::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.

#images=

def images=(value) -> ::Array<::Google::Cloud::Retail::V2::Image>

Parameter

value (::Array<::Google::Cloud::Retail::V2::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.

Returns

(::Array<::Google::Cloud::Retail::V2::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.

#language_code

def language_code() -> ::String

Returns

(::String) — 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.

#language_code=

def language_code=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#local_inventories

def local_inventories() -> ::Array<::Google::Cloud::Retail::V2::LocalInventory>

Returns

(::Array<::Google::Cloud::Retail::V2::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.

#materials

def materials() -> ::Array<::String>

Returns

(::Array<::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 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property material. Schema.org property Product.material.

#materials=

def materials=(value) -> ::Array<::String>

Parameter

value (::Array<::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 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property material. Schema.org property Product.material.

Returns

(::Array<::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 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Corresponding properties: Google Merchant Center property material. Schema.org property Product.material.

#name

def name() -> ::String

Returns

(::String) — Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id.

Returns

(::String) — Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id.

#patterns

def patterns() -> ::Array<::String>

Returns

(::Array<::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.

Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern.

#patterns=

def patterns=(value) -> ::Array<::String>

Parameter

value (::Array<::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.

Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern.

Returns

(::Array<::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.

Corresponding properties: Google Merchant Center property pattern. Schema.org property Product.pattern.

#price_info

def price_info() -> ::Google::Cloud::Retail::V2::PriceInfo

Returns

(::Google::Cloud::Retail::V2::PriceInfo) — Product price and cost information.

Corresponding properties: Google Merchant Center property price.

#price_info=

def price_info=(value) -> ::Google::Cloud::Retail::V2::PriceInfo

Parameter

value (::Google::Cloud::Retail::V2::PriceInfo) — Product price and cost information.

Corresponding properties: Google Merchant Center property price.

Returns

(::Google::Cloud::Retail::V2::PriceInfo) — Product price and cost information.

Corresponding properties: Google Merchant Center property price.

#primary_product_id

def primary_product_id() -> ::String

Returns

(::String) — 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.

#primary_product_id=

def primary_product_id=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#promotions

def promotions() -> ::Array<::Google::Cloud::Retail::V2::Promotion>

Returns

(::Array<::Google::Cloud::Retail::V2::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.

#promotions=

def promotions=(value) -> ::Array<::Google::Cloud::Retail::V2::Promotion>

Parameter

value (::Array<::Google::Cloud::Retail::V2::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.

Returns

(::Array<::Google::Cloud::Retail::V2::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

def publish_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::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.

#publish_time=

def publish_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::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.

Returns

(::Google::Protobuf::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.

#rating

def rating() -> ::Google::Cloud::Retail::V2::Rating

Returns

(::Google::Cloud::Retail::V2::Rating) — The rating of this product.

#rating=

def rating=(value) -> ::Google::Cloud::Retail::V2::Rating

Parameter

value (::Google::Cloud::Retail::V2::Rating) — The rating of this product.

Returns

(::Google::Cloud::Retail::V2::Rating) — The rating of this product.

#retrievable_fields

def retrievable_fields() -> ::Google::Protobuf::FieldMask

Returns

(::Google::Protobuf::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:
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.

#retrievable_fields=

def retrievable_fields=(value) -> ::Google::Protobuf::FieldMask

Parameter

value (::Google::Protobuf::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:
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.

Returns

(::Google::Protobuf::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:
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.

#sizes

def sizes() -> ::Array<::String>

Returns

(::Array<::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.

Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product.size.

#sizes=

def sizes=(value) -> ::Array<::String>

Parameter

value (::Array<::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.

Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product.size.

Returns

(::Array<::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.

Corresponding properties: Google Merchant Center property size, size_type, and size_system. Schema.org property Product.size.

#tags

def tags() -> ::Array<::String>

Returns

(::Array<::String>) — 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.

#tags=

def tags=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — 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.

Returns

(::Array<::String>) — 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.

#title

def title() -> ::String

Returns

(::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.

Corresponding properties: Google Merchant Center property title. Schema.org property Product.name.

#title=

def title=(value) -> ::String

Parameter

value (::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.

Corresponding properties: Google Merchant Center property title. Schema.org property Product.name.

Returns

(::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.

Corresponding properties: Google Merchant Center property title. Schema.org property Product.name.

#ttl

def ttl() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::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.

#ttl=

def ttl=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::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.

Returns

(::Google::Protobuf::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.

#type

def type() -> ::Google::Cloud::Retail::V2::Product::Type

Returns

(::Google::Cloud::Retail::V2::Product::Type) — Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.

#type=

def type=(value) -> ::Google::Cloud::Retail::V2::Product::Type

Parameter

value (::Google::Cloud::Retail::V2::Product::Type) — Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.

Returns

(::Google::Cloud::Retail::V2::Product::Type) — Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.

#uri

def uri() -> ::String

Returns

(::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.

Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url.

#uri=

def uri=(value) -> ::String

Parameter

value (::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.

Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url.

Returns

(::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.

Corresponding properties: Google Merchant Center property link. Schema.org property Offer.url.

#variants

def variants() -> ::Array<::Google::Cloud::Retail::V2::Product>

Returns

(::Array<::Google::Cloud::Retail::V2::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.