google-apis-retail_v2 0.29.0 → 0.32.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: 956cc4872d18a572f15cccb2c94cc45f16b755d1cffdcf10dfd3d6d735c1de57
4
- data.tar.gz: a678cbf4bb92a4e838dca0bdba64260acc25a0bf4901337ec7e58e56f369dbba
3
+ metadata.gz: 233478bb57c972e6f2f535ddfbcee72ebfc4052f5de8d79afc73db1f26b3cb15
4
+ data.tar.gz: 63088218281dafba204bea53192f5b6d10982c22b2a07c0f84c405dc9a12bc60
5
5
  SHA512:
6
- metadata.gz: 7bd2c43947ac03f046311f0afa03958b2f4a3437ff1246b466a152e2b1add0e842dd003b6489fe06abf51013613eac0f1dd7e8912d68cbe72591531512c53471
7
- data.tar.gz: ef8419859517ed96700ee7c29b6295351007b1c6e3d718ddacf31ec04d508c682e3dfbbe3b02e49d32191433fe0d42b9d869764f2acef0ca2986897ef8acc030
6
+ metadata.gz: 035f15cd06ef6bacb052c352f15e427d4372dbe9d6f8e90c2276062716a6827418932d86839d47359eeeb09b7dc165da57b49e806ca72ba18687e7557acbe0c1
7
+ data.tar.gz: 1269c8a22f73067dc09a72cbc04b3af2432874caa37c9471c97f2cc7ecfe869e620cb1db15ea0e08f2e94f6df34965b8112969e23bcda0d6f6ce6e1863c960ed
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.32.0 (2022-03-24)
4
+
5
+ * Regenerated from discovery document revision 20220319
6
+
7
+ ### v0.31.0 (2022-03-16)
8
+
9
+ * Regenerated from discovery document revision 20220310
10
+
11
+ ### v0.30.0 (2022-03-09)
12
+
13
+ * Regenerated from discovery document revision 20220303
14
+
3
15
  ### v0.29.0 (2022-02-24)
4
16
 
5
17
  * Regenerated from discovery document revision 20220217
@@ -416,7 +416,9 @@ module Google
416
416
  # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
417
417
  # preview. Please contact the support team for importing Google Analytics 4
418
418
  # events. The schema is available here: https://support.google.com/analytics/
419
- # answer/7029846.
419
+ # answer/7029846. Supported values for auto-completion imports: * `suggestions` (
420
+ # default): One JSON completion suggestion per line. * `denylist`: One JSON deny
421
+ # suggestion per line. * `allowlist`: One JSON allow suggestion per line.
420
422
  # Corresponds to the JSON property `dataSchema`
421
423
  # @return [String]
422
424
  attr_accessor :data_schema
@@ -437,11 +439,11 @@ module Google
437
439
  # Represents a whole or partial calendar date, such as a birthday. The time of
438
440
  # day and time zone are either specified elsewhere or are insignificant. The
439
441
  # date is relative to the Gregorian Calendar. This can represent one of the
440
- # following: * A full date, with non-zero year, month, and day values * A month
441
- # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
442
- # zero month and a zero day * A year and month, with a zero day (e.g., a credit
443
- # card expiration date) Related types: * google.type.TimeOfDay * google.type.
444
- # DateTime * google.protobuf.Timestamp
442
+ # following: * A full date, with non-zero year, month, and day values. * A month
443
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
444
+ # with a zero month and a zero day. * A year and month, with a zero day (for
445
+ # example, a credit card expiration date). Related types: * google.type.
446
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
445
447
  # Corresponds to the JSON property `partitionDate`
446
448
  # @return [Google::Apis::RetailV2::GoogleTypeDate]
447
449
  attr_accessor :partition_date
@@ -552,9 +554,9 @@ module Google
552
554
  class GoogleCloudRetailV2CompleteQueryResponse
553
555
  include Google::Apis::Core::Hashable
554
556
 
555
- # A unique complete token. This should be included in the SearchRequest
556
- # resulting from this completion, which enables accurate attribution of complete
557
- # model performance.
557
+ # A unique complete token. This should be included in the UserEvent.
558
+ # completion_detail for search events resulting from this completion, which
559
+ # enables accurate attribution of complete model performance.
558
560
  # Corresponds to the JSON property `attributionToken`
559
561
  # @return [String]
560
562
  attr_accessor :attribution_token
@@ -594,7 +596,9 @@ module Google
594
596
  class GoogleCloudRetailV2CompleteQueryResponseCompletionResult
595
597
  include Google::Apis::Core::Hashable
596
598
 
597
- # Additional custom attributes ingested through BigQuery.
599
+ # Custom attributes for the suggestion term. * For "user-data", the attributes
600
+ # are additional custom attributes ingested through BigQuery. * For "cloud-
601
+ # retail", the attributes are product attributes generated by Cloud Retail.
598
602
  # Corresponds to the JSON property `attributes`
599
603
  # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
600
604
  attr_accessor :attributes
@@ -847,7 +851,10 @@ module Google
847
851
  end
848
852
  end
849
853
 
850
- # Product thumbnail/detail image.
854
+ # Product image. Recommendations AI and Retail Search do not use product images
855
+ # to improve prediction and search results. However, product images can be
856
+ # returned in results, and are shown in prediction or search previews in the
857
+ # console.
851
858
  class GoogleCloudRetailV2Image
852
859
  include Google::Apis::Core::Hashable
853
860
 
@@ -977,8 +984,7 @@ module Google
977
984
  # @return [String]
978
985
  attr_accessor :notification_pubsub_topic
979
986
 
980
- # Id of the request / operation. This is parroting back the requestId that was
981
- # passed in the request.
987
+ # Deprecated. This field is never set.
982
988
  # Corresponds to the JSON property `requestId`
983
989
  # @return [String]
984
990
  attr_accessor :request_id
@@ -1038,11 +1044,7 @@ module Google
1038
1044
  # @return [String]
1039
1045
  attr_accessor :reconciliation_mode
1040
1046
 
1041
- # Unique identifier provided by client, within the ancestor dataset scope.
1042
- # Ensures idempotency and used for request deduplication. Server-generated if
1043
- # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
1044
- # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
1045
- # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
1047
+ # Deprecated. This field has no effect.
1046
1048
  # Corresponds to the JSON property `requestId`
1047
1049
  # @return [String]
1048
1050
  attr_accessor :request_id
@@ -1259,9 +1261,11 @@ module Google
1259
1261
  # do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "
1260
1262
  # Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-
1261
1263
  # "promotional") * filterOutOfStockItems If your filter blocks all prediction
1262
- # results, nothing will be returned. If you want generic (unfiltered) popular
1263
- # products to be returned instead, set `strictFiltering` to false in `
1264
- # PredictRequest.params`.
1264
+ # results, the API will return generic (unfiltered) popular products. If you
1265
+ # only want results strictly matching the filters, set `strictFiltering` to True
1266
+ # in `PredictRequest.params` to receive empty results instead. Note that the API
1267
+ # will never return items with storageStatus of "EXPIRED" or "DELETED"
1268
+ # regardless of filter choices.
1265
1269
  # Corresponds to the JSON property `filter`
1266
1270
  # @return [String]
1267
1271
  attr_accessor :filter
@@ -1668,7 +1672,7 @@ module Google
1668
1672
  # @return [String]
1669
1673
  attr_accessor :id
1670
1674
 
1671
- # Product images for the product.Highly recommended to put the main image to the
1675
+ # Product images for the product. We highly recommend putting the main image
1672
1676
  # first. A maximum of 300 images are allowed. Corresponding properties: Google
1673
1677
  # Merchant Center property [image_link](https://support.google.com/merchants/
1674
1678
  # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
@@ -2342,12 +2346,13 @@ module Google
2342
2346
  # @return [String]
2343
2347
  attr_accessor :branch
2344
2348
 
2345
- # The filter applied to every search request when quality improvement such as
2346
- # query expansion is needed. For example, if a query does not have enough
2347
- # results, an expanded query with SearchRequest.canonical_filter will be
2348
- # returned as a supplement of the original query. This field is strongly
2349
- # recommended to achieve high search quality. See SearchRequest.filter for more
2350
- # details about filter syntax.
2349
+ # The default filter that is applied when a user performs a search without
2350
+ # checking any filters on the search page. The filter applied to every search
2351
+ # request when quality improvement such as query expansion is needed. For
2352
+ # example, if a query does not have enough results, an expanded query with
2353
+ # SearchRequest.canonical_filter will be returned as a supplement of the
2354
+ # original query. This field is strongly recommended to achieve high search
2355
+ # quality. See SearchRequest.filter for more details about filter syntax.
2351
2356
  # Corresponds to the JSON property `canonicalFilter`
2352
2357
  # @return [String]
2353
2358
  attr_accessor :canonical_filter
@@ -3160,15 +3165,21 @@ module Google
3160
3165
  class GoogleCloudRetailV2UserEvent
3161
3166
  include Google::Apis::Core::Hashable
3162
3167
 
3163
- # Extra user event features to include in the recommendation model. This field
3164
- # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
3165
- # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
3166
- # 000 characters. * For text attributes, at most 400 values are allowed. Empty
3167
- # values are not allowed. Each value must be a UTF-8 encoded string with a
3168
- # length limit of 256 characters. * For number attributes, at most 400 values
3169
- # are allowed. For product recommendation, an example of extra user information
3170
- # is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
3171
- # site by coming to the site directly, or coming through Google search, and etc.
3168
+ # Extra user event features to include in the recommendation model. If you
3169
+ # provide custom attributes for ingested user events, also include them in the
3170
+ # user events that you associate with prediction requests. Custom attribute
3171
+ # formatting must be consistent between imported events and events provided with
3172
+ # prediction requests. This lets the Retail API use those custom attributes when
3173
+ # training models and serving predictions, which helps improve recommendation
3174
+ # quality. This field needs to pass all below criteria, otherwise an
3175
+ # INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string
3176
+ # with a length limit of 5,000 characters. * For text attributes, at most 400
3177
+ # values are allowed. Empty values are not allowed. Each value must be a UTF-8
3178
+ # encoded string with a length limit of 256 characters. * For number attributes,
3179
+ # at most 400 values are allowed. For product recommendations, an example of
3180
+ # extra user information is traffic_channel, which is how a user arrives at the
3181
+ # site. Users can arrive at the site by coming to the site directly, coming
3182
+ # through Google search, or in other ways.
3172
3183
  # Corresponds to the JSON property `attributes`
3173
3184
  # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
3174
3185
  attr_accessor :attributes
@@ -3732,8 +3743,7 @@ module Google
3732
3743
  # @return [String]
3733
3744
  attr_accessor :notification_pubsub_topic
3734
3745
 
3735
- # Id of the request / operation. This is parroting back the requestId that was
3736
- # passed in the request.
3746
+ # Deprecated. This field is never set.
3737
3747
  # Corresponds to the JSON property `requestId`
3738
3748
  # @return [String]
3739
3749
  attr_accessor :request_id
@@ -3839,6 +3849,74 @@ module Google
3839
3849
  end
3840
3850
  end
3841
3851
 
3852
+ # Metadata related to the progress of the PurgeProducts operation. This will be
3853
+ # returned by the google.longrunning.Operation.metadata field.
3854
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
3855
+ include Google::Apis::Core::Hashable
3856
+
3857
+ # Operation create time.
3858
+ # Corresponds to the JSON property `createTime`
3859
+ # @return [String]
3860
+ attr_accessor :create_time
3861
+
3862
+ # Count of entries that encountered errors while processing.
3863
+ # Corresponds to the JSON property `failureCount`
3864
+ # @return [Fixnum]
3865
+ attr_accessor :failure_count
3866
+
3867
+ # Count of entries that were deleted successfully.
3868
+ # Corresponds to the JSON property `successCount`
3869
+ # @return [Fixnum]
3870
+ attr_accessor :success_count
3871
+
3872
+ # Operation last update time. If the operation is done, this is also the finish
3873
+ # time.
3874
+ # Corresponds to the JSON property `updateTime`
3875
+ # @return [String]
3876
+ attr_accessor :update_time
3877
+
3878
+ def initialize(**args)
3879
+ update!(**args)
3880
+ end
3881
+
3882
+ # Update properties of this object
3883
+ def update!(**args)
3884
+ @create_time = args[:create_time] if args.key?(:create_time)
3885
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
3886
+ @success_count = args[:success_count] if args.key?(:success_count)
3887
+ @update_time = args[:update_time] if args.key?(:update_time)
3888
+ end
3889
+ end
3890
+
3891
+ # Response of the PurgeProductsRequest. If the long running operation is
3892
+ # successfully done, then this message is returned by the google.longrunning.
3893
+ # Operations.response field.
3894
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
3895
+ include Google::Apis::Core::Hashable
3896
+
3897
+ # The total count of products purged as a result of the operation.
3898
+ # Corresponds to the JSON property `purgeCount`
3899
+ # @return [Fixnum]
3900
+ attr_accessor :purge_count
3901
+
3902
+ # A sample of the product names that will be deleted. Only populated if `force`
3903
+ # is set to false. A max of 100 names will be returned and the names are chosen
3904
+ # at random.
3905
+ # Corresponds to the JSON property `purgeSample`
3906
+ # @return [Array<String>]
3907
+ attr_accessor :purge_sample
3908
+
3909
+ def initialize(**args)
3910
+ update!(**args)
3911
+ end
3912
+
3913
+ # Update properties of this object
3914
+ def update!(**args)
3915
+ @purge_count = args[:purge_count] if args.key?(:purge_count)
3916
+ @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
3917
+ end
3918
+ end
3919
+
3842
3920
  # Response of the PurgeUserEventsRequest. If the long running operation is
3843
3921
  # successfully done, then this message is returned by the google.longrunning.
3844
3922
  # Operations.response field.
@@ -4202,8 +4280,7 @@ module Google
4202
4280
  # @return [String]
4203
4281
  attr_accessor :notification_pubsub_topic
4204
4282
 
4205
- # Id of the request / operation. This is parroting back the requestId that was
4206
- # passed in the request.
4283
+ # Deprecated. This field is never set.
4207
4284
  # Corresponds to the JSON property `requestId`
4208
4285
  # @return [String]
4209
4286
  attr_accessor :request_id
@@ -4537,8 +4614,7 @@ module Google
4537
4614
  # A generic empty message that you can re-use to avoid defining duplicated empty
4538
4615
  # messages in your APIs. A typical example is to use it as the request or the
4539
4616
  # response type of an API method. For instance: service Foo ` rpc Bar(google.
4540
- # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
4541
- # `Empty` is empty JSON object ````.
4617
+ # protobuf.Empty) returns (google.protobuf.Empty); `
4542
4618
  class GoogleProtobufEmpty
4543
4619
  include Google::Apis::Core::Hashable
4544
4620
 
@@ -4593,11 +4669,11 @@ module Google
4593
4669
  # Represents a whole or partial calendar date, such as a birthday. The time of
4594
4670
  # day and time zone are either specified elsewhere or are insignificant. The
4595
4671
  # date is relative to the Gregorian Calendar. This can represent one of the
4596
- # following: * A full date, with non-zero year, month, and day values * A month
4597
- # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
4598
- # zero month and a zero day * A year and month, with a zero day (e.g., a credit
4599
- # card expiration date) Related types: * google.type.TimeOfDay * google.type.
4600
- # DateTime * google.protobuf.Timestamp
4672
+ # following: * A full date, with non-zero year, month, and day values. * A month
4673
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
4674
+ # with a zero month and a zero day. * A year and month, with a zero day (for
4675
+ # example, a credit card expiration date). Related types: * google.type.
4676
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
4601
4677
  class GoogleTypeDate
4602
4678
  include Google::Apis::Core::Hashable
4603
4679
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2
18
18
  # Version of the google-apis-retail_v2 gem
19
- GEM_VERSION = "0.29.0"
19
+ GEM_VERSION = "0.32.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220217"
25
+ REVISION = "20220319"
26
26
  end
27
27
  end
28
28
  end
@@ -580,6 +580,18 @@ module Google
580
580
  include Google::Apis::Core::JsonObjectSupport
581
581
  end
582
582
 
583
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
584
+ class Representation < Google::Apis::Core::JsonRepresentation; end
585
+
586
+ include Google::Apis::Core::JsonObjectSupport
587
+ end
588
+
589
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
590
+ class Representation < Google::Apis::Core::JsonRepresentation; end
591
+
592
+ include Google::Apis::Core::JsonObjectSupport
593
+ end
594
+
583
595
  class GoogleCloudRetailV2alphaPurgeUserEventsResponse
584
596
  class Representation < Google::Apis::Core::JsonRepresentation; end
585
597
 
@@ -1719,6 +1731,24 @@ module Google
1719
1731
  end
1720
1732
  end
1721
1733
 
1734
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
1735
+ # @private
1736
+ class Representation < Google::Apis::Core::JsonRepresentation
1737
+ property :create_time, as: 'createTime'
1738
+ property :failure_count, :numeric_string => true, as: 'failureCount'
1739
+ property :success_count, :numeric_string => true, as: 'successCount'
1740
+ property :update_time, as: 'updateTime'
1741
+ end
1742
+ end
1743
+
1744
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
1745
+ # @private
1746
+ class Representation < Google::Apis::Core::JsonRepresentation
1747
+ property :purge_count, :numeric_string => true, as: 'purgeCount'
1748
+ collection :purge_sample, as: 'purgeSample'
1749
+ end
1750
+ end
1751
+
1722
1752
  class GoogleCloudRetailV2alphaPurgeUserEventsResponse
1723
1753
  # @private
1724
1754
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -72,10 +72,12 @@ module Google
72
72
  # `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
73
73
  # `OTHER_`, e.g. `OTHER_IPHONE`.
74
74
  # @param [Array<String>, String] language_codes
75
- # The list of languages of the query. This is the BCP-47 language code, such as "
76
- # en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages]
77
- # (https://tools.ietf.org/html/bcp47). The maximum number of allowed characters
78
- # is 255. Only "en-US" is currently supported.
75
+ # The language filters applied to the output suggestions. If set, it should
76
+ # contain the language of the query. If not set, suggestions are returned
77
+ # without considering language restrictions. This is the BCP-47 language code,
78
+ # such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying
79
+ # Languages](https://tools.ietf.org/html/bcp47). The maximum number of language
80
+ # codes is 3.
79
81
  # @param [Fixnum] max_suggestions
80
82
  # Completion max suggestions. If left unset or set to 0, then will fallback to
81
83
  # the configured value CompletionConfig.max_suggestions. The maximum allowed max
@@ -84,12 +86,12 @@ module Google
84
86
  # Required. The query used to generate suggestions. The maximum number of
85
87
  # allowed characters is 255.
86
88
  # @param [String] visitor_id
87
- # A unique identifier for tracking visitors. For example, this could be
88
- # implemented with an HTTP cookie, which should be able to uniquely identify a
89
- # visitor on a single device. This unique identifier should not change if the
90
- # visitor logs in or out of the website. The field must be a UTF-8 encoded
91
- # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
92
- # error is returned.
89
+ # Required field. A unique identifier for tracking visitors. For example, this
90
+ # could be implemented with an HTTP cookie, which should be able to uniquely
91
+ # identify a visitor on a single device. This unique identifier should not
92
+ # change if the visitor logs in or out of the website. The field must be a UTF-8
93
+ # encoded string with a length limit of 128 characters. Otherwise, an
94
+ # INVALID_ARGUMENT error is returned.
93
95
  # @param [String] fields
94
96
  # Selector specifying which fields to include in a partial response.
95
97
  # @param [String] quota_user
@@ -721,9 +723,11 @@ module Google
721
723
  execute_or_queue_command(command, &block)
722
724
  end
723
725
 
724
- # Bulk import of processed completion dataset. Request processing may be
725
- # synchronous. Partial updating is not supported. This feature is only available
726
- # for users who have Retail Search enabled. Please submit a form [here](https://
726
+ # Bulk import of processed completion dataset. Request processing is
727
+ # asynchronous. Partial updating is not supported. The operation is successfully
728
+ # finished only after the imported suggestions are indexed successfully and
729
+ # ready for serving. The process takes hours. This feature is only available for
730
+ # users who have Retail Search enabled. Please submit a form [here](https://
727
731
  # cloud.google.com/contact) to contact cloud sales if you are interested in
728
732
  # using Retail Search.
729
733
  # @param [String] parent
@@ -839,7 +843,8 @@ module Google
839
843
  # Makes a recommendation prediction.
840
844
  # @param [String] placement
841
845
  # Required. Full resource name of the format: `name=projects/*/locations/global/
842
- # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
846
+ # catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
847
+ # catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
843
848
  # placement. Before you can request predictions from your model, you must create
844
849
  # at least one placement for it. For more information, see [Managing placements](
845
850
  # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
@@ -880,9 +885,10 @@ module Google
880
885
  # to contact cloud sales if you are interested in using Retail Search.
881
886
  # @param [String] placement
882
887
  # Required. The resource name of the search engine placement, such as `projects/*
883
- # /locations/global/catalogs/default_catalog/placements/default_search`. This
884
- # field is used to identify the serving configuration name and the set of models
885
- # that will be used to make the search.
888
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
889
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
890
+ # default_serving_config` This field is used to identify the serving
891
+ # configuration name and the set of models that will be used to make the search.
886
892
  # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
887
893
  # @param [String] fields
888
894
  # Selector specifying which fields to include in a partial response.
@@ -913,6 +919,85 @@ module Google
913
919
  execute_or_queue_command(command, &block)
914
920
  end
915
921
 
922
+ # Makes a recommendation prediction.
923
+ # @param [String] placement
924
+ # Required. Full resource name of the format: `name=projects/*/locations/global/
925
+ # catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
926
+ # catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
927
+ # placement. Before you can request predictions from your model, you must create
928
+ # at least one placement for it. For more information, see [Managing placements](
929
+ # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
930
+ # The full list of available placements can be seen at https://console.cloud.
931
+ # google.com/recommendation/catalogs/default_catalog/placements
932
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
933
+ # @param [String] fields
934
+ # Selector specifying which fields to include in a partial response.
935
+ # @param [String] quota_user
936
+ # Available to use for quota purposes for server-side applications. Can be any
937
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
938
+ # @param [Google::Apis::RequestOptions] options
939
+ # Request-specific options
940
+ #
941
+ # @yield [result, err] Result & error if block supplied
942
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse] parsed result object
943
+ # @yieldparam err [StandardError] error object if request failed
944
+ #
945
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse]
946
+ #
947
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
948
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
949
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
950
+ def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
951
+ command = make_simple_command(:post, 'v2/{+placement}:predict', options)
952
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation
953
+ command.request_object = google_cloud_retail_v2_predict_request_object
954
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation
955
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
956
+ command.params['placement'] = placement unless placement.nil?
957
+ command.query['fields'] = fields unless fields.nil?
958
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
959
+ execute_or_queue_command(command, &block)
960
+ end
961
+
962
+ # Performs a search. This feature is only available for users who have Retail
963
+ # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
964
+ # to contact cloud sales if you are interested in using Retail Search.
965
+ # @param [String] placement
966
+ # Required. The resource name of the search engine placement, such as `projects/*
967
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
968
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
969
+ # default_serving_config` This field is used to identify the serving
970
+ # configuration name and the set of models that will be used to make the search.
971
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
972
+ # @param [String] fields
973
+ # Selector specifying which fields to include in a partial response.
974
+ # @param [String] quota_user
975
+ # Available to use for quota purposes for server-side applications. Can be any
976
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
977
+ # @param [Google::Apis::RequestOptions] options
978
+ # Request-specific options
979
+ #
980
+ # @yield [result, err] Result & error if block supplied
981
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse] parsed result object
982
+ # @yieldparam err [StandardError] error object if request failed
983
+ #
984
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse]
985
+ #
986
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
987
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
988
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
989
+ def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
990
+ command = make_simple_command(:post, 'v2/{+placement}:search', options)
991
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation
992
+ command.request_object = google_cloud_retail_v2_search_request_object
993
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation
994
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
995
+ command.params['placement'] = placement unless placement.nil?
996
+ command.query['fields'] = fields unless fields.nil?
997
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
998
+ execute_or_queue_command(command, &block)
999
+ end
1000
+
916
1001
  # Writes a single user event from the browser. This uses a GET request to due to
917
1002
  # browser restriction of POST-ing to a 3rd party domain. This method is used
918
1003
  # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
@@ -1035,13 +1120,14 @@ module Google
1035
1120
  execute_or_queue_command(command, &block)
1036
1121
  end
1037
1122
 
1038
- # Triggers a user event rejoin operation with latest product catalog. Events
1039
- # will not be annotated with detailed product information if product is missing
1040
- # from the catalog at the time the user event is ingested, and these events are
1123
+ # Starts a user event rejoin operation with latest product catalog. Events will
1124
+ # not be annotated with detailed product information if product is missing from
1125
+ # the catalog at the time the user event is ingested, and these events are
1041
1126
  # stored as unjoined events with a limited usage on training and serving. This
1042
- # API can be used to trigger a 'join' operation on specified events with latest
1127
+ # method can be used to start a join operation on specified events with latest
1043
1128
  # version of product catalog. It can also be used to correct events joined with
1044
- # wrong product catalog.
1129
+ # the wrong product catalog. A rejoin operation can take hours or days to
1130
+ # complete.
1045
1131
  # @param [String] parent
1046
1132
  # Required. The parent catalog resource name, such as `projects/1234/locations/
1047
1133
  # global/catalogs/default_catalog`.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.29.0
4
+ version: 0.32.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-02-28 00:00:00.000000000 Z
11
+ date: 2022-03-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.29.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.32.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
63
63
  post_install_message:
64
64
  rdoc_options: []