Reference documentation and code samples for the Google Cloud Retail V2 Client class Product.
Product captures all metadata information of items to be recommended or searched.
Generated from protobuf message google.cloud.retail.v2.Product
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ expire_time |
Google\Protobuf\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. 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. |
↳ ttl |
Google\Protobuf\Duration
Input only. The TTL (time to live) of the product. 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. |
↳ name |
string
Immutable. Full resource name of the product, such as |
↳ id |
string
Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is |
↳ type |
int
Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset. |
↳ primary_product_id |
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. |
↳ collection_member_ids |
array
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 |
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. |
↳ categories |
array
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. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category. [mc_google_product_category]: https://support.google.com/merchants/answer/6324436 |
↳ title |
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. |
↳ brands |
array
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 |
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. |
↳ language_code |
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. |
↳ attributes |
array|Google\Protobuf\Internal\MapField
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: |
↳ tags |
array
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\PriceInfo
Product price and cost information. Corresponding properties: Google Merchant Center property price. |
↳ rating |
Google\Cloud\Retail\V2\Rating
The rating of this product. |
↳ available_time |
Google\Protobuf\Timestamp
The timestamp when this Product becomes available for SearchService.Search. |
↳ availability |
int
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\Int32Value
The available quantity of the item. |
↳ fulfillment_info |
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. |
↳ uri |
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. |
↳ images |
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. |
↳ audience |
Google\Cloud\Retail\V2\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\ColorInfo
The color of the product. Corresponding properties: Google Merchant Center property color. Schema.org property Product.color. |
↳ sizes |
array
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 |
array
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 |
array
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 |
array
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 |
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 |
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. |
↳ retrievable_fields |
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: * 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. |
↳ variants |
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. |
↳ local_inventories |
array<Google\Cloud\Retail\V2\LocalInventory>
Output only. A list of local inventories specific to different places. This is only available for users who have Retail Search enabled, and it can be managed by AddLocalInventories and RemoveLocalInventories APIs. |
getExpireTime
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. 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.
Generated from protobuf field .google.protobuf.Timestamp expire_time = 16;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasExpireTime
setExpireTime
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. 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.
Generated from protobuf field .google.protobuf.Timestamp expire_time = 16;
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getTtl
Input only. The TTL (time to live) of the product.
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.
Generated from protobuf field .google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasTtl
setTtl
Input only. The TTL (time to live) of the product.
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.
Generated from protobuf field .google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
getName
Immutable. Full resource name of the product, such as
projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id
.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
string |
setName
Immutable. Full resource name of the product, such as
projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id
.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getId
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.
Generated from protobuf field string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
string |
setId
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.
Generated from protobuf field string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getType
Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.
Generated from protobuf field .google.cloud.retail.v2.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
int |
setType
Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.
Generated from protobuf field .google.cloud.retail.v2.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPrimaryProductId
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.
Generated from protobuf field string primary_product_id = 4;
Returns | |
---|---|
Type | Description |
string |
setPrimaryProductId
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.
Generated from protobuf field string primary_product_id = 4;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCollectionMemberIds
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.
Generated from protobuf field repeated string collection_member_ids = 5;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setCollectionMemberIds
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.
Generated from protobuf field repeated string collection_member_ids = 5;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getGtin
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.
Generated from protobuf field string gtin = 6;
Returns | |
---|---|
Type | Description |
string |
setGtin
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.
Generated from protobuf field string gtin = 6;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getCategories
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. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category. [mc_google_product_category]: https://support.google.com/merchants/answer/6324436
Generated from protobuf field repeated string categories = 7;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setCategories
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. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category. [mc_google_product_category]: https://support.google.com/merchants/answer/6324436
Generated from protobuf field repeated string categories = 7;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getTitle
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.
Generated from protobuf field string title = 8 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
string |
setTitle
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.
Generated from protobuf field string title = 8 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getBrands
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.
Generated from protobuf field repeated string brands = 9;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setBrands
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.
Generated from protobuf field repeated string brands = 9;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getDescription
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.
Generated from protobuf field string description = 10;
Returns | |
---|---|
Type | Description |
string |
setDescription
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.
Generated from protobuf field string description = 10;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getLanguageCode
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.
Generated from protobuf field string language_code = 11;
Returns | |
---|---|
Type | Description |
string |
setLanguageCode
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.
Generated from protobuf field string language_code = 11;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAttributes
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
orKEY_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.
Generated from protobuf field map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 12;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setAttributes
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
orKEY_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.
Generated from protobuf field map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 12;
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getTags
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.
Generated from protobuf field repeated string tags = 13;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setTags
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.
Generated from protobuf field repeated string tags = 13;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getPriceInfo
Product price and cost information.
Corresponding properties: Google Merchant Center property price.
Generated from protobuf field .google.cloud.retail.v2.PriceInfo price_info = 14;
Returns | |
---|---|
Type | Description |
Google\Cloud\Retail\V2\PriceInfo|null |
hasPriceInfo
clearPriceInfo
setPriceInfo
Product price and cost information.
Corresponding properties: Google Merchant Center property price.
Generated from protobuf field .google.cloud.retail.v2.PriceInfo price_info = 14;
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Retail\V2\PriceInfo
|
Returns | |
---|---|
Type | Description |
$this |
getRating
The rating of this product.
Generated from protobuf field .google.cloud.retail.v2.Rating rating = 15;
Returns | |
---|---|
Type | Description |
Google\Cloud\Retail\V2\Rating|null |
hasRating
clearRating
setRating
The rating of this product.
Generated from protobuf field .google.cloud.retail.v2.Rating rating = 15;
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Retail\V2\Rating
|
Returns | |
---|---|
Type | Description |
$this |
getAvailableTime
The timestamp when this Product becomes available for SearchService.Search.
Generated from protobuf field .google.protobuf.Timestamp available_time = 18;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasAvailableTime
clearAvailableTime
setAvailableTime
The timestamp when this Product becomes available for SearchService.Search.
Generated from protobuf field .google.protobuf.Timestamp available_time = 18;
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getAvailability
The online availability of the Product.
Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability.
Generated from protobuf field .google.cloud.retail.v2.Product.Availability availability = 19;
Returns | |
---|---|
Type | Description |
int |
setAvailability
The online availability of the Product.
Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability.
Generated from protobuf field .google.cloud.retail.v2.Product.Availability availability = 19;
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getAvailableQuantity
The available quantity of the item.
Generated from protobuf field .google.protobuf.Int32Value available_quantity = 20;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Int32Value|null |
hasAvailableQuantity
clearAvailableQuantity
getAvailableQuantityValue
Returns the unboxed value from getAvailableQuantity()
The available quantity of the item.
Generated from protobuf field .google.protobuf.Int32Value available_quantity = 20;
Returns | |
---|---|
Type | Description |
int|null |
setAvailableQuantity
The available quantity of the item.
Generated from protobuf field .google.protobuf.Int32Value available_quantity = 20;
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Int32Value
|
Returns | |
---|---|
Type | Description |
$this |
setAvailableQuantityValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
The available quantity of the item.
Generated from protobuf field .google.protobuf.Int32Value available_quantity = 20;
Parameter | |
---|---|
Name | Description |
var |
int|null
|
Returns | |
---|---|
Type | Description |
$this |
getFulfillmentInfo
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.
Generated from protobuf field repeated .google.cloud.retail.v2.FulfillmentInfo fulfillment_info = 21;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setFulfillmentInfo
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.
Generated from protobuf field repeated .google.cloud.retail.v2.FulfillmentInfo fulfillment_info = 21;
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Retail\V2\FulfillmentInfo>
|
Returns | |
---|---|
Type | Description |
$this |
getUri
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.
Generated from protobuf field string uri = 22;
Returns | |
---|---|
Type | Description |
string |
setUri
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.
Generated from protobuf field string uri = 22;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getImages
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.
Generated from protobuf field repeated .google.cloud.retail.v2.Image images = 23;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setImages
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.
Generated from protobuf field repeated .google.cloud.retail.v2.Image images = 23;
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Retail\V2\Image>
|
Returns | |
---|---|
Type | Description |
$this |
getAudience
The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.
Generated from protobuf field .google.cloud.retail.v2.Audience audience = 24;
Returns | |
---|---|
Type | Description |
Google\Cloud\Retail\V2\Audience|null |
hasAudience
clearAudience
setAudience
The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product.
Generated from protobuf field .google.cloud.retail.v2.Audience audience = 24;
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Retail\V2\Audience
|
Returns | |
---|---|
Type | Description |
$this |
getColorInfo
The color of the product.
Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.
Generated from protobuf field .google.cloud.retail.v2.ColorInfo color_info = 25;
Returns | |
---|---|
Type | Description |
Google\Cloud\Retail\V2\ColorInfo|null |
hasColorInfo
clearColorInfo
setColorInfo
The color of the product.
Corresponding properties: Google Merchant Center property color. Schema.org property Product.color.
Generated from protobuf field .google.cloud.retail.v2.ColorInfo color_info = 25;
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Retail\V2\ColorInfo
|
Returns | |
---|---|
Type | Description |
$this |
getSizes
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.
Generated from protobuf field repeated string sizes = 26;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setSizes
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.
Generated from protobuf field repeated string sizes = 26;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getMaterials
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.
Generated from protobuf field repeated string materials = 27;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setMaterials
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.
Generated from protobuf field repeated string materials = 27;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getPatterns
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.
Generated from protobuf field repeated string patterns = 28;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setPatterns
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.
Generated from protobuf field repeated string patterns = 28;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getConditions
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.
Generated from protobuf field repeated string conditions = 29;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setConditions
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.
Generated from protobuf field repeated string conditions = 29;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getPromotions
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.
Generated from protobuf field repeated .google.cloud.retail.v2.Promotion promotions = 34;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setPromotions
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.
Generated from protobuf field repeated .google.cloud.retail.v2.Promotion promotions = 34;
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Retail\V2\Promotion>
|
Returns | |
---|---|
Type | Description |
$this |
getPublishTime
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.
Generated from protobuf field .google.protobuf.Timestamp publish_time = 33;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasPublishTime
clearPublishTime
setPublishTime
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.
Generated from protobuf field .google.protobuf.Timestamp publish_time = 33;
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getRetrievableFields
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.
Generated from protobuf field .google.protobuf.FieldMask retrievable_fields = 30;
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasRetrievableFields
clearRetrievableFields
setRetrievableFields
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.
Generated from protobuf field .google.protobuf.FieldMask retrievable_fields = 30;
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |
getVariants
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.
Generated from protobuf field repeated .google.cloud.retail.v2.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setVariants
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.
Generated from protobuf field repeated .google.cloud.retail.v2.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Retail\V2\Product>
|
Returns | |
---|---|
Type | Description |
$this |
getLocalInventories
Output only. A list of local inventories specific to different places.
This is only available for users who have Retail Search enabled, and it can be managed by AddLocalInventories and RemoveLocalInventories APIs.
Generated from protobuf field repeated .google.cloud.retail.v2.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setLocalInventories
Output only. A list of local inventories specific to different places.
This is only available for users who have Retail Search enabled, and it can be managed by AddLocalInventories and RemoveLocalInventories APIs.
Generated from protobuf field repeated .google.cloud.retail.v2.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Retail\V2\LocalInventory>
|
Returns | |
---|---|
Type | Description |
$this |
getExpiration
Returns | |
---|---|
Type | Description |
string |