google-apis-retail_v2alpha 0.31.0 → 0.34.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: 18a029383647d932f09ba42fb43f613584719f77281d2abf7e338ac10da47f34
4
- data.tar.gz: 6099066a25bf39ac050101ad18481004162a9260d36d05920a060740f1247721
3
+ metadata.gz: 82ba0873fffb5177af7796136383999137f3b300d93113a3a7d1079250df1ffb
4
+ data.tar.gz: 6e886f2d384917a8aeb825cfe1e0dd117888eaf1ed5c7ff8bd10a4c7dea8f2d0
5
5
  SHA512:
6
- metadata.gz: 0343de8c7d9410bc18663dc49e6cbecfe5e38862ff97a2d0cafa3e008e6157e7e931c69e51fc4f6106086000c5763642d07c0b16f1c6288b479d82d1bd311b73
7
- data.tar.gz: 2e3b43d5df3a4f68afcea87c3b403fc3c1eb9f4d78d3dc4bb070c6c62ee6047bfb875c47f41a28aeb0fcb64ac87ba20484da4e2e7a09ee5e91674b375df8f06d
6
+ metadata.gz: e5f285306766885d90316c1674eab733c87737d18dc830c879e54eacd7fbb6c4ba19acaac0ee99fa295eb1ce2ed561eaddf39e3d1e3cd425aa15d114c7e43261
7
+ data.tar.gz: e3492014caaee1ebc2cecdd16a23a1b7b279452b13747103861f60620f504d47e82686c9b73ab29b7d0f72ace525825fc7ec99f17b5844b4257169141d6945da
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.34.0 (2022-03-24)
4
+
5
+ * Regenerated from discovery document revision 20220319
6
+
7
+ ### v0.33.0 (2022-03-16)
8
+
9
+ * Regenerated from discovery document revision 20220310
10
+
11
+ ### v0.32.0 (2022-03-09)
12
+
13
+ * Regenerated from discovery document revision 20220303
14
+
3
15
  ### v0.31.0 (2022-03-04)
4
16
 
5
17
  * Regenerated from discovery document revision 20220224
@@ -373,8 +373,7 @@ module Google
373
373
  # @return [String]
374
374
  attr_accessor :notification_pubsub_topic
375
375
 
376
- # Id of the request / operation. This is parroting back the requestId that was
377
- # passed in the request.
376
+ # Deprecated. This field is never set.
378
377
  # Corresponds to the JSON property `requestId`
379
378
  # @return [String]
380
379
  attr_accessor :request_id
@@ -911,7 +910,9 @@ module Google
911
910
  # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
912
911
  # preview. Please contact the support team for importing Google Analytics 4
913
912
  # events. The schema is available here: https://support.google.com/analytics/
914
- # answer/7029846.
913
+ # answer/7029846. Supported values for auto-completion imports: * `suggestions` (
914
+ # default): One JSON completion suggestion per line. * `denylist`: One JSON deny
915
+ # suggestion per line. * `allowlist`: One JSON allow suggestion per line.
915
916
  # Corresponds to the JSON property `dataSchema`
916
917
  # @return [String]
917
918
  attr_accessor :data_schema
@@ -932,11 +933,11 @@ module Google
932
933
  # Represents a whole or partial calendar date, such as a birthday. The time of
933
934
  # day and time zone are either specified elsewhere or are insignificant. The
934
935
  # date is relative to the Gregorian Calendar. This can represent one of the
935
- # following: * A full date, with non-zero year, month, and day values * A month
936
- # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
937
- # zero month and a zero day * A year and month, with a zero day (e.g., a credit
938
- # card expiration date) Related types: * google.type.TimeOfDay * google.type.
939
- # DateTime * google.protobuf.Timestamp
936
+ # following: * A full date, with non-zero year, month, and day values. * A month
937
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
938
+ # with a zero month and a zero day. * A year and month, with a zero day (for
939
+ # example, a credit card expiration date). Related types: * google.type.
940
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
940
941
  # Corresponds to the JSON property `partitionDate`
941
942
  # @return [Google::Apis::RetailV2alpha::GoogleTypeDate]
942
943
  attr_accessor :partition_date
@@ -1123,9 +1124,9 @@ module Google
1123
1124
  class GoogleCloudRetailV2alphaCompleteQueryResponse
1124
1125
  include Google::Apis::Core::Hashable
1125
1126
 
1126
- # A unique complete token. This should be included in the SearchRequest
1127
- # resulting from this completion, which enables accurate attribution of complete
1128
- # model performance.
1127
+ # A unique complete token. This should be included in the UserEvent.
1128
+ # completion_detail for search events resulting from this completion, which
1129
+ # enables accurate attribution of complete model performance.
1129
1130
  # Corresponds to the JSON property `attributionToken`
1130
1131
  # @return [String]
1131
1132
  attr_accessor :attribution_token
@@ -1165,7 +1166,9 @@ module Google
1165
1166
  class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult
1166
1167
  include Google::Apis::Core::Hashable
1167
1168
 
1168
- # Additional custom attributes ingested through BigQuery.
1169
+ # Custom attributes for the suggestion term. * For "user-data", the attributes
1170
+ # are additional custom attributes ingested through BigQuery. * For "cloud-
1171
+ # retail", the attributes are product attributes generated by Cloud Retail.
1169
1172
  # Corresponds to the JSON property `attributes`
1170
1173
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
1171
1174
  attr_accessor :attributes
@@ -1205,6 +1208,103 @@ module Google
1205
1208
  end
1206
1209
  end
1207
1210
 
1211
+ # Catalog level autocomplete config for customers to customize autocomplete
1212
+ # feature's settings.
1213
+ class GoogleCloudRetailV2alphaCompletionConfig
1214
+ include Google::Apis::Core::Hashable
1215
+
1216
+ # The input config source for completion data.
1217
+ # Corresponds to the JSON property `allowlistInputConfig`
1218
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1219
+ attr_accessor :allowlist_input_config
1220
+
1221
+ # If set to true, the auto learning function is enabled. Auto learning uses user
1222
+ # data to generate suggestions using ML techniques. Default value is false. Only
1223
+ # after enabling auto learning can users use `cloud-retail` data in
1224
+ # CompleteQueryRequest.
1225
+ # Corresponds to the JSON property `autoLearning`
1226
+ # @return [Boolean]
1227
+ attr_accessor :auto_learning
1228
+ alias_method :auto_learning?, :auto_learning
1229
+
1230
+ # The input config source for completion data.
1231
+ # Corresponds to the JSON property `denylistInputConfig`
1232
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1233
+ attr_accessor :denylist_input_config
1234
+
1235
+ # Output only. LRO corresponding to the latest allowlist import. Can use
1236
+ # GetOperation API to retrieve the latest state of the Long Running Operation.
1237
+ # Corresponds to the JSON property `lastAllowlistImportOperation`
1238
+ # @return [String]
1239
+ attr_accessor :last_allowlist_import_operation
1240
+
1241
+ # Output only. LRO corresponding to the latest denylist import. Can use
1242
+ # GetOperation API to retrieve the latest state of the Long Running Operation.
1243
+ # Corresponds to the JSON property `lastDenylistImportOperation`
1244
+ # @return [String]
1245
+ attr_accessor :last_denylist_import_operation
1246
+
1247
+ # Output only. Name of the LRO corresponding to the latest suggestion terms list
1248
+ # import. Can use GetOperation API to retrieve the latest state of the Long
1249
+ # Running Operation.
1250
+ # Corresponds to the JSON property `lastSuggestionsImportOperation`
1251
+ # @return [String]
1252
+ attr_accessor :last_suggestions_import_operation
1253
+
1254
+ # Specifies the matching order for autocomplete suggestions, e.g., a query
1255
+ # consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes",
1256
+ # whereas a query of 'red s' with 'exact-prefix' specified would suggest "red
1257
+ # shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default
1258
+ # value: 'exact-prefix'.
1259
+ # Corresponds to the JSON property `matchingOrder`
1260
+ # @return [String]
1261
+ attr_accessor :matching_order
1262
+
1263
+ # The maximum number of autocomplete suggestions returned per term. The maximum
1264
+ # allowed max suggestions is 20. Default value is 20. If left unset or set to 0,
1265
+ # then will fallback to default value.
1266
+ # Corresponds to the JSON property `maxSuggestions`
1267
+ # @return [Fixnum]
1268
+ attr_accessor :max_suggestions
1269
+
1270
+ # The minimum number of characters needed to be typed in order to get
1271
+ # suggestions. Default value is 2. If left unset or set to 0, then will fallback
1272
+ # to default value.
1273
+ # Corresponds to the JSON property `minPrefixLength`
1274
+ # @return [Fixnum]
1275
+ attr_accessor :min_prefix_length
1276
+
1277
+ # Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
1278
+ # completionConfig
1279
+ # Corresponds to the JSON property `name`
1280
+ # @return [String]
1281
+ attr_accessor :name
1282
+
1283
+ # The input config source for completion data.
1284
+ # Corresponds to the JSON property `suggestionsInputConfig`
1285
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1286
+ attr_accessor :suggestions_input_config
1287
+
1288
+ def initialize(**args)
1289
+ update!(**args)
1290
+ end
1291
+
1292
+ # Update properties of this object
1293
+ def update!(**args)
1294
+ @allowlist_input_config = args[:allowlist_input_config] if args.key?(:allowlist_input_config)
1295
+ @auto_learning = args[:auto_learning] if args.key?(:auto_learning)
1296
+ @denylist_input_config = args[:denylist_input_config] if args.key?(:denylist_input_config)
1297
+ @last_allowlist_import_operation = args[:last_allowlist_import_operation] if args.key?(:last_allowlist_import_operation)
1298
+ @last_denylist_import_operation = args[:last_denylist_import_operation] if args.key?(:last_denylist_import_operation)
1299
+ @last_suggestions_import_operation = args[:last_suggestions_import_operation] if args.key?(:last_suggestions_import_operation)
1300
+ @matching_order = args[:matching_order] if args.key?(:matching_order)
1301
+ @max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
1302
+ @min_prefix_length = args[:min_prefix_length] if args.key?(:min_prefix_length)
1303
+ @name = args[:name] if args.key?(:name)
1304
+ @suggestions_input_config = args[:suggestions_input_config] if args.key?(:suggestions_input_config)
1305
+ end
1306
+ end
1307
+
1208
1308
  # The input config source for completion data.
1209
1309
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
1210
1310
  include Google::Apis::Core::Hashable
@@ -1382,6 +1482,14 @@ module Google
1382
1482
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule]
1383
1483
  attr_accessor :rule
1384
1484
 
1485
+ # Required. Specifies the use case for the control. Affects what condition
1486
+ # fields can be set. Only settable by search controls. Will default to
1487
+ # SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
1488
+ # search_solution_use_case per control.
1489
+ # Corresponds to the JSON property `searchSolutionUseCase`
1490
+ # @return [Array<String>]
1491
+ attr_accessor :search_solution_use_case
1492
+
1385
1493
  # Required. Immutable. The solution types that the serving config is used for.
1386
1494
  # Currently we support setting only one type of solution at creation time. Only `
1387
1495
  # SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
@@ -1401,6 +1509,7 @@ module Google
1401
1509
  @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
1402
1510
  @name = args[:name] if args.key?(:name)
1403
1511
  @rule = args[:rule] if args.key?(:rule)
1512
+ @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
1404
1513
  @solution_types = args[:solution_types] if args.key?(:solution_types)
1405
1514
  end
1406
1515
  end
@@ -1668,7 +1777,10 @@ module Google
1668
1777
  end
1669
1778
  end
1670
1779
 
1671
- # Product thumbnail/detail image.
1780
+ # Product image. Recommendations AI and Retail Search do not use product images
1781
+ # to improve prediction and search results. However, product images can be
1782
+ # returned in results, and are shown in prediction or search previews in the
1783
+ # console.
1672
1784
  class GoogleCloudRetailV2alphaImage
1673
1785
  include Google::Apis::Core::Hashable
1674
1786
 
@@ -1798,8 +1910,7 @@ module Google
1798
1910
  # @return [String]
1799
1911
  attr_accessor :notification_pubsub_topic
1800
1912
 
1801
- # Id of the request / operation. This is parroting back the requestId that was
1802
- # passed in the request.
1913
+ # Deprecated. This field is never set.
1803
1914
  # Corresponds to the JSON property `requestId`
1804
1915
  # @return [String]
1805
1916
  attr_accessor :request_id
@@ -1859,11 +1970,7 @@ module Google
1859
1970
  # @return [String]
1860
1971
  attr_accessor :reconciliation_mode
1861
1972
 
1862
- # Unique identifier provided by client, within the ancestor dataset scope.
1863
- # Ensures idempotency and used for request deduplication. Server-generated if
1864
- # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
1865
- # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
1866
- # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
1973
+ # Deprecated. This field has no effect.
1867
1974
  # Corresponds to the JSON property `requestId`
1868
1975
  # @return [String]
1869
1976
  attr_accessor :request_id
@@ -2133,10 +2240,10 @@ module Google
2133
2240
  # key must be a UTF-8 encoded string with a length limit of 32 characters. * The
2134
2241
  # key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or
2135
2242
  # KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or
2136
- # number). * The max number of values per attribute is 10. * For text values,
2137
- # the length limit is 256 UTF-8 characters. * The attribute does not support
2138
- # search. The `searchable` field should be unset or set to false. * The max
2139
- # summed total bytes of custom attribute keys and values per product is 5MiB.
2243
+ # number). * Only 1 value is allowed for each attribute. * For text values, the
2244
+ # length limit is 256 UTF-8 characters. * The attribute does not support search.
2245
+ # The `searchable` field should be unset or set to false. * The max summed total
2246
+ # bytes of custom attribute keys and values per product is 5MiB.
2140
2247
  # Corresponds to the JSON property `attributes`
2141
2248
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
2142
2249
  attr_accessor :attributes
@@ -2260,9 +2367,11 @@ module Google
2260
2367
  # do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "
2261
2368
  # Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-
2262
2369
  # "promotional") * filterOutOfStockItems If your filter blocks all prediction
2263
- # results, nothing will be returned. If you want generic (unfiltered) popular
2264
- # products to be returned instead, set `strictFiltering` to false in `
2265
- # PredictRequest.params`.
2370
+ # results, the API will return generic (unfiltered) popular products. If you
2371
+ # only want results strictly matching the filters, set `strictFiltering` to True
2372
+ # in `PredictRequest.params` to receive empty results instead. Note that the API
2373
+ # will never return items with storageStatus of "EXPIRED" or "DELETED"
2374
+ # regardless of filter choices.
2266
2375
  # Corresponds to the JSON property `filter`
2267
2376
  # @return [String]
2268
2377
  attr_accessor :filter
@@ -2669,7 +2778,7 @@ module Google
2669
2778
  # @return [String]
2670
2779
  attr_accessor :id
2671
2780
 
2672
- # Product images for the product.Highly recommended to put the main image to the
2781
+ # Product images for the product. We highly recommend putting the main image
2673
2782
  # first. A maximum of 300 images are allowed. Corresponding properties: Google
2674
2783
  # Merchant Center property [image_link](https://support.google.com/merchants/
2675
2784
  # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
@@ -3093,6 +3202,115 @@ module Google
3093
3202
  end
3094
3203
  end
3095
3204
 
3205
+ # Metadata related to the progress of the PurgeProducts operation. This will be
3206
+ # returned by the google.longrunning.Operation.metadata field.
3207
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
3208
+ include Google::Apis::Core::Hashable
3209
+
3210
+ # Operation create time.
3211
+ # Corresponds to the JSON property `createTime`
3212
+ # @return [String]
3213
+ attr_accessor :create_time
3214
+
3215
+ # Count of entries that encountered errors while processing.
3216
+ # Corresponds to the JSON property `failureCount`
3217
+ # @return [Fixnum]
3218
+ attr_accessor :failure_count
3219
+
3220
+ # Count of entries that were deleted successfully.
3221
+ # Corresponds to the JSON property `successCount`
3222
+ # @return [Fixnum]
3223
+ attr_accessor :success_count
3224
+
3225
+ # Operation last update time. If the operation is done, this is also the finish
3226
+ # time.
3227
+ # Corresponds to the JSON property `updateTime`
3228
+ # @return [String]
3229
+ attr_accessor :update_time
3230
+
3231
+ def initialize(**args)
3232
+ update!(**args)
3233
+ end
3234
+
3235
+ # Update properties of this object
3236
+ def update!(**args)
3237
+ @create_time = args[:create_time] if args.key?(:create_time)
3238
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
3239
+ @success_count = args[:success_count] if args.key?(:success_count)
3240
+ @update_time = args[:update_time] if args.key?(:update_time)
3241
+ end
3242
+ end
3243
+
3244
+ # Request message for PurgeProducts method.
3245
+ class GoogleCloudRetailV2alphaPurgeProductsRequest
3246
+ include Google::Apis::Core::Hashable
3247
+
3248
+ # Required. The filter string to specify the products to be deleted with a
3249
+ # length limit of 5,000 characters. Empty string filter is not allowed. "*"
3250
+ # implies delete all items in a branch. The eligible fields for filtering are: *
3251
+ # `availability`: Double quoted Product.availability string. * `create_time` :
3252
+ # in ISO 8601 "zulu" format. Supported syntax: * Comparators (">", "<", ">=", "<=
3253
+ # ", "="). Examples: * create_time <= "2015-02-13T17:05:46Z" * availability = "
3254
+ # IN_STOCK” * Conjunctions ("AND") Examples: * create_time <= "2015-02-13T17:05:
3255
+ # 46Z" AND availability = "PREORDER" * Disjunctions ("OR") Examples: *
3256
+ # create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK" * Can
3257
+ # support nested queries. Examples: * (create_time <= "2015-02-13T17:05:46Z" AND
3258
+ # availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND
3259
+ # availability = "IN_STOCK") * Filter Limits: * Filter should not contain more
3260
+ # than 6 conditions. * Max nesting depth should not exceed 2 levels. Examples
3261
+ # queries: * Delete back order products created before a timestamp. create_time <
3262
+ # = "2015-02-13T17:05:46Z" OR availability = "BACKORDER”
3263
+ # Corresponds to the JSON property `filter`
3264
+ # @return [String]
3265
+ attr_accessor :filter
3266
+
3267
+ # Actually perform the purge. If `force` is set to false, the method will return
3268
+ # the expected purge count without deleting any products.
3269
+ # Corresponds to the JSON property `force`
3270
+ # @return [Boolean]
3271
+ attr_accessor :force
3272
+ alias_method :force?, :force
3273
+
3274
+ def initialize(**args)
3275
+ update!(**args)
3276
+ end
3277
+
3278
+ # Update properties of this object
3279
+ def update!(**args)
3280
+ @filter = args[:filter] if args.key?(:filter)
3281
+ @force = args[:force] if args.key?(:force)
3282
+ end
3283
+ end
3284
+
3285
+ # Response of the PurgeProductsRequest. If the long running operation is
3286
+ # successfully done, then this message is returned by the google.longrunning.
3287
+ # Operations.response field.
3288
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
3289
+ include Google::Apis::Core::Hashable
3290
+
3291
+ # The total count of products purged as a result of the operation.
3292
+ # Corresponds to the JSON property `purgeCount`
3293
+ # @return [Fixnum]
3294
+ attr_accessor :purge_count
3295
+
3296
+ # A sample of the product names that will be deleted. Only populated if `force`
3297
+ # is set to false. A max of 100 names will be returned and the names are chosen
3298
+ # at random.
3299
+ # Corresponds to the JSON property `purgeSample`
3300
+ # @return [Array<String>]
3301
+ attr_accessor :purge_sample
3302
+
3303
+ def initialize(**args)
3304
+ update!(**args)
3305
+ end
3306
+
3307
+ # Update properties of this object
3308
+ def update!(**args)
3309
+ @purge_count = args[:purge_count] if args.key?(:purge_count)
3310
+ @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
3311
+ end
3312
+ end
3313
+
3096
3314
  # Request message for PurgeUserEvents method.
3097
3315
  class GoogleCloudRetailV2alphaPurgeUserEventsRequest
3098
3316
  include Google::Apis::Core::Hashable
@@ -3804,12 +4022,13 @@ module Google
3804
4022
  # @return [String]
3805
4023
  attr_accessor :branch
3806
4024
 
3807
- # The filter applied to every search request when quality improvement such as
3808
- # query expansion is needed. For example, if a query does not have enough
3809
- # results, an expanded query with SearchRequest.canonical_filter will be
3810
- # returned as a supplement of the original query. This field is strongly
3811
- # recommended to achieve high search quality. See SearchRequest.filter for more
3812
- # details about filter syntax.
4025
+ # The default filter that is applied when a user performs a search without
4026
+ # checking any filters on the search page. The filter applied to every search
4027
+ # request when quality improvement such as query expansion is needed. For
4028
+ # example, if a query does not have enough results, an expanded query with
4029
+ # SearchRequest.canonical_filter will be returned as a supplement of the
4030
+ # original query. This field is strongly recommended to achieve high search
4031
+ # quality. See SearchRequest.filter for more details about filter syntax.
3813
4032
  # Corresponds to the JSON property `canonicalFilter`
3814
4033
  # @return [String]
3815
4034
  attr_accessor :canonical_filter
@@ -4808,15 +5027,21 @@ module Google
4808
5027
  class GoogleCloudRetailV2alphaUserEvent
4809
5028
  include Google::Apis::Core::Hashable
4810
5029
 
4811
- # Extra user event features to include in the recommendation model. This field
4812
- # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
4813
- # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
4814
- # 000 characters. * For text attributes, at most 400 values are allowed. Empty
4815
- # values are not allowed. Each value must be a UTF-8 encoded string with a
4816
- # length limit of 256 characters. * For number attributes, at most 400 values
4817
- # are allowed. For product recommendation, an example of extra user information
4818
- # is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
4819
- # site by coming to the site directly, or coming through Google search, and etc.
5030
+ # Extra user event features to include in the recommendation model. If you
5031
+ # provide custom attributes for ingested user events, also include them in the
5032
+ # user events that you associate with prediction requests. Custom attribute
5033
+ # formatting must be consistent between imported events and events provided with
5034
+ # prediction requests. This lets the Retail API use those custom attributes when
5035
+ # training models and serving predictions, which helps improve recommendation
5036
+ # quality. This field needs to pass all below criteria, otherwise an
5037
+ # INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string
5038
+ # with a length limit of 5,000 characters. * For text attributes, at most 400
5039
+ # values are allowed. Empty values are not allowed. Each value must be a UTF-8
5040
+ # encoded string with a length limit of 256 characters. * For number attributes,
5041
+ # at most 400 values are allowed. For product recommendations, an example of
5042
+ # extra user information is traffic_channel, which is how a user arrives at the
5043
+ # site. Users can arrive at the site by coming to the site directly, coming
5044
+ # through Google search, or in other ways.
4820
5045
  # Corresponds to the JSON property `attributes`
4821
5046
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
4822
5047
  attr_accessor :attributes
@@ -5351,8 +5576,7 @@ module Google
5351
5576
  # @return [String]
5352
5577
  attr_accessor :notification_pubsub_topic
5353
5578
 
5354
- # Id of the request / operation. This is parroting back the requestId that was
5355
- # passed in the request.
5579
+ # Deprecated. This field is never set.
5356
5580
  # Corresponds to the JSON property `requestId`
5357
5581
  # @return [String]
5358
5582
  attr_accessor :request_id
@@ -5686,8 +5910,7 @@ module Google
5686
5910
  # A generic empty message that you can re-use to avoid defining duplicated empty
5687
5911
  # messages in your APIs. A typical example is to use it as the request or the
5688
5912
  # response type of an API method. For instance: service Foo ` rpc Bar(google.
5689
- # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
5690
- # `Empty` is empty JSON object ````.
5913
+ # protobuf.Empty) returns (google.protobuf.Empty); `
5691
5914
  class GoogleProtobufEmpty
5692
5915
  include Google::Apis::Core::Hashable
5693
5916
 
@@ -5742,11 +5965,11 @@ module Google
5742
5965
  # Represents a whole or partial calendar date, such as a birthday. The time of
5743
5966
  # day and time zone are either specified elsewhere or are insignificant. The
5744
5967
  # date is relative to the Gregorian Calendar. This can represent one of the
5745
- # following: * A full date, with non-zero year, month, and day values * A month
5746
- # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
5747
- # zero month and a zero day * A year and month, with a zero day (e.g., a credit
5748
- # card expiration date) Related types: * google.type.TimeOfDay * google.type.
5749
- # DateTime * google.protobuf.Timestamp
5968
+ # following: * A full date, with non-zero year, month, and day values. * A month
5969
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
5970
+ # with a zero month and a zero day. * A year and month, with a zero day (for
5971
+ # example, a credit card expiration date). Related types: * google.type.
5972
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
5750
5973
  class GoogleTypeDate
5751
5974
  include Google::Apis::Core::Hashable
5752
5975
 
@@ -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.31.0"
19
+ GEM_VERSION = "0.34.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 = "20220224"
25
+ REVISION = "20220319"
26
26
  end
27
27
  end
28
28
  end
@@ -262,6 +262,12 @@ module Google
262
262
  include Google::Apis::Core::JsonObjectSupport
263
263
  end
264
264
 
265
+ class GoogleCloudRetailV2alphaCompletionConfig
266
+ class Representation < Google::Apis::Core::JsonRepresentation; end
267
+
268
+ include Google::Apis::Core::JsonObjectSupport
269
+ end
270
+
265
271
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
266
272
  class Representation < Google::Apis::Core::JsonRepresentation; end
267
273
 
@@ -526,6 +532,24 @@ module Google
526
532
  include Google::Apis::Core::JsonObjectSupport
527
533
  end
528
534
 
535
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
536
+ class Representation < Google::Apis::Core::JsonRepresentation; end
537
+
538
+ include Google::Apis::Core::JsonObjectSupport
539
+ end
540
+
541
+ class GoogleCloudRetailV2alphaPurgeProductsRequest
542
+ class Representation < Google::Apis::Core::JsonRepresentation; end
543
+
544
+ include Google::Apis::Core::JsonObjectSupport
545
+ end
546
+
547
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
548
+ class Representation < Google::Apis::Core::JsonRepresentation; end
549
+
550
+ include Google::Apis::Core::JsonObjectSupport
551
+ end
552
+
529
553
  class GoogleCloudRetailV2alphaPurgeUserEventsRequest
530
554
  class Representation < Google::Apis::Core::JsonRepresentation; end
531
555
 
@@ -1296,6 +1320,26 @@ module Google
1296
1320
  end
1297
1321
  end
1298
1322
 
1323
+ class GoogleCloudRetailV2alphaCompletionConfig
1324
+ # @private
1325
+ class Representation < Google::Apis::Core::JsonRepresentation
1326
+ property :allowlist_input_config, as: 'allowlistInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1327
+
1328
+ property :auto_learning, as: 'autoLearning'
1329
+ property :denylist_input_config, as: 'denylistInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1330
+
1331
+ property :last_allowlist_import_operation, as: 'lastAllowlistImportOperation'
1332
+ property :last_denylist_import_operation, as: 'lastDenylistImportOperation'
1333
+ property :last_suggestions_import_operation, as: 'lastSuggestionsImportOperation'
1334
+ property :matching_order, as: 'matchingOrder'
1335
+ property :max_suggestions, as: 'maxSuggestions'
1336
+ property :min_prefix_length, as: 'minPrefixLength'
1337
+ property :name, as: 'name'
1338
+ property :suggestions_input_config, as: 'suggestionsInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1339
+
1340
+ end
1341
+ end
1342
+
1299
1343
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
1300
1344
  # @private
1301
1345
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1349,6 +1393,7 @@ module Google
1349
1393
  property :name, as: 'name'
1350
1394
  property :rule, as: 'rule', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule::Representation
1351
1395
 
1396
+ collection :search_solution_use_case, as: 'searchSolutionUseCase'
1352
1397
  collection :solution_types, as: 'solutionTypes'
1353
1398
  end
1354
1399
  end
@@ -1757,6 +1802,32 @@ module Google
1757
1802
  end
1758
1803
  end
1759
1804
 
1805
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
1806
+ # @private
1807
+ class Representation < Google::Apis::Core::JsonRepresentation
1808
+ property :create_time, as: 'createTime'
1809
+ property :failure_count, :numeric_string => true, as: 'failureCount'
1810
+ property :success_count, :numeric_string => true, as: 'successCount'
1811
+ property :update_time, as: 'updateTime'
1812
+ end
1813
+ end
1814
+
1815
+ class GoogleCloudRetailV2alphaPurgeProductsRequest
1816
+ # @private
1817
+ class Representation < Google::Apis::Core::JsonRepresentation
1818
+ property :filter, as: 'filter'
1819
+ property :force, as: 'force'
1820
+ end
1821
+ end
1822
+
1823
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
1824
+ # @private
1825
+ class Representation < Google::Apis::Core::JsonRepresentation
1826
+ property :purge_count, :numeric_string => true, as: 'purgeCount'
1827
+ collection :purge_sample, as: 'purgeSample'
1828
+ end
1829
+ end
1830
+
1760
1831
  class GoogleCloudRetailV2alphaPurgeUserEventsRequest
1761
1832
  # @private
1762
1833
  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
@@ -154,6 +156,37 @@ module Google
154
156
  execute_or_queue_command(command, &block)
155
157
  end
156
158
 
159
+ # Gets a CompletionConfig.
160
+ # @param [String] name
161
+ # Required. Full CompletionConfig resource name. Format: projects/`
162
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
163
+ # @param [String] fields
164
+ # Selector specifying which fields to include in a partial response.
165
+ # @param [String] quota_user
166
+ # Available to use for quota purposes for server-side applications. Can be any
167
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
168
+ # @param [Google::Apis::RequestOptions] options
169
+ # Request-specific options
170
+ #
171
+ # @yield [result, err] Result & error if block supplied
172
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] parsed result object
173
+ # @yieldparam err [StandardError] error object if request failed
174
+ #
175
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig]
176
+ #
177
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
178
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
179
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
180
+ def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
181
+ command = make_simple_command(:get, 'v2alpha/{+name}', options)
182
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
183
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
184
+ command.params['name'] = name unless name.nil?
185
+ command.query['fields'] = fields unless fields.nil?
186
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
187
+ execute_or_queue_command(command, &block)
188
+ end
189
+
157
190
  # Get which branch is currently default branch set by CatalogService.
158
191
  # SetDefaultBranch method under a specified parent catalog.
159
192
  # @param [String] catalog
@@ -363,6 +396,46 @@ module Google
363
396
  execute_or_queue_command(command, &block)
364
397
  end
365
398
 
399
+ # Updates the CompletionConfigs.
400
+ # @param [String] name
401
+ # Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
402
+ # completionConfig
403
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] google_cloud_retail_v2alpha_completion_config_object
404
+ # @param [String] update_mask
405
+ # Indicates which fields in the provided CompletionConfig to update. The
406
+ # following are the only supported fields: * CompletionConfig.matching_order *
407
+ # CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length *
408
+ # CompletionConfig.auto_learning If not set, all supported fields are updated.
409
+ # @param [String] fields
410
+ # Selector specifying which fields to include in a partial response.
411
+ # @param [String] quota_user
412
+ # Available to use for quota purposes for server-side applications. Can be any
413
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
414
+ # @param [Google::Apis::RequestOptions] options
415
+ # Request-specific options
416
+ #
417
+ # @yield [result, err] Result & error if block supplied
418
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] parsed result object
419
+ # @yieldparam err [StandardError] error object if request failed
420
+ #
421
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig]
422
+ #
423
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
424
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
425
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
426
+ def update_project_location_catalog_completion_config(name, google_cloud_retail_v2alpha_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
427
+ command = make_simple_command(:patch, 'v2alpha/{+name}', options)
428
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
429
+ command.request_object = google_cloud_retail_v2alpha_completion_config_object
430
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
431
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
432
+ command.params['name'] = name unless name.nil?
433
+ command.query['updateMask'] = update_mask unless update_mask.nil?
434
+ command.query['fields'] = fields unless fields.nil?
435
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
436
+ execute_or_queue_command(command, &block)
437
+ end
438
+
366
439
  # Adds the specified CatalogAttribute to the AttributesConfig. If the
367
440
  # CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
368
441
  # @param [String] attributes_config
@@ -858,6 +931,47 @@ module Google
858
931
  execute_or_queue_command(command, &block)
859
932
  end
860
933
 
934
+ # Permanently deletes all selected Products under a branch. This process is
935
+ # asynchronous. If the request is valid, the removal will be enqueued and
936
+ # processed offline. Depending on the number of Products, this operation could
937
+ # take hours to complete. Before the operation completes, some Products may
938
+ # still be returned by GetProduct or ListProducts. Depending on the number of
939
+ # Products, this operation could take hours to complete. To get a sample of
940
+ # Products that would be deleted, set PurgeProductsRequest.force to false.
941
+ # @param [String] parent
942
+ # Required. The resource name of the branch under which the products are created.
943
+ # The format is `projects/$`projectId`/locations/global/catalogs/$`catalogId`/
944
+ # branches/$`branchId``
945
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest] google_cloud_retail_v2alpha_purge_products_request_object
946
+ # @param [String] fields
947
+ # Selector specifying which fields to include in a partial response.
948
+ # @param [String] quota_user
949
+ # Available to use for quota purposes for server-side applications. Can be any
950
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
951
+ # @param [Google::Apis::RequestOptions] options
952
+ # Request-specific options
953
+ #
954
+ # @yield [result, err] Result & error if block supplied
955
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
956
+ # @yieldparam err [StandardError] error object if request failed
957
+ #
958
+ # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
959
+ #
960
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
961
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
962
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
963
+ def purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
964
+ command = make_simple_command(:post, 'v2alpha/{+parent}/products:purge', options)
965
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest::Representation
966
+ command.request_object = google_cloud_retail_v2alpha_purge_products_request_object
967
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
968
+ command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
969
+ command.params['parent'] = parent unless parent.nil?
970
+ command.query['fields'] = fields unless fields.nil?
971
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
972
+ execute_or_queue_command(command, &block)
973
+ end
974
+
861
975
  # Incrementally removes place IDs from a Product.fulfillment_info.place_ids.
862
976
  # This process is asynchronous and does not require the Product to exist before
863
977
  # updating fulfillment information. If the request is valid, the update will be
@@ -998,9 +1112,11 @@ module Google
998
1112
  execute_or_queue_command(command, &block)
999
1113
  end
1000
1114
 
1001
- # Bulk import of processed completion dataset. Request processing may be
1002
- # synchronous. Partial updating is not supported. This feature is only available
1003
- # for users who have Retail Search enabled. Please submit a form [here](https://
1115
+ # Bulk import of processed completion dataset. Request processing is
1116
+ # asynchronous. Partial updating is not supported. The operation is successfully
1117
+ # finished only after the imported suggestions are indexed successfully and
1118
+ # ready for serving. The process takes hours. This feature is only available for
1119
+ # users who have Retail Search enabled. Please submit a form [here](https://
1004
1120
  # cloud.google.com/contact) to contact cloud sales if you are interested in
1005
1121
  # using Retail Search.
1006
1122
  # @param [String] parent
@@ -1307,7 +1423,8 @@ module Google
1307
1423
  # Makes a recommendation prediction.
1308
1424
  # @param [String] placement
1309
1425
  # Required. Full resource name of the format: `name=projects/*/locations/global/
1310
- # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
1426
+ # catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
1427
+ # catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
1311
1428
  # placement. Before you can request predictions from your model, you must create
1312
1429
  # at least one placement for it. For more information, see [Managing placements](
1313
1430
  # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
@@ -1348,9 +1465,10 @@ module Google
1348
1465
  # to contact cloud sales if you are interested in using Retail Search.
1349
1466
  # @param [String] placement
1350
1467
  # Required. The resource name of the search engine placement, such as `projects/*
1351
- # /locations/global/catalogs/default_catalog/placements/default_search`. This
1352
- # field is used to identify the serving configuration name and the set of models
1353
- # that will be used to make the search.
1468
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
1469
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1470
+ # default_serving_config` This field is used to identify the serving
1471
+ # configuration name and the set of models that will be used to make the search.
1354
1472
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1355
1473
  # @param [String] fields
1356
1474
  # Selector specifying which fields to include in a partial response.
@@ -1605,6 +1723,46 @@ module Google
1605
1723
  execute_or_queue_command(command, &block)
1606
1724
  end
1607
1725
 
1726
+ # Makes a recommendation prediction.
1727
+ # @param [String] placement
1728
+ # Required. Full resource name of the format: `name=projects/*/locations/global/
1729
+ # catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
1730
+ # catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
1731
+ # placement. Before you can request predictions from your model, you must create
1732
+ # at least one placement for it. For more information, see [Managing placements](
1733
+ # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
1734
+ # The full list of available placements can be seen at https://console.cloud.
1735
+ # google.com/recommendation/catalogs/default_catalog/placements
1736
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
1737
+ # @param [String] fields
1738
+ # Selector specifying which fields to include in a partial response.
1739
+ # @param [String] quota_user
1740
+ # Available to use for quota purposes for server-side applications. Can be any
1741
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1742
+ # @param [Google::Apis::RequestOptions] options
1743
+ # Request-specific options
1744
+ #
1745
+ # @yield [result, err] Result & error if block supplied
1746
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse] parsed result object
1747
+ # @yieldparam err [StandardError] error object if request failed
1748
+ #
1749
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse]
1750
+ #
1751
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1752
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1753
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1754
+ def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1755
+ command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
1756
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
1757
+ command.request_object = google_cloud_retail_v2alpha_predict_request_object
1758
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
1759
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
1760
+ command.params['placement'] = placement unless placement.nil?
1761
+ command.query['fields'] = fields unless fields.nil?
1762
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1763
+ execute_or_queue_command(command, &block)
1764
+ end
1765
+
1608
1766
  # Disables a Control on the specified ServingConfig. The control is removed from
1609
1767
  # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
1610
1768
  # the ServingConfig.
@@ -1642,6 +1800,45 @@ module Google
1642
1800
  execute_or_queue_command(command, &block)
1643
1801
  end
1644
1802
 
1803
+ # Performs a search. This feature is only available for users who have Retail
1804
+ # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
1805
+ # to contact cloud sales if you are interested in using Retail Search.
1806
+ # @param [String] placement
1807
+ # Required. The resource name of the search engine placement, such as `projects/*
1808
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
1809
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1810
+ # default_serving_config` This field is used to identify the serving
1811
+ # configuration name and the set of models that will be used to make the search.
1812
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1813
+ # @param [String] fields
1814
+ # Selector specifying which fields to include in a partial response.
1815
+ # @param [String] quota_user
1816
+ # Available to use for quota purposes for server-side applications. Can be any
1817
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1818
+ # @param [Google::Apis::RequestOptions] options
1819
+ # Request-specific options
1820
+ #
1821
+ # @yield [result, err] Result & error if block supplied
1822
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse] parsed result object
1823
+ # @yieldparam err [StandardError] error object if request failed
1824
+ #
1825
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse]
1826
+ #
1827
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1828
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1829
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1830
+ def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1831
+ command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
1832
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
1833
+ command.request_object = google_cloud_retail_v2alpha_search_request_object
1834
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
1835
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
1836
+ command.params['placement'] = placement unless placement.nil?
1837
+ command.query['fields'] = fields unless fields.nil?
1838
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1839
+ execute_or_queue_command(command, &block)
1840
+ end
1841
+
1645
1842
  # Writes a single user event from the browser. This uses a GET request to due to
1646
1843
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1647
1844
  # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
@@ -1764,13 +1961,14 @@ module Google
1764
1961
  execute_or_queue_command(command, &block)
1765
1962
  end
1766
1963
 
1767
- # Triggers a user event rejoin operation with latest product catalog. Events
1768
- # will not be annotated with detailed product information if product is missing
1769
- # from the catalog at the time the user event is ingested, and these events are
1964
+ # Starts a user event rejoin operation with latest product catalog. Events will
1965
+ # not be annotated with detailed product information if product is missing from
1966
+ # the catalog at the time the user event is ingested, and these events are
1770
1967
  # stored as unjoined events with a limited usage on training and serving. This
1771
- # API can be used to trigger a 'join' operation on specified events with latest
1968
+ # method can be used to start a join operation on specified events with latest
1772
1969
  # version of product catalog. It can also be used to correct events joined with
1773
- # wrong product catalog.
1970
+ # the wrong product catalog. A rejoin operation can take hours or days to
1971
+ # complete.
1774
1972
  # @param [String] parent
1775
1973
  # Required. The parent catalog resource name, such as `projects/1234/locations/
1776
1974
  # global/catalogs/default_catalog`.
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.31.0
4
+ version: 0.34.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-03-07 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_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.31.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.34.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: []