google-apis-retail_v2alpha 0.33.0 → 0.36.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: 28c4b9d5bc9ab2434afee8a37fc05065f33e4c1f877cdbc49c66842ce818531d
4
- data.tar.gz: 586c391c1b0770ee1add05161217fa51b71fe15949f03c489c0d15a1cd861ffd
3
+ metadata.gz: fded543728d24f668d94eab627257d7b2b4b35bfa5040463ebe7b947814cc445
4
+ data.tar.gz: 398dab6a6d9156d5744f23b56fc5b4f8df10f80e8ddb9e85b92936a9fb1c55d5
5
5
  SHA512:
6
- metadata.gz: 8c6f8ac592b5a64f5ddd5611412c337c6230aa21dd2e03613ff379f286a7dd7bae87131dad3a07fa0ffcf180381e99f46d34c3490587c921f2353044bfe5fa0a
7
- data.tar.gz: 7a129795a38abcc73706846069990a9bae357a873e339f907ec2d75b82b53f156476b25092bf345a931d4501491f3a9d349087a3486c027910ef9661881614b3
6
+ metadata.gz: 0b5d043eb964f4b1f4a420c0637f14a3e8e4c67f1fee378fc5789d5767ae440f86ce130c760a7df96635e26f6fd8064df8990a97d3dc8217f1bcf296e91a6b14
7
+ data.tar.gz: a2ccb8df5765151de59180404029c918fafb267dadadc647aa12a1344dee448a1fb966c9178a94a79285763e999177cbe614d9c70d48de78be6419d78541ebd3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.36.0 (2022-04-14)
4
+
5
+ * Regenerated from discovery document revision 20220408
6
+
7
+ ### v0.35.0 (2022-03-31)
8
+
9
+ * Regenerated from discovery document revision 20220324
10
+
11
+ ### v0.34.0 (2022-03-24)
12
+
13
+ * Regenerated from discovery document revision 20220319
14
+
3
15
  ### v0.33.0 (2022-03-16)
4
16
 
5
17
  * Regenerated from discovery document revision 20220310
@@ -308,6 +308,35 @@ module Google
308
308
  end
309
309
  end
310
310
 
311
+ # Metadata related to the progress of the AddLocalInventories operation.
312
+ # Currently empty because there is no meaningful metadata populated from the
313
+ # AddLocalInventories method.
314
+ class GoogleCloudRetailV2AddLocalInventoriesMetadata
315
+ include Google::Apis::Core::Hashable
316
+
317
+ def initialize(**args)
318
+ update!(**args)
319
+ end
320
+
321
+ # Update properties of this object
322
+ def update!(**args)
323
+ end
324
+ end
325
+
326
+ # Response of the AddLocalInventories API. Currently empty because there is no
327
+ # meaningful response populated from the AddLocalInventories method.
328
+ class GoogleCloudRetailV2AddLocalInventoriesResponse
329
+ include Google::Apis::Core::Hashable
330
+
331
+ def initialize(**args)
332
+ update!(**args)
333
+ end
334
+
335
+ # Update properties of this object
336
+ def update!(**args)
337
+ end
338
+ end
339
+
311
340
  # Response of the ImportCompletionDataRequest. If the long running operation is
312
341
  # done, this message is returned by the google.longrunning.Operations.response
313
342
  # field if the operation is successful.
@@ -373,8 +402,7 @@ module Google
373
402
  # @return [String]
374
403
  attr_accessor :notification_pubsub_topic
375
404
 
376
- # Id of the request / operation. This is parroting back the requestId that was
377
- # passed in the request.
405
+ # Deprecated. This field is never set.
378
406
  # Corresponds to the JSON property `requestId`
379
407
  # @return [String]
380
408
  attr_accessor :request_id
@@ -562,6 +590,35 @@ module Google
562
590
  end
563
591
  end
564
592
 
593
+ # Metadata related to the progress of the RemoveLocalInventories operation.
594
+ # Currently empty because there is no meaningful metadata populated from the
595
+ # RemoveLocalInventories method.
596
+ class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
597
+ include Google::Apis::Core::Hashable
598
+
599
+ def initialize(**args)
600
+ update!(**args)
601
+ end
602
+
603
+ # Update properties of this object
604
+ def update!(**args)
605
+ end
606
+ end
607
+
608
+ # Response of the RemoveLocalInventories API. Currently empty because there is
609
+ # no meaningful response populated from the RemoveLocalInventories method.
610
+ class GoogleCloudRetailV2RemoveLocalInventoriesResponse
611
+ include Google::Apis::Core::Hashable
612
+
613
+ def initialize(**args)
614
+ update!(**args)
615
+ end
616
+
617
+ # Update properties of this object
618
+ def update!(**args)
619
+ end
620
+ end
621
+
565
622
  # Metadata related to the progress of the SetInventory operation. Currently
566
623
  # empty because there is no meaningful metadata populated from the SetInventory
567
624
  # method.
@@ -911,7 +968,9 @@ module Google
911
968
  # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
912
969
  # preview. Please contact the support team for importing Google Analytics 4
913
970
  # events. The schema is available here: https://support.google.com/analytics/
914
- # answer/7029846.
971
+ # answer/7029846. Supported values for auto-completion imports: * `suggestions` (
972
+ # default): One JSON completion suggestion per line. * `denylist`: One JSON deny
973
+ # suggestion per line. * `allowlist`: One JSON allow suggestion per line.
915
974
  # Corresponds to the JSON property `dataSchema`
916
975
  # @return [String]
917
976
  attr_accessor :data_schema
@@ -1123,9 +1182,9 @@ module Google
1123
1182
  class GoogleCloudRetailV2alphaCompleteQueryResponse
1124
1183
  include Google::Apis::Core::Hashable
1125
1184
 
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.
1185
+ # A unique complete token. This should be included in the UserEvent.
1186
+ # completion_detail for search events resulting from this completion, which
1187
+ # enables accurate attribution of complete model performance.
1129
1188
  # Corresponds to the JSON property `attributionToken`
1130
1189
  # @return [String]
1131
1190
  attr_accessor :attribution_token
@@ -1165,7 +1224,9 @@ module Google
1165
1224
  class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult
1166
1225
  include Google::Apis::Core::Hashable
1167
1226
 
1168
- # Additional custom attributes ingested through BigQuery.
1227
+ # Custom attributes for the suggestion term. * For "user-data", the attributes
1228
+ # are additional custom attributes ingested through BigQuery. * For "cloud-
1229
+ # retail", the attributes are product attributes generated by Cloud Retail.
1169
1230
  # Corresponds to the JSON property `attributes`
1170
1231
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
1171
1232
  attr_accessor :attributes
@@ -1205,6 +1266,103 @@ module Google
1205
1266
  end
1206
1267
  end
1207
1268
 
1269
+ # Catalog level autocomplete config for customers to customize autocomplete
1270
+ # feature's settings.
1271
+ class GoogleCloudRetailV2alphaCompletionConfig
1272
+ include Google::Apis::Core::Hashable
1273
+
1274
+ # The input config source for completion data.
1275
+ # Corresponds to the JSON property `allowlistInputConfig`
1276
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1277
+ attr_accessor :allowlist_input_config
1278
+
1279
+ # If set to true, the auto learning function is enabled. Auto learning uses user
1280
+ # data to generate suggestions using ML techniques. Default value is false. Only
1281
+ # after enabling auto learning can users use `cloud-retail` data in
1282
+ # CompleteQueryRequest.
1283
+ # Corresponds to the JSON property `autoLearning`
1284
+ # @return [Boolean]
1285
+ attr_accessor :auto_learning
1286
+ alias_method :auto_learning?, :auto_learning
1287
+
1288
+ # The input config source for completion data.
1289
+ # Corresponds to the JSON property `denylistInputConfig`
1290
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1291
+ attr_accessor :denylist_input_config
1292
+
1293
+ # Output only. LRO corresponding to the latest allowlist import. Can use
1294
+ # GetOperation API to retrieve the latest state of the Long Running Operation.
1295
+ # Corresponds to the JSON property `lastAllowlistImportOperation`
1296
+ # @return [String]
1297
+ attr_accessor :last_allowlist_import_operation
1298
+
1299
+ # Output only. LRO corresponding to the latest denylist import. Can use
1300
+ # GetOperation API to retrieve the latest state of the Long Running Operation.
1301
+ # Corresponds to the JSON property `lastDenylistImportOperation`
1302
+ # @return [String]
1303
+ attr_accessor :last_denylist_import_operation
1304
+
1305
+ # Output only. Name of the LRO corresponding to the latest suggestion terms list
1306
+ # import. Can use GetOperation API to retrieve the latest state of the Long
1307
+ # Running Operation.
1308
+ # Corresponds to the JSON property `lastSuggestionsImportOperation`
1309
+ # @return [String]
1310
+ attr_accessor :last_suggestions_import_operation
1311
+
1312
+ # Specifies the matching order for autocomplete suggestions, e.g., a query
1313
+ # consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes",
1314
+ # whereas a query of 'red s' with 'exact-prefix' specified would suggest "red
1315
+ # shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default
1316
+ # value: 'exact-prefix'.
1317
+ # Corresponds to the JSON property `matchingOrder`
1318
+ # @return [String]
1319
+ attr_accessor :matching_order
1320
+
1321
+ # The maximum number of autocomplete suggestions returned per term. The maximum
1322
+ # allowed max suggestions is 20. Default value is 20. If left unset or set to 0,
1323
+ # then will fallback to default value.
1324
+ # Corresponds to the JSON property `maxSuggestions`
1325
+ # @return [Fixnum]
1326
+ attr_accessor :max_suggestions
1327
+
1328
+ # The minimum number of characters needed to be typed in order to get
1329
+ # suggestions. Default value is 2. If left unset or set to 0, then will fallback
1330
+ # to default value.
1331
+ # Corresponds to the JSON property `minPrefixLength`
1332
+ # @return [Fixnum]
1333
+ attr_accessor :min_prefix_length
1334
+
1335
+ # Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
1336
+ # completionConfig
1337
+ # Corresponds to the JSON property `name`
1338
+ # @return [String]
1339
+ attr_accessor :name
1340
+
1341
+ # The input config source for completion data.
1342
+ # Corresponds to the JSON property `suggestionsInputConfig`
1343
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig]
1344
+ attr_accessor :suggestions_input_config
1345
+
1346
+ def initialize(**args)
1347
+ update!(**args)
1348
+ end
1349
+
1350
+ # Update properties of this object
1351
+ def update!(**args)
1352
+ @allowlist_input_config = args[:allowlist_input_config] if args.key?(:allowlist_input_config)
1353
+ @auto_learning = args[:auto_learning] if args.key?(:auto_learning)
1354
+ @denylist_input_config = args[:denylist_input_config] if args.key?(:denylist_input_config)
1355
+ @last_allowlist_import_operation = args[:last_allowlist_import_operation] if args.key?(:last_allowlist_import_operation)
1356
+ @last_denylist_import_operation = args[:last_denylist_import_operation] if args.key?(:last_denylist_import_operation)
1357
+ @last_suggestions_import_operation = args[:last_suggestions_import_operation] if args.key?(:last_suggestions_import_operation)
1358
+ @matching_order = args[:matching_order] if args.key?(:matching_order)
1359
+ @max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
1360
+ @min_prefix_length = args[:min_prefix_length] if args.key?(:min_prefix_length)
1361
+ @name = args[:name] if args.key?(:name)
1362
+ @suggestions_input_config = args[:suggestions_input_config] if args.key?(:suggestions_input_config)
1363
+ end
1364
+ end
1365
+
1208
1366
  # The input config source for completion data.
1209
1367
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
1210
1368
  include Google::Apis::Core::Hashable
@@ -1382,14 +1540,6 @@ module Google
1382
1540
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule]
1383
1541
  attr_accessor :rule
1384
1542
 
1385
- # Required. Specifies the use case for the control. Affects what condition
1386
- # fields can be set. Only settable by search controls. Will default to
1387
- # SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
1388
- # search_solution_use_case per control.
1389
- # Corresponds to the JSON property `searchSolutionUseCase`
1390
- # @return [Array<String>]
1391
- attr_accessor :search_solution_use_case
1392
-
1393
1543
  # Required. Immutable. The solution types that the serving config is used for.
1394
1544
  # Currently we support setting only one type of solution at creation time. Only `
1395
1545
  # SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
@@ -1409,7 +1559,6 @@ module Google
1409
1559
  @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
1410
1560
  @name = args[:name] if args.key?(:name)
1411
1561
  @rule = args[:rule] if args.key?(:rule)
1412
- @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
1413
1562
  @solution_types = args[:solution_types] if args.key?(:solution_types)
1414
1563
  end
1415
1564
  end
@@ -1810,8 +1959,7 @@ module Google
1810
1959
  # @return [String]
1811
1960
  attr_accessor :notification_pubsub_topic
1812
1961
 
1813
- # Id of the request / operation. This is parroting back the requestId that was
1814
- # passed in the request.
1962
+ # Deprecated. This field is never set.
1815
1963
  # Corresponds to the JSON property `requestId`
1816
1964
  # @return [String]
1817
1965
  attr_accessor :request_id
@@ -1871,11 +2019,7 @@ module Google
1871
2019
  # @return [String]
1872
2020
  attr_accessor :reconciliation_mode
1873
2021
 
1874
- # Unique identifier provided by client, within the ancestor dataset scope.
1875
- # Ensures idempotency and used for request deduplication. Server-generated if
1876
- # unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
1877
- # 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
1878
- # when ImportProductsRequest.reconciliation_mode is set to `FULL`.
2022
+ # Deprecated. This field has no effect.
1879
2023
  # Corresponds to the JSON property `requestId`
1880
2024
  # @return [String]
1881
2025
  attr_accessor :request_id
@@ -2153,6 +2297,18 @@ module Google
2153
2297
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
2154
2298
  attr_accessor :attributes
2155
2299
 
2300
+ # Input only. Supported fulfillment types. Valid fulfillment type values include
2301
+ # commonly used types (such as pickup in store and same day delivery), and
2302
+ # custom types. Customers have to map custom types to their display names before
2303
+ # rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-
2304
+ # day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "
2305
+ # custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an
2306
+ # invalid value other than these, an INVALID_ARGUMENT error is returned. All the
2307
+ # elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
2308
+ # Corresponds to the JSON property `fulfillmentTypes`
2309
+ # @return [Array<String>]
2310
+ attr_accessor :fulfillment_types
2311
+
2156
2312
  # The place ID for the current set of inventory information.
2157
2313
  # Corresponds to the JSON property `placeId`
2158
2314
  # @return [String]
@@ -2170,6 +2326,7 @@ module Google
2170
2326
  # Update properties of this object
2171
2327
  def update!(**args)
2172
2328
  @attributes = args[:attributes] if args.key?(:attributes)
2329
+ @fulfillment_types = args[:fulfillment_types] if args.key?(:fulfillment_types)
2173
2330
  @place_id = args[:place_id] if args.key?(:place_id)
2174
2331
  @price_info = args[:price_info] if args.key?(:price_info)
2175
2332
  end
@@ -2202,7 +2359,8 @@ module Google
2202
2359
  # Language of the title/description and other string attributes. Use language
2203
2360
  # tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO
2204
2361
  # 639-1. This specifies the language of offers in Merchant Center that will be
2205
- # accepted. If empty no language filtering will be performed.
2362
+ # accepted. If empty no language filtering will be performed. Example value: `en`
2363
+ # .
2206
2364
  # Corresponds to the JSON property `languageCode`
2207
2365
  # @return [String]
2208
2366
  attr_accessor :language_code
@@ -2987,13 +3145,13 @@ module Google
2987
3145
  # The type of Products allowed to be ingested into the catalog. Acceptable
2988
3146
  # values are: * `primary` (default): You can ingest Products of all types. When
2989
3147
  # ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
2990
- # `variant`: You can only ingest Product.Type.VARIANT Products. This means
2991
- # Product.primary_product_id cannot be empty. If this field is set to an invalid
2992
- # value other than these, an INVALID_ARGUMENT error is returned. If this field
2993
- # is `variant` and merchant_center_product_id_field is `itemGroupId`, an
2994
- # INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
2995
- # google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
2996
- # details.
3148
+ # `variant` (incompatible with Retail Search): You can only ingest Product.Type.
3149
+ # VARIANT Products. This means Product.primary_product_id cannot be empty. If
3150
+ # this field is set to an invalid value other than these, an INVALID_ARGUMENT
3151
+ # error is returned. If this field is `variant` and
3152
+ # merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error
3153
+ # is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#
3154
+ # product-levels) for more details.
2997
3155
  # Corresponds to the JSON property `ingestionProductType`
2998
3156
  # @return [String]
2999
3157
  attr_accessor :ingestion_product_type
@@ -3006,8 +3164,8 @@ module Google
3006
3164
  # the item group. If this field is set to an invalid value other than these, an
3007
3165
  # INVALID_ARGUMENT error is returned. If this field is `itemGroupId` and
3008
3166
  # ingestion_product_type is `variant`, an INVALID_ARGUMENT error is returned.
3009
- # See [Using product levels](https://cloud.google.com/retail/recommendations-ai/
3010
- # docs/catalog#product-levels) for more details.
3167
+ # See [Product levels](https://cloud.google.com/retail/docs/catalog#product-
3168
+ # levels) for more details.
3011
3169
  # Corresponds to the JSON property `merchantCenterProductIdField`
3012
3170
  # @return [String]
3013
3171
  attr_accessor :merchant_center_product_id_field
@@ -3156,7 +3314,7 @@ module Google
3156
3314
  # `availability`: Double quoted Product.availability string. * `create_time` :
3157
3315
  # in ISO 8601 "zulu" format. Supported syntax: * Comparators (">", "<", ">=", "<=
3158
3316
  # ", "="). Examples: * create_time <= "2015-02-13T17:05:46Z" * availability = "
3159
- # IN_STOCK * Conjunctions ("AND") Examples: * create_time <= "2015-02-13T17:05:
3317
+ # IN_STOCK" * Conjunctions ("AND") Examples: * create_time <= "2015-02-13T17:05:
3160
3318
  # 46Z" AND availability = "PREORDER" * Disjunctions ("OR") Examples: *
3161
3319
  # create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK" * Can
3162
3320
  # support nested queries. Examples: * (create_time <= "2015-02-13T17:05:46Z" AND
@@ -3164,7 +3322,7 @@ module Google
3164
3322
  # availability = "IN_STOCK") * Filter Limits: * Filter should not contain more
3165
3323
  # than 6 conditions. * Max nesting depth should not exceed 2 levels. Examples
3166
3324
  # queries: * Delete back order products created before a timestamp. create_time <
3167
- # = "2015-02-13T17:05:46Z" OR availability = "BACKORDER
3325
+ # = "2015-02-13T17:05:46Z" OR availability = "BACKORDER"
3168
3326
  # Corresponds to the JSON property `filter`
3169
3327
  # @return [String]
3170
3328
  attr_accessor :filter
@@ -4008,7 +4166,8 @@ module Google
4008
4166
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec]
4009
4167
  attr_accessor :personalization_spec
4010
4168
 
4011
- # Raw search query.
4169
+ # Raw search query. If this field is empty, the request is considered a category
4170
+ # browsing request and returned results are based on filter and page_categories.
4012
4171
  # Corresponds to the JSON property `query`
4013
4172
  # @return [String]
4014
4173
  attr_accessor :query
@@ -5114,10 +5273,12 @@ module Google
5114
5273
  # Required. A unique identifier for tracking visitors. For example, this could
5115
5274
  # be implemented with an HTTP cookie, which should be able to uniquely identify
5116
5275
  # a visitor on a single device. This unique identifier should not change if the
5117
- # visitor log in/out of the website. The field must be a UTF-8 encoded string
5118
- # with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
5119
- # returned. The field should not contain PII or user-data. We recommend to use
5120
- # Google Analystics [Client ID](https://developers.google.com/analytics/
5276
+ # visitor log in/out of the website. Don't set the field to the same fixed ID
5277
+ # for different users. This mixes the event history of those users together,
5278
+ # which results in degraded model quality. The field must be a UTF-8 encoded
5279
+ # string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
5280
+ # error is returned. The field should not contain PII or user-data. We recommend
5281
+ # to use Google Analystics [Client ID](https://developers.google.com/analytics/
5121
5282
  # devguides/collection/analyticsjs/field-reference#clientId) for this field.
5122
5283
  # Corresponds to the JSON property `visitorId`
5123
5284
  # @return [String]
@@ -5244,13 +5405,12 @@ module Google
5244
5405
  attr_accessor :direct_user_request
5245
5406
  alias_method :direct_user_request?, :direct_user_request
5246
5407
 
5247
- # The end user's IP address. Required for getting SearchResponse.
5248
- # sponsored_results. This field is used to extract location information for
5249
- # personalization. This field must be either an IPv4 address (e.g. "104.133.9.80"
5250
- # ) or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334").
5251
- # Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when
5252
- # using the JavaScript tag in UserEventService.CollectUserEvent or if
5253
- # direct_user_request is set.
5408
+ # The end user's IP address. This field is used to extract location information
5409
+ # for personalization. This field must be either an IPv4 address (e.g. "104.133.
5410
+ # 9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334").
5411
+ # Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when:
5412
+ # * setting SearchRequest.user_info. * using the JavaScript tag in
5413
+ # UserEventService.CollectUserEvent or if direct_user_request is set.
5254
5414
  # Corresponds to the JSON property `ipAddress`
5255
5415
  # @return [String]
5256
5416
  attr_accessor :ip_address
@@ -5266,7 +5426,10 @@ module Google
5266
5426
  attr_accessor :user_agent
5267
5427
 
5268
5428
  # Highly recommended for logged-in users. Unique identifier for logged-in user,
5269
- # such as a user name. The field must be a UTF-8 encoded string with a length
5429
+ # such as a user name. Don't set for anonymous users. Always use a hashed value
5430
+ # for this ID. Don't set the field to the same fixed ID for different users.
5431
+ # This mixes the event history of those users together, which results in
5432
+ # degraded model quality. The field must be a UTF-8 encoded string with a length
5270
5433
  # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5271
5434
  # Corresponds to the JSON property `userId`
5272
5435
  # @return [String]
@@ -5314,6 +5477,35 @@ module Google
5314
5477
  end
5315
5478
  end
5316
5479
 
5480
+ # Metadata related to the progress of the AddLocalInventories operation.
5481
+ # Currently empty because there is no meaningful metadata populated from the
5482
+ # AddLocalInventories method.
5483
+ class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
5484
+ include Google::Apis::Core::Hashable
5485
+
5486
+ def initialize(**args)
5487
+ update!(**args)
5488
+ end
5489
+
5490
+ # Update properties of this object
5491
+ def update!(**args)
5492
+ end
5493
+ end
5494
+
5495
+ # Response of the AddLocalInventories API. Currently empty because there is no
5496
+ # meaningful response populated from the AddLocalInventories method.
5497
+ class GoogleCloudRetailV2betaAddLocalInventoriesResponse
5498
+ include Google::Apis::Core::Hashable
5499
+
5500
+ def initialize(**args)
5501
+ update!(**args)
5502
+ end
5503
+
5504
+ # Update properties of this object
5505
+ def update!(**args)
5506
+ end
5507
+ end
5508
+
5317
5509
  # Configuration of destination for Export related errors.
5318
5510
  class GoogleCloudRetailV2betaExportErrorsConfig
5319
5511
  include Google::Apis::Core::Hashable
@@ -5481,8 +5673,7 @@ module Google
5481
5673
  # @return [String]
5482
5674
  attr_accessor :notification_pubsub_topic
5483
5675
 
5484
- # Id of the request / operation. This is parroting back the requestId that was
5485
- # passed in the request.
5676
+ # Deprecated. This field is never set.
5486
5677
  # Corresponds to the JSON property `requestId`
5487
5678
  # @return [String]
5488
5679
  attr_accessor :request_id
@@ -5670,6 +5861,35 @@ module Google
5670
5861
  end
5671
5862
  end
5672
5863
 
5864
+ # Metadata related to the progress of the RemoveLocalInventories operation.
5865
+ # Currently empty because there is no meaningful metadata populated from the
5866
+ # RemoveLocalInventories method.
5867
+ class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
5868
+ include Google::Apis::Core::Hashable
5869
+
5870
+ def initialize(**args)
5871
+ update!(**args)
5872
+ end
5873
+
5874
+ # Update properties of this object
5875
+ def update!(**args)
5876
+ end
5877
+ end
5878
+
5879
+ # Response of the RemoveLocalInventories API. Currently empty because there is
5880
+ # no meaningful response populated from the RemoveLocalInventories method.
5881
+ class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
5882
+ include Google::Apis::Core::Hashable
5883
+
5884
+ def initialize(**args)
5885
+ update!(**args)
5886
+ end
5887
+
5888
+ # Update properties of this object
5889
+ def update!(**args)
5890
+ end
5891
+ end
5892
+
5673
5893
  # Metadata related to the progress of the SetInventory operation. Currently
5674
5894
  # empty because there is no meaningful metadata populated from the SetInventory
5675
5895
  # method.
@@ -5816,8 +6036,7 @@ module Google
5816
6036
  # A generic empty message that you can re-use to avoid defining duplicated empty
5817
6037
  # messages in your APIs. A typical example is to use it as the request or the
5818
6038
  # response type of an API method. For instance: service Foo ` rpc Bar(google.
5819
- # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
5820
- # `Empty` is empty JSON object ````.
6039
+ # protobuf.Empty) returns (google.protobuf.Empty); `
5821
6040
  class GoogleProtobufEmpty
5822
6041
  include Google::Apis::Core::Hashable
5823
6042
 
@@ -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.33.0"
19
+ GEM_VERSION = "0.36.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 = "20220310"
25
+ REVISION = "20220408"
26
26
  end
27
27
  end
28
28
  end
@@ -76,6 +76,18 @@ module Google
76
76
  include Google::Apis::Core::JsonObjectSupport
77
77
  end
78
78
 
79
+ class GoogleCloudRetailV2AddLocalInventoriesMetadata
80
+ class Representation < Google::Apis::Core::JsonRepresentation; end
81
+
82
+ include Google::Apis::Core::JsonObjectSupport
83
+ end
84
+
85
+ class GoogleCloudRetailV2AddLocalInventoriesResponse
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
79
91
  class GoogleCloudRetailV2ImportCompletionDataResponse
80
92
  class Representation < Google::Apis::Core::JsonRepresentation; end
81
93
 
@@ -142,6 +154,18 @@ module Google
142
154
  include Google::Apis::Core::JsonObjectSupport
143
155
  end
144
156
 
157
+ class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
158
+ class Representation < Google::Apis::Core::JsonRepresentation; end
159
+
160
+ include Google::Apis::Core::JsonObjectSupport
161
+ end
162
+
163
+ class GoogleCloudRetailV2RemoveLocalInventoriesResponse
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
145
169
  class GoogleCloudRetailV2SetInventoryMetadata
146
170
  class Representation < Google::Apis::Core::JsonRepresentation; end
147
171
 
@@ -262,6 +286,12 @@ module Google
262
286
  include Google::Apis::Core::JsonObjectSupport
263
287
  end
264
288
 
289
+ class GoogleCloudRetailV2alphaCompletionConfig
290
+ class Representation < Google::Apis::Core::JsonRepresentation; end
291
+
292
+ include Google::Apis::Core::JsonObjectSupport
293
+ end
294
+
265
295
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
266
296
  class Representation < Google::Apis::Core::JsonRepresentation; end
267
297
 
@@ -838,6 +868,18 @@ module Google
838
868
  include Google::Apis::Core::JsonObjectSupport
839
869
  end
840
870
 
871
+ class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
872
+ class Representation < Google::Apis::Core::JsonRepresentation; end
873
+
874
+ include Google::Apis::Core::JsonObjectSupport
875
+ end
876
+
877
+ class GoogleCloudRetailV2betaAddLocalInventoriesResponse
878
+ class Representation < Google::Apis::Core::JsonRepresentation; end
879
+
880
+ include Google::Apis::Core::JsonObjectSupport
881
+ end
882
+
841
883
  class GoogleCloudRetailV2betaExportErrorsConfig
842
884
  class Representation < Google::Apis::Core::JsonRepresentation; end
843
885
 
@@ -928,6 +970,18 @@ module Google
928
970
  include Google::Apis::Core::JsonObjectSupport
929
971
  end
930
972
 
973
+ class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
974
+ class Representation < Google::Apis::Core::JsonRepresentation; end
975
+
976
+ include Google::Apis::Core::JsonObjectSupport
977
+ end
978
+
979
+ class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
980
+ class Representation < Google::Apis::Core::JsonRepresentation; end
981
+
982
+ include Google::Apis::Core::JsonObjectSupport
983
+ end
984
+
931
985
  class GoogleCloudRetailV2betaSetInventoryMetadata
932
986
  class Representation < Google::Apis::Core::JsonRepresentation; end
933
987
 
@@ -1057,6 +1111,18 @@ module Google
1057
1111
  end
1058
1112
  end
1059
1113
 
1114
+ class GoogleCloudRetailV2AddLocalInventoriesMetadata
1115
+ # @private
1116
+ class Representation < Google::Apis::Core::JsonRepresentation
1117
+ end
1118
+ end
1119
+
1120
+ class GoogleCloudRetailV2AddLocalInventoriesResponse
1121
+ # @private
1122
+ class Representation < Google::Apis::Core::JsonRepresentation
1123
+ end
1124
+ end
1125
+
1060
1126
  class GoogleCloudRetailV2ImportCompletionDataResponse
1061
1127
  # @private
1062
1128
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1144,6 +1210,18 @@ module Google
1144
1210
  end
1145
1211
  end
1146
1212
 
1213
+ class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
1214
+ # @private
1215
+ class Representation < Google::Apis::Core::JsonRepresentation
1216
+ end
1217
+ end
1218
+
1219
+ class GoogleCloudRetailV2RemoveLocalInventoriesResponse
1220
+ # @private
1221
+ class Representation < Google::Apis::Core::JsonRepresentation
1222
+ end
1223
+ end
1224
+
1147
1225
  class GoogleCloudRetailV2SetInventoryMetadata
1148
1226
  # @private
1149
1227
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1314,6 +1392,26 @@ module Google
1314
1392
  end
1315
1393
  end
1316
1394
 
1395
+ class GoogleCloudRetailV2alphaCompletionConfig
1396
+ # @private
1397
+ class Representation < Google::Apis::Core::JsonRepresentation
1398
+ property :allowlist_input_config, as: 'allowlistInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1399
+
1400
+ property :auto_learning, as: 'autoLearning'
1401
+ property :denylist_input_config, as: 'denylistInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1402
+
1403
+ property :last_allowlist_import_operation, as: 'lastAllowlistImportOperation'
1404
+ property :last_denylist_import_operation, as: 'lastDenylistImportOperation'
1405
+ property :last_suggestions_import_operation, as: 'lastSuggestionsImportOperation'
1406
+ property :matching_order, as: 'matchingOrder'
1407
+ property :max_suggestions, as: 'maxSuggestions'
1408
+ property :min_prefix_length, as: 'minPrefixLength'
1409
+ property :name, as: 'name'
1410
+ property :suggestions_input_config, as: 'suggestionsInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
1411
+
1412
+ end
1413
+ end
1414
+
1317
1415
  class GoogleCloudRetailV2alphaCompletionDataInputConfig
1318
1416
  # @private
1319
1417
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1367,7 +1465,6 @@ module Google
1367
1465
  property :name, as: 'name'
1368
1466
  property :rule, as: 'rule', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule::Representation
1369
1467
 
1370
- collection :search_solution_use_case, as: 'searchSolutionUseCase'
1371
1468
  collection :solution_types, as: 'solutionTypes'
1372
1469
  end
1373
1470
  end
@@ -1585,6 +1682,7 @@ module Google
1585
1682
  class Representation < Google::Apis::Core::JsonRepresentation
1586
1683
  hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
1587
1684
 
1685
+ collection :fulfillment_types, as: 'fulfillmentTypes'
1588
1686
  property :place_id, as: 'placeId'
1589
1687
  property :price_info, as: 'priceInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo::Representation
1590
1688
 
@@ -2291,6 +2389,18 @@ module Google
2291
2389
  end
2292
2390
  end
2293
2391
 
2392
+ class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
2393
+ # @private
2394
+ class Representation < Google::Apis::Core::JsonRepresentation
2395
+ end
2396
+ end
2397
+
2398
+ class GoogleCloudRetailV2betaAddLocalInventoriesResponse
2399
+ # @private
2400
+ class Representation < Google::Apis::Core::JsonRepresentation
2401
+ end
2402
+ end
2403
+
2294
2404
  class GoogleCloudRetailV2betaExportErrorsConfig
2295
2405
  # @private
2296
2406
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2413,6 +2523,18 @@ module Google
2413
2523
  end
2414
2524
  end
2415
2525
 
2526
+ class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
2527
+ # @private
2528
+ class Representation < Google::Apis::Core::JsonRepresentation
2529
+ end
2530
+ end
2531
+
2532
+ class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
2533
+ # @private
2534
+ class Representation < Google::Apis::Core::JsonRepresentation
2535
+ end
2536
+ end
2537
+
2416
2538
  class GoogleCloudRetailV2betaSetInventoryMetadata
2417
2539
  # @private
2418
2540
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -52,9 +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 submit a form [here]
56
- # (https://cloud.google.com/contact) to contact cloud sales if you are
57
- # interested in using Retail Search.
55
+ # available for users who have Retail Search enabled. Please enable Retail
56
+ # Search on Cloud Console before using this feature.
58
57
  # @param [String] catalog
59
58
  # Required. Catalog for which the completion is performed. Full resource name of
60
59
  # catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
@@ -156,6 +155,37 @@ module Google
156
155
  execute_or_queue_command(command, &block)
157
156
  end
158
157
 
158
+ # Gets a CompletionConfig.
159
+ # @param [String] name
160
+ # Required. Full CompletionConfig resource name. Format: projects/`
161
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
162
+ # @param [String] fields
163
+ # Selector specifying which fields to include in a partial response.
164
+ # @param [String] quota_user
165
+ # Available to use for quota purposes for server-side applications. Can be any
166
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
167
+ # @param [Google::Apis::RequestOptions] options
168
+ # Request-specific options
169
+ #
170
+ # @yield [result, err] Result & error if block supplied
171
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] parsed result object
172
+ # @yieldparam err [StandardError] error object if request failed
173
+ #
174
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig]
175
+ #
176
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
177
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
178
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
179
+ def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
180
+ command = make_simple_command(:get, 'v2alpha/{+name}', options)
181
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
182
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
183
+ command.params['name'] = name unless name.nil?
184
+ command.query['fields'] = fields unless fields.nil?
185
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
186
+ execute_or_queue_command(command, &block)
187
+ end
188
+
159
189
  # Get which branch is currently default branch set by CatalogService.
160
190
  # SetDefaultBranch method under a specified parent catalog.
161
191
  # @param [String] catalog
@@ -365,6 +395,46 @@ module Google
365
395
  execute_or_queue_command(command, &block)
366
396
  end
367
397
 
398
+ # Updates the CompletionConfigs.
399
+ # @param [String] name
400
+ # Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
401
+ # completionConfig
402
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] google_cloud_retail_v2alpha_completion_config_object
403
+ # @param [String] update_mask
404
+ # Indicates which fields in the provided CompletionConfig to update. The
405
+ # following are the only supported fields: * CompletionConfig.matching_order *
406
+ # CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length *
407
+ # CompletionConfig.auto_learning If not set, all supported fields are updated.
408
+ # @param [String] fields
409
+ # Selector specifying which fields to include in a partial response.
410
+ # @param [String] quota_user
411
+ # Available to use for quota purposes for server-side applications. Can be any
412
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
413
+ # @param [Google::Apis::RequestOptions] options
414
+ # Request-specific options
415
+ #
416
+ # @yield [result, err] Result & error if block supplied
417
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] parsed result object
418
+ # @yieldparam err [StandardError] error object if request failed
419
+ #
420
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig]
421
+ #
422
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
423
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
424
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
425
+ 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)
426
+ command = make_simple_command(:patch, 'v2alpha/{+name}', options)
427
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
428
+ command.request_object = google_cloud_retail_v2alpha_completion_config_object
429
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
430
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
431
+ command.params['name'] = name unless name.nil?
432
+ command.query['updateMask'] = update_mask unless update_mask.nil?
433
+ command.query['fields'] = fields unless fields.nil?
434
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
435
+ execute_or_queue_command(command, &block)
436
+ end
437
+
368
438
  # Adds the specified CatalogAttribute to the AttributesConfig. If the
369
439
  # CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
370
440
  # @param [String] attributes_config
@@ -508,9 +578,8 @@ module Google
508
578
  # enqueued and processed downstream. As a consequence, when a response is
509
579
  # returned, the added place IDs are not immediately manifested in the Product
510
580
  # queried by GetProduct or ListProducts. This feature is only available for
511
- # users who have Retail Search enabled. Please submit a form [here](https://
512
- # cloud.google.com/contact) to contact cloud sales if you are interested in
513
- # using Retail Search.
581
+ # users who have Retail Search enabled. Please enable Retail Search on Cloud
582
+ # Console before using this feature.
514
583
  # @param [String] product
515
584
  # Required. Full resource name of Product, such as `projects/*/locations/global/
516
585
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -555,8 +624,7 @@ module Google
555
624
  # ListProducts. Local inventory information can only be modified using this
556
625
  # method. CreateProduct and UpdateProduct has no effect on local inventories.
557
626
  # This feature is only available for users who have Retail Search enabled.
558
- # Please submit a form [here](https://cloud.google.com/contact) to contact Cloud
559
- # sales if you are interested in using Retail Search.
627
+ # Please enable Retail Search on Cloud Console before using this feature.
560
628
  # @param [String] product
561
629
  # Required. Full resource name of Product, such as `projects/*/locations/global/
562
630
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -828,7 +896,9 @@ module Google
828
896
  # output only fields are NOT supported. If not set, all supported fields (the
829
897
  # fields that are neither immutable nor output only) are updated. If an
830
898
  # unsupported or unknown field is provided, an INVALID_ARGUMENT error is
831
- # returned.
899
+ # returned. The attribute key can be updated by setting the mask path as "
900
+ # attributes.$`key_name`". If a key name is present in the mask but not in the
901
+ # patching product from the request, this key will be deleted after the update.
832
902
  # @param [String] fields
833
903
  # Selector specifying which fields to include in a partial response.
834
904
  # @param [String] quota_user
@@ -907,9 +977,8 @@ module Google
907
977
  # enqueued and processed downstream. As a consequence, when a response is
908
978
  # returned, the removed place IDs are not immediately manifested in the Product
909
979
  # queried by GetProduct or ListProducts. This feature is only available for
910
- # users who have Retail Search enabled. Please submit a form [here](https://
911
- # cloud.google.com/contact) to contact cloud sales if you are interested in
912
- # using Retail Search.
980
+ # users who have Retail Search enabled. Please enable Retail Search on Cloud
981
+ # Console before using this feature.
913
982
  # @param [String] product
914
983
  # Required. Full resource name of Product, such as `projects/*/locations/global/
915
984
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -952,8 +1021,8 @@ module Google
952
1021
  # queried by GetProduct or ListProducts. Local inventory information can only be
953
1022
  # removed using this method. CreateProduct and UpdateProduct has no effect on
954
1023
  # local inventories. This feature is only available for users who have Retail
955
- # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
956
- # to contact Cloud sales if you are interested in using Retail Search.
1024
+ # Search enabled. Please enable Retail Search on Cloud Console before using this
1025
+ # feature.
957
1026
  # @param [String] product
958
1027
  # Required. Full resource name of Product, such as `projects/*/locations/global/
959
1028
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -1005,9 +1074,8 @@ module Google
1005
1074
  # SetInventoryRequest.set_mask, then any existing inventory information will be
1006
1075
  # preserved. Pre-existing inventory information can only be updated with
1007
1076
  # SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
1008
- # is only available for users who have Retail Search enabled. Please submit a
1009
- # form [here](https://cloud.google.com/contact) to contact cloud sales if you
1010
- # are interested in using Retail Search.
1077
+ # is only available for users who have Retail Search enabled. Please enable
1078
+ # Retail Search on Cloud Console before using this feature.
1011
1079
  # @param [String] name
1012
1080
  # Immutable. Full resource name of the product, such as `projects/*/locations/
1013
1081
  # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1041,11 +1109,12 @@ module Google
1041
1109
  execute_or_queue_command(command, &block)
1042
1110
  end
1043
1111
 
1044
- # Bulk import of processed completion dataset. Request processing may be
1045
- # synchronous. Partial updating is not supported. This feature is only available
1046
- # for users who have Retail Search enabled. Please submit a form [here](https://
1047
- # cloud.google.com/contact) to contact cloud sales if you are interested in
1048
- # using Retail Search.
1112
+ # Bulk import of processed completion dataset. Request processing is
1113
+ # asynchronous. Partial updating is not supported. The operation is successfully
1114
+ # finished only after the imported suggestions are indexed successfully and
1115
+ # ready for serving. The process takes hours. This feature is only available for
1116
+ # users who have Retail Search enabled. Please enable Retail Search on Cloud
1117
+ # Console before using this feature.
1049
1118
  # @param [String] parent
1050
1119
  # Required. The catalog which the suggestions dataset belongs to. Format: `
1051
1120
  # projects/1234/locations/global/catalogs/default_catalog`.
@@ -1350,12 +1419,15 @@ module Google
1350
1419
  # Makes a recommendation prediction.
1351
1420
  # @param [String] placement
1352
1421
  # Required. Full resource name of the format: `name=projects/*/locations/global/
1353
- # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
1354
- # placement. Before you can request predictions from your model, you must create
1355
- # at least one placement for it. For more information, see [Managing placements](
1356
- # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
1357
- # The full list of available placements can be seen at https://console.cloud.
1358
- # google.com/recommendation/catalogs/default_catalog/placements
1422
+ # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1423
+ # global/catalogs/default_catalog/placements/*`. We recommend using the `
1424
+ # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1425
+ # Recommendations AI serving config or placement. Before you can request
1426
+ # predictions from your model, you must create at least one serving config or
1427
+ # placement for it. For more information, see [Managing serving configurations].
1428
+ # (https://cloud.google.com/retail/docs/manage-configs). The full list of
1429
+ # available serving configs can be seen at https://console.cloud.google.com/ai/
1430
+ # retail/catalogs/default_catalog/configs
1359
1431
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
1360
1432
  # @param [String] fields
1361
1433
  # Selector specifying which fields to include in a partial response.
@@ -1387,13 +1459,15 @@ module Google
1387
1459
  end
1388
1460
 
1389
1461
  # Performs a search. This feature is only available for users who have Retail
1390
- # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
1391
- # to contact cloud sales if you are interested in using Retail Search.
1462
+ # Search enabled. Please enable Retail Search on Cloud Console before using this
1463
+ # feature.
1392
1464
  # @param [String] placement
1393
- # Required. The resource name of the search engine placement, such as `projects/*
1394
- # /locations/global/catalogs/default_catalog/placements/default_search`. This
1395
- # field is used to identify the serving configuration name and the set of models
1396
- # that will be used to make the search.
1465
+ # Required. The resource name of the Retail Search serving config, such as `
1466
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1467
+ # default_serving_config` or the name of the legacy placement resource, such as `
1468
+ # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1469
+ # . This field is used to identify the serving configuration name and the set of
1470
+ # models that will be used to make the search.
1397
1471
  # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1398
1472
  # @param [String] fields
1399
1473
  # Selector specifying which fields to include in a partial response.
@@ -1648,6 +1722,48 @@ module Google
1648
1722
  execute_or_queue_command(command, &block)
1649
1723
  end
1650
1724
 
1725
+ # Makes a recommendation prediction.
1726
+ # @param [String] placement
1727
+ # Required. Full resource name of the format: `name=projects/*/locations/global/
1728
+ # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1729
+ # global/catalogs/default_catalog/placements/*`. We recommend using the `
1730
+ # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1731
+ # Recommendations AI serving config or placement. Before you can request
1732
+ # predictions from your model, you must create at least one serving config or
1733
+ # placement for it. For more information, see [Managing serving configurations].
1734
+ # (https://cloud.google.com/retail/docs/manage-configs). The full list of
1735
+ # available serving configs can be seen at https://console.cloud.google.com/ai/
1736
+ # retail/catalogs/default_catalog/configs
1737
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
1738
+ # @param [String] fields
1739
+ # Selector specifying which fields to include in a partial response.
1740
+ # @param [String] quota_user
1741
+ # Available to use for quota purposes for server-side applications. Can be any
1742
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1743
+ # @param [Google::Apis::RequestOptions] options
1744
+ # Request-specific options
1745
+ #
1746
+ # @yield [result, err] Result & error if block supplied
1747
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse] parsed result object
1748
+ # @yieldparam err [StandardError] error object if request failed
1749
+ #
1750
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse]
1751
+ #
1752
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1753
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1754
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1755
+ def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1756
+ command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
1757
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
1758
+ command.request_object = google_cloud_retail_v2alpha_predict_request_object
1759
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
1760
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
1761
+ command.params['placement'] = placement unless placement.nil?
1762
+ command.query['fields'] = fields unless fields.nil?
1763
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1764
+ execute_or_queue_command(command, &block)
1765
+ end
1766
+
1651
1767
  # Disables a Control on the specified ServingConfig. The control is removed from
1652
1768
  # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
1653
1769
  # the ServingConfig.
@@ -1685,6 +1801,46 @@ module Google
1685
1801
  execute_or_queue_command(command, &block)
1686
1802
  end
1687
1803
 
1804
+ # Performs a search. This feature is only available for users who have Retail
1805
+ # Search enabled. Please enable Retail Search on Cloud Console before using this
1806
+ # feature.
1807
+ # @param [String] placement
1808
+ # Required. The resource name of the Retail Search serving config, such as `
1809
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1810
+ # default_serving_config` or the name of the legacy placement resource, such as `
1811
+ # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1812
+ # . This field is used to identify the serving configuration name and the set of
1813
+ # models that will be used to make the search.
1814
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
1815
+ # @param [String] fields
1816
+ # Selector specifying which fields to include in a partial response.
1817
+ # @param [String] quota_user
1818
+ # Available to use for quota purposes for server-side applications. Can be any
1819
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1820
+ # @param [Google::Apis::RequestOptions] options
1821
+ # Request-specific options
1822
+ #
1823
+ # @yield [result, err] Result & error if block supplied
1824
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse] parsed result object
1825
+ # @yieldparam err [StandardError] error object if request failed
1826
+ #
1827
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse]
1828
+ #
1829
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1830
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1831
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1832
+ def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1833
+ command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
1834
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
1835
+ command.request_object = google_cloud_retail_v2alpha_search_request_object
1836
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
1837
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
1838
+ command.params['placement'] = placement unless placement.nil?
1839
+ command.query['fields'] = fields unless fields.nil?
1840
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1841
+ execute_or_queue_command(command, &block)
1842
+ end
1843
+
1688
1844
  # Writes a single user event from the browser. This uses a GET request to due to
1689
1845
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1690
1846
  # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
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.33.0
4
+ version: 0.36.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-21 00:00:00.000000000 Z
11
+ date: 2022-04-18 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.33.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.36.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: []