<?php

# Generated by the protocol buffer compiler. DO NOT EDIT!

# source: google/cloud/retail/v2/product.proto

namespace Google\Cloud\Retail\V2;

use Google\Protobuf\Internal\GPBType;

use Google\Protobuf\Internal\RepeatedField;

use Google\Protobuf\Internal\GPBUtil;

/**

* Product captures all metadata information of items to be recommended or

* searched.

*

* Generated from protobuf message <code>google.cloud.retail.v2.Product</code>

*/

class Product extends \Google\Protobuf\Internal\Message

{

/**

* Immutable. Full resource name of the product, such as

* `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.

*

* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code>

*/

private $name = '';

/**

* Immutable. [Product][google.cloud.retail.v2.Product] identifier, which is

* the final component of [name][google.cloud.retail.v2.Product.name]. For

* example, this field is "id_1", if

* [name][google.cloud.retail.v2.Product.name] is

* `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`.

* This field must be a UTF-8 encoded string with a length limit of 128

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [id](https://support.google.com/merchants/answer/6324405). Schema.org

* Property [Product.sku](https://schema.org/sku).

*

* Generated from protobuf field <code>string id = 2 [(.google.api.field_behavior) = IMMUTABLE];</code>

*/

private $id = '';

/**

* Immutable. The type of the product. Default to

* [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2.ProductLevelConfig.ingestion_product_type]

* if unset.

*

* Generated from protobuf field <code>.google.cloud.retail.v2.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE];</code>

*/

private $type = 0;

/**

* Variant group identifier. Must be an

* [id][google.cloud.retail.v2.Product.id], with the same parent branch with

* this product. Otherwise, an error is thrown.

* For [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]

* [Product][google.cloud.retail.v2.Product]s, this field can only be empty or

* set to the same value as [id][google.cloud.retail.v2.Product.id].

* For VARIANT [Product][google.cloud.retail.v2.Product]s, this field cannot

* be empty. A maximum of 2,000 products are allowed to share the same

* [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]

* [Product][google.cloud.retail.v2.Product]. Otherwise, an INVALID_ARGUMENT

* error is returned.

* Google Merchant Center Property

* [item_group_id](https://support.google.com/merchants/answer/6324507).

* Schema.org Property

* [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).

* This field must be enabled before it can be used. [Learn

* more](https://cloud.google.com/recommendations-ai/docs/catalog#item-group-id).

*

* Generated from protobuf field <code>string primary_product_id = 4;</code>

*/

private $primary_product_id = '';

/**

* The [id][google.cloud.retail.v2.Product.id] of the collection members when

* [type][google.cloud.retail.v2.Product.type] is

* [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION].

* 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 <code>repeated string collection_member_ids = 5;</code>

*/

private $collection_member_ids;

/**

* The Global Trade Item Number (GTIN) of the product.

* This field must be a UTF-8 encoded string with a length limit of 128

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is

* returned.

* Google Merchant Center property

* [gtin](https://support.google.com/merchants/answer/6324461).

* Schema.org property

* [Product.isbn](https://schema.org/isbn) or

* [Product.gtin8](https://schema.org/gtin8) or

* [Product.gtin12](https://schema.org/gtin12) or

* [Product.gtin13](https://schema.org/gtin13) or

* [Product.gtin14](https://schema.org/gtin14).

* If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.

*

* Generated from protobuf field <code>string gtin = 6;</code>

*/

private $gtin = '';

/**

* 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][google.cloud.retail.v2.Product.Type.PRIMARY]

* [Product][google.cloud.retail.v2.Product] otherwise an INVALID_ARGUMENT

* error is returned.

* At most 250 values are allowed per

* [Product][google.cloud.retail.v2.Product]. Empty values are not allowed.

* Each value must be a UTF-8 encoded string with a length limit of 5,000

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [google_product_category][mc_google_product_category]. Schema.org property

* [Product.category] (https://schema.org/category).

* [mc_google_product_category]:

* https://support.google.com/merchants/answer/6324436

*

* Generated from protobuf field <code>repeated string categories = 7;</code>

*/

private $categories;

/**

* Required. Product title.

* This field must be a UTF-8 encoded string with a length limit of 1,000

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [title](https://support.google.com/merchants/answer/6324415). Schema.org

* property [Product.name](https://schema.org/name).

*

* Generated from protobuf field <code>string title = 8 [(.google.api.field_behavior) = REQUIRED];</code>

*/

private $title = '';

/**

* The brands of the product.

* A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded

* string with a length limit of 1,000 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [brand](https://support.google.com/merchants/answer/6324351). Schema.org

* property [Product.brand](https://schema.org/brand).

*

* Generated from protobuf field <code>repeated string brands = 9;</code>

*/

private $brands;

/**

* Product description.

* This field must be a UTF-8 encoded string with a length limit of 5,000

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [description](https://support.google.com/merchants/answer/6324468).

* schema.org property [Product.description](https://schema.org/description).

*

* Generated from protobuf field <code>string description = 10;</code>

*/

private $description = '';

/**

* Language of the title/description and other string attributes. Use language

* tags defined by [BCP 47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].

* For product prediction, this field is ignored and the model automatically

* detects the text language. The [Product][google.cloud.retail.v2.Product]

* can include text in different languages, but duplicating

* [Product][google.cloud.retail.v2.Product]s to provide text in multiple

* languages can result in degraded model performance.

* For product search this field is in use. It defaults to "en-US" if unset.

*

* Generated from protobuf field <code>string language_code = 11;</code>

*/

private $language_code = '';

/**

* 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.

*

* Generated from protobuf field <code>map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 12;</code>

*/

private $attributes;

/**

* Custom tags associated with the product.

* At most 250 values are allowed per

* [Product][google.cloud.retail.v2.Product]. This value must be a UTF-8

* encoded string with a length limit of 1,000 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* This tag can be used for filtering recommendation results by passing the

* tag as part of the

* [PredictRequest.filter][google.cloud.retail.v2.PredictRequest.filter].

* Google Merchant Center property

* [custom_label_0–4](https://support.google.com/merchants/answer/6324473).

*

* Generated from protobuf field <code>repeated string tags = 13;</code>

*/

private $tags;

/**

* Product price and cost information.

* Google Merchant Center property

* [price](https://support.google.com/merchants/answer/6324371).

*

* Generated from protobuf field <code>.google.cloud.retail.v2.PriceInfo price_info = 14;</code>

*/

private $price_info = null;

/**

* The rating of this product.

*

* Generated from protobuf field <code>.google.cloud.retail.v2.Rating rating = 15;</code>

*/

private $rating = null;

/**

* The timestamp when this [Product][google.cloud.retail.v2.Product] becomes

* available for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

*

* Generated from protobuf field <code>.google.protobuf.Timestamp available_time = 18;</code>

*/

private $available_time = null;

/**

* The online availability of the [Product][google.cloud.retail.v2.Product].

* Default to

* [Availability.IN_STOCK][google.cloud.retail.v2.Product.Availability.IN_STOCK].

* Google Merchant Center Property

* [availability](https://support.google.com/merchants/answer/6324448).

* Schema.org Property [Offer.availability](https://schema.org/availability).

*

* Generated from protobuf field <code>.google.cloud.retail.v2.Product.Availability availability = 19;</code>

*/

private $availability = 0;

/**

* The available quantity of the item.

*

* Generated from protobuf field <code>.google.protobuf.Int32Value available_quantity = 20;</code>

*/

private $available_quantity = null;

/**

* 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][google.cloud.retail.v2.FulfillmentInfo.type].

* Otherwise, an INVALID_ARGUMENT error is returned.

*

* Generated from protobuf field <code>repeated .google.cloud.retail.v2.FulfillmentInfo fulfillment_info = 21;</code>

*/

private $fulfillment_info;

/**

* Canonical URL directly linking to the product detail page.

* It is strongly recommended to provide a valid uri for the product,

* otherwise the service performance could be significantly degraded.

* This field must be a UTF-8 encoded string with a length limit of 5,000

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [link](https://support.google.com/merchants/answer/6324416). Schema.org

* property [Offer.url](https://schema.org/url).

*

* Generated from protobuf field <code>string uri = 22;</code>

*/

private $uri = '';

/**

* Product images for the product.Highly recommended to put the main image

* to the first.

* A maximum of 300 images are allowed.

* Google Merchant Center property

* [image_link](https://support.google.com/merchants/answer/6324350).

* Schema.org property [Product.image](https://schema.org/image).

*

* Generated from protobuf field <code>repeated .google.cloud.retail.v2.Image images = 23;</code>

*/

private $images;

/**

* The target group associated with a given audience (e.g. male, veterans,

* car owners, musicians, etc.) of the product.

*

* Generated from protobuf field <code>.google.cloud.retail.v2.Audience audience = 24;</code>

*/

private $audience = null;

/**

* The color of the product.

* Google Merchant Center property

* [color](https://support.google.com/merchants/answer/6324487). Schema.org

* property [Product.color](https://schema.org/color).

*

* Generated from protobuf field <code>.google.cloud.retail.v2.ColorInfo color_info = 25;</code>

*/

private $color_info = null;

/**

* 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][google.cloud.retail.v2.Product]. Each value must be a UTF-8

* encoded string with a length limit of 128 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [size](https://support.google.com/merchants/answer/6324492),

* [size_type](https://support.google.com/merchants/answer/6324497) and

* [size_system](https://support.google.com/merchants/answer/6324502).

* Schema.org property [Product.size](https://schema.org/size).

*

* Generated from protobuf field <code>repeated string sizes = 26;</code>

*/

private $sizes;

/**

* The material of the product. For example, "leather", "wooden".

* A maximum of 20 values are allowed. Each value must be a UTF-8 encoded

* string with a length limit of 128 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [material](https://support.google.com/merchants/answer/6324410). Schema.org

* property [Product.material](https://schema.org/material).

*

* Generated from protobuf field <code>repeated string materials = 27;</code>

*/

private $materials;

/**

* The pattern or graphic print of the product. For example, "striped", "polka

* dot", "paisley".

* A maximum of 20 values are allowed per

* [Product][google.cloud.retail.v2.Product]. Each value must be a UTF-8

* encoded string with a length limit of 128 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [pattern](https://support.google.com/merchants/answer/6324483). Schema.org

* property [Product.pattern](https://schema.org/pattern).

*

* Generated from protobuf field <code>repeated string patterns = 28;</code>

*/

private $patterns;

/**

* The condition of the product. Strongly encouraged to use the standard

* values: "new", "refurbished", "used".

* A maximum of 5 values are allowed per

* [Product][google.cloud.retail.v2.Product]. Each value must be a UTF-8

* encoded string with a length limit of 128 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [condition](https://support.google.com/merchants/answer/6324469).

* Schema.org property

* [Offer.itemCondition](https://schema.org/itemCondition).

*

* Generated from protobuf field <code>repeated string conditions = 29;</code>

*/

private $conditions;

/**

* The promotions applied to the product. A maximum of 10 values are allowed

* per [Product][google.cloud.retail.v2.Product].

*

* Generated from protobuf field <code>repeated .google.cloud.retail.v2.Promotion promotions = 34;</code>

*/

private $promotions;

/**

* 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][google.cloud.retail.v2.Product.available_time], given it

* purely describes product freshness regardless of when it is available on

* search and recommendation.

*

* Generated from protobuf field <code>.google.protobuf.Timestamp publish_time = 33;</code>

*/

private $publish_time = null;

/**

* Indicates which fields in the [Product][google.cloud.retail.v2.Product]s

* are returned in [SearchResponse][google.cloud.retail.v2.SearchResponse].

* Supported fields for all [type][google.cloud.retail.v2.Product.type]s:

* * [audience][google.cloud.retail.v2.Product.audience]

* * [availability][google.cloud.retail.v2.Product.availability]

* * [brands][google.cloud.retail.v2.Product.brands]

* * [color_info][google.cloud.retail.v2.Product.color_info]

* * [conditions][google.cloud.retail.v2.Product.conditions]

* * [gtin][google.cloud.retail.v2.Product.gtin]

* * [materials][google.cloud.retail.v2.Product.materials]

* * [name][google.cloud.retail.v2.Product.name]

* * [patterns][google.cloud.retail.v2.Product.patterns]

* * [price_info][google.cloud.retail.v2.Product.price_info]

* * [rating][google.cloud.retail.v2.Product.rating]

* * [sizes][google.cloud.retail.v2.Product.sizes]

* * [title][google.cloud.retail.v2.Product.title]

* * [uri][google.cloud.retail.v2.Product.uri]

* Supported fields only for

* [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and

* [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]:

* * [categories][google.cloud.retail.v2.Product.categories]

* * [description][google.cloud.retail.v2.Product.description]

* * [images][google.cloud.retail.v2.Product.images]

* Supported fields only for

* [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]:

* * Only the first image in [images][google.cloud.retail.v2.Product.images]

* To mark [attributes][google.cloud.retail.v2.Product.attributes] as

* retrievable, include paths of the form "attributes.key" where "key" is the

* key of a custom attribute, as specified in

* [attributes][google.cloud.retail.v2.Product.attributes].

* For [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and

* [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], the

* following fields are always returned in

* [SearchResponse][google.cloud.retail.v2.SearchResponse] by default:

* * [name][google.cloud.retail.v2.Product.name]

* For [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT], the

* following fields are always returned in by default:

* * [name][google.cloud.retail.v2.Product.name]

* * [color_info][google.cloud.retail.v2.Product.color_info]

* Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is

* returned.

* Note: Returning more fields in

* [SearchResponse][google.cloud.retail.v2.SearchResponse] may increase

* response payload size and serving latency.

*

* Generated from protobuf field <code>.google.protobuf.FieldMask retrievable_fields = 30;</code>

*/

private $retrievable_fields = null;

/**

* Output only. Product variants grouped together on primary product which

* share similar product attributes. It's automatically grouped by

* [primary_product_id][google.cloud.retail.v2.Product.primary_product_id] for

* all the product variants. Only populated for

* [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]

* [Product][google.cloud.retail.v2.Product]s.

* Note: This field is OUTPUT_ONLY for

* [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct].

* Do not set this field in API requests.

*

* Generated from protobuf field <code>repeated .google.cloud.retail.v2.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>

*/

private $variants;

protected $expiration;

/**

* Constructor.

*

* @param array $data {

* Optional. Data for populating the Message object.

*

* @type \Google\Protobuf\Timestamp $expire_time

* The timestamp when this product becomes unavailable for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

* If it is set, the [Product][google.cloud.retail.v2.Product] is not

* available for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search] after

* [expire_time][google.cloud.retail.v2.Product.expire_time]. However, the

* product can still be retrieved by

* [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]

* and

* [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

* [expire_time][google.cloud.retail.v2.Product.expire_time] must be later

* than [available_time][google.cloud.retail.v2.Product.available_time] and

* [publish_time][google.cloud.retail.v2.Product.publish_time], otherwise an

* INVALID_ARGUMENT error is thrown.

* Google Merchant Center property

* [expiration_date](https://support.google.com/merchants/answer/6324499).

* @type \Google\Protobuf\Duration $ttl

* Input only. The TTL (time to live) of the product.

* If it is set, it must be a non-negative value, and

* [expire_time][google.cloud.retail.v2.Product.expire_time] is set as

* current timestamp plus [ttl][google.cloud.retail.v2.Product.ttl]. The

* derived [expire_time][google.cloud.retail.v2.Product.expire_time] is

* returned in the output and [ttl][google.cloud.retail.v2.Product.ttl] is

* left blank when retrieving the [Product][google.cloud.retail.v2.Product].

* If it is set, the product is not available for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search] after

* current timestamp plus [ttl][google.cloud.retail.v2.Product.ttl].

* However, the product can still be retrieved by

* [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]

* and

* [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

* @type string $name

* Immutable. Full resource name of the product, such as

* `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.

* @type string $id

* Immutable. [Product][google.cloud.retail.v2.Product] identifier, which is

* the final component of [name][google.cloud.retail.v2.Product.name]. For

* example, this field is "id_1", if

* [name][google.cloud.retail.v2.Product.name] is

* `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`.

* This field must be a UTF-8 encoded string with a length limit of 128

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [id](https://support.google.com/merchants/answer/6324405). Schema.org

* Property [Product.sku](https://schema.org/sku).

* @type int $type

* Immutable. The type of the product. Default to

* [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2.ProductLevelConfig.ingestion_product_type]

* if unset.

* @type string $primary_product_id

* Variant group identifier. Must be an

* [id][google.cloud.retail.v2.Product.id], with the same parent branch with

* this product. Otherwise, an error is thrown.

* For [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]

* [Product][google.cloud.retail.v2.Product]s, this field can only be empty or

* set to the same value as [id][google.cloud.retail.v2.Product.id].

* For VARIANT [Product][google.cloud.retail.v2.Product]s, this field cannot

* be empty. A maximum of 2,000 products are allowed to share the same

* [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]

* [Product][google.cloud.retail.v2.Product]. Otherwise, an INVALID_ARGUMENT

* error is returned.

* Google Merchant Center Property

* [item_group_id](https://support.google.com/merchants/answer/6324507).

* Schema.org Property

* [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).

* This field must be enabled before it can be used. [Learn

* more](https://cloud.google.com/recommendations-ai/docs/catalog#item-group-id).

* @type string[]|\Google\Protobuf\Internal\RepeatedField $collection_member_ids

* The [id][google.cloud.retail.v2.Product.id] of the collection members when

* [type][google.cloud.retail.v2.Product.type] is

* [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION].

* Should not set it for other types. A maximum of 1000 values are allowed.

* Otherwise, an INVALID_ARGUMENT error is return.

* @type string $gtin

* The Global Trade Item Number (GTIN) of the product.

* This field must be a UTF-8 encoded string with a length limit of 128

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is

* returned.

* Google Merchant Center property

* [gtin](https://support.google.com/merchants/answer/6324461).

* Schema.org property

* [Product.isbn](https://schema.org/isbn) or

* [Product.gtin8](https://schema.org/gtin8) or

* [Product.gtin12](https://schema.org/gtin12) or

* [Product.gtin13](https://schema.org/gtin13) or

* [Product.gtin14](https://schema.org/gtin14).

* If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.

* @type string[]|\Google\Protobuf\Internal\RepeatedField $categories

* 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][google.cloud.retail.v2.Product.Type.PRIMARY]

* [Product][google.cloud.retail.v2.Product] otherwise an INVALID_ARGUMENT

* error is returned.

* At most 250 values are allowed per

* [Product][google.cloud.retail.v2.Product]. Empty values are not allowed.

* Each value must be a UTF-8 encoded string with a length limit of 5,000

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [google_product_category][mc_google_product_category]. Schema.org property

* [Product.category] (https://schema.org/category).

* [mc_google_product_category]:

* https://support.google.com/merchants/answer/6324436

* @type string $title

* Required. Product title.

* This field must be a UTF-8 encoded string with a length limit of 1,000

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [title](https://support.google.com/merchants/answer/6324415). Schema.org

* property [Product.name](https://schema.org/name).

* @type string[]|\Google\Protobuf\Internal\RepeatedField $brands

* The brands of the product.

* A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded

* string with a length limit of 1,000 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [brand](https://support.google.com/merchants/answer/6324351). Schema.org

* property [Product.brand](https://schema.org/brand).

* @type string $description

* Product description.

* This field must be a UTF-8 encoded string with a length limit of 5,000

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [description](https://support.google.com/merchants/answer/6324468).

* schema.org property [Product.description](https://schema.org/description).

* @type string $language_code

* Language of the title/description and other string attributes. Use language

* tags defined by [BCP 47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].

* For product prediction, this field is ignored and the model automatically

* detects the text language. The [Product][google.cloud.retail.v2.Product]

* can include text in different languages, but duplicating

* [Product][google.cloud.retail.v2.Product]s to provide text in multiple

* languages can result in degraded model performance.

* For product search this field is in use. It defaults to "en-US" if unset.

* @type array|\Google\Protobuf\Internal\MapField $attributes

* Highly encouraged. Extra product attributes to be included. For example,

* for products, this could include the store name, vendor, style, color, etc.

* These are very strong signals for recommendation model, thus we highly

* recommend providing the attributes here.

* Features that can take on one of a limited number of possible values. Two

* types of features can be set are:

* Textual features. some examples would be the brand/maker of a product, or

* country of a customer. Numerical features. Some examples would be the

* height/weight of a product, or age of a customer.

* For example: `{ "vendor": {"text": ["vendor123", "vendor456"]},

* "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]}

* }`.

* This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT

* error is returned:

* * Max entries count: 200.

* * The key must be a UTF-8 encoded string with a length limit of 128

* characters.

* * For indexable attribute, the key must match the pattern:

* `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, key0LikeThis or KEY_1_LIKE_THIS.

* @type string[]|\Google\Protobuf\Internal\RepeatedField $tags

* Custom tags associated with the product.

* At most 250 values are allowed per

* [Product][google.cloud.retail.v2.Product]. This value must be a UTF-8

* encoded string with a length limit of 1,000 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* This tag can be used for filtering recommendation results by passing the

* tag as part of the

* [PredictRequest.filter][google.cloud.retail.v2.PredictRequest.filter].

* Google Merchant Center property

* [custom_label_0–4](https://support.google.com/merchants/answer/6324473).

* @type \Google\Cloud\Retail\V2\PriceInfo $price_info

* Product price and cost information.

* Google Merchant Center property

* [price](https://support.google.com/merchants/answer/6324371).

* @type \Google\Cloud\Retail\V2\Rating $rating

* The rating of this product.

* @type \Google\Protobuf\Timestamp $available_time

* The timestamp when this [Product][google.cloud.retail.v2.Product] becomes

* available for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

* @type int $availability

* The online availability of the [Product][google.cloud.retail.v2.Product].

* Default to

* [Availability.IN_STOCK][google.cloud.retail.v2.Product.Availability.IN_STOCK].

* Google Merchant Center Property

* [availability](https://support.google.com/merchants/answer/6324448).

* Schema.org Property [Offer.availability](https://schema.org/availability).

* @type \Google\Protobuf\Int32Value $available_quantity

* The available quantity of the item.

* @type \Google\Cloud\Retail\V2\FulfillmentInfo[]|\Google\Protobuf\Internal\RepeatedField $fulfillment_info

* 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][google.cloud.retail.v2.FulfillmentInfo.type].

* Otherwise, an INVALID_ARGUMENT error is returned.

* @type string $uri

* Canonical URL directly linking to the product detail page.

* It is strongly recommended to provide a valid uri for the product,

* otherwise the service performance could be significantly degraded.

* This field must be a UTF-8 encoded string with a length limit of 5,000

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [link](https://support.google.com/merchants/answer/6324416). Schema.org

* property [Offer.url](https://schema.org/url).

* @type \Google\Cloud\Retail\V2\Image[]|\Google\Protobuf\Internal\RepeatedField $images

* Product images for the product.Highly recommended to put the main image

* to the first.

* A maximum of 300 images are allowed.

* Google Merchant Center property

* [image_link](https://support.google.com/merchants/answer/6324350).

* Schema.org property [Product.image](https://schema.org/image).

* @type \Google\Cloud\Retail\V2\Audience $audience

* The target group associated with a given audience (e.g. male, veterans,

* car owners, musicians, etc.) of the product.

* @type \Google\Cloud\Retail\V2\ColorInfo $color_info

* The color of the product.

* Google Merchant Center property

* [color](https://support.google.com/merchants/answer/6324487). Schema.org

* property [Product.color](https://schema.org/color).

* @type string[]|\Google\Protobuf\Internal\RepeatedField $sizes

* 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][google.cloud.retail.v2.Product]. Each value must be a UTF-8

* encoded string with a length limit of 128 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [size](https://support.google.com/merchants/answer/6324492),

* [size_type](https://support.google.com/merchants/answer/6324497) and

* [size_system](https://support.google.com/merchants/answer/6324502).

* Schema.org property [Product.size](https://schema.org/size).

* @type string[]|\Google\Protobuf\Internal\RepeatedField $materials

* The material of the product. For example, "leather", "wooden".

* A maximum of 20 values are allowed. Each value must be a UTF-8 encoded

* string with a length limit of 128 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [material](https://support.google.com/merchants/answer/6324410). Schema.org

* property [Product.material](https://schema.org/material).

* @type string[]|\Google\Protobuf\Internal\RepeatedField $patterns

* The pattern or graphic print of the product. For example, "striped", "polka

* dot", "paisley".

* A maximum of 20 values are allowed per

* [Product][google.cloud.retail.v2.Product]. Each value must be a UTF-8

* encoded string with a length limit of 128 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [pattern](https://support.google.com/merchants/answer/6324483). Schema.org

* property [Product.pattern](https://schema.org/pattern).

* @type string[]|\Google\Protobuf\Internal\RepeatedField $conditions

* The condition of the product. Strongly encouraged to use the standard

* values: "new", "refurbished", "used".

* A maximum of 5 values are allowed per

* [Product][google.cloud.retail.v2.Product]. Each value must be a UTF-8

* encoded string with a length limit of 128 characters. Otherwise, an

* INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [condition](https://support.google.com/merchants/answer/6324469).

* Schema.org property

* [Offer.itemCondition](https://schema.org/itemCondition).

* @type \Google\Cloud\Retail\V2\Promotion[]|\Google\Protobuf\Internal\RepeatedField $promotions

* The promotions applied to the product. A maximum of 10 values are allowed

* per [Product][google.cloud.retail.v2.Product].

* @type \Google\Protobuf\Timestamp $publish_time

* 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][google.cloud.retail.v2.Product.available_time], given it

* purely describes product freshness regardless of when it is available on

* search and recommendation.

* @type \Google\Protobuf\FieldMask $retrievable_fields

* Indicates which fields in the [Product][google.cloud.retail.v2.Product]s

* are returned in [SearchResponse][google.cloud.retail.v2.SearchResponse].

* Supported fields for all [type][google.cloud.retail.v2.Product.type]s:

* * [audience][google.cloud.retail.v2.Product.audience]

* * [availability][google.cloud.retail.v2.Product.availability]

* * [brands][google.cloud.retail.v2.Product.brands]

* * [color_info][google.cloud.retail.v2.Product.color_info]

* * [conditions][google.cloud.retail.v2.Product.conditions]

* * [gtin][google.cloud.retail.v2.Product.gtin]

* * [materials][google.cloud.retail.v2.Product.materials]

* * [name][google.cloud.retail.v2.Product.name]

* * [patterns][google.cloud.retail.v2.Product.patterns]

* * [price_info][google.cloud.retail.v2.Product.price_info]

* * [rating][google.cloud.retail.v2.Product.rating]

* * [sizes][google.cloud.retail.v2.Product.sizes]

* * [title][google.cloud.retail.v2.Product.title]

* * [uri][google.cloud.retail.v2.Product.uri]

* Supported fields only for

* [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and

* [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION]:

* * [categories][google.cloud.retail.v2.Product.categories]

* * [description][google.cloud.retail.v2.Product.description]

* * [images][google.cloud.retail.v2.Product.images]

* Supported fields only for

* [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]:

* * Only the first image in [images][google.cloud.retail.v2.Product.images]

* To mark [attributes][google.cloud.retail.v2.Product.attributes] as

* retrievable, include paths of the form "attributes.key" where "key" is the

* key of a custom attribute, as specified in

* [attributes][google.cloud.retail.v2.Product.attributes].

* For [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and

* [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], the

* following fields are always returned in

* [SearchResponse][google.cloud.retail.v2.SearchResponse] by default:

* * [name][google.cloud.retail.v2.Product.name]

* For [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT], the

* following fields are always returned in by default:

* * [name][google.cloud.retail.v2.Product.name]

* * [color_info][google.cloud.retail.v2.Product.color_info]

* Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is

* returned.

* Note: Returning more fields in

* [SearchResponse][google.cloud.retail.v2.SearchResponse] may increase

* response payload size and serving latency.

* @type \Google\Cloud\Retail\V2\Product[]|\Google\Protobuf\Internal\RepeatedField $variants

* Output only. Product variants grouped together on primary product which

* share similar product attributes. It's automatically grouped by

* [primary_product_id][google.cloud.retail.v2.Product.primary_product_id] for

* all the product variants. Only populated for

* [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]

* [Product][google.cloud.retail.v2.Product]s.

* Note: This field is OUTPUT_ONLY for

* [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct].

* Do not set this field in API requests.

* }

*/

public function __construct($data = NULL) {

\GPBMetadata\Google\Cloud\Retail\V2\Product::initOnce();

parent::__construct($data);

}

/**

* The timestamp when this product becomes unavailable for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

* If it is set, the [Product][google.cloud.retail.v2.Product] is not

* available for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search] after

* [expire_time][google.cloud.retail.v2.Product.expire_time]. However, the

* product can still be retrieved by

* [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]

* and

* [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

* [expire_time][google.cloud.retail.v2.Product.expire_time] must be later

* than [available_time][google.cloud.retail.v2.Product.available_time] and

* [publish_time][google.cloud.retail.v2.Product.publish_time], otherwise an

* INVALID_ARGUMENT error is thrown.

* Google Merchant Center property

* [expiration_date](https://support.google.com/merchants/answer/6324499).

*

* Generated from protobuf field <code>.google.protobuf.Timestamp expire_time = 16;</code>

* @return \Google\Protobuf\Timestamp|null

*/

public function getExpireTime()

{

return $this->readOneof(16);

}

public function hasExpireTime()

{

return $this->hasOneof(16);

}

/**

* The timestamp when this product becomes unavailable for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

* If it is set, the [Product][google.cloud.retail.v2.Product] is not

* available for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search] after

* [expire_time][google.cloud.retail.v2.Product.expire_time]. However, the

* product can still be retrieved by

* [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]

* and

* [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

* [expire_time][google.cloud.retail.v2.Product.expire_time] must be later

* than [available_time][google.cloud.retail.v2.Product.available_time] and

* [publish_time][google.cloud.retail.v2.Product.publish_time], otherwise an

* INVALID_ARGUMENT error is thrown.

* Google Merchant Center property

* [expiration_date](https://support.google.com/merchants/answer/6324499).

*

* Generated from protobuf field <code>.google.protobuf.Timestamp expire_time = 16;</code>

* @param \Google\Protobuf\Timestamp $var

* @return $this

*/

public function setExpireTime($var)

{

GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);

$this->writeOneof(16, $var);

return $this;

}

/**

* Input only. The TTL (time to live) of the product.

* If it is set, it must be a non-negative value, and

* [expire_time][google.cloud.retail.v2.Product.expire_time] is set as

* current timestamp plus [ttl][google.cloud.retail.v2.Product.ttl]. The

* derived [expire_time][google.cloud.retail.v2.Product.expire_time] is

* returned in the output and [ttl][google.cloud.retail.v2.Product.ttl] is

* left blank when retrieving the [Product][google.cloud.retail.v2.Product].

* If it is set, the product is not available for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search] after

* current timestamp plus [ttl][google.cloud.retail.v2.Product.ttl].

* However, the product can still be retrieved by

* [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]

* and

* [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

*

* Generated from protobuf field <code>.google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];</code>

* @return \Google\Protobuf\Duration|null

*/

public function getTtl()

{

return $this->readOneof(17);

}

public function hasTtl()

{

return $this->hasOneof(17);

}

/**

* Input only. The TTL (time to live) of the product.

* If it is set, it must be a non-negative value, and

* [expire_time][google.cloud.retail.v2.Product.expire_time] is set as

* current timestamp plus [ttl][google.cloud.retail.v2.Product.ttl]. The

* derived [expire_time][google.cloud.retail.v2.Product.expire_time] is

* returned in the output and [ttl][google.cloud.retail.v2.Product.ttl] is

* left blank when retrieving the [Product][google.cloud.retail.v2.Product].

* If it is set, the product is not available for

* [SearchService.Search][google.cloud.retail.v2.SearchService.Search] after

* current timestamp plus [ttl][google.cloud.retail.v2.Product.ttl].

* However, the product can still be retrieved by

* [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]

* and

* [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].

*

* Generated from protobuf field <code>.google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY];</code>

* @param \Google\Protobuf\Duration $var

* @return $this

*/

public function setTtl($var)

{

GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);

$this->writeOneof(17, $var);

return $this;

}

/**

* Immutable. Full resource name of the product, such as

* `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.

*

* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code>

* @return string

*/

public function getName()

{

return $this->name;

}

/**

* Immutable. Full resource name of the product, such as

* `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.

*

* Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code>

* @param string $var

* @return $this

*/

public function setName($var)

{

GPBUtil::checkString($var, True);

$this->name = $var;

return $this;

}

/**

* Immutable. [Product][google.cloud.retail.v2.Product] identifier, which is

* the final component of [name][google.cloud.retail.v2.Product.name]. For

* example, this field is "id_1", if

* [name][google.cloud.retail.v2.Product.name] is

* `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`.

* This field must be a UTF-8 encoded string with a length limit of 128

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [id](https://support.google.com/merchants/answer/6324405). Schema.org

* Property [Product.sku](https://schema.org/sku).

*

* Generated from protobuf field <code>string id = 2 [(.google.api.field_behavior) = IMMUTABLE];</code>

* @return string

*/

public function getId()

{

return $this->id;

}

/**

* Immutable. [Product][google.cloud.retail.v2.Product] identifier, which is

* the final component of [name][google.cloud.retail.v2.Product.name]. For

* example, this field is "id_1", if

* [name][google.cloud.retail.v2.Product.name] is

* `projects/&#42;&#47;locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`.

* This field must be a UTF-8 encoded string with a length limit of 128

* characters. Otherwise, an INVALID_ARGUMENT error is returned.

* Google Merchant Center property

* [id](https://support.google.com/merchants/answer/6324405). Schema.org

* Property [Product.sku](https://schema.org/sku).

*

* Generated from protobuf field <code>string id = 2 [(.google.api.field_behavior) = IMMUTABLE];</code>

* @param string $var

* @return $this

*/

public function setId($var)

{

GPBUtil::checkString($var, True);

$this->id = $var;

return $this;

}

/**

* Immutable. The type of the product. Default to

* [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2.ProductLevelConfig.ingestion_product_type]

* if unset.

*

* Generated from protobuf field <code>.google.cloud.retail.v2.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE];</code>

* @return int

*/

public function getType()

{

return $this->type;