google-apis-retail_v2 0.99.0 → 0.101.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a27138edd092d39b390a9109e4149ecd8cbdffa83e9b9a3e7d14a87d8e7cb29b
4
- data.tar.gz: bedf3ea5a61ba663e3f3022023a076eb9b5be0033459cc3791f2557952bafedd
3
+ metadata.gz: 680a42cf4e9f51dd52a643eb7048e676921274048e424a19ddb013b9315b8b5f
4
+ data.tar.gz: 1fdb8add6adb047d7595716b8728df06f6409b67796868c97accd101fde65563
5
5
  SHA512:
6
- metadata.gz: f549f09ddea9f89c2b4d23766e70234fbb8bf2397510bb5457e3df32df440bbbdfcd68e30880bb5be932f53e4e9b7b171a8c4a57dea988b1a6f01ab986b5ce36
7
- data.tar.gz: 5e57b3f3d48fdaf75319b5fbb1ce86955440bd136f24f2973cb090c35ffb0efeed45f959f8c87cb2daf4704024bd4a63a502c9a6cf94bc9efe5a8ec9e3eecfdc
6
+ metadata.gz: 30fc70bd16a6f9363260f365a428e7b17e2caab331fc82fadda12595afa60fecfb8df696a51aad2da27814a9fbe3d05faefa23c88210f103603a0d3c29b88b53
7
+ data.tar.gz: e3a4de2117e6901ba6d70ccaa884d3d5af7caeac8812b278fac32735628391736284df60282aa0737eb3f0873a4451652041ba3f2b86986bcc1414b621553710
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.101.0 (2024-09-22)
4
+
5
+ * Regenerated from discovery document revision 20240912
6
+
7
+ ### v0.100.0 (2024-09-01)
8
+
9
+ * Regenerated from discovery document revision 20240822
10
+
3
11
  ### v0.99.0 (2024-08-18)
4
12
 
5
13
  * Regenerated from discovery document revision 20240816
@@ -1085,7 +1085,8 @@ module Google
1085
1085
  end
1086
1086
  end
1087
1087
 
1088
- # Resource that represents attribute results.
1088
+ # Resource that represents attribute results. The list of suggestions for the
1089
+ # attribute.
1089
1090
  class GoogleCloudRetailV2CompleteQueryResponseAttributeResult
1090
1091
  include Google::Apis::Core::Hashable
1091
1092
 
@@ -3000,10 +3001,15 @@ module Google
3000
3001
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Audience]
3001
3002
  attr_accessor :audience
3002
3003
 
3003
- # The online availability of the Product. Default to Availability.IN_STOCK.
3004
- # Corresponding properties: Google Merchant Center property [availability](https:
3005
- # //support.google.com/merchants/answer/6324448). Schema.org property [Offer.
3006
- # availability](https://schema.org/availability).
3004
+ # The online availability of the Product. Default to Availability.IN_STOCK. For
3005
+ # primary products with variants set the availability of the primary as
3006
+ # Availability.OUT_OF_STOCK and set the true availability at the variant level.
3007
+ # This way the primary product will be considered "in stock" as long as it has
3008
+ # at least one variant in stock. For primary products with no variants set the
3009
+ # true availability at the primary level. Corresponding properties: Google
3010
+ # Merchant Center property [availability](https://support.google.com/merchants/
3011
+ # answer/6324448). Schema.org property [Offer.availability](https://schema.org/
3012
+ # availability).
3007
3013
  # Corresponds to the JSON property `availability`
3008
3014
  # @return [String]
3009
3015
  attr_accessor :availability
@@ -3359,6 +3365,58 @@ module Google
3359
3365
  end
3360
3366
  end
3361
3367
 
3368
+ # Product attribute name and numeric interval.
3369
+ class GoogleCloudRetailV2ProductAttributeInterval
3370
+ include Google::Apis::Core::Hashable
3371
+
3372
+ # A floating point interval.
3373
+ # Corresponds to the JSON property `interval`
3374
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Interval]
3375
+ attr_accessor :interval
3376
+
3377
+ # The attribute name (e.g. "length")
3378
+ # Corresponds to the JSON property `name`
3379
+ # @return [String]
3380
+ attr_accessor :name
3381
+
3382
+ def initialize(**args)
3383
+ update!(**args)
3384
+ end
3385
+
3386
+ # Update properties of this object
3387
+ def update!(**args)
3388
+ @interval = args[:interval] if args.key?(:interval)
3389
+ @name = args[:name] if args.key?(:name)
3390
+ end
3391
+ end
3392
+
3393
+ # Product attribute which structured by an attribute name and value. This
3394
+ # structure is used in conversational search filters and answers. For example,
3395
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
3396
+ class GoogleCloudRetailV2ProductAttributeValue
3397
+ include Google::Apis::Core::Hashable
3398
+
3399
+ # The attribute name.
3400
+ # Corresponds to the JSON property `name`
3401
+ # @return [String]
3402
+ attr_accessor :name
3403
+
3404
+ # The attribute value.
3405
+ # Corresponds to the JSON property `value`
3406
+ # @return [String]
3407
+ attr_accessor :value
3408
+
3409
+ def initialize(**args)
3410
+ update!(**args)
3411
+ end
3412
+
3413
+ # Update properties of this object
3414
+ def update!(**args)
3415
+ @name = args[:name] if args.key?(:name)
3416
+ @value = args[:value] if args.key?(:value)
3417
+ end
3418
+ end
3419
+
3362
3420
  # Detailed product information associated with a user event.
3363
3421
  class GoogleCloudRetailV2ProductDetail
3364
3422
  include Google::Apis::Core::Hashable
@@ -4532,6 +4590,12 @@ module Google
4532
4590
  # @return [String]
4533
4591
  attr_accessor :canonical_filter
4534
4592
 
4593
+ # This field specifies all conversational related parameters addition to
4594
+ # traditional retail search.
4595
+ # Corresponds to the JSON property `conversationalSearchSpec`
4596
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpec]
4597
+ attr_accessor :conversational_search_spec
4598
+
4535
4599
  # The specifications of dynamically generated facets.
4536
4600
  # Corresponds to the JSON property `dynamicFacetSpec`
4537
4601
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec]
@@ -4648,6 +4712,11 @@ module Google
4648
4712
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec]
4649
4713
  attr_accessor :spell_correction_spec
4650
4714
 
4715
+ # This field specifies tile navigation related parameters.
4716
+ # Corresponds to the JSON property `tileNavigationSpec`
4717
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestTileNavigationSpec]
4718
+ attr_accessor :tile_navigation_spec
4719
+
4651
4720
  # Information of an end user.
4652
4721
  # Corresponds to the JSON property `userInfo`
4653
4722
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
@@ -4702,6 +4771,7 @@ module Google
4702
4771
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
4703
4772
  @branch = args[:branch] if args.key?(:branch)
4704
4773
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
4774
+ @conversational_search_spec = args[:conversational_search_spec] if args.key?(:conversational_search_spec)
4705
4775
  @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
4706
4776
  @entity = args[:entity] if args.key?(:entity)
4707
4777
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
@@ -4717,6 +4787,7 @@ module Google
4717
4787
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
4718
4788
  @search_mode = args[:search_mode] if args.key?(:search_mode)
4719
4789
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
4790
+ @tile_navigation_spec = args[:tile_navigation_spec] if args.key?(:tile_navigation_spec)
4720
4791
  @user_info = args[:user_info] if args.key?(:user_info)
4721
4792
  @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
4722
4793
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
@@ -4792,6 +4863,102 @@ module Google
4792
4863
  end
4793
4864
  end
4794
4865
 
4866
+ # This field specifies all conversational related parameters addition to
4867
+ # traditional retail search.
4868
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpec
4869
+ include Google::Apis::Core::Hashable
4870
+
4871
+ # This field specifies the conversation id, which maintains the state of the
4872
+ # conversation between client side and server side. Use the value from the
4873
+ # previous ConversationalSearchResult.conversation_id. For the initial request,
4874
+ # this should be empty.
4875
+ # Corresponds to the JSON property `conversationId`
4876
+ # @return [String]
4877
+ attr_accessor :conversation_id
4878
+
4879
+ # This field specifies whether the customer would like to do conversational
4880
+ # search. If this field is set to true, conversational related extra information
4881
+ # will be returned from server side, including follow-up question, answer
4882
+ # options, etc.
4883
+ # Corresponds to the JSON property `followupConversationRequested`
4884
+ # @return [Boolean]
4885
+ attr_accessor :followup_conversation_requested
4886
+ alias_method :followup_conversation_requested?, :followup_conversation_requested
4887
+
4888
+ # This field specifies the current user answer during the conversational search.
4889
+ # This can be either user selected from suggested answers or user input plain
4890
+ # text.
4891
+ # Corresponds to the JSON property `userAnswer`
4892
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer]
4893
+ attr_accessor :user_answer
4894
+
4895
+ def initialize(**args)
4896
+ update!(**args)
4897
+ end
4898
+
4899
+ # Update properties of this object
4900
+ def update!(**args)
4901
+ @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
4902
+ @followup_conversation_requested = args[:followup_conversation_requested] if args.key?(:followup_conversation_requested)
4903
+ @user_answer = args[:user_answer] if args.key?(:user_answer)
4904
+ end
4905
+ end
4906
+
4907
+ # This field specifies the current user answer during the conversational search.
4908
+ # This can be either user selected from suggested answers or user input plain
4909
+ # text.
4910
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer
4911
+ include Google::Apis::Core::Hashable
4912
+
4913
+ # This field specifies the selected answers during the conversational search.
4914
+ # Corresponds to the JSON property `selectedAnswer`
4915
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer]
4916
+ attr_accessor :selected_answer
4917
+
4918
+ # This field specifies the incremental input text from the user during the
4919
+ # conversational search.
4920
+ # Corresponds to the JSON property `textAnswer`
4921
+ # @return [String]
4922
+ attr_accessor :text_answer
4923
+
4924
+ def initialize(**args)
4925
+ update!(**args)
4926
+ end
4927
+
4928
+ # Update properties of this object
4929
+ def update!(**args)
4930
+ @selected_answer = args[:selected_answer] if args.key?(:selected_answer)
4931
+ @text_answer = args[:text_answer] if args.key?(:text_answer)
4932
+ end
4933
+ end
4934
+
4935
+ # This field specifies the selected answers during the conversational search.
4936
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer
4937
+ include Google::Apis::Core::Hashable
4938
+
4939
+ # Product attribute which structured by an attribute name and value. This
4940
+ # structure is used in conversational search filters and answers. For example,
4941
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
4942
+ # Corresponds to the JSON property `productAttributeValue`
4943
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue]
4944
+ attr_accessor :product_attribute_value
4945
+
4946
+ # This field is deprecated and should not be set.
4947
+ # Corresponds to the JSON property `productAttributeValues`
4948
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue>]
4949
+ attr_accessor :product_attribute_values
4950
+
4951
+ def initialize(**args)
4952
+ update!(**args)
4953
+ end
4954
+
4955
+ # Update properties of this object
4956
+ def update!(**args)
4957
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
4958
+ @product_attribute_values = args[:product_attribute_values] if args.key?(:product_attribute_values)
4959
+ end
4960
+ end
4961
+
4795
4962
  # The specifications of dynamically generated facets.
4796
4963
  class GoogleCloudRetailV2SearchRequestDynamicFacetSpec
4797
4964
  include Google::Apis::Core::Hashable
@@ -5070,6 +5237,35 @@ module Google
5070
5237
  end
5071
5238
  end
5072
5239
 
5240
+ # This field specifies tile navigation related parameters.
5241
+ class GoogleCloudRetailV2SearchRequestTileNavigationSpec
5242
+ include Google::Apis::Core::Hashable
5243
+
5244
+ # This field specifies the tiles which are already clicked in client side. NOTE:
5245
+ # This field is not being used for filtering search products. Client side should
5246
+ # also put all the applied tiles in SearchRequest.filter.
5247
+ # Corresponds to the JSON property `appliedTiles`
5248
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Tile>]
5249
+ attr_accessor :applied_tiles
5250
+
5251
+ # This field specifies whether the customer would like to request tile
5252
+ # navigation.
5253
+ # Corresponds to the JSON property `tileNavigationRequested`
5254
+ # @return [Boolean]
5255
+ attr_accessor :tile_navigation_requested
5256
+ alias_method :tile_navigation_requested?, :tile_navigation_requested
5257
+
5258
+ def initialize(**args)
5259
+ update!(**args)
5260
+ end
5261
+
5262
+ # Update properties of this object
5263
+ def update!(**args)
5264
+ @applied_tiles = args[:applied_tiles] if args.key?(:applied_tiles)
5265
+ @tile_navigation_requested = args[:tile_navigation_requested] if args.key?(:tile_navigation_requested)
5266
+ end
5267
+ end
5268
+
5073
5269
  # Response message for SearchService.Search method.
5074
5270
  class GoogleCloudRetailV2SearchResponse
5075
5271
  include Google::Apis::Core::Hashable
@@ -5087,6 +5283,12 @@ module Google
5087
5283
  # @return [String]
5088
5284
  attr_accessor :attribution_token
5089
5285
 
5286
+ # This field specifies all related information that is needed on client side for
5287
+ # UI rendering of conversational retail search.
5288
+ # Corresponds to the JSON property `conversationalSearchResult`
5289
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResult]
5290
+ attr_accessor :conversational_search_result
5291
+
5090
5292
  # Contains the spell corrected query, if found. If the spell correction type is
5091
5293
  # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
5092
5294
  # original query is used for search.
@@ -5135,6 +5337,12 @@ module Google
5135
5337
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult>]
5136
5338
  attr_accessor :results
5137
5339
 
5340
+ # This field specifies all related information for tile navigation that will be
5341
+ # used in client side.
5342
+ # Corresponds to the JSON property `tileNavigationResult`
5343
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseTileNavigationResult]
5344
+ attr_accessor :tile_navigation_result
5345
+
5138
5346
  # The estimated total count of matched items irrespective of pagination. The
5139
5347
  # count of results returned by pagination may be less than the total_size that
5140
5348
  # matches.
@@ -5150,6 +5358,7 @@ module Google
5150
5358
  def update!(**args)
5151
5359
  @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
5152
5360
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
5361
+ @conversational_search_result = args[:conversational_search_result] if args.key?(:conversational_search_result)
5153
5362
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
5154
5363
  @experiment_info = args[:experiment_info] if args.key?(:experiment_info)
5155
5364
  @facets = args[:facets] if args.key?(:facets)
@@ -5158,10 +5367,113 @@ module Google
5158
5367
  @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
5159
5368
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
5160
5369
  @results = args[:results] if args.key?(:results)
5370
+ @tile_navigation_result = args[:tile_navigation_result] if args.key?(:tile_navigation_result)
5161
5371
  @total_size = args[:total_size] if args.key?(:total_size)
5162
5372
  end
5163
5373
  end
5164
5374
 
5375
+ # This field specifies all related information that is needed on client side for
5376
+ # UI rendering of conversational retail search.
5377
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResult
5378
+ include Google::Apis::Core::Hashable
5379
+
5380
+ # Additional filter that client side need to apply.
5381
+ # Corresponds to the JSON property `additionalFilter`
5382
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter]
5383
+ attr_accessor :additional_filter
5384
+
5385
+ # This field is deprecated but will be kept for backward compatibility. There is
5386
+ # expected to have only one additional filter and the value will be the same to
5387
+ # the same as field `additional_filter`.
5388
+ # Corresponds to the JSON property `additionalFilters`
5389
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter>]
5390
+ attr_accessor :additional_filters
5391
+
5392
+ # Conversation UUID. This field will be stored in client side storage to
5393
+ # maintain the conversation session with server and will be used for next search
5394
+ # request's SearchRequest.ConversationalSearchSpec.conversation_id to restore
5395
+ # conversation state in server.
5396
+ # Corresponds to the JSON property `conversationId`
5397
+ # @return [String]
5398
+ attr_accessor :conversation_id
5399
+
5400
+ # The follow-up question. e.g., `What is the color?`
5401
+ # Corresponds to the JSON property `followupQuestion`
5402
+ # @return [String]
5403
+ attr_accessor :followup_question
5404
+
5405
+ # The current refined query for the conversational search. This field will be
5406
+ # used in customer UI that the query in the search bar should be replaced with
5407
+ # the refined query. For example, if SearchRequest.query is `dress` and next
5408
+ # SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`,
5409
+ # which does not match any product attribute value filters, the refined query
5410
+ # will be `dress, red color`.
5411
+ # Corresponds to the JSON property `refinedQuery`
5412
+ # @return [String]
5413
+ attr_accessor :refined_query
5414
+
5415
+ # The answer options provided to client for the follow-up question.
5416
+ # Corresponds to the JSON property `suggestedAnswers`
5417
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer>]
5418
+ attr_accessor :suggested_answers
5419
+
5420
+ def initialize(**args)
5421
+ update!(**args)
5422
+ end
5423
+
5424
+ # Update properties of this object
5425
+ def update!(**args)
5426
+ @additional_filter = args[:additional_filter] if args.key?(:additional_filter)
5427
+ @additional_filters = args[:additional_filters] if args.key?(:additional_filters)
5428
+ @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
5429
+ @followup_question = args[:followup_question] if args.key?(:followup_question)
5430
+ @refined_query = args[:refined_query] if args.key?(:refined_query)
5431
+ @suggested_answers = args[:suggested_answers] if args.key?(:suggested_answers)
5432
+ end
5433
+ end
5434
+
5435
+ # Additional filter that client side need to apply.
5436
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter
5437
+ include Google::Apis::Core::Hashable
5438
+
5439
+ # Product attribute which structured by an attribute name and value. This
5440
+ # structure is used in conversational search filters and answers. For example,
5441
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
5442
+ # Corresponds to the JSON property `productAttributeValue`
5443
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue]
5444
+ attr_accessor :product_attribute_value
5445
+
5446
+ def initialize(**args)
5447
+ update!(**args)
5448
+ end
5449
+
5450
+ # Update properties of this object
5451
+ def update!(**args)
5452
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
5453
+ end
5454
+ end
5455
+
5456
+ # Suggested answers to the follow-up question.
5457
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer
5458
+ include Google::Apis::Core::Hashable
5459
+
5460
+ # Product attribute which structured by an attribute name and value. This
5461
+ # structure is used in conversational search filters and answers. For example,
5462
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
5463
+ # Corresponds to the JSON property `productAttributeValue`
5464
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue]
5465
+ attr_accessor :product_attribute_value
5466
+
5467
+ def initialize(**args)
5468
+ update!(**args)
5469
+ end
5470
+
5471
+ # Update properties of this object
5472
+ def update!(**args)
5473
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
5474
+ end
5475
+ end
5476
+
5165
5477
  # A facet result.
5166
5478
  class GoogleCloudRetailV2SearchResponseFacet
5167
5479
  include Google::Apis::Core::Hashable
@@ -5337,6 +5649,26 @@ module Google
5337
5649
  end
5338
5650
  end
5339
5651
 
5652
+ # This field specifies all related information for tile navigation that will be
5653
+ # used in client side.
5654
+ class GoogleCloudRetailV2SearchResponseTileNavigationResult
5655
+ include Google::Apis::Core::Hashable
5656
+
5657
+ # The current tiles that are used for tile navigation, sorted by engagement.
5658
+ # Corresponds to the JSON property `tiles`
5659
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Tile>]
5660
+ attr_accessor :tiles
5661
+
5662
+ def initialize(**args)
5663
+ update!(**args)
5664
+ end
5665
+
5666
+ # Update properties of this object
5667
+ def update!(**args)
5668
+ @tiles = args[:tiles] if args.key?(:tiles)
5669
+ end
5670
+ end
5671
+
5340
5672
  # Configures metadata that is used to generate serving time results (e.g. search
5341
5673
  # results or recommendation predictions).
5342
5674
  class GoogleCloudRetailV2ServingConfig
@@ -5647,6 +5979,41 @@ module Google
5647
5979
  end
5648
5980
  end
5649
5981
 
5982
+ # This field specifies the tile information including an attribute key,
5983
+ # attribute value. More fields will be added in the future, eg: product id or
5984
+ # product counts, etc.
5985
+ class GoogleCloudRetailV2Tile
5986
+ include Google::Apis::Core::Hashable
5987
+
5988
+ # Product attribute name and numeric interval.
5989
+ # Corresponds to the JSON property `productAttributeInterval`
5990
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeInterval]
5991
+ attr_accessor :product_attribute_interval
5992
+
5993
+ # Product attribute which structured by an attribute name and value. This
5994
+ # structure is used in conversational search filters and answers. For example,
5995
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
5996
+ # Corresponds to the JSON property `productAttributeValue`
5997
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue]
5998
+ attr_accessor :product_attribute_value
5999
+
6000
+ # The representative product id for this tile.
6001
+ # Corresponds to the JSON property `representativeProductId`
6002
+ # @return [String]
6003
+ attr_accessor :representative_product_id
6004
+
6005
+ def initialize(**args)
6006
+ update!(**args)
6007
+ end
6008
+
6009
+ # Update properties of this object
6010
+ def update!(**args)
6011
+ @product_attribute_interval = args[:product_attribute_interval] if args.key?(:product_attribute_interval)
6012
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
6013
+ @representative_product_id = args[:representative_product_id] if args.key?(:representative_product_id)
6014
+ end
6015
+ end
6016
+
5650
6017
  # Metadata associated with a tune operation.
5651
6018
  class GoogleCloudRetailV2TuneModelMetadata
5652
6019
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2
18
18
  # Version of the google-apis-retail_v2 gem
19
- GEM_VERSION = "0.99.0"
19
+ GEM_VERSION = "0.101.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240816"
25
+ REVISION = "20240912"
26
26
  end
27
27
  end
28
28
  end
@@ -508,6 +508,18 @@ module Google
508
508
  include Google::Apis::Core::JsonObjectSupport
509
509
  end
510
510
 
511
+ class GoogleCloudRetailV2ProductAttributeInterval
512
+ class Representation < Google::Apis::Core::JsonRepresentation; end
513
+
514
+ include Google::Apis::Core::JsonObjectSupport
515
+ end
516
+
517
+ class GoogleCloudRetailV2ProductAttributeValue
518
+ class Representation < Google::Apis::Core::JsonRepresentation; end
519
+
520
+ include Google::Apis::Core::JsonObjectSupport
521
+ end
522
+
511
523
  class GoogleCloudRetailV2ProductDetail
512
524
  class Representation < Google::Apis::Core::JsonRepresentation; end
513
525
 
@@ -754,6 +766,24 @@ module Google
754
766
  include Google::Apis::Core::JsonObjectSupport
755
767
  end
756
768
 
769
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpec
770
+ class Representation < Google::Apis::Core::JsonRepresentation; end
771
+
772
+ include Google::Apis::Core::JsonObjectSupport
773
+ end
774
+
775
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer
776
+ class Representation < Google::Apis::Core::JsonRepresentation; end
777
+
778
+ include Google::Apis::Core::JsonObjectSupport
779
+ end
780
+
781
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer
782
+ class Representation < Google::Apis::Core::JsonRepresentation; end
783
+
784
+ include Google::Apis::Core::JsonObjectSupport
785
+ end
786
+
757
787
  class GoogleCloudRetailV2SearchRequestDynamicFacetSpec
758
788
  class Representation < Google::Apis::Core::JsonRepresentation; end
759
789
 
@@ -790,12 +820,36 @@ module Google
790
820
  include Google::Apis::Core::JsonObjectSupport
791
821
  end
792
822
 
823
+ class GoogleCloudRetailV2SearchRequestTileNavigationSpec
824
+ class Representation < Google::Apis::Core::JsonRepresentation; end
825
+
826
+ include Google::Apis::Core::JsonObjectSupport
827
+ end
828
+
793
829
  class GoogleCloudRetailV2SearchResponse
794
830
  class Representation < Google::Apis::Core::JsonRepresentation; end
795
831
 
796
832
  include Google::Apis::Core::JsonObjectSupport
797
833
  end
798
834
 
835
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResult
836
+ class Representation < Google::Apis::Core::JsonRepresentation; end
837
+
838
+ include Google::Apis::Core::JsonObjectSupport
839
+ end
840
+
841
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter
842
+ class Representation < Google::Apis::Core::JsonRepresentation; end
843
+
844
+ include Google::Apis::Core::JsonObjectSupport
845
+ end
846
+
847
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer
848
+ class Representation < Google::Apis::Core::JsonRepresentation; end
849
+
850
+ include Google::Apis::Core::JsonObjectSupport
851
+ end
852
+
799
853
  class GoogleCloudRetailV2SearchResponseFacet
800
854
  class Representation < Google::Apis::Core::JsonRepresentation; end
801
855
 
@@ -820,6 +874,12 @@ module Google
820
874
  include Google::Apis::Core::JsonObjectSupport
821
875
  end
822
876
 
877
+ class GoogleCloudRetailV2SearchResponseTileNavigationResult
878
+ class Representation < Google::Apis::Core::JsonRepresentation; end
879
+
880
+ include Google::Apis::Core::JsonObjectSupport
881
+ end
882
+
823
883
  class GoogleCloudRetailV2ServingConfig
824
884
  class Representation < Google::Apis::Core::JsonRepresentation; end
825
885
 
@@ -850,6 +910,12 @@ module Google
850
910
  include Google::Apis::Core::JsonObjectSupport
851
911
  end
852
912
 
913
+ class GoogleCloudRetailV2Tile
914
+ class Representation < Google::Apis::Core::JsonRepresentation; end
915
+
916
+ include Google::Apis::Core::JsonObjectSupport
917
+ end
918
+
853
919
  class GoogleCloudRetailV2TuneModelMetadata
854
920
  class Representation < Google::Apis::Core::JsonRepresentation; end
855
921
 
@@ -2243,6 +2309,23 @@ module Google
2243
2309
  end
2244
2310
  end
2245
2311
 
2312
+ class GoogleCloudRetailV2ProductAttributeInterval
2313
+ # @private
2314
+ class Representation < Google::Apis::Core::JsonRepresentation
2315
+ property :interval, as: 'interval', class: Google::Apis::RetailV2::GoogleCloudRetailV2Interval, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Interval::Representation
2316
+
2317
+ property :name, as: 'name'
2318
+ end
2319
+ end
2320
+
2321
+ class GoogleCloudRetailV2ProductAttributeValue
2322
+ # @private
2323
+ class Representation < Google::Apis::Core::JsonRepresentation
2324
+ property :name, as: 'name'
2325
+ property :value, as: 'value'
2326
+ end
2327
+ end
2328
+
2246
2329
  class GoogleCloudRetailV2ProductDetail
2247
2330
  # @private
2248
2331
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2567,6 +2650,8 @@ module Google
2567
2650
 
2568
2651
  property :branch, as: 'branch'
2569
2652
  property :canonical_filter, as: 'canonicalFilter'
2653
+ property :conversational_search_spec, as: 'conversationalSearchSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpec::Representation
2654
+
2570
2655
  property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec::Representation
2571
2656
 
2572
2657
  property :entity, as: 'entity'
@@ -2587,6 +2672,8 @@ module Google
2587
2672
  property :search_mode, as: 'searchMode'
2588
2673
  property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec::Representation
2589
2674
 
2675
+ property :tile_navigation_spec, as: 'tileNavigationSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestTileNavigationSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestTileNavigationSpec::Representation
2676
+
2590
2677
  property :user_info, as: 'userInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo::Representation
2591
2678
 
2592
2679
  collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -2611,6 +2698,35 @@ module Google
2611
2698
  end
2612
2699
  end
2613
2700
 
2701
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpec
2702
+ # @private
2703
+ class Representation < Google::Apis::Core::JsonRepresentation
2704
+ property :conversation_id, as: 'conversationId'
2705
+ property :followup_conversation_requested, as: 'followupConversationRequested'
2706
+ property :user_answer, as: 'userAnswer', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer::Representation
2707
+
2708
+ end
2709
+ end
2710
+
2711
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer
2712
+ # @private
2713
+ class Representation < Google::Apis::Core::JsonRepresentation
2714
+ property :selected_answer, as: 'selectedAnswer', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer::Representation
2715
+
2716
+ property :text_answer, as: 'textAnswer'
2717
+ end
2718
+ end
2719
+
2720
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer
2721
+ # @private
2722
+ class Representation < Google::Apis::Core::JsonRepresentation
2723
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2724
+
2725
+ collection :product_attribute_values, as: 'productAttributeValues', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2726
+
2727
+ end
2728
+ end
2729
+
2614
2730
  class GoogleCloudRetailV2SearchRequestDynamicFacetSpec
2615
2731
  # @private
2616
2732
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2667,11 +2783,22 @@ module Google
2667
2783
  end
2668
2784
  end
2669
2785
 
2786
+ class GoogleCloudRetailV2SearchRequestTileNavigationSpec
2787
+ # @private
2788
+ class Representation < Google::Apis::Core::JsonRepresentation
2789
+ collection :applied_tiles, as: 'appliedTiles', class: Google::Apis::RetailV2::GoogleCloudRetailV2Tile, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Tile::Representation
2790
+
2791
+ property :tile_navigation_requested, as: 'tileNavigationRequested'
2792
+ end
2793
+ end
2794
+
2670
2795
  class GoogleCloudRetailV2SearchResponse
2671
2796
  # @private
2672
2797
  class Representation < Google::Apis::Core::JsonRepresentation
2673
2798
  collection :applied_controls, as: 'appliedControls'
2674
2799
  property :attribution_token, as: 'attributionToken'
2800
+ property :conversational_search_result, as: 'conversationalSearchResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResult::Representation
2801
+
2675
2802
  property :corrected_query, as: 'correctedQuery'
2676
2803
  collection :experiment_info, as: 'experimentInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo::Representation
2677
2804
 
@@ -2685,10 +2812,43 @@ module Google
2685
2812
  property :redirect_uri, as: 'redirectUri'
2686
2813
  collection :results, as: 'results', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult::Representation
2687
2814
 
2815
+ property :tile_navigation_result, as: 'tileNavigationResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseTileNavigationResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseTileNavigationResult::Representation
2816
+
2688
2817
  property :total_size, as: 'totalSize'
2689
2818
  end
2690
2819
  end
2691
2820
 
2821
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResult
2822
+ # @private
2823
+ class Representation < Google::Apis::Core::JsonRepresentation
2824
+ property :additional_filter, as: 'additionalFilter', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter::Representation
2825
+
2826
+ collection :additional_filters, as: 'additionalFilters', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter::Representation
2827
+
2828
+ property :conversation_id, as: 'conversationId'
2829
+ property :followup_question, as: 'followupQuestion'
2830
+ property :refined_query, as: 'refinedQuery'
2831
+ collection :suggested_answers, as: 'suggestedAnswers', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer::Representation
2832
+
2833
+ end
2834
+ end
2835
+
2836
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter
2837
+ # @private
2838
+ class Representation < Google::Apis::Core::JsonRepresentation
2839
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2840
+
2841
+ end
2842
+ end
2843
+
2844
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer
2845
+ # @private
2846
+ class Representation < Google::Apis::Core::JsonRepresentation
2847
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2848
+
2849
+ end
2850
+ end
2851
+
2692
2852
  class GoogleCloudRetailV2SearchResponseFacet
2693
2853
  # @private
2694
2854
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2732,6 +2892,14 @@ module Google
2732
2892
  end
2733
2893
  end
2734
2894
 
2895
+ class GoogleCloudRetailV2SearchResponseTileNavigationResult
2896
+ # @private
2897
+ class Representation < Google::Apis::Core::JsonRepresentation
2898
+ collection :tiles, as: 'tiles', class: Google::Apis::RetailV2::GoogleCloudRetailV2Tile, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Tile::Representation
2899
+
2900
+ end
2901
+ end
2902
+
2735
2903
  class GoogleCloudRetailV2ServingConfig
2736
2904
  # @private
2737
2905
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2792,6 +2960,17 @@ module Google
2792
2960
  end
2793
2961
  end
2794
2962
 
2963
+ class GoogleCloudRetailV2Tile
2964
+ # @private
2965
+ class Representation < Google::Apis::Core::JsonRepresentation
2966
+ property :product_attribute_interval, as: 'productAttributeInterval', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeInterval, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeInterval::Representation
2967
+
2968
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2969
+
2970
+ property :representative_product_id, as: 'representativeProductId'
2971
+ end
2972
+ end
2973
+
2795
2974
  class GoogleCloudRetailV2TuneModelMetadata
2796
2975
  # @private
2797
2976
  class Representation < Google::Apis::Core::JsonRepresentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.99.0
4
+ version: 0.101.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-08-18 00:00:00.000000000 Z
11
+ date: 2024-09-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.99.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.101.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
63
63
  post_install_message:
64
64
  rdoc_options: []