google-apis-retail_v2alpha 0.72.0 → 0.74.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: '0826c11d9c669ef022a9f609f4721474fc17e61b935b3759a5fe790aaee9cc3b'
4
- data.tar.gz: 94aba8656a48ec89ad0fe24e029eb5a99c9f8eadf4adf7c9d8f062c79304a4ec
3
+ metadata.gz: d8f55eda4658a84aed629800971bc2ef19d3f51131af51965ca65bb3be91c40c
4
+ data.tar.gz: fde1d2f8328e00e17ceadc6c2242e723db3221cc746e1139c4db8b6ac2991e44
5
5
  SHA512:
6
- metadata.gz: b7ff53530df13273a950e8b576b0b70aecde4fc0e74c1cd5523773d9753c3063ee29ebfbefcbebd2abaae54474838eab76a97c09e3a9422943d59501486e6732
7
- data.tar.gz: 2f9fea79c9a717b8897c0bd5a4b321c5c581ed66c8eeb95ec477925782adef3979cdb31f9be6930479f9c1ae36abb1d650d5c8b07d01a8b9b86c975b15be8e46
6
+ metadata.gz: f0d427471d03fe866cf1b328f8ca6a39044be82d9e882f804f98c7962757ab581251f6bea6096212b8a1e7a0cfa6f00e596ed364a795414ab5a0791bc7529514
7
+ data.tar.gz: 9a5b4ee35111122ed10fa43440f9419da911283f651d4a633533becdd9e3fdb15d5647f6be40ad06d7516fcbc01263248239e0a973021599bb38da624e1b7bed
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.74.0 (2023-04-30)
4
+
5
+ * Regenerated from discovery document revision 20230420
6
+
7
+ ### v0.73.0 (2023-04-23)
8
+
9
+ * Regenerated from discovery document revision 20230413
10
+
3
11
  ### v0.72.0 (2023-03-26)
4
12
 
5
13
  * Regenerated from discovery document revision 20230321
@@ -555,6 +555,11 @@ module Google
555
555
  # @return [String]
556
556
  attr_accessor :last_tune_time
557
557
 
558
+ # Additional model features config.
559
+ # Corresponds to the JSON property `modelFeaturesConfig`
560
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelModelFeaturesConfig]
561
+ attr_accessor :model_features_config
562
+
558
563
  # Required. The fully qualified resource name of the model. Format: `projects/`
559
564
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
560
565
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -644,6 +649,7 @@ module Google
644
649
  @display_name = args[:display_name] if args.key?(:display_name)
645
650
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
646
651
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
652
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
647
653
  @name = args[:name] if args.key?(:name)
648
654
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
649
655
  @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
@@ -656,6 +662,46 @@ module Google
656
662
  end
657
663
  end
658
664
 
665
+ # More configs of the frequently-bought-together model type.
666
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
667
+ include Google::Apis::Core::Hashable
668
+
669
+ # Optional. Specifies the context of the model when used in predict requests.
670
+ # Only settable for the `frequently-bought-together` type. Will default to
671
+ # MULTI_CONTEXT if not specified.
672
+ # Corresponds to the JSON property `contextProductsType`
673
+ # @return [String]
674
+ attr_accessor :context_products_type
675
+
676
+ def initialize(**args)
677
+ update!(**args)
678
+ end
679
+
680
+ # Update properties of this object
681
+ def update!(**args)
682
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
683
+ end
684
+ end
685
+
686
+ # Additional model features config.
687
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
688
+ include Google::Apis::Core::Hashable
689
+
690
+ # More configs of the frequently-bought-together model type.
691
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
692
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig]
693
+ attr_accessor :frequently_bought_together_config
694
+
695
+ def initialize(**args)
696
+ update!(**args)
697
+ end
698
+
699
+ # Update properties of this object
700
+ def update!(**args)
701
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
702
+ end
703
+ end
704
+
659
705
  # Represents an ordered combination of valid serving configs, which can be used
660
706
  # for `PAGE_OPTIMIZATION` recommendations.
661
707
  class GoogleCloudRetailV2ModelServingConfigList
@@ -1383,6 +1429,25 @@ module Google
1383
1429
  # @return [String]
1384
1430
  attr_accessor :exact_searchable_option
1385
1431
 
1432
+ # Set manually for numerical attributes only. If the facet SearchResponse.
1433
+ # FacetSpec.intervals are not set by the customer for a numerical attribute,
1434
+ # then a weekly pipeline will calculate some intervals using some percentiles on
1435
+ # the distribution of all its product numerical attribute values. The latter
1436
+ # computed intervals might not be ideal for the use case of that attribute. For
1437
+ # this reason, the customer can set them manually. As another option, for any
1438
+ # numerical attribute that is passed as a facet key in the request along with
1439
+ # some given intervals, then these given intervals will be the facet intervals
1440
+ # returned in the response.
1441
+ # Corresponds to the JSON property `facetIntervals`
1442
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaInterval>]
1443
+ attr_accessor :facet_intervals
1444
+
1445
+ # Each instance represents a list of attribute values to ignore as facet values
1446
+ # for a specific time range.
1447
+ # Corresponds to the JSON property `ignoredFacetValues`
1448
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttributeIgnoredFacetValues>]
1449
+ attr_accessor :ignored_facet_values
1450
+
1386
1451
  # Output only. Indicates whether this attribute has been used by any products. `
1387
1452
  # True` if at least one Product is using this attribute in Product.attributes.
1388
1453
  # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
@@ -1456,6 +1521,8 @@ module Google
1456
1521
  def update!(**args)
1457
1522
  @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
1458
1523
  @exact_searchable_option = args[:exact_searchable_option] if args.key?(:exact_searchable_option)
1524
+ @facet_intervals = args[:facet_intervals] if args.key?(:facet_intervals)
1525
+ @ignored_facet_values = args[:ignored_facet_values] if args.key?(:ignored_facet_values)
1459
1526
  @in_use = args[:in_use] if args.key?(:in_use)
1460
1527
  @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
1461
1528
  @key = args[:key] if args.key?(:key)
@@ -1466,6 +1533,44 @@ module Google
1466
1533
  end
1467
1534
  end
1468
1535
 
1536
+ # Facet values to ignore on facets during the specified time range for the given
1537
+ # SearchResponse.Facet.key attribute.
1538
+ class GoogleCloudRetailV2alphaCatalogAttributeIgnoredFacetValues
1539
+ include Google::Apis::Core::Hashable
1540
+
1541
+ # If start time is empty and end time is not empty, then ignore these facet
1542
+ # values before end time.
1543
+ # Corresponds to the JSON property `endTime`
1544
+ # @return [String]
1545
+ attr_accessor :end_time
1546
+
1547
+ # Time range for the current list of facet values to ignore. If multiple time
1548
+ # ranges are specified for an facet value for the current attribute, consider
1549
+ # all of them. If both are empty, ignore always. If start time and end time are
1550
+ # set, then start time must be before end time. If start time is not empty and
1551
+ # end time is empty, then will ignore these facet values after the start time.
1552
+ # Corresponds to the JSON property `startTime`
1553
+ # @return [String]
1554
+ attr_accessor :start_time
1555
+
1556
+ # List of facet values to ignore for the following time range. The facet values
1557
+ # are the same as the attribute values.
1558
+ # Corresponds to the JSON property `values`
1559
+ # @return [Array<String>]
1560
+ attr_accessor :values
1561
+
1562
+ def initialize(**args)
1563
+ update!(**args)
1564
+ end
1565
+
1566
+ # Update properties of this object
1567
+ def update!(**args)
1568
+ @end_time = args[:end_time] if args.key?(:end_time)
1569
+ @start_time = args[:start_time] if args.key?(:start_time)
1570
+ @values = args[:values] if args.key?(:values)
1571
+ end
1572
+ end
1573
+
1469
1574
  # The color information of a Product.
1470
1575
  class GoogleCloudRetailV2alphaColorInfo
1471
1576
  include Google::Apis::Core::Hashable
@@ -1530,8 +1635,8 @@ module Google
1530
1635
  attr_accessor :completion_results
1531
1636
 
1532
1637
  # Matched recent searches of this user. The maximum number of recent searches is
1533
- # 10. This field is a restricted feature. Contact Retail Search support team if
1534
- # you are interested in enabling it. This feature is only available when
1638
+ # 10. This field is a restricted feature. If you want to enable it, contact
1639
+ # Retail Search support. This feature is only available when
1535
1640
  # CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
1536
1641
  # recent searches satisfy the follow rules: * They are ordered from latest to
1537
1642
  # oldest. * They are matched with CompleteQueryRequest.query case insensitively.
@@ -1586,11 +1691,26 @@ module Google
1586
1691
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
1587
1692
  attr_accessor :attributes
1588
1693
 
1694
+ # Facet information for the suggestion term. Gives the number of items resulting
1695
+ # from a search with this suggestion term for each facet. This is an
1696
+ # experimental feature for limited customers. If you want to receive this facet
1697
+ # information, reach out to the Retail support team.
1698
+ # Corresponds to the JSON property `facets`
1699
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet>]
1700
+ attr_accessor :facets
1701
+
1589
1702
  # The suggestion for the query.
1590
1703
  # Corresponds to the JSON property `suggestion`
1591
1704
  # @return [String]
1592
1705
  attr_accessor :suggestion
1593
1706
 
1707
+ # Total number of products associated with a search with this suggestion. This
1708
+ # is an experimental feature for limited customers. If you want to receive this
1709
+ # product count information, reach out to the Retail support team.
1710
+ # Corresponds to the JSON property `totalProductCount`
1711
+ # @return [Fixnum]
1712
+ attr_accessor :total_product_count
1713
+
1594
1714
  def initialize(**args)
1595
1715
  update!(**args)
1596
1716
  end
@@ -1598,7 +1718,9 @@ module Google
1598
1718
  # Update properties of this object
1599
1719
  def update!(**args)
1600
1720
  @attributes = args[:attributes] if args.key?(:attributes)
1721
+ @facets = args[:facets] if args.key?(:facets)
1601
1722
  @suggestion = args[:suggestion] if args.key?(:suggestion)
1723
+ @total_product_count = args[:total_product_count] if args.key?(:total_product_count)
1602
1724
  end
1603
1725
  end
1604
1726
 
@@ -1660,8 +1782,8 @@ module Google
1660
1782
  attr_accessor :last_denylist_import_operation
1661
1783
 
1662
1784
  # Output only. Name of the LRO corresponding to the latest suggestion terms list
1663
- # import. Can use GetOperation API to retrieve the latest state of the Long
1664
- # Running Operation.
1785
+ # import. Can use GetOperation API method to retrieve the latest state of the
1786
+ # Long Running Operation.
1665
1787
  # Corresponds to the JSON property `lastSuggestionsImportOperation`
1666
1788
  # @return [String]
1667
1789
  attr_accessor :last_suggestions_import_operation
@@ -2033,16 +2155,16 @@ module Google
2033
2155
  end
2034
2156
  end
2035
2157
 
2036
- # Metadata for active A/B testing Experiments.
2158
+ # Metadata for active A/B testing Experiment.
2037
2159
  class GoogleCloudRetailV2alphaExperimentInfo
2038
2160
  include Google::Apis::Core::Hashable
2039
2161
 
2040
2162
  # The fully qualified resource name of the experiment that provides the serving
2041
2163
  # config under test, should an active experiment exist. For example: `projects/*/
2042
2164
  # locations/global/catalogs/default_catalog/experiments/experiment_id`
2043
- # Corresponds to the JSON property `experimentName`
2165
+ # Corresponds to the JSON property `experiment`
2044
2166
  # @return [String]
2045
- attr_accessor :experiment_name
2167
+ attr_accessor :experiment
2046
2168
 
2047
2169
  # Metadata for active serving config A/B tests.
2048
2170
  # Corresponds to the JSON property `servingConfigExperiment`
@@ -2055,7 +2177,7 @@ module Google
2055
2177
 
2056
2178
  # Update properties of this object
2057
2179
  def update!(**args)
2058
- @experiment_name = args[:experiment_name] if args.key?(:experiment_name)
2180
+ @experiment = args[:experiment] if args.key?(:experiment)
2059
2181
  @serving_config_experiment = args[:serving_config_experiment] if args.key?(:serving_config_experiment)
2060
2182
  end
2061
2183
  end
@@ -2520,9 +2642,11 @@ module Google
2520
2642
  # the import is finished, a notification is sent to specified Pub/Sub topic. The
2521
2643
  # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
2522
2644
  # projects/`project`/topics/`topic``. It has to be within the same project as
2523
- # ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.
2524
- # gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the
2525
- # topic.
2645
+ # ImportProductsRequest.parent. Make sure that both `cloud-retail-customer-data-
2646
+ # access@system.gserviceaccount.com` and `service-@gcp-sa-retail.iam.
2647
+ # gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on the
2648
+ # topic. Only supported when ImportProductsRequest.reconciliation_mode is set to
2649
+ # `FULL`.
2526
2650
  # Corresponds to the JSON property `notificationPubsubTopic`
2527
2651
  # @return [String]
2528
2652
  attr_accessor :notification_pubsub_topic
@@ -2903,7 +3027,7 @@ module Google
2903
3027
 
2904
3028
  # Represents a link between a Merchant Center account and a branch. Once a link
2905
3029
  # is established, products from the linked merchant center account will be
2906
- # streamed to the linked branch. LINT.IfChange(MerchantCenterAccountLink)
3030
+ # streamed to the linked branch.
2907
3031
  class GoogleCloudRetailV2alphaMerchantCenterAccountLink
2908
3032
  include Google::Apis::Core::Hashable
2909
3033
 
@@ -2961,7 +3085,7 @@ module Google
2961
3085
  # @return [String]
2962
3086
  attr_accessor :name
2963
3087
 
2964
- # Output only. GCP project ID.
3088
+ # Output only. Google Cloud project ID.
2965
3089
  # Corresponds to the JSON property `projectId`
2966
3090
  # @return [String]
2967
3091
  attr_accessor :project_id
@@ -3169,6 +3293,11 @@ module Google
3169
3293
  # @return [String]
3170
3294
  attr_accessor :last_tune_time
3171
3295
 
3296
+ # Additional model features config.
3297
+ # Corresponds to the JSON property `modelFeaturesConfig`
3298
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelModelFeaturesConfig]
3299
+ attr_accessor :model_features_config
3300
+
3172
3301
  # Required. The fully qualified resource name of the model. Format: `projects/`
3173
3302
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
3174
3303
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -3266,6 +3395,7 @@ module Google
3266
3395
  @display_name = args[:display_name] if args.key?(:display_name)
3267
3396
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
3268
3397
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
3398
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
3269
3399
  @name = args[:name] if args.key?(:name)
3270
3400
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
3271
3401
  @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
@@ -3279,6 +3409,46 @@ module Google
3279
3409
  end
3280
3410
  end
3281
3411
 
3412
+ # More configs of the frequently-bought-together model type.
3413
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
3414
+ include Google::Apis::Core::Hashable
3415
+
3416
+ # Optional. Specifies the context of the model when used in predict requests.
3417
+ # Only settable for the `frequently-bought-together` type. Will default to
3418
+ # MULTI_CONTEXT if not specified.
3419
+ # Corresponds to the JSON property `contextProductsType`
3420
+ # @return [String]
3421
+ attr_accessor :context_products_type
3422
+
3423
+ def initialize(**args)
3424
+ update!(**args)
3425
+ end
3426
+
3427
+ # Update properties of this object
3428
+ def update!(**args)
3429
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
3430
+ end
3431
+ end
3432
+
3433
+ # Additional model features config.
3434
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
3435
+ include Google::Apis::Core::Hashable
3436
+
3437
+ # More configs of the frequently-bought-together model type.
3438
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
3439
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig]
3440
+ attr_accessor :frequently_bought_together_config
3441
+
3442
+ def initialize(**args)
3443
+ update!(**args)
3444
+ end
3445
+
3446
+ # Update properties of this object
3447
+ def update!(**args)
3448
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
3449
+ end
3450
+ end
3451
+
3282
3452
  # The PageOptimizationConfig for model training. This determines how many panels
3283
3453
  # to optimize for, and which serving configs to consider for each panel. The
3284
3454
  # purpose of this model is to optimize which ServingConfig to show on which
@@ -4982,11 +5152,11 @@ module Google
4982
5152
  include Google::Apis::Core::Hashable
4983
5153
 
4984
5154
  # A filter to apply on the matching condition results. Supported features: *
4985
- # filter must be set. * Filter syntax is identical to SearchRequest.filter. See
4986
- # more details at the Retail Search [user guide](/retail/search/docs/filter-and-
4987
- # order#filter). * To filter products with product ID "product_1" or "product_2",
4988
- # and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(
4989
- # colorFamilies: ANY("Red", "Blue")) *
5155
+ # filter must be set. * Filter syntax is identical to SearchRequest.filter. For
5156
+ # more information, see [Filter](/retail/docs/filter-and-order#filter). * To
5157
+ # filter products with product ID "product_1" or "product_2", and color "Red" or
5158
+ # "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("
5159
+ # Red", "Blue")) *
4990
5160
  # Corresponds to the JSON property `filter`
4991
5161
  # @return [String]
4992
5162
  attr_accessor :filter
@@ -5138,13 +5308,6 @@ module Google
5138
5308
  class GoogleCloudRetailV2alphaSearchRequest
5139
5309
  include Google::Apis::Core::Hashable
5140
5310
 
5141
- # Represents the banner in request, for projects that combine banners. For
5142
- # example: a retailer can sell products under different banners like retailer-
5143
- # main, retailer-baby, retailer-meds, etc. under one project.
5144
- # Corresponds to the JSON property `banner`
5145
- # @return [String]
5146
- attr_accessor :banner
5147
-
5148
5311
  # Boost specification to boost certain items.
5149
5312
  # Corresponds to the JSON property `boostSpec`
5150
5313
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec]
@@ -5161,9 +5324,9 @@ module Google
5161
5324
  # checking any filters on the search page. The filter applied to every search
5162
5325
  # request when quality improvement such as query expansion is needed. For
5163
5326
  # example, if a query does not have enough results, an expanded query with
5164
- # SearchRequest.canonical_filter will be returned as a supplement of the
5165
- # original query. This field is strongly recommended to achieve high search
5166
- # quality. See SearchRequest.filter for more details about filter syntax.
5327
+ # SearchRequest.canonical_filter is returned as a supplement of the original
5328
+ # query. This field is strongly recommended to achieve high search quality. For
5329
+ # more information about filter syntax, see SearchRequest.filter.
5167
5330
  # Corresponds to the JSON property `canonicalFilter`
5168
5331
  # @return [String]
5169
5332
  attr_accessor :canonical_filter
@@ -5173,8 +5336,16 @@ module Google
5173
5336
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec]
5174
5337
  attr_accessor :dynamic_facet_spec
5175
5338
 
5339
+ # The entity for customers that may run multiple different entities, domains,
5340
+ # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`
5341
+ # , `youtube.com`, etc. If this is set, it should be exactly matched with
5342
+ # UserEvent.entity to get search results boosted by entity.
5343
+ # Corresponds to the JSON property `entity`
5344
+ # @return [String]
5345
+ attr_accessor :entity
5346
+
5176
5347
  # Facet specifications for faceted search. If empty, no facets are returned. A
5177
- # maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is
5348
+ # maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is
5178
5349
  # returned.
5179
5350
  # Corresponds to the JSON property `facetSpecs`
5180
5351
  # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec>]
@@ -5182,8 +5353,8 @@ module Google
5182
5353
 
5183
5354
  # The filter syntax consists of an expression language for constructing a
5184
5355
  # predicate from one or more fields of the products being filtered. Filter
5185
- # expression is case-sensitive. See more details at this [user guide](https://
5186
- # cloud.google.com/retail/docs/filter-and-order#filter). If this field is
5356
+ # expression is case-sensitive. For more information, see [Filter](https://cloud.
5357
+ # google.com/retail/docs/filter-and-order#filter). If this field is
5187
5358
  # unrecognizable, an INVALID_ARGUMENT is returned.
5188
5359
  # Corresponds to the JSON property `filter`
5189
5360
  # @return [String]
@@ -5198,8 +5369,9 @@ module Google
5198
5369
  # UTF-8 encoding, and international characters are allowed. * The key portion of
5199
5370
  # a label must be unique. However, you can use the same key with multiple
5200
5371
  # resources. * Keys must start with a lowercase letter or international
5201
- # character. See [Google Cloud Document](https://cloud.google.com/resource-
5202
- # manager/docs/creating-managing-labels#requirements) for more details.
5372
+ # character. For more information, see [Requirements for labels](https://cloud.
5373
+ # google.com/resource-manager/docs/creating-managing-labels#requirements) in the
5374
+ # Resource Manager documentation.
5203
5375
  # Corresponds to the JSON property `labels`
5204
5376
  # @return [Hash<String,String>]
5205
5377
  attr_accessor :labels
@@ -5214,14 +5386,14 @@ module Google
5214
5386
 
5215
5387
  # The order in which products are returned. Products can be ordered by a field
5216
5388
  # in an Product object. Leave it unset if ordered by relevance. OrderBy
5217
- # expression is case-sensitive. See more details at this [user guide](https://
5218
- # cloud.google.com/retail/docs/filter-and-order#order). If this field is
5389
+ # expression is case-sensitive. For more information, see [Order](https://cloud.
5390
+ # google.com/retail/docs/filter-and-order#order). If this field is
5219
5391
  # unrecognizable, an INVALID_ARGUMENT is returned.
5220
5392
  # Corresponds to the JSON property `orderBy`
5221
5393
  # @return [String]
5222
5394
  attr_accessor :order_by
5223
5395
 
5224
- # The categories associated with a category page. Required for category
5396
+ # The categories associated with a category page. Must be set for category
5225
5397
  # navigation queries to achieve good search quality. The format should be the
5226
5398
  # same as UserEvent.page_categories; To represent full path of category, use '>'
5227
5399
  # sign to separate different hierarchies. If '>' is part of the category name,
@@ -5266,8 +5438,8 @@ module Google
5266
5438
 
5267
5439
  # The relevance threshold of the search results. Defaults to RelevanceThreshold.
5268
5440
  # HIGH, which means only the most relevant results are shown, and the least
5269
- # number of results are returned. See more details at this [user guide](https://
5270
- # cloud.google.com/retail/docs/result-size#relevance_thresholding).
5441
+ # number of results are returned. For more information, see [Adjust result size](
5442
+ # https://cloud.google.com/retail/docs/result-size#relevance_thresholding).
5271
5443
  # Corresponds to the JSON property `relevanceThreshold`
5272
5444
  # @return [String]
5273
5445
  attr_accessor :relevance_threshold
@@ -5334,11 +5506,11 @@ module Google
5334
5506
 
5335
5507
  # Update properties of this object
5336
5508
  def update!(**args)
5337
- @banner = args[:banner] if args.key?(:banner)
5338
5509
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
5339
5510
  @branch = args[:branch] if args.key?(:branch)
5340
5511
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
5341
5512
  @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
5513
+ @entity = args[:entity] if args.key?(:entity)
5342
5514
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
5343
5515
  @filter = args[:filter] if args.key?(:filter)
5344
5516
  @labels = args[:labels] if args.key?(:labels)
@@ -5453,23 +5625,22 @@ module Google
5453
5625
 
5454
5626
  # Enables dynamic position for this facet. If set to true, the position of this
5455
5627
  # facet among all facets in the response is determined by Google Retail Search.
5456
- # It will be ordered together with dynamic facets if dynamic facets is enabled.
5457
- # If set to false, the position of this facet in the response will be the same
5458
- # as in the request, and it will be ranked before the facets with dynamic
5459
- # position enable and all dynamic facets. For example, you may always want to
5460
- # have rating facet returned in the response, but it's not necessarily to always
5461
- # display the rating facet at the top. In that case, you can set
5462
- # enable_dynamic_position to true so that the position of rating facet in
5463
- # response will be determined by Google Retail Search. Another example, assuming
5464
- # you have the following facets in the request: * "rating",
5465
- # enable_dynamic_position = true * "price", enable_dynamic_position = false * "
5466
- # brands", enable_dynamic_position = false And also you have a dynamic facets
5467
- # enable, which will generate a facet 'gender'. Then the final order of the
5468
- # facets in the response can be ("price", "brands", "rating", "gender") or ("
5469
- # price", "brands", "gender", "rating") depends on how Google Retail Search
5470
- # orders "gender" and "rating" facets. However, notice that "price" and "brands"
5471
- # will always be ranked at 1st and 2nd position since their
5472
- # enable_dynamic_position are false.
5628
+ # It is ordered together with dynamic facets if dynamic facets is enabled. If
5629
+ # set to false, the position of this facet in the response is the same as in the
5630
+ # request, and it is ranked before the facets with dynamic position enable and
5631
+ # all dynamic facets. For example, you may always want to have rating facet
5632
+ # returned in the response, but it's not necessarily to always display the
5633
+ # rating facet at the top. In that case, you can set enable_dynamic_position to
5634
+ # true so that the position of rating facet in response is determined by Google
5635
+ # Retail Search. Another example, assuming you have the following facets in the
5636
+ # request: * "rating", enable_dynamic_position = true * "price",
5637
+ # enable_dynamic_position = false * "brands", enable_dynamic_position = false
5638
+ # And also you have a dynamic facets enable, which generates a facet "gender".
5639
+ # Then, the final order of the facets in the response can be ("price", "brands",
5640
+ # "rating", "gender") or ("price", "brands", "gender", "rating") depends on how
5641
+ # Google Retail Search orders "gender" and "rating" facets. However, notice that
5642
+ # "price" and "brands" are always ranked at first and second position because
5643
+ # their enable_dynamic_position values are false.
5473
5644
  # Corresponds to the JSON property `enableDynamicPosition`
5474
5645
  # @return [Boolean]
5475
5646
  attr_accessor :enable_dynamic_position
@@ -5533,19 +5704,21 @@ module Google
5533
5704
 
5534
5705
  # Only get facet values that contains the given strings. For example, suppose "
5535
5706
  # categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe".
5536
- # If set "contains" to "Shoe", the "categories" facet will give only "Women >
5537
- # Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
5707
+ # If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe"
5708
+ # and "Men > Shoe". Only supported on textual fields. Maximum is 10.
5538
5709
  # Corresponds to the JSON property `contains`
5539
5710
  # @return [Array<String>]
5540
5711
  attr_accessor :contains
5541
5712
 
5542
- # For all numerical facet keys that appear in the list of products from the
5543
- # catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are computed from their
5544
- # distribution weekly. If the model assigns a high score to a numerical facet
5545
- # key and its intervals are not specified in the search request, these
5546
- # percentiles will become the bounds for its intervals and will be returned in
5547
- # the response. If the facet key intervals are specified in the request, then
5548
- # the specified intervals will be returned instead.
5713
+ # Set only if values should be bucketized into intervals. Must be set for facets
5714
+ # with numerical values. Must not be set for facet with text values. Maximum
5715
+ # number of intervals is 40. For all numerical facet keys that appear in the
5716
+ # list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and
5717
+ # 100 are computed from their distribution weekly. If the model assigns a high
5718
+ # score to a numerical facet key and its intervals are not specified in the
5719
+ # search request, these percentiles become the bounds for its intervals and are
5720
+ # returned in the response. If the facet key intervals are specified in the
5721
+ # request, then the specified intervals are returned instead.
5549
5722
  # Corresponds to the JSON property `intervals`
5550
5723
  # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaInterval>]
5551
5724
  attr_accessor :intervals
@@ -5579,7 +5752,7 @@ module Google
5579
5752
 
5580
5753
  # Only get facet values that start with the given string prefix. For example,
5581
5754
  # suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men
5582
- # > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "
5755
+ # > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "
5583
5756
  # Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum
5584
5757
  # is 10.
5585
5758
  # Corresponds to the JSON property `prefixes`
@@ -5587,16 +5760,15 @@ module Google
5587
5760
  attr_accessor :prefixes
5588
5761
 
5589
5762
  # The query that is used to compute facet for the given facet key. When provided,
5590
- # it will override the default behavior of facet computation. The query syntax
5591
- # is the same as a filter expression. See SearchRequest.filter for detail syntax
5763
+ # it overrides the default behavior of facet computation. The query syntax is
5764
+ # the same as a filter expression. See SearchRequest.filter for detail syntax
5592
5765
  # and limitations. Notice that there is no limitation on FacetKey.key when query
5593
- # is specified. In the response, SearchResponse.Facet.values.value will be
5594
- # always "1" and SearchResponse.Facet.values.count will be the number of results
5595
- # that match the query. For example, you can set a customized facet for "
5596
- # shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.
5597
- # query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then
5598
- # the facet will count the products that are both in stock and ship to store "
5599
- # 123".
5766
+ # is specified. In the response, SearchResponse.Facet.values.value is always "1"
5767
+ # and SearchResponse.Facet.values.count is the number of results that match the
5768
+ # query. For example, you can set a customized facet for "shipToStore", where
5769
+ # FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability:
5770
+ # ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet counts the
5771
+ # products that are both in stock and ship to store "123".
5600
5772
  # Corresponds to the JSON property `query`
5601
5773
  # @return [String]
5602
5774
  attr_accessor :query
@@ -6388,13 +6560,6 @@ module Google
6388
6560
  # @return [String]
6389
6561
  attr_accessor :attribution_token
6390
6562
 
6391
- # Represents the banner of the user event, for projects that combine banners.
6392
- # For example: retailer can have events from multiple banners like retailer-main,
6393
- # retailer-baby, retailer-meds, etc. under one project.
6394
- # Corresponds to the JSON property `banner`
6395
- # @return [String]
6396
- attr_accessor :banner
6397
-
6398
6563
  # The ID or name of the associated shopping cart. This ID is used to associate
6399
6564
  # multiple items added or present in the cart before purchase. This can only be
6400
6565
  # set for `add-to-cart`, `purchase-complete`, or `shopping-cart-page-view`
@@ -6409,6 +6574,14 @@ module Google
6409
6574
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDetail]
6410
6575
  attr_accessor :completion_detail
6411
6576
 
6577
+ # The entity for customers that may run multiple different entities, domains,
6578
+ # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`
6579
+ # , `youtube.com`, etc. We recommend that you set this field to get better per-
6580
+ # entity search, completion, and prediction results.
6581
+ # Corresponds to the JSON property `entity`
6582
+ # @return [String]
6583
+ attr_accessor :entity
6584
+
6412
6585
  # Only required for UserEventService.ImportUserEvents method. Timestamp of when
6413
6586
  # the user event happened.
6414
6587
  # Corresponds to the JSON property `eventTime`
@@ -6562,9 +6735,9 @@ module Google
6562
6735
  def update!(**args)
6563
6736
  @attributes = args[:attributes] if args.key?(:attributes)
6564
6737
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
6565
- @banner = args[:banner] if args.key?(:banner)
6566
6738
  @cart_id = args[:cart_id] if args.key?(:cart_id)
6567
6739
  @completion_detail = args[:completion_detail] if args.key?(:completion_detail)
6740
+ @entity = args[:entity] if args.key?(:entity)
6568
6741
  @event_time = args[:event_time] if args.key?(:event_time)
6569
6742
  @event_type = args[:event_type] if args.key?(:event_type)
6570
6743
  @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
@@ -7145,7 +7318,7 @@ module Google
7145
7318
 
7146
7319
  # Represents a link between a Merchant Center account and a branch. Once a link
7147
7320
  # is established, products from the linked merchant center account will be
7148
- # streamed to the linked branch. LINT.IfChange(MerchantCenterAccountLink)
7321
+ # streamed to the linked branch.
7149
7322
  class GoogleCloudRetailV2betaMerchantCenterAccountLink
7150
7323
  include Google::Apis::Core::Hashable
7151
7324
 
@@ -7203,7 +7376,7 @@ module Google
7203
7376
  # @return [String]
7204
7377
  attr_accessor :name
7205
7378
 
7206
- # Output only. GCP project ID.
7379
+ # Output only. Google Cloud project ID.
7207
7380
  # Corresponds to the JSON property `projectId`
7208
7381
  # @return [String]
7209
7382
  attr_accessor :project_id
@@ -7295,6 +7468,11 @@ module Google
7295
7468
  # @return [String]
7296
7469
  attr_accessor :last_tune_time
7297
7470
 
7471
+ # Additional model features config.
7472
+ # Corresponds to the JSON property `modelFeaturesConfig`
7473
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaModelModelFeaturesConfig]
7474
+ attr_accessor :model_features_config
7475
+
7298
7476
  # Required. The fully qualified resource name of the model. Format: `projects/`
7299
7477
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
7300
7478
  # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -7384,6 +7562,7 @@ module Google
7384
7562
  @display_name = args[:display_name] if args.key?(:display_name)
7385
7563
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
7386
7564
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
7565
+ @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
7387
7566
  @name = args[:name] if args.key?(:name)
7388
7567
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
7389
7568
  @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
@@ -7396,6 +7575,46 @@ module Google
7396
7575
  end
7397
7576
  end
7398
7577
 
7578
+ # More configs of the frequently-bought-together model type.
7579
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
7580
+ include Google::Apis::Core::Hashable
7581
+
7582
+ # Optional. Specifies the context of the model when used in predict requests.
7583
+ # Only settable for the `frequently-bought-together` type. Will default to
7584
+ # MULTI_CONTEXT if not specified.
7585
+ # Corresponds to the JSON property `contextProductsType`
7586
+ # @return [String]
7587
+ attr_accessor :context_products_type
7588
+
7589
+ def initialize(**args)
7590
+ update!(**args)
7591
+ end
7592
+
7593
+ # Update properties of this object
7594
+ def update!(**args)
7595
+ @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
7596
+ end
7597
+ end
7598
+
7599
+ # Additional model features config.
7600
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
7601
+ include Google::Apis::Core::Hashable
7602
+
7603
+ # More configs of the frequently-bought-together model type.
7604
+ # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
7605
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig]
7606
+ attr_accessor :frequently_bought_together_config
7607
+
7608
+ def initialize(**args)
7609
+ update!(**args)
7610
+ end
7611
+
7612
+ # Update properties of this object
7613
+ def update!(**args)
7614
+ @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
7615
+ end
7616
+ end
7617
+
7399
7618
  # Represents an ordered combination of valid serving configs, which can be used
7400
7619
  # for `PAGE_OPTIMIZATION` recommendations.
7401
7620
  class GoogleCloudRetailV2betaModelServingConfigList
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2alpha
18
18
  # Version of the google-apis-retail_v2alpha gem
19
- GEM_VERSION = "0.72.0"
19
+ GEM_VERSION = "0.74.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230321"
25
+ REVISION = "20230420"
26
26
  end
27
27
  end
28
28
  end
@@ -130,6 +130,18 @@ module Google
130
130
  include Google::Apis::Core::JsonObjectSupport
131
131
  end
132
132
 
133
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
133
145
  class GoogleCloudRetailV2ModelServingConfigList
134
146
  class Representation < Google::Apis::Core::JsonRepresentation; end
135
147
 
@@ -310,6 +322,12 @@ module Google
310
322
  include Google::Apis::Core::JsonObjectSupport
311
323
  end
312
324
 
325
+ class GoogleCloudRetailV2alphaCatalogAttributeIgnoredFacetValues
326
+ class Representation < Google::Apis::Core::JsonRepresentation; end
327
+
328
+ include Google::Apis::Core::JsonObjectSupport
329
+ end
330
+
313
331
  class GoogleCloudRetailV2alphaColorInfo
314
332
  class Representation < Google::Apis::Core::JsonRepresentation; end
315
333
 
@@ -598,6 +616,18 @@ module Google
598
616
  include Google::Apis::Core::JsonObjectSupport
599
617
  end
600
618
 
619
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
620
+ class Representation < Google::Apis::Core::JsonRepresentation; end
621
+
622
+ include Google::Apis::Core::JsonObjectSupport
623
+ end
624
+
625
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
626
+ class Representation < Google::Apis::Core::JsonRepresentation; end
627
+
628
+ include Google::Apis::Core::JsonObjectSupport
629
+ end
630
+
601
631
  class GoogleCloudRetailV2alphaModelPageOptimizationConfig
602
632
  class Representation < Google::Apis::Core::JsonRepresentation; end
603
633
 
@@ -1168,6 +1198,18 @@ module Google
1168
1198
  include Google::Apis::Core::JsonObjectSupport
1169
1199
  end
1170
1200
 
1201
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
1202
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1203
+
1204
+ include Google::Apis::Core::JsonObjectSupport
1205
+ end
1206
+
1207
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
1208
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1209
+
1210
+ include Google::Apis::Core::JsonObjectSupport
1211
+ end
1212
+
1171
1213
  class GoogleCloudRetailV2betaModelServingConfigList
1172
1214
  class Representation < Google::Apis::Core::JsonRepresentation; end
1173
1215
 
@@ -1445,6 +1487,8 @@ module Google
1445
1487
  property :display_name, as: 'displayName'
1446
1488
  property :filtering_option, as: 'filteringOption'
1447
1489
  property :last_tune_time, as: 'lastTuneTime'
1490
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelModelFeaturesConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelModelFeaturesConfig::Representation
1491
+
1448
1492
  property :name, as: 'name'
1449
1493
  property :optimization_objective, as: 'optimizationObjective'
1450
1494
  property :periodic_tuning_state, as: 'periodicTuningState'
@@ -1458,6 +1502,21 @@ module Google
1458
1502
  end
1459
1503
  end
1460
1504
 
1505
+ class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
1506
+ # @private
1507
+ class Representation < Google::Apis::Core::JsonRepresentation
1508
+ property :context_products_type, as: 'contextProductsType'
1509
+ end
1510
+ end
1511
+
1512
+ class GoogleCloudRetailV2ModelModelFeaturesConfig
1513
+ # @private
1514
+ class Representation < Google::Apis::Core::JsonRepresentation
1515
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig::Representation
1516
+
1517
+ end
1518
+ end
1519
+
1461
1520
  class GoogleCloudRetailV2ModelServingConfigList
1462
1521
  # @private
1463
1522
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1679,6 +1738,10 @@ module Google
1679
1738
  class Representation < Google::Apis::Core::JsonRepresentation
1680
1739
  property :dynamic_facetable_option, as: 'dynamicFacetableOption'
1681
1740
  property :exact_searchable_option, as: 'exactSearchableOption'
1741
+ collection :facet_intervals, as: 'facetIntervals', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaInterval, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaInterval::Representation
1742
+
1743
+ collection :ignored_facet_values, as: 'ignoredFacetValues', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttributeIgnoredFacetValues, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttributeIgnoredFacetValues::Representation
1744
+
1682
1745
  property :in_use, as: 'inUse'
1683
1746
  property :indexable_option, as: 'indexableOption'
1684
1747
  property :key, as: 'key'
@@ -1689,6 +1752,15 @@ module Google
1689
1752
  end
1690
1753
  end
1691
1754
 
1755
+ class GoogleCloudRetailV2alphaCatalogAttributeIgnoredFacetValues
1756
+ # @private
1757
+ class Representation < Google::Apis::Core::JsonRepresentation
1758
+ property :end_time, as: 'endTime'
1759
+ property :start_time, as: 'startTime'
1760
+ collection :values, as: 'values'
1761
+ end
1762
+ end
1763
+
1692
1764
  class GoogleCloudRetailV2alphaColorInfo
1693
1765
  # @private
1694
1766
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1722,7 +1794,10 @@ module Google
1722
1794
  class Representation < Google::Apis::Core::JsonRepresentation
1723
1795
  hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
1724
1796
 
1797
+ collection :facets, as: 'facets', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet::Representation
1798
+
1725
1799
  property :suggestion, as: 'suggestion'
1800
+ property :total_product_count, as: 'totalProductCount'
1726
1801
  end
1727
1802
  end
1728
1803
 
@@ -1839,7 +1914,7 @@ module Google
1839
1914
  class GoogleCloudRetailV2alphaExperimentInfo
1840
1915
  # @private
1841
1916
  class Representation < Google::Apis::Core::JsonRepresentation
1842
- property :experiment_name, as: 'experimentName'
1917
+ property :experiment, as: 'experiment'
1843
1918
  property :serving_config_experiment, as: 'servingConfigExperiment', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment::Representation
1844
1919
 
1845
1920
  end
@@ -2155,6 +2230,8 @@ module Google
2155
2230
  property :display_name, as: 'displayName'
2156
2231
  property :filtering_option, as: 'filteringOption'
2157
2232
  property :last_tune_time, as: 'lastTuneTime'
2233
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelModelFeaturesConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelModelFeaturesConfig::Representation
2234
+
2158
2235
  property :name, as: 'name'
2159
2236
  property :optimization_objective, as: 'optimizationObjective'
2160
2237
  property :page_optimization_config, as: 'pageOptimizationConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig::Representation
@@ -2170,6 +2247,21 @@ module Google
2170
2247
  end
2171
2248
  end
2172
2249
 
2250
+ class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
2251
+ # @private
2252
+ class Representation < Google::Apis::Core::JsonRepresentation
2253
+ property :context_products_type, as: 'contextProductsType'
2254
+ end
2255
+ end
2256
+
2257
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfig
2258
+ # @private
2259
+ class Representation < Google::Apis::Core::JsonRepresentation
2260
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
2261
+
2262
+ end
2263
+ end
2264
+
2173
2265
  class GoogleCloudRetailV2alphaModelPageOptimizationConfig
2174
2266
  # @private
2175
2267
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2621,13 +2713,13 @@ module Google
2621
2713
  class GoogleCloudRetailV2alphaSearchRequest
2622
2714
  # @private
2623
2715
  class Representation < Google::Apis::Core::JsonRepresentation
2624
- property :banner, as: 'banner'
2625
2716
  property :boost_spec, as: 'boostSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec::Representation
2626
2717
 
2627
2718
  property :branch, as: 'branch'
2628
2719
  property :canonical_filter, as: 'canonicalFilter'
2629
2720
  property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec::Representation
2630
2721
 
2722
+ property :entity, as: 'entity'
2631
2723
  collection :facet_specs, as: 'facetSpecs', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec::Representation
2632
2724
 
2633
2725
  property :filter, as: 'filter'
@@ -2883,10 +2975,10 @@ module Google
2883
2975
  hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
2884
2976
 
2885
2977
  property :attribution_token, as: 'attributionToken'
2886
- property :banner, as: 'banner'
2887
2978
  property :cart_id, as: 'cartId'
2888
2979
  property :completion_detail, as: 'completionDetail', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDetail, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDetail::Representation
2889
2980
 
2981
+ property :entity, as: 'entity'
2890
2982
  property :event_time, as: 'eventTime'
2891
2983
  property :event_type, as: 'eventType'
2892
2984
  collection :experiment_ids, as: 'experimentIds'
@@ -3121,6 +3213,8 @@ module Google
3121
3213
  property :display_name, as: 'displayName'
3122
3214
  property :filtering_option, as: 'filteringOption'
3123
3215
  property :last_tune_time, as: 'lastTuneTime'
3216
+ property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaModelModelFeaturesConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaModelModelFeaturesConfig::Representation
3217
+
3124
3218
  property :name, as: 'name'
3125
3219
  property :optimization_objective, as: 'optimizationObjective'
3126
3220
  property :periodic_tuning_state, as: 'periodicTuningState'
@@ -3134,6 +3228,21 @@ module Google
3134
3228
  end
3135
3229
  end
3136
3230
 
3231
+ class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
3232
+ # @private
3233
+ class Representation < Google::Apis::Core::JsonRepresentation
3234
+ property :context_products_type, as: 'contextProductsType'
3235
+ end
3236
+ end
3237
+
3238
+ class GoogleCloudRetailV2betaModelModelFeaturesConfig
3239
+ # @private
3240
+ class Representation < Google::Apis::Core::JsonRepresentation
3241
+ property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
3242
+
3243
+ end
3244
+ end
3245
+
3137
3246
  class GoogleCloudRetailV2betaModelServingConfigList
3138
3247
  # @private
3139
3248
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -57,8 +57,6 @@ module Google
57
57
  # @param [String] catalog
58
58
  # Required. Catalog for which the completion is performed. Full resource name of
59
59
  # catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
60
- # @param [String] banner
61
- # The banner context for completion suggestions.
62
60
  # @param [String] dataset
63
61
  # Determines which dataset to use for fetching completion. "user-data" will use
64
62
  # the imported dataset through CompletionService.ImportCompletionData. "cloud-
@@ -76,6 +74,11 @@ module Google
76
74
  # @param [Boolean] enable_attribute_suggestions
77
75
  # If true, attribute suggestions are enabled and provided in response. This
78
76
  # field is only available for "cloud-retail" dataset.
77
+ # @param [String] entity
78
+ # The entity for customers who run multiple entities, domains, sites, or regions,
79
+ # for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`,
80
+ # etc. If this is set, it must be an exact match with UserEvent.entity to get
81
+ # per-entity autocomplete results.
79
82
  # @param [Array<String>, String] language_codes
80
83
  # Note that this field applies for `user-data` dataset only. For requests with `
81
84
  # cloud-retail` dataset, setting this field has no effect. The language filters
@@ -115,15 +118,15 @@ module Google
115
118
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
116
119
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
117
120
  # @raise [Google::Apis::AuthorizationError] Authorization is required
118
- def complete_project_location_catalog_query(catalog, banner: nil, dataset: nil, device_type: nil, enable_attribute_suggestions: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil, &block)
121
+ def complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, enable_attribute_suggestions: nil, entity: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil, &block)
119
122
  command = make_simple_command(:get, 'v2alpha/{+catalog}:completeQuery', options)
120
123
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse::Representation
121
124
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse
122
125
  command.params['catalog'] = catalog unless catalog.nil?
123
- command.query['banner'] = banner unless banner.nil?
124
126
  command.query['dataset'] = dataset unless dataset.nil?
125
127
  command.query['deviceType'] = device_type unless device_type.nil?
126
128
  command.query['enableAttributeSuggestions'] = enable_attribute_suggestions unless enable_attribute_suggestions.nil?
129
+ command.query['entity'] = entity unless entity.nil?
127
130
  command.query['languageCodes'] = language_codes unless language_codes.nil?
128
131
  command.query['maxSuggestions'] = max_suggestions unless max_suggestions.nil?
129
132
  command.query['query'] = query unless query.nil?
@@ -647,13 +650,13 @@ module Google
647
650
  execute_or_queue_command(command, &block)
648
651
  end
649
652
 
650
- # It is recommended to use the ProductService.AddLocalInventories method instead
651
- # of ProductService.AddFulfillmentPlaces. ProductService.AddLocalInventories
652
- # achieves the same results but provides more fine-grained control over
653
- # ingesting local inventory data. Incrementally adds place IDs to Product.
654
- # fulfillment_info.place_ids. This process is asynchronous and does not require
655
- # the Product to exist before updating fulfillment information. If the request
656
- # is valid, the update will be enqueued and processed downstream. As a
653
+ # We recommend that you use the ProductService.AddLocalInventories method
654
+ # instead of the ProductService.AddFulfillmentPlaces method. ProductService.
655
+ # AddLocalInventories achieves the same results but provides more fine-grained
656
+ # control over ingesting local inventory data. Incrementally adds place IDs to
657
+ # Product.fulfillment_info.place_ids. This process is asynchronous and does not
658
+ # require the Product to exist before updating fulfillment information. If the
659
+ # request is valid, the update will be enqueued and processed downstream. As a
657
660
  # consequence, when a response is returned, the added place IDs are not
658
661
  # immediately manifested in the Product queried by ProductService.GetProduct or
659
662
  # ProductService.ListProducts. The returned Operations will be obsolete after 1
@@ -797,7 +800,7 @@ module Google
797
800
  # Product.Type.PRIMARY Product with more than one variants. Otherwise, an
798
801
  # INVALID_ARGUMENT error is returned. All inventory information for the named
799
802
  # Product will be deleted.
800
- # @param [Boolean] cascade_delete
803
+ # @param [Boolean] force
801
804
  # This value only applies to the case when the target product is of type PRIMARY.
802
805
  # When deleting a product of VARIANT/COLLECTION type, this value will be
803
806
  # ignored. When set to true, the subsequent variant products will be deleted.
@@ -820,12 +823,12 @@ module Google
820
823
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
821
824
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
822
825
  # @raise [Google::Apis::AuthorizationError] Authorization is required
823
- def delete_project_location_catalog_branch_product(name, cascade_delete: nil, fields: nil, quota_user: nil, options: nil, &block)
826
+ def delete_project_location_catalog_branch_product(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
824
827
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
825
828
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
826
829
  command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
827
830
  command.params['name'] = name unless name.nil?
828
- command.query['cascadeDelete'] = cascade_delete unless cascade_delete.nil?
831
+ command.query['force'] = force unless force.nil?
829
832
  command.query['fields'] = fields unless fields.nil?
830
833
  command.query['quotaUser'] = quota_user unless quota_user.nil?
831
834
  execute_or_queue_command(command, &block)
@@ -1062,8 +1065,8 @@ module Google
1062
1065
  execute_or_queue_command(command, &block)
1063
1066
  end
1064
1067
 
1065
- # It is recommended to use the ProductService.RemoveLocalInventories method
1066
- # instead of ProductService.RemoveFulfillmentPlaces. ProductService.
1068
+ # We recommend that you use the ProductService.RemoveLocalInventories method
1069
+ # instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.
1067
1070
  # RemoveLocalInventories achieves the same results but provides more fine-
1068
1071
  # grained control over ingesting local inventory data. Incrementally removes
1069
1072
  # place IDs from a Product.fulfillment_info.place_ids. This process is
@@ -1441,17 +1444,12 @@ module Google
1441
1444
  execute_or_queue_command(command, &block)
1442
1445
  end
1443
1446
 
1444
- # Creates a MerchantCenterAccountLink. MerchantCenterAccountLink cannot be set
1445
- # to a different oneof field, if so an INVALID_ARGUMENT is returned.
1446
- # @param [String] name
1447
- # Output only. Immutable. Full resource name of the Merchant Center Account Link,
1448
- # such as `projects/*/locations/global/catalogs/default_catalog/
1449
- # merchantCenterAccountLinks/merchant_center_account_link`.
1450
- # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaMerchantCenterAccountLink] google_cloud_retail_v2alpha_merchant_center_account_link_object
1447
+ # Creates a MerchantCenterAccountLink.
1451
1448
  # @param [String] parent
1452
1449
  # Required. The branch resource where this MerchantCenterAccountLink will be
1453
1450
  # created. Format: projects/`PROJECT_NUMBER`/locations/global/catalogs/`
1454
1451
  # CATALOG_ID``
1452
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaMerchantCenterAccountLink] google_cloud_retail_v2alpha_merchant_center_account_link_object
1455
1453
  # @param [String] fields
1456
1454
  # Selector specifying which fields to include in a partial response.
1457
1455
  # @param [String] quota_user
@@ -1469,14 +1467,13 @@ module Google
1469
1467
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1470
1468
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1471
1469
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1472
- def create_project_location_catalog_merchant_center_account_link_merchant_center_account_link(name, google_cloud_retail_v2alpha_merchant_center_account_link_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
1473
- command = make_simple_command(:post, 'v2alpha/{+name}', options)
1470
+ def create_project_location_catalog_merchant_center_account_link(parent, google_cloud_retail_v2alpha_merchant_center_account_link_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1471
+ command = make_simple_command(:post, 'v2alpha/{+parent}/merchantCenterAccountLinks', options)
1474
1472
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaMerchantCenterAccountLink::Representation
1475
1473
  command.request_object = google_cloud_retail_v2alpha_merchant_center_account_link_object
1476
1474
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
1477
1475
  command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
1478
- command.params['name'] = name unless name.nil?
1479
- command.query['parent'] = parent unless parent.nil?
1476
+ command.params['parent'] = parent unless parent.nil?
1480
1477
  command.query['fields'] = fields unless fields.nil?
1481
1478
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1482
1479
  execute_or_queue_command(command, &block)
@@ -1953,7 +1950,7 @@ module Google
1953
1950
  # default_serving_config` or the name of the legacy placement resource, such as `
1954
1951
  # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1955
1952
  # . This field is used to identify the serving config name and the set of models
1956
- # that will be used to make the search.
1953
+ # that are used to make the search.
1957
1954
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1958
1955
  # @param [String] fields
1959
1956
  # Selector specifying which fields to include in a partial response.
@@ -2296,7 +2293,7 @@ module Google
2296
2293
  # default_serving_config` or the name of the legacy placement resource, such as `
2297
2294
  # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
2298
2295
  # . This field is used to identify the serving config name and the set of models
2299
- # that will be used to make the search.
2296
+ # that are used to make the search.
2300
2297
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
2301
2298
  # @param [String] fields
2302
2299
  # Selector specifying which fields to include in a partial response.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.72.0
4
+ version: 0.74.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: 2023-03-26 00:00:00.000000000 Z
11
+ date: 2023-04-30 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_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.72.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.74.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
63
63
  post_install_message:
64
64
  rdoc_options: []