google.cloud.retail.v2.Product */ class Product extends \Google\Protobuf\Internal\Message { /** * 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]; */ 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/*/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](https://support.google.com/merchants/answer/6324405). Schema.org * property [Product.sku](https://schema.org/sku). * * Generated from protobuf field string id = 2 [(.google.api.field_behavior) = IMMUTABLE]; */ 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 .google.cloud.retail.v2.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE]; */ 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. * Corresponding properties: Google Merchant Center property * [item_group_id](https://support.google.com/merchants/answer/6324507). * Schema.org property * [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). * * Generated from protobuf field string primary_product_id = 4; */ 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]. * Non-existent product ids are allowed. * The [type][google.cloud.retail.v2.Product.type] of the members must be * either [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] or * [Type.VARIANT][google.cloud.retail.v2.Product.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; */ 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. * Corresponding properties: Google Merchant Center property * [gtin](https://support.google.com/merchants/answer/6324461). * Schema.org property * [Product.isbn](https://schema.org/isbn), * [Product.gtin8](https://schema.org/gtin8), * [Product.gtin12](https://schema.org/gtin12), * [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 string gtin = 6; */ 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, 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. * Corresponding properties: 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 repeated string categories = 7; */ 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. * Corresponding properties: 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 string title = 8 [(.google.api.field_behavior) = REQUIRED]; */ 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. * Corresponding properties: 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 repeated string brands = 9; */ 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. * Corresponding properties: 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 string description = 10; */ 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 string language_code = 11; */ 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`. * * 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 attributes = 12; */ 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]. * Corresponding properties: Google Merchant Center property * [custom_label_0–4](https://support.google.com/merchants/answer/6324473). * * Generated from protobuf field repeated string tags = 13; */ private $tags; /** * Product price and cost information. * Corresponding properties: Google Merchant Center property * [price](https://support.google.com/merchants/answer/6324371). * * Generated from protobuf field .google.cloud.retail.v2.PriceInfo price_info = 14; */ private $price_info = null; /** * The rating of this product. * * Generated from protobuf field .google.cloud.retail.v2.Rating rating = 15; */ private $rating = null; /** * The timestamp when this [Product][google.cloud.retail.v2.Product] becomes * available for * [SearchService.Search][google.cloud.retail.v2.SearchService.Search]. Note * that this is only applicable to * [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and * [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and * ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. * * Generated from protobuf field .google.protobuf.Timestamp available_time = 18; */ 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]. * Corresponding properties: 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 .google.cloud.retail.v2.Product.Availability availability = 19; */ private $availability = 0; /** * The available quantity of the item. * * Generated from protobuf field .google.protobuf.Int32Value available_quantity = 20; */ 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 repeated .google.cloud.retail.v2.FulfillmentInfo fulfillment_info = 21; */ 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. * Corresponding properties: 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 string uri = 22; */ private $uri = ''; /** * 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](https://support.google.com/merchants/answer/6324350). * Schema.org property [Product.image](https://schema.org/image). * * Generated from protobuf field repeated .google.cloud.retail.v2.Image images = 23; */ 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 .google.cloud.retail.v2.Audience audience = 24; */ private $audience = null; /** * The color of the product. * Corresponding properties: 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 .google.cloud.retail.v2.ColorInfo color_info = 25; */ 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. * Corresponding properties: 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 repeated string sizes = 26; */ 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 200 characters. Otherwise, an * INVALID_ARGUMENT error is returned. * Corresponding properties: 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 repeated string materials = 27; */ 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. * Corresponding properties: 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 repeated string patterns = 28; */ private $patterns; /** * The condition of the product. Strongly encouraged to use the standard * values: "new", "refurbished", "used". * A maximum of 1 value is 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. * Corresponding properties: 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 repeated string conditions = 29; */ private $conditions; /** * The promotions applied to the product. A maximum of 10 values are allowed * per [Product][google.cloud.retail.v2.Product]. Only * [Promotion.promotion_id][google.cloud.retail.v2.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; */ 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 .google.protobuf.Timestamp publish_time = 33; */ 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] * The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is * returned. * Note: Returning more fields in * [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase * response payload size and serving latency. * This field is deprecated. Use the retrievable site-wide control instead. * * Generated from protobuf field .google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true]; * @deprecated */ protected $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 repeated .google.cloud.retail.v2.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $variants; /** * 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 * [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] * and * [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] * APIs. * * Generated from protobuf field repeated .google.cloud.retail.v2.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $local_inventories; 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]. Note * that this is only applicable to * [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and * [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and * ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. * In general, we suggest the users to delete the stale products explicitly, * instead of using this field to determine staleness. * If it is set, 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. * Corresponding properties: 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. Note that this is only * applicable to [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] * and [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], * and ignored for * [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. In general, * we suggest the users to delete the stale products explicitly, instead of * using this field to determine staleness. * If it is set, it must be a non-negative value, and * [expire_time][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/*/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/*/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](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. * Corresponding properties: Google Merchant Center property * [item_group_id](https://support.google.com/merchants/answer/6324507). * Schema.org property * [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). * @type array|\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]. * Non-existent product ids are allowed. * The [type][google.cloud.retail.v2.Product.type] of the members must be * either [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] or * [Type.VARIANT][google.cloud.retail.v2.Product.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. * @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. * Corresponding properties: Google Merchant Center property * [gtin](https://support.google.com/merchants/answer/6324461). * Schema.org property * [Product.isbn](https://schema.org/isbn), * [Product.gtin8](https://schema.org/gtin8), * [Product.gtin12](https://schema.org/gtin12), * [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 array|\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, 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. * Corresponding properties: 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. * Corresponding properties: Google Merchant Center property * [title](https://support.google.com/merchants/answer/6324415). Schema.org * property [Product.name](https://schema.org/name). * @type array|\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. * Corresponding properties: 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. * Corresponding properties: 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`. * * 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. * @type array|\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]. * Corresponding properties: 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. * Corresponding properties: 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]. Note * that this is only applicable to * [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and * [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and * ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. * @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]. * Corresponding properties: 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 array<\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. * Corresponding properties: Google Merchant Center property * [link](https://support.google.com/merchants/answer/6324416). Schema.org * property [Offer.url](https://schema.org/url). * @type array<\Google\Cloud\Retail\V2\Image>|\Google\Protobuf\Internal\RepeatedField $images * 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](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. * Corresponding properties: Google Merchant Center property * [color](https://support.google.com/merchants/answer/6324487). Schema.org * property [Product.color](https://schema.org/color). * @type array|\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. * Corresponding properties: 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 array|\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 200 characters. Otherwise, an * INVALID_ARGUMENT error is returned. * Corresponding properties: Google Merchant Center property * [material](https://support.google.com/merchants/answer/6324410). Schema.org * property [Product.material](https://schema.org/material). * @type array|\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. * Corresponding properties: Google Merchant Center property * [pattern](https://support.google.com/merchants/answer/6324483). Schema.org * property [Product.pattern](https://schema.org/pattern). * @type array|\Google\Protobuf\Internal\RepeatedField $conditions * The condition of the product. Strongly encouraged to use the standard * values: "new", "refurbished", "used". * A maximum of 1 value is 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. * Corresponding properties: Google Merchant Center property * [condition](https://support.google.com/merchants/answer/6324469). * Schema.org property * [Offer.itemCondition](https://schema.org/itemCondition). * @type array<\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]. Only * [Promotion.promotion_id][google.cloud.retail.v2.Promotion.promotion_id] * will be used, other fields will be ignored if set. * @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] * The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is * returned. * Note: Returning more fields in * [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase * response payload size and serving latency. * This field is deprecated. Use the retrievable site-wide control instead. * @type array<\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. * @type array<\Google\Cloud\Retail\V2\LocalInventory>|\Google\Protobuf\Internal\RepeatedField $local_inventories * 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 * [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] * and * [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] * APIs. * } */ 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]. Note * that this is only applicable to * [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and * [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and * ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. * In general, we suggest the users to delete the stale products explicitly, * instead of using this field to determine staleness. * If it is set, 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. * Corresponding properties: Google Merchant Center property * [expiration_date](https://support.google.com/merchants/answer/6324499). * * Generated from protobuf field .google.protobuf.Timestamp expire_time = 16; * @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]. Note * that this is only applicable to * [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and * [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and * ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. * In general, we suggest the users to delete the stale products explicitly, * instead of using this field to determine staleness. * If it is set, 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. * Corresponding properties: Google Merchant Center property * [expiration_date](https://support.google.com/merchants/answer/6324499). * * Generated from protobuf field .google.protobuf.Timestamp expire_time = 16; * @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. Note that this is only * applicable to [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] * and [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], * and ignored for * [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. In general, * we suggest the users to delete the stale products explicitly, instead of * using this field to determine staleness. * If it is set, it must be a non-negative value, and * [expire_time][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 .google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY]; * @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. Note that this is only * applicable to [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] * and [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], * and ignored for * [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. In general, * we suggest the users to delete the stale products explicitly, instead of * using this field to determine staleness. * If it is set, it must be a non-negative value, and * [expire_time][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 .google.protobuf.Duration ttl = 17 [(.google.api.field_behavior) = INPUT_ONLY]; * @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/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE]; * @return string */ public function getName() { return $this->name; } /** * 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]; * @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/*/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](https://support.google.com/merchants/answer/6324405). Schema.org * property [Product.sku](https://schema.org/sku). * * Generated from protobuf field string id = 2 [(.google.api.field_behavior) = IMMUTABLE]; * @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/*/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](https://support.google.com/merchants/answer/6324405). Schema.org * property [Product.sku](https://schema.org/sku). * * Generated from protobuf field string id = 2 [(.google.api.field_behavior) = IMMUTABLE]; * @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 .google.cloud.retail.v2.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE]; * @return int */ public function getType() { return $this->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. * * Generated from protobuf field .google.cloud.retail.v2.Product.Type type = 3 [(.google.api.field_behavior) = IMMUTABLE]; * @param int $var * @return $this */ public function setType($var) { GPBUtil::checkEnum($var, \Google\Cloud\Retail\V2\Product\Type::class); $this->type = $var; return $this; } /** * 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. * Corresponding properties: Google Merchant Center property * [item_group_id](https://support.google.com/merchants/answer/6324507). * Schema.org property * [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). * * Generated from protobuf field string primary_product_id = 4; * @return string */ public function getPrimaryProductId() { return $this->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. * Corresponding properties: Google Merchant Center property * [item_group_id](https://support.google.com/merchants/answer/6324507). * Schema.org property * [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). * * Generated from protobuf field string primary_product_id = 4; * @param string $var * @return $this */ public function setPrimaryProductId($var) { GPBUtil::checkString($var, True); $this->primary_product_id = $var; return $this; } /** * 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]. * Non-existent product ids are allowed. * The [type][google.cloud.retail.v2.Product.type] of the members must be * either [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] or * [Type.VARIANT][google.cloud.retail.v2.Product.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; * @return \Google\Protobuf\Internal\RepeatedField */ public function getCollectionMemberIds() { return $this->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]. * Non-existent product ids are allowed. * The [type][google.cloud.retail.v2.Product.type] of the members must be * either [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] or * [Type.VARIANT][google.cloud.retail.v2.Product.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; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setCollectionMemberIds($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->collection_member_ids = $arr; return $this; } /** * 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](https://support.google.com/merchants/answer/6324461). * Schema.org property * [Product.isbn](https://schema.org/isbn), * [Product.gtin8](https://schema.org/gtin8), * [Product.gtin12](https://schema.org/gtin12), * [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 string gtin = 6; * @return string */ public function getGtin() { return $this->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. * Corresponding properties: Google Merchant Center property * [gtin](https://support.google.com/merchants/answer/6324461). * Schema.org property * [Product.isbn](https://schema.org/isbn), * [Product.gtin8](https://schema.org/gtin8), * [Product.gtin12](https://schema.org/gtin12), * [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 string gtin = 6; * @param string $var * @return $this */ public function setGtin($var) { GPBUtil::checkString($var, True); $this->gtin = $var; return $this; } /** * Product categories. This field is repeated for supporting one product * belonging to several parallel categories. Strongly recommended using the * full path for better search / recommendation quality. * To represent full path of category, use '>' sign to separate different * hierarchies. If '>' is part of the category name, replace it with * other character(s). * For example, if a shoes product belongs to both * ["Shoes & Accessories" -> "Shoes"] and * ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be * represented as: * "categories": [ * "Shoes & Accessories > Shoes", * "Sports & Fitness > Athletic Clothing > Shoes" * ] * Must be set for [Type.PRIMARY][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. * Corresponding properties: 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 repeated string categories = 7; * @return \Google\Protobuf\Internal\RepeatedField */ public function getCategories() { return $this->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, 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. * Corresponding properties: 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 repeated string categories = 7; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setCategories($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->categories = $arr; return $this; } /** * 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](https://support.google.com/merchants/answer/6324415). Schema.org * property [Product.name](https://schema.org/name). * * Generated from protobuf field string title = 8 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getTitle() { return $this->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. * Corresponding properties: 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 string title = 8 [(.google.api.field_behavior) = REQUIRED]; * @param string $var * @return $this */ public function setTitle($var) { GPBUtil::checkString($var, True); $this->title = $var; return $this; } /** * 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](https://support.google.com/merchants/answer/6324351). Schema.org * property [Product.brand](https://schema.org/brand). * * Generated from protobuf field repeated string brands = 9; * @return \Google\Protobuf\Internal\RepeatedField */ public function getBrands() { return $this->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. * Corresponding properties: 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 repeated string brands = 9; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setBrands($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->brands = $arr; return $this; } /** * 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](https://support.google.com/merchants/answer/6324468). * Schema.org property [Product.description](https://schema.org/description). * * Generated from protobuf field string description = 10; * @return string */ public function getDescription() { return $this->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. * Corresponding properties: 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 string description = 10; * @param string $var * @return $this */ public function setDescription($var) { GPBUtil::checkString($var, True); $this->description = $var; return $this; } /** * 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 string language_code = 11; * @return string */ public function getLanguageCode() { return $this->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. * * Generated from protobuf field string language_code = 11; * @param string $var * @return $this */ public function setLanguageCode($var) { GPBUtil::checkString($var, True); $this->language_code = $var; return $this; } /** * Highly encouraged. Extra product attributes to be included. For example, * for products, this could include the store name, vendor, style, color, etc. * These are very strong signals for recommendation model, thus we highly * recommend providing the attributes here. * Features that can take on one of a limited number of possible values. Two * types of features can be set are: * Textual features. some examples would be the brand/maker of a product, or * country of a customer. Numerical features. Some examples would be the * height/weight of a product, or age of a customer. * For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, * "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} * }`. * This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT * error is returned: * * Max entries count: 200. * * The key must be a UTF-8 encoded string with a length limit of 128 * characters. * * For indexable attribute, the key must match the pattern: * `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or * `KEY_1_LIKE_THIS`. * * For text attributes, at most 400 values are allowed. Empty values are not * allowed. Each value must be a non-empty UTF-8 encoded string with a * length limit of 256 characters. * * For number attributes, at most 400 values are allowed. * * Generated from protobuf field map attributes = 12; * @return \Google\Protobuf\Internal\MapField */ public function getAttributes() { return $this->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`. * * 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 attributes = 12; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ public function setAttributes($var) { $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\CustomAttribute::class); $this->attributes = $arr; return $this; } /** * 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]. * Corresponding properties: Google Merchant Center property * [custom_label_0–4](https://support.google.com/merchants/answer/6324473). * * Generated from protobuf field repeated string tags = 13; * @return \Google\Protobuf\Internal\RepeatedField */ public function getTags() { return $this->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]. * Corresponding properties: Google Merchant Center property * [custom_label_0–4](https://support.google.com/merchants/answer/6324473). * * Generated from protobuf field repeated string tags = 13; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setTags($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->tags = $arr; return $this; } /** * Product price and cost information. * Corresponding properties: Google Merchant Center property * [price](https://support.google.com/merchants/answer/6324371). * * Generated from protobuf field .google.cloud.retail.v2.PriceInfo price_info = 14; * @return \Google\Cloud\Retail\V2\PriceInfo|null */ public function getPriceInfo() { return $this->price_info; } public function hasPriceInfo() { return isset($this->price_info); } public function clearPriceInfo() { unset($this->price_info); } /** * Product price and cost information. * Corresponding properties: Google Merchant Center property * [price](https://support.google.com/merchants/answer/6324371). * * Generated from protobuf field .google.cloud.retail.v2.PriceInfo price_info = 14; * @param \Google\Cloud\Retail\V2\PriceInfo $var * @return $this */ public function setPriceInfo($var) { GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\PriceInfo::class); $this->price_info = $var; return $this; } /** * The rating of this product. * * Generated from protobuf field .google.cloud.retail.v2.Rating rating = 15; * @return \Google\Cloud\Retail\V2\Rating|null */ public function getRating() { return $this->rating; } public function hasRating() { return isset($this->rating); } public function clearRating() { unset($this->rating); } /** * The rating of this product. * * Generated from protobuf field .google.cloud.retail.v2.Rating rating = 15; * @param \Google\Cloud\Retail\V2\Rating $var * @return $this */ public function setRating($var) { GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\Rating::class); $this->rating = $var; return $this; } /** * The timestamp when this [Product][google.cloud.retail.v2.Product] becomes * available for * [SearchService.Search][google.cloud.retail.v2.SearchService.Search]. Note * that this is only applicable to * [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and * [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and * ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. * * Generated from protobuf field .google.protobuf.Timestamp available_time = 18; * @return \Google\Protobuf\Timestamp|null */ public function getAvailableTime() { return $this->available_time; } public function hasAvailableTime() { return isset($this->available_time); } public function clearAvailableTime() { unset($this->available_time); } /** * The timestamp when this [Product][google.cloud.retail.v2.Product] becomes * available for * [SearchService.Search][google.cloud.retail.v2.SearchService.Search]. Note * that this is only applicable to * [Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] and * [Type.COLLECTION][google.cloud.retail.v2.Product.Type.COLLECTION], and * ignored for [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]. * * Generated from protobuf field .google.protobuf.Timestamp available_time = 18; * @param \Google\Protobuf\Timestamp $var * @return $this */ public function setAvailableTime($var) { GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); $this->available_time = $var; return $this; } /** * The online availability of the [Product][google.cloud.retail.v2.Product]. * Default to * [Availability.IN_STOCK][google.cloud.retail.v2.Product.Availability.IN_STOCK]. * Corresponding properties: 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 .google.cloud.retail.v2.Product.Availability availability = 19; * @return int */ public function getAvailability() { return $this->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]. * Corresponding properties: 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 .google.cloud.retail.v2.Product.Availability availability = 19; * @param int $var * @return $this */ public function setAvailability($var) { GPBUtil::checkEnum($var, \Google\Cloud\Retail\V2\Product\Availability::class); $this->availability = $var; return $this; } /** * The available quantity of the item. * * Generated from protobuf field .google.protobuf.Int32Value available_quantity = 20; * @return \Google\Protobuf\Int32Value|null */ public function getAvailableQuantity() { return $this->available_quantity; } public function hasAvailableQuantity() { return isset($this->available_quantity); } public function clearAvailableQuantity() { unset($this->available_quantity); } /** * Returns the unboxed value from getAvailableQuantity() * The available quantity of the item. * * Generated from protobuf field .google.protobuf.Int32Value available_quantity = 20; * @return int|null */ public function getAvailableQuantityValue() { return $this->readWrapperValue("available_quantity"); } /** * The available quantity of the item. * * Generated from protobuf field .google.protobuf.Int32Value available_quantity = 20; * @param \Google\Protobuf\Int32Value $var * @return $this */ public function setAvailableQuantity($var) { GPBUtil::checkMessage($var, \Google\Protobuf\Int32Value::class); $this->available_quantity = $var; return $this; } /** * 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; * @param int|null $var * @return $this */ public function setAvailableQuantityValue($var) { $this->writeWrapperValue("available_quantity", $var); return $this;} /** * 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 repeated .google.cloud.retail.v2.FulfillmentInfo fulfillment_info = 21; * @return \Google\Protobuf\Internal\RepeatedField */ public function getFulfillmentInfo() { return $this->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. * * Generated from protobuf field repeated .google.cloud.retail.v2.FulfillmentInfo fulfillment_info = 21; * @param array<\Google\Cloud\Retail\V2\FulfillmentInfo>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setFulfillmentInfo($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\FulfillmentInfo::class); $this->fulfillment_info = $arr; return $this; } /** * 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](https://support.google.com/merchants/answer/6324416). Schema.org * property [Offer.url](https://schema.org/url). * * Generated from protobuf field string uri = 22; * @return string */ public function getUri() { return $this->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. * Corresponding properties: 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 string uri = 22; * @param string $var * @return $this */ public function setUri($var) { GPBUtil::checkString($var, True); $this->uri = $var; return $this; } /** * 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](https://support.google.com/merchants/answer/6324350). * Schema.org property [Product.image](https://schema.org/image). * * Generated from protobuf field repeated .google.cloud.retail.v2.Image images = 23; * @return \Google\Protobuf\Internal\RepeatedField */ public function getImages() { return $this->images; } /** * 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](https://support.google.com/merchants/answer/6324350). * Schema.org property [Product.image](https://schema.org/image). * * Generated from protobuf field repeated .google.cloud.retail.v2.Image images = 23; * @param array<\Google\Cloud\Retail\V2\Image>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setImages($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\Image::class); $this->images = $arr; return $this; } /** * 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; * @return \Google\Cloud\Retail\V2\Audience|null */ public function getAudience() { return $this->audience; } public function hasAudience() { return isset($this->audience); } public function clearAudience() { unset($this->audience); } /** * 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; * @param \Google\Cloud\Retail\V2\Audience $var * @return $this */ public function setAudience($var) { GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\Audience::class); $this->audience = $var; return $this; } /** * The color of the product. * Corresponding properties: 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 .google.cloud.retail.v2.ColorInfo color_info = 25; * @return \Google\Cloud\Retail\V2\ColorInfo|null */ public function getColorInfo() { return $this->color_info; } public function hasColorInfo() { return isset($this->color_info); } public function clearColorInfo() { unset($this->color_info); } /** * The color of the product. * Corresponding properties: 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 .google.cloud.retail.v2.ColorInfo color_info = 25; * @param \Google\Cloud\Retail\V2\ColorInfo $var * @return $this */ public function setColorInfo($var) { GPBUtil::checkMessage($var, \Google\Cloud\Retail\V2\ColorInfo::class); $this->color_info = $var; return $this; } /** * 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. * Corresponding properties: 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 repeated string sizes = 26; * @return \Google\Protobuf\Internal\RepeatedField */ public function getSizes() { return $this->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. * Corresponding properties: 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 repeated string sizes = 26; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setSizes($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->sizes = $arr; return $this; } /** * 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](https://support.google.com/merchants/answer/6324410). Schema.org * property [Product.material](https://schema.org/material). * * Generated from protobuf field repeated string materials = 27; * @return \Google\Protobuf\Internal\RepeatedField */ public function getMaterials() { return $this->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 200 characters. Otherwise, an * INVALID_ARGUMENT error is returned. * Corresponding properties: 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 repeated string materials = 27; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setMaterials($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->materials = $arr; return $this; } /** * 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. * Corresponding properties: 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 repeated string patterns = 28; * @return \Google\Protobuf\Internal\RepeatedField */ public function getPatterns() { return $this->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. * Corresponding properties: 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 repeated string patterns = 28; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setPatterns($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->patterns = $arr; return $this; } /** * The condition of the product. Strongly encouraged to use the standard * values: "new", "refurbished", "used". * A maximum of 1 value is 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. * Corresponding properties: 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 repeated string conditions = 29; * @return \Google\Protobuf\Internal\RepeatedField */ public function getConditions() { return $this->conditions; } /** * The condition of the product. Strongly encouraged to use the standard * values: "new", "refurbished", "used". * A maximum of 1 value is 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. * Corresponding properties: 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 repeated string conditions = 29; * @param array|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setConditions($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->conditions = $arr; return $this; } /** * The promotions applied to the product. A maximum of 10 values are allowed * per [Product][google.cloud.retail.v2.Product]. Only * [Promotion.promotion_id][google.cloud.retail.v2.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; * @return \Google\Protobuf\Internal\RepeatedField */ public function getPromotions() { return $this->promotions; } /** * The promotions applied to the product. A maximum of 10 values are allowed * per [Product][google.cloud.retail.v2.Product]. Only * [Promotion.promotion_id][google.cloud.retail.v2.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; * @param array<\Google\Cloud\Retail\V2\Promotion>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setPromotions($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\Promotion::class); $this->promotions = $arr; return $this; } /** * 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 .google.protobuf.Timestamp publish_time = 33; * @return \Google\Protobuf\Timestamp|null */ public function getPublishTime() { return $this->publish_time; } public function hasPublishTime() { return isset($this->publish_time); } public function clearPublishTime() { unset($this->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. * * Generated from protobuf field .google.protobuf.Timestamp publish_time = 33; * @param \Google\Protobuf\Timestamp $var * @return $this */ public function setPublishTime($var) { GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class); $this->publish_time = $var; return $this; } /** * 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] * The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is * returned. * Note: Returning more fields in * [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase * response payload size and serving latency. * This field is deprecated. Use the retrievable site-wide control instead. * * Generated from protobuf field .google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true]; * @return \Google\Protobuf\FieldMask|null * @deprecated */ public function getRetrievableFields() { @trigger_error('retrievable_fields is deprecated.', E_USER_DEPRECATED); return $this->retrievable_fields; } public function hasRetrievableFields() { @trigger_error('retrievable_fields is deprecated.', E_USER_DEPRECATED); return isset($this->retrievable_fields); } public function clearRetrievableFields() { @trigger_error('retrievable_fields is deprecated.', E_USER_DEPRECATED); unset($this->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] * The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is * returned. * Note: Returning more fields in * [SearchResponse][google.cloud.retail.v2.SearchResponse] can increase * response payload size and serving latency. * This field is deprecated. Use the retrievable site-wide control instead. * * Generated from protobuf field .google.protobuf.FieldMask retrievable_fields = 30 [deprecated = true]; * @param \Google\Protobuf\FieldMask $var * @return $this * @deprecated */ public function setRetrievableFields($var) { @trigger_error('retrievable_fields is deprecated.', E_USER_DEPRECATED); GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class); $this->retrievable_fields = $var; return $this; } /** * 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 repeated .google.cloud.retail.v2.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getVariants() { return $this->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. * * Generated from protobuf field repeated .google.cloud.retail.v2.Product variants = 31 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param array<\Google\Cloud\Retail\V2\Product>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setVariants($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\Product::class); $this->variants = $arr; return $this; } /** * 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 * [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] * and * [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] * APIs. * * Generated from protobuf field repeated .google.cloud.retail.v2.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return \Google\Protobuf\Internal\RepeatedField */ public function getLocalInventories() { return $this->local_inventories; } /** * 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 * [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] * and * [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] * APIs. * * Generated from protobuf field repeated .google.cloud.retail.v2.LocalInventory local_inventories = 35 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param array<\Google\Cloud\Retail\V2\LocalInventory>|\Google\Protobuf\Internal\RepeatedField $var * @return $this */ public function setLocalInventories($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Retail\V2\LocalInventory::class); $this->local_inventories = $arr; return $this; } /** * @return string */ public function getExpiration() { return $this->whichOneof("expiration"); } }