google-apis-retail_v2alpha 0.53.0 → 0.54.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: 21b93df1e143e62ad68aaf507f3bd12656e2a5db1f4cc5a9fda9ee3e03cc2bb7
4
- data.tar.gz: 809c137f35f36feae0a9e988caa7518399a4aa5bfe9009dab87c78a1a6babdb4
3
+ metadata.gz: a84b377b5e3876b5d1aa8417ff0f7a5c81a7ddae9fa135b9d8101aab0979ab83
4
+ data.tar.gz: cf01058dc4d9467ff4604aff45e738332d10cd34ae37ec3b453a0f12076afa1d
5
5
  SHA512:
6
- metadata.gz: d513e46213cdc51515262aaf664e9319d97ad4cdd49fb3afd517572138f2559a6428c2e2eb13ca1b6d9b12a88fbf1037d0df81264d5005a1b22c6f8c5998d476
7
- data.tar.gz: 5ae30acff83cfd78f4b6eb545e75ae0867c50e08db663dffa294a7da0c5e46aa4342427a47cdc07aee12ab1680bf0a7770abaa8678362d4f11a39c39670fb2b0
6
+ metadata.gz: 9dc5b47987648a68f7ca7d3e2b1d2212fbf062062b196b2da890cb07e5ca833c442d9e2b0abefcf2b9a8470b04e5e4af97134a583f93469aee510d949cffab8b
7
+ data.tar.gz: 6dbe5b867aff110e2ddac846dc9677aa60b834251025292d67b5ba0a0dafa4c10e29ca999ea4af56070e1f9231e5f5e349c59f56ee2e0238cd93469d2c3aa0b3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.54.0 (2022-08-25)
4
+
5
+ * Regenerated from discovery document revision 20220822
6
+
3
7
  ### v0.53.0 (2022-08-21)
4
8
 
5
9
  * Unspecified changes
@@ -531,7 +531,7 @@ module Google
531
531
  end
532
532
  end
533
533
 
534
- # Metadata for RejoinUserEvents method.
534
+ # Metadata for `RejoinUserEvents` method.
535
535
  class GoogleCloudRetailV2RejoinUserEventsMetadata
536
536
  include Google::Apis::Core::Hashable
537
537
 
@@ -544,7 +544,7 @@ module Google
544
544
  end
545
545
  end
546
546
 
547
- # Response message for RejoinUserEvents method.
547
+ # Response message for `RejoinUserEvents` method.
548
548
  class GoogleCloudRetailV2RejoinUserEventsResponse
549
549
  include Google::Apis::Core::Hashable
550
550
 
@@ -1562,8 +1562,8 @@ module Google
1562
1562
 
1563
1563
  # The value of the term to match on. Value cannot be empty. Value can have at
1564
1564
  # most 3 terms if specified as a partial match. Each space separated string is
1565
- # considered as one term. Example) "a b c" is 3 terms and allowed, " a b c d" is
1566
- # 4 terms and not allowed for partial match.
1565
+ # considered as one term. For example, "a b c" is 3 terms and allowed, but " a b
1566
+ # c d" is 4 terms and not allowed for a partial match.
1567
1567
  # Corresponds to the JSON property `value`
1568
1568
  # @return [String]
1569
1569
  attr_accessor :value
@@ -1605,14 +1605,14 @@ module Google
1605
1605
  end
1606
1606
  end
1607
1607
 
1608
- # Configures dynamic serving time metadata that is used to pre and post process
1609
- # search/recommendation model results.
1608
+ # Configures dynamic metadata that can be linked to a ServingConfig and affect
1609
+ # search or recommendation results at serving time.
1610
1610
  class GoogleCloudRetailV2alphaControl
1611
1611
  include Google::Apis::Core::Hashable
1612
1612
 
1613
- # Output only. List of serving configuration ids that that are associated with
1614
- # this control. Note the association is managed via the ServingConfig, this is
1615
- # an output only denormalizeed view. Assumed to be in the same catalog.
1613
+ # Output only. List of serving configuration ids that are associated with this
1614
+ # control in the same Catalog. Note the association is managed via the
1615
+ # ServingConfig, this is an output only denormalized view.
1616
1616
  # Corresponds to the JSON property `associatedServingConfigIds`
1617
1617
  # @return [Array<String>]
1618
1618
  attr_accessor :associated_serving_config_ids
@@ -1636,13 +1636,21 @@ module Google
1636
1636
  attr_accessor :name
1637
1637
 
1638
1638
  # A rule is a condition-action pair * A condition defines when a rule is to be
1639
- # triggered. * An action specifies what occurs on that trigger. Currently only
1640
- # boost rules are supported. Currently only supported by the search endpoint.
1639
+ # triggered. * An action specifies what occurs on that trigger. Currently rules
1640
+ # only work for controls with SOLUTION_TYPE_SEARCH.
1641
1641
  # Corresponds to the JSON property `rule`
1642
1642
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule]
1643
1643
  attr_accessor :rule
1644
1644
 
1645
- # Required. Immutable. The solution types that the serving config is used for.
1645
+ # Specifies the use case for the control. Affects what condition fields can be
1646
+ # set. Only settable by search controls. Will default to
1647
+ # SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
1648
+ # search_solution_use_case per control.
1649
+ # Corresponds to the JSON property `searchSolutionUseCase`
1650
+ # @return [Array<String>]
1651
+ attr_accessor :search_solution_use_case
1652
+
1653
+ # Required. Immutable. The solution types that the control is used for.
1646
1654
  # Currently we support setting only one type of solution at creation time. Only `
1647
1655
  # SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
1648
1656
  # provided at creation time, will default to SOLUTION_TYPE_SEARCH.
@@ -1661,6 +1669,7 @@ module Google
1661
1669
  @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
1662
1670
  @name = args[:name] if args.key?(:name)
1663
1671
  @rule = args[:rule] if args.key?(:rule)
1672
+ @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
1664
1673
  @solution_types = args[:solution_types] if args.key?(:solution_types)
1665
1674
  end
1666
1675
  end
@@ -1669,8 +1678,9 @@ module Google
1669
1678
  class GoogleCloudRetailV2alphaCreateModelMetadata
1670
1679
  include Google::Apis::Core::Hashable
1671
1680
 
1672
- # The resource name of the model that this create applies to. Format: projects/`
1681
+ # The resource name of the model that this create applies to. Format: `projects/`
1673
1682
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1683
+ # `
1674
1684
  # Corresponds to the JSON property `model`
1675
1685
  # @return [String]
1676
1686
  attr_accessor :model
@@ -1763,8 +1773,8 @@ module Google
1763
1773
  end
1764
1774
  end
1765
1775
 
1766
- # Metadata related to the progress of the Export operation. This will be
1767
- # returned by the google.longrunning.Operation.metadata field.
1776
+ # Metadata related to the progress of the Export operation. This is returned by
1777
+ # the google.longrunning.Operation.metadata field.
1768
1778
  class GoogleCloudRetailV2alphaExportMetadata
1769
1779
  include Google::Apis::Core::Hashable
1770
1780
 
@@ -3223,11 +3233,11 @@ module Google
3223
3233
  # belonging to several parallel categories. Strongly recommended using the full
3224
3234
  # path for better search / recommendation quality. To represent full path of
3225
3235
  # category, use '>' sign to separate different hierarchies. If '>' is part of
3226
- # the category name, please replace it with other character(s). For example, if
3227
- # a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["
3228
- # Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented
3229
- # as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness >
3230
- # Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an
3236
+ # the category name, replace it with other character(s). For example, if a shoes
3237
+ # product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports &
3238
+ # Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "
3239
+ # categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic
3240
+ # Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an
3231
3241
  # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
3232
3242
  # Empty values are not allowed. Each value must be a UTF-8 encoded string with
3233
3243
  # a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
@@ -3335,6 +3345,13 @@ module Google
3335
3345
  # @return [String]
3336
3346
  attr_accessor :language_code
3337
3347
 
3348
+ # Output only. A list of local inventories specific to different places. This is
3349
+ # only available for users who have Retail Search enabled, and it can be managed
3350
+ # by AddLocalInventories and RemoveLocalInventories APIs.
3351
+ # Corresponds to the JSON property `localInventories`
3352
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory>]
3353
+ attr_accessor :local_inventories
3354
+
3338
3355
  # The material of the product. For example, "leather", "wooden". A maximum of 20
3339
3356
  # values are allowed. Each value must be a UTF-8 encoded string with a length
3340
3357
  # limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -3513,6 +3530,7 @@ module Google
3513
3530
  @id = args[:id] if args.key?(:id)
3514
3531
  @images = args[:images] if args.key?(:images)
3515
3532
  @language_code = args[:language_code] if args.key?(:language_code)
3533
+ @local_inventories = args[:local_inventories] if args.key?(:local_inventories)
3516
3534
  @materials = args[:materials] if args.key?(:materials)
3517
3535
  @name = args[:name] if args.key?(:name)
3518
3536
  @patterns = args[:patterns] if args.key?(:patterns)
@@ -3948,7 +3966,7 @@ module Google
3948
3966
  end
3949
3967
  end
3950
3968
 
3951
- # Metadata for RejoinUserEvents method.
3969
+ # Metadata for `RejoinUserEvents` method.
3952
3970
  class GoogleCloudRetailV2alphaRejoinUserEventsMetadata
3953
3971
  include Google::Apis::Core::Hashable
3954
3972
 
@@ -3966,8 +3984,8 @@ module Google
3966
3984
  include Google::Apis::Core::Hashable
3967
3985
 
3968
3986
  # The type of the user event rejoin to define the scope and range of the user
3969
- # events to be rejoined with the latest product catalog. Defaults to
3970
- # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
3987
+ # events to be rejoined with the latest product catalog. Defaults to `
3988
+ # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to an
3971
3989
  # invalid integer value.
3972
3990
  # Corresponds to the JSON property `userEventRejoinScope`
3973
3991
  # @return [String]
@@ -3983,7 +4001,7 @@ module Google
3983
4001
  end
3984
4002
  end
3985
4003
 
3986
- # Response message for RejoinUserEvents method.
4004
+ # Response message for `RejoinUserEvents` method.
3987
4005
  class GoogleCloudRetailV2alphaRejoinUserEventsResponse
3988
4006
  include Google::Apis::Core::Hashable
3989
4007
 
@@ -4235,8 +4253,8 @@ module Google
4235
4253
  end
4236
4254
 
4237
4255
  # A rule is a condition-action pair * A condition defines when a rule is to be
4238
- # triggered. * An action specifies what occurs on that trigger. Currently only
4239
- # boost rules are supported. Currently only supported by the search endpoint.
4256
+ # triggered. * An action specifies what occurs on that trigger. Currently rules
4257
+ # only work for controls with SOLUTION_TYPE_SEARCH.
4240
4258
  class GoogleCloudRetailV2alphaRule
4241
4259
  include Google::Apis::Core::Hashable
4242
4260
 
@@ -4645,9 +4663,9 @@ module Google
4645
4663
  # navigation queries to achieve good search quality. The format should be the
4646
4664
  # same as UserEvent.page_categories; To represent full path of category, use '>'
4647
4665
  # sign to separate different hierarchies. If '>' is part of the category name,
4648
- # please replace it with other character(s). Category pages include special
4649
- # pages such as sales or promotions. For instance, a special sale page may have
4650
- # the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
4666
+ # replace it with other character(s). Category pages include special pages such
4667
+ # as sales or promotions. For instance, a special sale page may have the
4668
+ # category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
4651
4669
  # Corresponds to the JSON property `pageCategories`
4652
4670
  # @return [Array<String>]
4653
4671
  attr_accessor :page_categories
@@ -5382,9 +5400,7 @@ module Google
5382
5400
  end
5383
5401
 
5384
5402
  # Configures metadata that is used to generate serving time results (e.g. search
5385
- # results or recommendation predictions). The ServingConfig is passed in the
5386
- # search and predict request and together with the Catalog.default_branch,
5387
- # generates results.
5403
+ # results or recommendation predictions).
5388
5404
  class GoogleCloudRetailV2alphaServingConfig
5389
5405
  include Google::Apis::Core::Hashable
5390
5406
 
@@ -5407,16 +5423,21 @@ module Google
5407
5423
  # @return [String]
5408
5424
  attr_accessor :display_name
5409
5425
 
5410
- # How much diversity to use in recommendation model results e.g. 'medium-
5411
- # diversity' or 'high-diversity'. Currently supported values: * 'no-diversity' *
5412
- # 'low-diversity' * 'medium-diversity' * 'high-diversity' * 'auto-diversity' If
5426
+ # How much diversity to use in recommendation model results e.g. `medium-
5427
+ # diversity` or `high-diversity`. Currently supported values: * `no-diversity` *
5428
+ # `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If
5413
5429
  # not specified, we choose default based on recommendation model type. Default
5414
- # value: 'no-diversity'. Can only be set if solution_types is
5430
+ # value: `no-diversity`. Can only be set if solution_types is
5415
5431
  # SOLUTION_TYPE_RECOMMENDATION.
5416
5432
  # Corresponds to the JSON property `diversityLevel`
5417
5433
  # @return [String]
5418
5434
  attr_accessor :diversity_level
5419
5435
 
5436
+ # What kind of diversity to use - data driven or rule based.
5437
+ # Corresponds to the JSON property `diversityType`
5438
+ # @return [String]
5439
+ attr_accessor :diversity_type
5440
+
5420
5441
  # Condition do not associate specifications. If multiple do not associate
5421
5442
  # conditions match, all matching do not associate controls in the list will
5422
5443
  # execute. - Order does not matter. - Maximum number of specifications is 100.
@@ -5430,10 +5451,10 @@ module Google
5430
5451
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec]
5431
5452
  attr_accessor :dynamic_facet_spec
5432
5453
 
5433
- # Whether to add additional category filters on the 'similar-items' model. If
5434
- # not specified, we enable it by default. Allowed values are: * 'no-category-
5435
- # match': No additional filtering of original results from the model and the
5436
- # customer's filters. * 'relaxed-category-match': Only keep results with
5454
+ # Whether to add additional category filters on the `similar-items` model. If
5455
+ # not specified, we enable it by default. Allowed values are: * `no-category-
5456
+ # match`: No additional filtering of original results from the model and the
5457
+ # customer's filters. * `relaxed-category-match`: Only keep results with
5437
5458
  # categories that match at least one item categories in the PredictRequests's
5438
5459
  # context item. * If customer also sends filters in the PredictRequest, then the
5439
5460
  # results will satisfy both conditions (user given and category match). Can only
@@ -5467,7 +5488,7 @@ module Google
5467
5488
  # @return [Array<String>]
5468
5489
  attr_accessor :ignore_control_ids
5469
5490
 
5470
- # The id of the model to use at serving time. Currently only
5491
+ # The id of the model in the same Catalog to use at serving time. Currently only
5471
5492
  # RecommendationModels are supported: https://cloud.google.com/retail/
5472
5493
  # recommendations-ai/docs/create-models Can be changed but only to a compatible
5473
5494
  # model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when
@@ -5491,13 +5512,18 @@ module Google
5491
5512
  # @return [Array<String>]
5492
5513
  attr_accessor :oneway_synonyms_control_ids
5493
5514
 
5515
+ # The specification for personalization.
5516
+ # Corresponds to the JSON property `personalizationSpec`
5517
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec]
5518
+ attr_accessor :personalization_spec
5519
+
5494
5520
  # How much price ranking we want in serving results. Price reranking causes
5495
5521
  # product items with a similar recommendation probability to be ordered by price,
5496
5522
  # with the highest-priced items first. This setting could result in a decrease
5497
- # in click-through and conversion rates. Allowed values are: * 'no-price-
5498
- # reranking' * 'low-price-raranking' * 'medium-price-reranking' * 'high-price-
5499
- # reranking' If not specified, we choose default based on model type. Default
5500
- # value: 'no-price-reranking'. Can only be set if solution_types is
5523
+ # in click-through and conversion rates. Allowed values are: * `no-price-
5524
+ # reranking` * `low-price-raranking` * `medium-price-reranking` * `high-price-
5525
+ # reranking` If not specified, we choose default based on model type. Default
5526
+ # value: `no-price-reranking`. Can only be set if solution_types is
5501
5527
  # SOLUTION_TYPE_RECOMMENDATION.
5502
5528
  # Corresponds to the JSON property `priceRerankingLevel`
5503
5529
  # @return [String]
@@ -5541,6 +5567,7 @@ module Google
5541
5567
  @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
5542
5568
  @display_name = args[:display_name] if args.key?(:display_name)
5543
5569
  @diversity_level = args[:diversity_level] if args.key?(:diversity_level)
5570
+ @diversity_type = args[:diversity_type] if args.key?(:diversity_type)
5544
5571
  @do_not_associate_control_ids = args[:do_not_associate_control_ids] if args.key?(:do_not_associate_control_ids)
5545
5572
  @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
5546
5573
  @enable_category_filter_level = args[:enable_category_filter_level] if args.key?(:enable_category_filter_level)
@@ -5550,6 +5577,7 @@ module Google
5550
5577
  @model_id = args[:model_id] if args.key?(:model_id)
5551
5578
  @name = args[:name] if args.key?(:name)
5552
5579
  @oneway_synonyms_control_ids = args[:oneway_synonyms_control_ids] if args.key?(:oneway_synonyms_control_ids)
5580
+ @personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
5553
5581
  @price_reranking_level = args[:price_reranking_level] if args.key?(:price_reranking_level)
5554
5582
  @redirect_control_ids = args[:redirect_control_ids] if args.key?(:redirect_control_ids)
5555
5583
  @replacement_control_ids = args[:replacement_control_ids] if args.key?(:replacement_control_ids)
@@ -5702,8 +5730,9 @@ module Google
5702
5730
  class GoogleCloudRetailV2alphaTuneModelMetadata
5703
5731
  include Google::Apis::Core::Hashable
5704
5732
 
5705
- # The resource name of the model that this tune applies to. Format: projects/`
5733
+ # The resource name of the model that this tune applies to. Format: `projects/`
5706
5734
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
5735
+ # `
5707
5736
  # Corresponds to the JSON property `model`
5708
5737
  # @return [String]
5709
5738
  attr_accessor :model
@@ -5853,12 +5882,12 @@ module Google
5853
5882
 
5854
5883
  # The categories associated with a category page. To represent full path of
5855
5884
  # category, use '>' sign to separate different hierarchies. If '>' is part of
5856
- # the category name, please replace it with other character(s). Category pages
5857
- # include special pages such as sales or promotions. For instance, a special
5858
- # sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017
5859
- # Black Friday Deals"]. Required for `category-page-view` events. At least one
5860
- # of search_query or page_categories is required for `search` events. Other
5861
- # event types should not set this field. Otherwise, an INVALID_ARGUMENT error is
5885
+ # the category name, replace it with other character(s). Category pages include
5886
+ # special pages such as sales or promotions. For instance, a special sale page
5887
+ # may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black
5888
+ # Friday Deals"]. Required for `category-page-view` events. At least one of
5889
+ # search_query or page_categories is required for `search` events. Other event
5890
+ # types should not set this field. Otherwise, an INVALID_ARGUMENT error is
5862
5891
  # returned.
5863
5892
  # Corresponds to the JSON property `pageCategories`
5864
5893
  # @return [Array<String>]
@@ -6213,8 +6242,8 @@ module Google
6213
6242
  end
6214
6243
  end
6215
6244
 
6216
- # Metadata related to the progress of the Export operation. This will be
6217
- # returned by the google.longrunning.Operation.metadata field.
6245
+ # Metadata related to the progress of the Export operation. This is returned by
6246
+ # the google.longrunning.Operation.metadata field.
6218
6247
  class GoogleCloudRetailV2betaExportMetadata
6219
6248
  include Google::Apis::Core::Hashable
6220
6249
 
@@ -6517,7 +6546,7 @@ module Google
6517
6546
  end
6518
6547
  end
6519
6548
 
6520
- # Metadata for RejoinUserEvents method.
6549
+ # Metadata for `RejoinUserEvents` method.
6521
6550
  class GoogleCloudRetailV2betaRejoinUserEventsMetadata
6522
6551
  include Google::Apis::Core::Hashable
6523
6552
 
@@ -6530,7 +6559,7 @@ module Google
6530
6559
  end
6531
6560
  end
6532
6561
 
6533
- # Response message for RejoinUserEvents method.
6562
+ # Response message for `RejoinUserEvents` method.
6534
6563
  class GoogleCloudRetailV2betaRejoinUserEventsResponse
6535
6564
  include Google::Apis::Core::Hashable
6536
6565
 
@@ -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.53.0"
19
+ GEM_VERSION = "0.54.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.9.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220811"
25
+ REVISION = "20220822"
26
26
  end
27
27
  end
28
28
  end
@@ -1610,6 +1610,7 @@ module Google
1610
1610
  property :name, as: 'name'
1611
1611
  property :rule, as: 'rule', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule::Representation
1612
1612
 
1613
+ collection :search_solution_use_case, as: 'searchSolutionUseCase'
1613
1614
  collection :solution_types, as: 'solutionTypes'
1614
1615
  end
1615
1616
  end
@@ -2030,6 +2031,8 @@ module Google
2030
2031
  collection :images, as: 'images', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImage, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImage::Representation
2031
2032
 
2032
2033
  property :language_code, as: 'languageCode'
2034
+ collection :local_inventories, as: 'localInventories', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory::Representation
2035
+
2033
2036
  collection :materials, as: 'materials'
2034
2037
  property :name, as: 'name'
2035
2038
  collection :patterns, as: 'patterns'
@@ -2519,6 +2522,7 @@ module Google
2519
2522
  collection :boost_control_ids, as: 'boostControlIds'
2520
2523
  property :display_name, as: 'displayName'
2521
2524
  property :diversity_level, as: 'diversityLevel'
2525
+ property :diversity_type, as: 'diversityType'
2522
2526
  collection :do_not_associate_control_ids, as: 'doNotAssociateControlIds'
2523
2527
  property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec::Representation
2524
2528
 
@@ -2529,6 +2533,8 @@ module Google
2529
2533
  property :model_id, as: 'modelId'
2530
2534
  property :name, as: 'name'
2531
2535
  collection :oneway_synonyms_control_ids, as: 'onewaySynonymsControlIds'
2536
+ property :personalization_spec, as: 'personalizationSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec::Representation
2537
+
2532
2538
  property :price_reranking_level, as: 'priceRerankingLevel'
2533
2539
  collection :redirect_control_ids, as: 'redirectControlIds'
2534
2540
  collection :replacement_control_ids, as: 'replacementControlIds'
@@ -52,8 +52,8 @@ module Google
52
52
  end
53
53
 
54
54
  # Completes the specified prefix with keyword suggestions. This feature is only
55
- # available for users who have Retail Search enabled. Please enable Retail
56
- # Search on Cloud Console before using this feature.
55
+ # available for users who have Retail Search enabled. Enable Retail Search on
56
+ # Cloud Console before using this feature.
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`.
@@ -159,8 +159,8 @@ module Google
159
159
 
160
160
  # Gets a CompletionConfig.
161
161
  # @param [String] name
162
- # Required. Full CompletionConfig resource name. Format: projects/`
163
- # project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
162
+ # Required. Full CompletionConfig resource name. Format: `projects/`
163
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig`
164
164
  # @param [String] fields
165
165
  # Selector specifying which fields to include in a partial response.
166
166
  # @param [String] quota_user
@@ -609,6 +609,37 @@ module Google
609
609
  execute_or_queue_command(command, &block)
610
610
  end
611
611
 
612
+ # Gets the latest state of a long-running operation. Clients can use this method
613
+ # to poll the operation result at intervals as recommended by the API service.
614
+ # @param [String] name
615
+ # The name of the operation resource.
616
+ # @param [String] fields
617
+ # Selector specifying which fields to include in a partial response.
618
+ # @param [String] quota_user
619
+ # Available to use for quota purposes for server-side applications. Can be any
620
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
621
+ # @param [Google::Apis::RequestOptions] options
622
+ # Request-specific options
623
+ #
624
+ # @yield [result, err] Result & error if block supplied
625
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
626
+ # @yieldparam err [StandardError] error object if request failed
627
+ #
628
+ # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
629
+ #
630
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
631
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
632
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
633
+ def get_project_location_catalog_branch_place_operation(name, fields: nil, quota_user: nil, options: nil, &block)
634
+ command = make_simple_command(:get, 'v2alpha/{+name}', options)
635
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
636
+ command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
637
+ command.params['name'] = name unless name.nil?
638
+ command.query['fields'] = fields unless fields.nil?
639
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
640
+ execute_or_queue_command(command, &block)
641
+ end
642
+
612
643
  # Incrementally adds place IDs to Product.fulfillment_info.place_ids. This
613
644
  # process is asynchronous and does not require the Product to exist before
614
645
  # updating fulfillment information. If the request is valid, the update will be
@@ -619,8 +650,7 @@ module Google
619
650
  # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
620
651
  # associated with the stale updates will not be marked as done until being
621
652
  # obsolete. This feature is only available for users who have Retail Search
622
- # enabled. Please enable Retail Search on Cloud Console before using this
623
- # feature.
653
+ # enabled. Enable Retail Search on Cloud Console before using this feature.
624
654
  # @param [String] product
625
655
  # Required. Full resource name of Product, such as `projects/*/locations/global/
626
656
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -669,8 +699,8 @@ module Google
669
699
  # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
670
700
  # issued, the Operations associated with the stale updates will not be marked as
671
701
  # done until being obsolete. This feature is only available for users who have
672
- # Retail Search enabled. Please enable Retail Search on Cloud Console before
673
- # using this feature.
702
+ # Retail Search enabled. Enable Retail Search on Cloud Console before using this
703
+ # feature.
674
704
  # @param [String] product
675
705
  # Required. Full resource name of Product, such as `projects/*/locations/global/
676
706
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -1028,8 +1058,7 @@ module Google
1028
1058
  # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
1029
1059
  # associated with the stale updates will not be marked as done until being
1030
1060
  # obsolete. This feature is only available for users who have Retail Search
1031
- # enabled. Please enable Retail Search on Cloud Console before using this
1032
- # feature.
1061
+ # enabled. Enable Retail Search on Cloud Console before using this feature.
1033
1062
  # @param [String] product
1034
1063
  # Required. Full resource name of Product, such as `projects/*/locations/global/
1035
1064
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -1076,8 +1105,8 @@ module Google
1076
1105
  # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
1077
1106
  # issued, the Operations associated with the stale updates will not be marked as
1078
1107
  # done until being obsolete. This feature is only available for users who have
1079
- # Retail Search enabled. Please enable Retail Search on Cloud Console before
1080
- # using this feature.
1108
+ # Retail Search enabled. Enable Retail Search on Cloud Console before using this
1109
+ # feature.
1081
1110
  # @param [String] product
1082
1111
  # Required. Full resource name of Product, such as `projects/*/locations/global/
1083
1112
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -1116,26 +1145,26 @@ module Google
1116
1145
  # Updates inventory information for a Product while respecting the last update
1117
1146
  # timestamps of each inventory field. This process is asynchronous and does not
1118
1147
  # require the Product to exist before updating fulfillment information. If the
1119
- # request is valid, the update will be enqueued and processed downstream. As a
1148
+ # request is valid, the update is enqueued and processed downstream. As a
1120
1149
  # consequence, when a response is returned, updates are not immediately
1121
1150
  # manifested in the Product queried by ProductService.GetProduct or
1122
1151
  # ProductService.ListProducts. When inventory is updated with ProductService.
1123
1152
  # CreateProduct and ProductService.UpdateProduct, the specified inventory field
1124
- # value(s) will overwrite any existing value(s) while ignoring the last update
1125
- # time for this field. Furthermore, the last update time for the specified
1126
- # inventory fields will be overwritten to the time of the ProductService.
1127
- # CreateProduct or ProductService.UpdateProduct request. If no inventory fields
1128
- # are set in CreateProductRequest.product, then any pre-existing inventory
1129
- # information for this product will be used. If no inventory fields are set in
1130
- # SetInventoryRequest.set_mask, then any existing inventory information will be
1131
- # preserved. Pre-existing inventory information can only be updated with
1132
- # ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and
1133
- # ProductService.RemoveFulfillmentPlaces. The returned Operations will be
1134
- # obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards.
1135
- # If conflicting updates are issued, the Operations associated with the stale
1136
- # updates will not be marked as done until being obsolete. This feature is only
1137
- # available for users who have Retail Search enabled. Please enable Retail
1138
- # Search on Cloud Console before using this feature.
1153
+ # value(s) overwrite any existing value(s) while ignoring the last update time
1154
+ # for this field. Furthermore, the last update times for the specified inventory
1155
+ # fields are overwritten by the times of the ProductService.CreateProduct or
1156
+ # ProductService.UpdateProduct request. If no inventory fields are set in
1157
+ # CreateProductRequest.product, then any pre-existing inventory information for
1158
+ # this product is used. If no inventory fields are set in SetInventoryRequest.
1159
+ # set_mask, then any existing inventory information is preserved. Pre-existing
1160
+ # inventory information can only be updated with ProductService.SetInventory,
1161
+ # ProductService.AddFulfillmentPlaces, and ProductService.
1162
+ # RemoveFulfillmentPlaces. The returned Operations is obsolete after one day,
1163
+ # and the GetOperation API returns `NOT_FOUND` afterwards. If conflicting
1164
+ # updates are issued, the Operations associated with the stale updates are not
1165
+ # marked as done until they are obsolete. This feature is only available for
1166
+ # users who have Retail Search enabled. Enable Retail Search on Cloud Console
1167
+ # before using this feature.
1139
1168
  # @param [String] name
1140
1169
  # Immutable. Full resource name of the product, such as `projects/*/locations/
1141
1170
  # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1173,8 +1202,8 @@ module Google
1173
1202
  # asynchronous. Partial updating is not supported. The operation is successfully
1174
1203
  # finished only after the imported suggestions are indexed successfully and
1175
1204
  # ready for serving. The process takes hours. This feature is only available for
1176
- # users who have Retail Search enabled. Please enable Retail Search on Cloud
1177
- # Console before using this feature.
1205
+ # users who have Retail Search enabled. Enable Retail Search on Cloud Console
1206
+ # before using this feature.
1178
1207
  # @param [String] parent
1179
1208
  # Required. The catalog which the suggestions dataset belongs to. Format: `
1180
1209
  # projects/1234/locations/global/catalogs/default_catalog`.
@@ -1283,7 +1312,7 @@ module Google
1283
1312
 
1284
1313
  # Gets a Control.
1285
1314
  # @param [String] name
1286
- # Required. The resource name of the Control to delete. Format: `projects/`
1315
+ # Required. The resource name of the Control to get. Format: `projects/`
1287
1316
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
1288
1317
  # control_id``
1289
1318
  # @param [String] fields
@@ -1313,7 +1342,7 @@ module Google
1313
1342
  execute_or_queue_command(command, &block)
1314
1343
  end
1315
1344
 
1316
- # Lists all Controls linked to this catalog.
1345
+ # Lists all Controls by their parent Catalog.
1317
1346
  # @param [String] parent
1318
1347
  # Required. The catalog resource name. Format: `projects/`project_number`/
1319
1348
  # locations/`location_id`/catalogs/`catalog_id``
@@ -1359,7 +1388,7 @@ module Google
1359
1388
  end
1360
1389
 
1361
1390
  # Updates a Control. Control cannot be set to a different oneof field, if so an
1362
- # INVALID_ARGUMENT is returned. If the Control to delete does not exist, a
1391
+ # INVALID_ARGUMENT is returned. If the Control to update does not exist, a
1363
1392
  # NOT_FOUND error is returned.
1364
1393
  # @param [String] name
1365
1394
  # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/
@@ -1401,8 +1430,8 @@ module Google
1401
1430
 
1402
1431
  # Creates a new model.
1403
1432
  # @param [String] parent
1404
- # Required. The parent resource under which to create the model. Format:
1405
- # projects/`project_number`/locations/`location_id`/catalogs/`catalog_id`
1433
+ # Required. The parent resource under which to create the model. Format: `
1434
+ # projects/`project_number`/locations/`location_id`/catalogs/`catalog_id``
1406
1435
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] google_cloud_retail_v2alpha_model_object
1407
1436
  # @param [Boolean] dry_run
1408
1437
  # Optional. Whether to run a dry run to validate the request (without actually
@@ -1439,8 +1468,9 @@ module Google
1439
1468
 
1440
1469
  # Deletes an existing model.
1441
1470
  # @param [String] name
1442
- # Required. The resource name of the Model to delete. Format: projects/`
1471
+ # Required. The resource name of the Model to delete. Format: `projects/`
1443
1472
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1473
+ # `
1444
1474
  # @param [String] fields
1445
1475
  # Selector specifying which fields to include in a partial response.
1446
1476
  # @param [String] quota_user
@@ -1470,8 +1500,8 @@ module Google
1470
1500
 
1471
1501
  # Lists all the models linked to this event store.
1472
1502
  # @param [String] parent
1473
- # Required. The parent for which to list models. Format: projects/`
1474
- # project_number`/locations/`location_id`/catalogs/`catalog_id`
1503
+ # Required. The parent for which to list models. Format: `projects/`
1504
+ # project_number`/locations/`location_id`/catalogs/`catalog_id``
1475
1505
  # @param [Fixnum] page_size
1476
1506
  # Optional. Maximum number of results to return. If unspecified, defaults to 50.
1477
1507
  # Max allowed value is 1000.
@@ -1551,8 +1581,8 @@ module Google
1551
1581
 
1552
1582
  # Pauses the training of an existing model.
1553
1583
  # @param [String] name
1554
- # Required. The name of the model to pause. Format: projects/`project_number`/
1555
- # locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1584
+ # Required. The name of the model to pause. Format: `projects/`project_number`/
1585
+ # locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
1556
1586
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest] google_cloud_retail_v2alpha_pause_model_request_object
1557
1587
  # @param [String] fields
1558
1588
  # Selector specifying which fields to include in a partial response.
@@ -1585,8 +1615,8 @@ module Google
1585
1615
 
1586
1616
  # Resumes the training of an existing model.
1587
1617
  # @param [String] name
1588
- # Required. The name of the model to resume. Format: projects/`project_number`/
1589
- # locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1618
+ # Required. The name of the model to resume. Format: `projects/`project_number`/
1619
+ # locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
1590
1620
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest] google_cloud_retail_v2alpha_resume_model_request_object
1591
1621
  # @param [String] fields
1592
1622
  # Selector specifying which fields to include in a partial response.
@@ -1619,8 +1649,9 @@ module Google
1619
1649
 
1620
1650
  # Tunes an existing model.
1621
1651
  # @param [String] name
1622
- # Required. The resource name of the model to tune. Format: projects/`
1652
+ # Required. The resource name of the model to tune. Format: `projects/`
1623
1653
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1654
+ # `
1624
1655
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest] google_cloud_retail_v2alpha_tune_model_request_object
1625
1656
  # @param [String] fields
1626
1657
  # Selector specifying which fields to include in a partial response.
@@ -1771,7 +1802,7 @@ module Google
1771
1802
  end
1772
1803
 
1773
1804
  # Performs a search. This feature is only available for users who have Retail
1774
- # Search enabled. Please enable Retail Search on Cloud Console before using this
1805
+ # Search enabled. Enable Retail Search on Cloud Console before using this
1775
1806
  # feature.
1776
1807
  # @param [String] placement
1777
1808
  # Required. The resource name of the Retail Search serving config, such as `
@@ -1817,9 +1848,9 @@ module Google
1817
1848
  # Returns a FAILED_PRECONDITION error if the addition could exceed maximum
1818
1849
  # number of control allowed for that type of control.
1819
1850
  # @param [String] serving_config
1820
- # Required. The source ServingConfig resource name . Format: projects/`
1851
+ # Required. The source ServingConfig resource name . Format: `projects/`
1821
1852
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1822
- # serving_config_id`
1853
+ # serving_config_id``
1823
1854
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest] google_cloud_retail_v2alpha_add_control_request_object
1824
1855
  # @param [String] fields
1825
1856
  # Selector specifying which fields to include in a partial response.
@@ -1893,9 +1924,9 @@ module Google
1893
1924
  # Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does
1894
1925
  # not exist.
1895
1926
  # @param [String] name
1896
- # Required. The resource name of the ServingConfig to delete. Format: projects/`
1927
+ # Required. The resource name of the ServingConfig to delete. Format: `projects/`
1897
1928
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1898
- # serving_config_id`
1929
+ # serving_config_id``
1899
1930
  # @param [String] fields
1900
1931
  # Selector specifying which fields to include in a partial response.
1901
1932
  # @param [String] quota_user
@@ -1926,9 +1957,9 @@ module Google
1926
1957
  # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
1927
1958
  # exist.
1928
1959
  # @param [String] name
1929
- # Required. The resource name of the ServingConfig to get. Format: projects/`
1960
+ # Required. The resource name of the ServingConfig to get. Format: `projects/`
1930
1961
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1931
- # serving_config_id`
1962
+ # serving_config_id``
1932
1963
  # @param [String] fields
1933
1964
  # Selector specifying which fields to include in a partial response.
1934
1965
  # @param [String] quota_user
@@ -1958,8 +1989,8 @@ module Google
1958
1989
 
1959
1990
  # Lists all ServingConfigs linked to this catalog.
1960
1991
  # @param [String] parent
1961
- # Required. The catalog resource name. Format: projects/`project_number`/
1962
- # locations/`location_id`/catalogs/`catalog_id`
1992
+ # Required. The catalog resource name. Format: `projects/`project_number`/
1993
+ # locations/`location_id`/catalogs/`catalog_id``
1963
1994
  # @param [Fixnum] page_size
1964
1995
  # Optional. Maximum number of results to return. If unspecified, defaults to 100.
1965
1996
  # If a value greater than 100 is provided, at most 100 results are returned.
@@ -2080,9 +2111,9 @@ module Google
2080
2111
  # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
2081
2112
  # the ServingConfig.
2082
2113
  # @param [String] serving_config
2083
- # Required. The source ServingConfig resource name . Format: projects/`
2114
+ # Required. The source ServingConfig resource name . Format: `projects/`
2084
2115
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
2085
- # serving_config_id`
2116
+ # serving_config_id``
2086
2117
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest] google_cloud_retail_v2alpha_remove_control_request_object
2087
2118
  # @param [String] fields
2088
2119
  # Selector specifying which fields to include in a partial response.
@@ -2114,7 +2145,7 @@ module Google
2114
2145
  end
2115
2146
 
2116
2147
  # Performs a search. This feature is only available for users who have Retail
2117
- # Search enabled. Please enable Retail Search on Cloud Console before using this
2148
+ # Search enabled. Enable Retail Search on Cloud Console before using this
2118
2149
  # feature.
2119
2150
  # @param [String] placement
2120
2151
  # Required. The resource name of the Retail Search serving config, such as `
@@ -2275,12 +2306,12 @@ module Google
2275
2306
  execute_or_queue_command(command, &block)
2276
2307
  end
2277
2308
 
2278
- # Starts a user event rejoin operation with latest product catalog. Events will
2279
- # not be annotated with detailed product information if product is missing from
2280
- # the catalog at the time the user event is ingested, and these events are
2281
- # stored as unjoined events with a limited usage on training and serving. This
2282
- # method can be used to start a join operation on specified events with latest
2283
- # version of product catalog. It can also be used to correct events joined with
2309
+ # Starts a user-event rejoin operation with latest product catalog. Events are
2310
+ # not annotated with detailed product information for products that are missing
2311
+ # from the catalog when the user event is ingested. These events are stored as
2312
+ # unjoined events with limited usage on training and serving. You can use this
2313
+ # method to start a join operation on specified events with the latest version
2314
+ # of product catalog. You can also use this method to correct events joined with
2284
2315
  # the wrong product catalog. A rejoin operation can take hours or days to
2285
2316
  # complete.
2286
2317
  # @param [String] parent
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.53.0
4
+ version: 0.54.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: 2022-08-22 00:00:00.000000000 Z
11
+ date: 2022-08-29 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.53.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.54.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: []