product.proto 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567
  1. // Copyright 2021 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.cloud.retail.v2alpha;
  16. import "google/api/field_behavior.proto";
  17. import "google/api/resource.proto";
  18. import "google/cloud/retail/v2alpha/common.proto";
  19. import "google/cloud/retail/v2alpha/promotion.proto";
  20. import "google/protobuf/duration.proto";
  21. import "google/protobuf/field_mask.proto";
  22. import "google/protobuf/timestamp.proto";
  23. import "google/protobuf/wrappers.proto";
  24. option csharp_namespace = "Google.Cloud.Retail.V2Alpha";
  25. option go_package = "google.golang.org/genproto/googleapis/cloud/retail/v2alpha;retail";
  26. option java_multiple_files = true;
  27. option java_outer_classname = "ProductProto";
  28. option java_package = "com.google.cloud.retail.v2alpha";
  29. option objc_class_prefix = "RETAIL";
  30. option php_namespace = "Google\\Cloud\\Retail\\V2alpha";
  31. option ruby_package = "Google::Cloud::Retail::V2alpha";
  32. option (google.api.resource_definition) = {
  33. type: "retail.googleapis.com/Branch"
  34. pattern: "projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}"
  35. };
  36. // Product captures all metadata information of items to be recommended or
  37. // searched.
  38. message Product {
  39. option (google.api.resource) = {
  40. type: "retail.googleapis.com/Product"
  41. pattern: "projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}"
  42. };
  43. // The type of this product.
  44. enum Type {
  45. // Default value. Default to
  46. // [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2alpha.ProductLevelConfig.ingestion_product_type]
  47. // if unset.
  48. TYPE_UNSPECIFIED = 0;
  49. // The primary type.
  50. //
  51. // As the primary unit for predicting, indexing and search serving, a
  52. // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
  53. // [Product][google.cloud.retail.v2alpha.Product] is grouped with multiple
  54. // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
  55. // [Product][google.cloud.retail.v2alpha.Product]s.
  56. PRIMARY = 1;
  57. // The variant type.
  58. //
  59. // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
  60. // [Product][google.cloud.retail.v2alpha.Product]s usually share some common
  61. // attributes on the same
  62. // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
  63. // [Product][google.cloud.retail.v2alpha.Product]s, but they have variant
  64. // attributes like different colors, sizes and prices, etc.
  65. VARIANT = 2;
  66. // The collection type. Collection products are bundled
  67. // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
  68. // [Product][google.cloud.retail.v2alpha.Product]s or
  69. // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
  70. // [Product][google.cloud.retail.v2alpha.Product]s that are sold together,
  71. // such as a jewelry set with necklaces, earrings and rings, etc.
  72. COLLECTION = 3;
  73. }
  74. // Product availability. If this field is unspecified, the product is
  75. // assumed to be in stock.
  76. enum Availability {
  77. // Default product availability. Default to
  78. // [Availability.IN_STOCK][google.cloud.retail.v2alpha.Product.Availability.IN_STOCK]
  79. // if unset.
  80. AVAILABILITY_UNSPECIFIED = 0;
  81. // Product in stock.
  82. IN_STOCK = 1;
  83. // Product out of stock.
  84. OUT_OF_STOCK = 2;
  85. // Product that is in pre-order state.
  86. PREORDER = 3;
  87. // Product that is back-ordered (i.e. temporarily out of stock).
  88. BACKORDER = 4;
  89. }
  90. oneof expiration {
  91. // The timestamp when this product becomes unavailable for
  92. // [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
  93. //
  94. // If it is set, the [Product][google.cloud.retail.v2alpha.Product] is not
  95. // available for
  96. // [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]
  97. // after [expire_time][google.cloud.retail.v2alpha.Product.expire_time].
  98. // However, the product can still be retrieved by
  99. // [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]
  100. // and
  101. // [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
  102. //
  103. // [expire_time][google.cloud.retail.v2alpha.Product.expire_time] must be
  104. // later than
  105. // [available_time][google.cloud.retail.v2alpha.Product.available_time] and
  106. // [publish_time][google.cloud.retail.v2alpha.Product.publish_time],
  107. // otherwise an INVALID_ARGUMENT error is thrown.
  108. //
  109. // Corresponding properties: Google Merchant Center property
  110. // [expiration_date](https://support.google.com/merchants/answer/6324499).
  111. google.protobuf.Timestamp expire_time = 16;
  112. // Input only. The TTL (time to live) of the product.
  113. //
  114. // If it is set, it must be a non-negative value, and
  115. // [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is set as
  116. // current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl].
  117. // The derived
  118. // [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is
  119. // returned in the output and [ttl][google.cloud.retail.v2alpha.Product.ttl]
  120. // is left blank when retrieving the
  121. // [Product][google.cloud.retail.v2alpha.Product].
  122. //
  123. // If it is set, the product is not available for
  124. // [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]
  125. // after current timestamp plus
  126. // [ttl][google.cloud.retail.v2alpha.Product.ttl]. However, the product can
  127. // still be retrieved by
  128. // [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]
  129. // and
  130. // [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
  131. google.protobuf.Duration ttl = 17
  132. [(google.api.field_behavior) = INPUT_ONLY];
  133. }
  134. // Immutable. Full resource name of the product, such as
  135. // `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
  136. string name = 1 [(google.api.field_behavior) = IMMUTABLE];
  137. // Immutable. [Product][google.cloud.retail.v2alpha.Product] identifier, which
  138. // is the final component of [name][google.cloud.retail.v2alpha.Product.name].
  139. // For example, this field is "id_1", if
  140. // [name][google.cloud.retail.v2alpha.Product.name] is
  141. // `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`.
  142. //
  143. // This field must be a UTF-8 encoded string with a length limit of 128
  144. // characters. Otherwise, an INVALID_ARGUMENT error is returned.
  145. //
  146. // Corresponding properties: Google Merchant Center property
  147. // [id](https://support.google.com/merchants/answer/6324405). Schema.org
  148. // property [Product.sku](https://schema.org/sku).
  149. string id = 2 [(google.api.field_behavior) = IMMUTABLE];
  150. // Immutable. The type of the product. Default to
  151. // [Catalog.product_level_config.ingestion_product_type][google.cloud.retail.v2alpha.ProductLevelConfig.ingestion_product_type]
  152. // if unset.
  153. Type type = 3 [(google.api.field_behavior) = IMMUTABLE];
  154. // Variant group identifier. Must be an
  155. // [id][google.cloud.retail.v2alpha.Product.id], with the same parent branch
  156. // with this product. Otherwise, an error is thrown.
  157. //
  158. // For [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
  159. // [Product][google.cloud.retail.v2alpha.Product]s, this field can only be
  160. // empty or set to the same value as
  161. // [id][google.cloud.retail.v2alpha.Product.id].
  162. //
  163. // For VARIANT [Product][google.cloud.retail.v2alpha.Product]s, this field
  164. // cannot be empty. A maximum of 2,000 products are allowed to share the same
  165. // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
  166. // [Product][google.cloud.retail.v2alpha.Product]. Otherwise, an
  167. // INVALID_ARGUMENT error is returned.
  168. //
  169. // Corresponding properties: Google Merchant Center property
  170. // [item_group_id](https://support.google.com/merchants/answer/6324507).
  171. // Schema.org property
  172. // [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
  173. string primary_product_id = 4;
  174. // The [id][google.cloud.retail.v2alpha.Product.id] of the collection members
  175. // when [type][google.cloud.retail.v2alpha.Product.type] is
  176. // [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION].
  177. //
  178. // Non-existent product ids are allowed.
  179. // The [type][google.cloud.retail.v2alpha.Product.type] of the members must be
  180. // either [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] or
  181. // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT] otherwise
  182. // and INVALID_ARGUMENT error is thrown. Should not set it for other types. A
  183. // maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is
  184. // return.
  185. repeated string collection_member_ids = 5;
  186. // The Global Trade Item Number (GTIN) of the product.
  187. //
  188. // This field must be a UTF-8 encoded string with a length limit of 128
  189. // characters. Otherwise, an INVALID_ARGUMENT error is returned.
  190. //
  191. // This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
  192. // returned.
  193. //
  194. // Corresponding properties: Google Merchant Center property
  195. // [gtin](https://support.google.com/merchants/answer/6324461).
  196. // Schema.org property
  197. // [Product.isbn](https://schema.org/isbn),
  198. // [Product.gtin8](https://schema.org/gtin8),
  199. // [Product.gtin12](https://schema.org/gtin12),
  200. // [Product.gtin13](https://schema.org/gtin13), or
  201. // [Product.gtin14](https://schema.org/gtin14).
  202. //
  203. // If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
  204. string gtin = 6;
  205. // Product categories. This field is repeated for supporting one product
  206. // belonging to several parallel categories. Strongly recommended using the
  207. // full path for better search / recommendation quality.
  208. //
  209. //
  210. // To represent full path of category, use '>' sign to separate different
  211. // hierarchies. If '>' is part of the category name, please replace it with
  212. // other character(s).
  213. //
  214. // For example, if a shoes product belongs to both
  215. // ["Shoes & Accessories" -> "Shoes"] and
  216. // ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
  217. // represented as:
  218. //
  219. // "categories": [
  220. // "Shoes & Accessories > Shoes",
  221. // "Sports & Fitness > Athletic Clothing > Shoes"
  222. // ]
  223. //
  224. // Must be set for
  225. // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
  226. // [Product][google.cloud.retail.v2alpha.Product] otherwise an
  227. // INVALID_ARGUMENT error is returned.
  228. //
  229. // At most 250 values are allowed per
  230. // [Product][google.cloud.retail.v2alpha.Product]. Empty values are not
  231. // allowed. Each value must be a UTF-8 encoded string with a length limit of
  232. // 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
  233. //
  234. // Corresponding properties: Google Merchant Center property
  235. // [google_product_category][mc_google_product_category]. Schema.org property
  236. // [Product.category] (https://schema.org/category).
  237. //
  238. // [mc_google_product_category]:
  239. // https://support.google.com/merchants/answer/6324436
  240. repeated string categories = 7;
  241. // Required. Product title.
  242. //
  243. // This field must be a UTF-8 encoded string with a length limit of 1,000
  244. // characters. Otherwise, an INVALID_ARGUMENT error is returned.
  245. //
  246. // Corresponding properties: Google Merchant Center property
  247. // [title](https://support.google.com/merchants/answer/6324415). Schema.org
  248. // property [Product.name](https://schema.org/name).
  249. string title = 8 [(google.api.field_behavior) = REQUIRED];
  250. // The brands of the product.
  251. //
  252. // A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded
  253. // string with a length limit of 1,000 characters. Otherwise, an
  254. // INVALID_ARGUMENT error is returned.
  255. //
  256. // Corresponding properties: Google Merchant Center property
  257. // [brand](https://support.google.com/merchants/answer/6324351). Schema.org
  258. // property [Product.brand](https://schema.org/brand).
  259. repeated string brands = 9;
  260. // Product description.
  261. //
  262. // This field must be a UTF-8 encoded string with a length limit of 5,000
  263. // characters. Otherwise, an INVALID_ARGUMENT error is returned.
  264. //
  265. // Corresponding properties: Google Merchant Center property
  266. // [description](https://support.google.com/merchants/answer/6324468).
  267. // Schema.org property [Product.description](https://schema.org/description).
  268. string description = 10;
  269. // Language of the title/description and other string attributes. Use language
  270. // tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
  271. //
  272. // For product prediction, this field is ignored and the model automatically
  273. // detects the text language. The
  274. // [Product][google.cloud.retail.v2alpha.Product] can include text in
  275. // different languages, but duplicating
  276. // [Product][google.cloud.retail.v2alpha.Product]s to provide text in multiple
  277. // languages can result in degraded model performance.
  278. //
  279. // For product search this field is in use. It defaults to "en-US" if unset.
  280. string language_code = 11;
  281. // Highly encouraged. Extra product attributes to be included. For example,
  282. // for products, this could include the store name, vendor, style, color, etc.
  283. // These are very strong signals for recommendation model, thus we highly
  284. // recommend providing the attributes here.
  285. //
  286. // Features that can take on one of a limited number of possible values. Two
  287. // types of features can be set are:
  288. //
  289. // Textual features. some examples would be the brand/maker of a product, or
  290. // country of a customer. Numerical features. Some examples would be the
  291. // height/weight of a product, or age of a customer.
  292. //
  293. // For example: `{ "vendor": {"text": ["vendor123", "vendor456"]},
  294. // "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]}
  295. // }`.
  296. //
  297. // This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
  298. // error is returned:
  299. //
  300. // * Max entries count: 200.
  301. // * The key must be a UTF-8 encoded string with a length limit of 128
  302. // characters.
  303. // * For indexable attribute, the key must match the pattern:
  304. // `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or
  305. // `KEY_1_LIKE_THIS`.
  306. // * For text attributes, at most 400 values are allowed. Empty values are not
  307. // allowed. Each value must be a non-empty UTF-8 encoded string with a
  308. // length limit of 256 characters.
  309. // * For number attributes, at most 400 values are allowed.
  310. map<string, CustomAttribute> attributes = 12;
  311. // Custom tags associated with the product.
  312. //
  313. // At most 250 values are allowed per
  314. // [Product][google.cloud.retail.v2alpha.Product]. This value must be a UTF-8
  315. // encoded string with a length limit of 1,000 characters. Otherwise, an
  316. // INVALID_ARGUMENT error is returned.
  317. //
  318. // This tag can be used for filtering recommendation results by passing the
  319. // tag as part of the
  320. // [PredictRequest.filter][google.cloud.retail.v2alpha.PredictRequest.filter].
  321. //
  322. // Corresponding properties: Google Merchant Center property
  323. // [custom_label_0–4](https://support.google.com/merchants/answer/6324473).
  324. repeated string tags = 13;
  325. // Product price and cost information.
  326. //
  327. // Corresponding properties: Google Merchant Center property
  328. // [price](https://support.google.com/merchants/answer/6324371).
  329. PriceInfo price_info = 14;
  330. // The rating of this product.
  331. Rating rating = 15;
  332. // The timestamp when this [Product][google.cloud.retail.v2alpha.Product]
  333. // becomes available for
  334. // [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].
  335. google.protobuf.Timestamp available_time = 18;
  336. // The online availability of the
  337. // [Product][google.cloud.retail.v2alpha.Product]. Default to
  338. // [Availability.IN_STOCK][google.cloud.retail.v2alpha.Product.Availability.IN_STOCK].
  339. //
  340. // Corresponding properties: Google Merchant Center property
  341. // [availability](https://support.google.com/merchants/answer/6324448).
  342. // Schema.org property [Offer.availability](https://schema.org/availability).
  343. Availability availability = 19;
  344. // The available quantity of the item.
  345. google.protobuf.Int32Value available_quantity = 20;
  346. // Fulfillment information, such as the store IDs for in-store pickup or
  347. // region IDs for different shipping methods.
  348. //
  349. // All the elements must have distinct
  350. // [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type].
  351. // Otherwise, an INVALID_ARGUMENT error is returned.
  352. repeated FulfillmentInfo fulfillment_info = 21;
  353. // Canonical URL directly linking to the product detail page.
  354. //
  355. // It is strongly recommended to provide a valid uri for the product,
  356. // otherwise the service performance could be significantly degraded.
  357. //
  358. // This field must be a UTF-8 encoded string with a length limit of 5,000
  359. // characters. Otherwise, an INVALID_ARGUMENT error is returned.
  360. //
  361. // Corresponding properties: Google Merchant Center property
  362. // [link](https://support.google.com/merchants/answer/6324416). Schema.org
  363. // property [Offer.url](https://schema.org/url).
  364. string uri = 22;
  365. // Product images for the product. We highly recommend putting the main
  366. // image first.
  367. //
  368. // A maximum of 300 images are allowed.
  369. //
  370. // Corresponding properties: Google Merchant Center property
  371. // [image_link](https://support.google.com/merchants/answer/6324350).
  372. // Schema.org property [Product.image](https://schema.org/image).
  373. repeated Image images = 23;
  374. // The target group associated with a given audience (e.g. male, veterans,
  375. // car owners, musicians, etc.) of the product.
  376. Audience audience = 24;
  377. // The color of the product.
  378. //
  379. // Corresponding properties: Google Merchant Center property
  380. // [color](https://support.google.com/merchants/answer/6324487). Schema.org
  381. // property [Product.color](https://schema.org/color).
  382. ColorInfo color_info = 25;
  383. // The size of the product. To represent different size systems or size types,
  384. // consider using this format: [[[size_system:]size_type:]size_value].
  385. //
  386. // For example, in "US:MENS:M", "US" represents size system; "MENS" represents
  387. // size type; "M" represents size value. In "GIRLS:27", size system is empty;
  388. // "GIRLS" represents size type; "27" represents size value. In "32 inches",
  389. // both size system and size type are empty, while size value is "32 inches".
  390. //
  391. // A maximum of 20 values are allowed per
  392. // [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8
  393. // encoded string with a length limit of 128 characters. Otherwise, an
  394. // INVALID_ARGUMENT error is returned.
  395. //
  396. // Corresponding properties: Google Merchant Center property
  397. // [size](https://support.google.com/merchants/answer/6324492),
  398. // [size_type](https://support.google.com/merchants/answer/6324497), and
  399. // [size_system](https://support.google.com/merchants/answer/6324502).
  400. // Schema.org property [Product.size](https://schema.org/size).
  401. repeated string sizes = 26;
  402. // The material of the product. For example, "leather", "wooden".
  403. //
  404. // A maximum of 20 values are allowed. Each value must be a UTF-8 encoded
  405. // string with a length limit of 200 characters. Otherwise, an
  406. // INVALID_ARGUMENT error is returned.
  407. //
  408. // Corresponding properties: Google Merchant Center property
  409. // [material](https://support.google.com/merchants/answer/6324410). Schema.org
  410. // property [Product.material](https://schema.org/material).
  411. repeated string materials = 27;
  412. // The pattern or graphic print of the product. For example, "striped", "polka
  413. // dot", "paisley".
  414. //
  415. // A maximum of 20 values are allowed per
  416. // [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8
  417. // encoded string with a length limit of 128 characters. Otherwise, an
  418. // INVALID_ARGUMENT error is returned.
  419. //
  420. // Corresponding properties: Google Merchant Center property
  421. // [pattern](https://support.google.com/merchants/answer/6324483). Schema.org
  422. // property [Product.pattern](https://schema.org/pattern).
  423. repeated string patterns = 28;
  424. // The condition of the product. Strongly encouraged to use the standard
  425. // values: "new", "refurbished", "used".
  426. //
  427. // A maximum of 1 value is allowed per
  428. // [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8
  429. // encoded string with a length limit of 128 characters. Otherwise, an
  430. // INVALID_ARGUMENT error is returned.
  431. //
  432. // Corresponding properties: Google Merchant Center property
  433. // [condition](https://support.google.com/merchants/answer/6324469).
  434. // Schema.org property
  435. // [Offer.itemCondition](https://schema.org/itemCondition).
  436. repeated string conditions = 29;
  437. // The promotions applied to the product. A maximum of 10 values are allowed
  438. // per [Product][google.cloud.retail.v2alpha.Product]. Only
  439. // [Promotion.promotion_id][google.cloud.retail.v2alpha.Promotion.promotion_id]
  440. // will be used, other fields will be ignored if set.
  441. repeated Promotion promotions = 34;
  442. // The timestamp when the product is published by the retailer for the first
  443. // time, which indicates the freshness of the products. Note that this field
  444. // is different from
  445. // [available_time][google.cloud.retail.v2alpha.Product.available_time], given
  446. // it purely describes product freshness regardless of when it is available on
  447. // search and recommendation.
  448. google.protobuf.Timestamp publish_time = 33;
  449. // Indicates which fields in the
  450. // [Product][google.cloud.retail.v2alpha.Product]s are returned in
  451. // [SearchResponse][google.cloud.retail.v2alpha.SearchResponse].
  452. //
  453. // Supported fields for all [type][google.cloud.retail.v2alpha.Product.type]s:
  454. //
  455. // * [audience][google.cloud.retail.v2alpha.Product.audience]
  456. // * [availability][google.cloud.retail.v2alpha.Product.availability]
  457. // * [brands][google.cloud.retail.v2alpha.Product.brands]
  458. // * [color_info][google.cloud.retail.v2alpha.Product.color_info]
  459. // * [conditions][google.cloud.retail.v2alpha.Product.conditions]
  460. // * [gtin][google.cloud.retail.v2alpha.Product.gtin]
  461. // * [materials][google.cloud.retail.v2alpha.Product.materials]
  462. // * [name][google.cloud.retail.v2alpha.Product.name]
  463. // * [patterns][google.cloud.retail.v2alpha.Product.patterns]
  464. // * [price_info][google.cloud.retail.v2alpha.Product.price_info]
  465. // * [rating][google.cloud.retail.v2alpha.Product.rating]
  466. // * [sizes][google.cloud.retail.v2alpha.Product.sizes]
  467. // * [title][google.cloud.retail.v2alpha.Product.title]
  468. // * [uri][google.cloud.retail.v2alpha.Product.uri]
  469. //
  470. // Supported fields only for
  471. // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and
  472. // [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]:
  473. //
  474. // * [categories][google.cloud.retail.v2alpha.Product.categories]
  475. // * [description][google.cloud.retail.v2alpha.Product.description]
  476. // * [images][google.cloud.retail.v2alpha.Product.images]
  477. //
  478. // Supported fields only for
  479. // [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]:
  480. //
  481. // * Only the first image in
  482. // [images][google.cloud.retail.v2alpha.Product.images]
  483. //
  484. // To mark [attributes][google.cloud.retail.v2alpha.Product.attributes] as
  485. // retrievable, include paths of the form "attributes.key" where "key" is the
  486. // key of a custom attribute, as specified in
  487. // [attributes][google.cloud.retail.v2alpha.Product.attributes].
  488. //
  489. // For [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and
  490. // [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], the
  491. // following fields are always returned in
  492. // [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] by default:
  493. //
  494. // * [name][google.cloud.retail.v2alpha.Product.name]
  495. //
  496. // For [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT], the
  497. // following fields are always returned in by default:
  498. //
  499. // * [name][google.cloud.retail.v2alpha.Product.name]
  500. // * [color_info][google.cloud.retail.v2alpha.Product.color_info]
  501. //
  502. // The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
  503. // returned.
  504. //
  505. // Note: Returning more fields in
  506. // [SearchResponse][google.cloud.retail.v2alpha.SearchResponse] can increase
  507. // response payload size and serving latency.
  508. google.protobuf.FieldMask retrievable_fields = 30;
  509. // Output only. Product variants grouped together on primary product which
  510. // share similar product attributes. It's automatically grouped by
  511. // [primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
  512. // for all the product variants. Only populated for
  513. // [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
  514. // [Product][google.cloud.retail.v2alpha.Product]s.
  515. //
  516. // Note: This field is OUTPUT_ONLY for
  517. // [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct].
  518. // Do not set this field in API requests.
  519. repeated Product variants = 31 [(google.api.field_behavior) = OUTPUT_ONLY];
  520. }