google-apis-retail_v2alpha 0.32.0 → 0.35.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: b8f924967f8b766a58754b7d1ccc3595971b65f718056048c78c38dc9fbe6a5e
4
- data.tar.gz: 791e94ff6a65503f21d744b484177ab537f5244340a94e651409e36a0a9e4577
3
+ metadata.gz: c0fd269bd8d363bde55fb078faa86e74e1a323df56bcdc81846cf82107e23cde
4
+ data.tar.gz: 42fcacb10da9e023b5393ee211f0a3c01814ece82fc7f95f230dc57f5d30d8a6
5
5
  SHA512:
6
- metadata.gz: 2bbf179ac2a176dabde0c4f8a56f2a76775bd92423286ab1bc6cdbf58572164cceeada2dd67b06d479e3eb16e450ad3e3f7297845f682bf92b1790121951763e
7
- data.tar.gz: 6a68d68ef8ca196bedb13a310df75e08d1684302235e74cebb58e10e0ccc075abcc19481dff48f4abe6c626cbbf002227602d020923a56436888913c8aa2520e
6
+ metadata.gz: 75cb4ab0fd396f681da64abfe00f028f0a80ad9384430069bb97314b6ae685b095d3a23382675aef2dad849107d7243a622c2fcd92b4fe5bc5610fa0769d576f
7
+ data.tar.gz: 05a66051d85bd1ab7ee804d0cbee4a2e5955c2b2cd6cdcd6cc4ec0b15f020280fd8197a6fa6ef3711cc232e256268d0670918aa6c5e70abb16a57447eb4177f6
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.35.0 (2022-03-31)
4
+
5
+ * Regenerated from discovery document revision 20220324
6
+
7
+ ### v0.34.0 (2022-03-24)
8
+
9
+ * Regenerated from discovery document revision 20220319
10
+
11
+ ### v0.33.0 (2022-03-16)
12
+
13
+ * Regenerated from discovery document revision 20220310
14
+
3
15
  ### v0.32.0 (2022-03-09)
4
16
 
5
17
  * Regenerated from discovery document revision 20220303
@@ -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,6 +1540,14 @@ module Google
1382
1540
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule]
1383
1541
  attr_accessor :rule
1384
1542
 
1543
+ # Required. Specifies the use case for the control. Affects what condition
1544
+ # fields can be set. Only settable by search controls. Will default to
1545
+ # SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
1546
+ # search_solution_use_case per control.
1547
+ # Corresponds to the JSON property `searchSolutionUseCase`
1548
+ # @return [Array<String>]
1549
+ attr_accessor :search_solution_use_case
1550
+
1385
1551
  # Required. Immutable. The solution types that the serving config is used for.
1386
1552
  # Currently we support setting only one type of solution at creation time. Only `
1387
1553
  # SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
@@ -1401,6 +1567,7 @@ module Google
1401
1567
  @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
1402
1568
  @name = args[:name] if args.key?(:name)
1403
1569
  @rule = args[:rule] if args.key?(:rule)
1570
+ @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
1404
1571
  @solution_types = args[:solution_types] if args.key?(:solution_types)
1405
1572
  end
1406
1573
  end
@@ -1668,7 +1835,10 @@ module Google
1668
1835
  end
1669
1836
  end
1670
1837
 
1671
- # Product thumbnail/detail image.
1838
+ # Product image. Recommendations AI and Retail Search do not use product images
1839
+ # to improve prediction and search results. However, product images can be
1840
+ # returned in results, and are shown in prediction or search previews in the
1841
+ # console.
1672
1842
  class GoogleCloudRetailV2alphaImage
1673
1843
  include Google::Apis::Core::Hashable
1674
1844
 
@@ -1798,8 +1968,7 @@ module Google
1798
1968
  # @return [String]
1799
1969
  attr_accessor :notification_pubsub_topic
1800
1970
 
1801
- # Id of the request / operation. This is parroting back the requestId that was
1802
- # passed in the request.
1971
+ # Deprecated. This field is never set.
1803
1972
  # Corresponds to the JSON property `requestId`
1804
1973
  # @return [String]
1805
1974
  attr_accessor :request_id
@@ -1859,11 +2028,7 @@ module Google
1859
2028
  # @return [String]
1860
2029
  attr_accessor :reconciliation_mode
1861
2030
 
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`.
2031
+ # Deprecated. This field has no effect.
1867
2032
  # Corresponds to the JSON property `requestId`
1868
2033
  # @return [String]
1869
2034
  attr_accessor :request_id
@@ -2133,14 +2298,26 @@ module Google
2133
2298
  # key must be a UTF-8 encoded string with a length limit of 32 characters. * The
2134
2299
  # key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or
2135
2300
  # 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.
2301
+ # number). * Only 1 value is allowed for each attribute. * For text values, the
2302
+ # length limit is 256 UTF-8 characters. * The attribute does not support search.
2303
+ # The `searchable` field should be unset or set to false. * The max summed total
2304
+ # bytes of custom attribute keys and values per product is 5MiB.
2140
2305
  # Corresponds to the JSON property `attributes`
2141
2306
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
2142
2307
  attr_accessor :attributes
2143
2308
 
2309
+ # Input only. Supported fulfillment types. Valid fulfillment type values include
2310
+ # commonly used types (such as pickup in store and same day delivery), and
2311
+ # custom types. Customers have to map custom types to their display names before
2312
+ # rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-
2313
+ # day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "
2314
+ # custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an
2315
+ # invalid value other than these, an INVALID_ARGUMENT error is returned. All the
2316
+ # elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
2317
+ # Corresponds to the JSON property `fulfillmentTypes`
2318
+ # @return [Array<String>]
2319
+ attr_accessor :fulfillment_types
2320
+
2144
2321
  # The place ID for the current set of inventory information.
2145
2322
  # Corresponds to the JSON property `placeId`
2146
2323
  # @return [String]
@@ -2158,6 +2335,7 @@ module Google
2158
2335
  # Update properties of this object
2159
2336
  def update!(**args)
2160
2337
  @attributes = args[:attributes] if args.key?(:attributes)
2338
+ @fulfillment_types = args[:fulfillment_types] if args.key?(:fulfillment_types)
2161
2339
  @place_id = args[:place_id] if args.key?(:place_id)
2162
2340
  @price_info = args[:price_info] if args.key?(:price_info)
2163
2341
  end
@@ -2190,7 +2368,8 @@ module Google
2190
2368
  # Language of the title/description and other string attributes. Use language
2191
2369
  # tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO
2192
2370
  # 639-1. This specifies the language of offers in Merchant Center that will be
2193
- # accepted. If empty no language filtering will be performed.
2371
+ # accepted. If empty no language filtering will be performed. Example value: `en`
2372
+ # .
2194
2373
  # Corresponds to the JSON property `languageCode`
2195
2374
  # @return [String]
2196
2375
  attr_accessor :language_code
@@ -2260,9 +2439,11 @@ module Google
2260
2439
  # do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "
2261
2440
  # Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-
2262
2441
  # "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`.
2442
+ # results, the API will return generic (unfiltered) popular products. If you
2443
+ # only want results strictly matching the filters, set `strictFiltering` to True
2444
+ # in `PredictRequest.params` to receive empty results instead. Note that the API
2445
+ # will never return items with storageStatus of "EXPIRED" or "DELETED"
2446
+ # regardless of filter choices.
2266
2447
  # Corresponds to the JSON property `filter`
2267
2448
  # @return [String]
2268
2449
  attr_accessor :filter
@@ -2669,7 +2850,7 @@ module Google
2669
2850
  # @return [String]
2670
2851
  attr_accessor :id
2671
2852
 
2672
- # Product images for the product.Highly recommended to put the main image to the
2853
+ # Product images for the product. We highly recommend putting the main image
2673
2854
  # first. A maximum of 300 images are allowed. Corresponding properties: Google
2674
2855
  # Merchant Center property [image_link](https://support.google.com/merchants/
2675
2856
  # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
@@ -3093,6 +3274,115 @@ module Google
3093
3274
  end
3094
3275
  end
3095
3276
 
3277
+ # Metadata related to the progress of the PurgeProducts operation. This will be
3278
+ # returned by the google.longrunning.Operation.metadata field.
3279
+ class GoogleCloudRetailV2alphaPurgeProductsMetadata
3280
+ include Google::Apis::Core::Hashable
3281
+
3282
+ # Operation create time.
3283
+ # Corresponds to the JSON property `createTime`
3284
+ # @return [String]
3285
+ attr_accessor :create_time
3286
+
3287
+ # Count of entries that encountered errors while processing.
3288
+ # Corresponds to the JSON property `failureCount`
3289
+ # @return [Fixnum]
3290
+ attr_accessor :failure_count
3291
+
3292
+ # Count of entries that were deleted successfully.
3293
+ # Corresponds to the JSON property `successCount`
3294
+ # @return [Fixnum]
3295
+ attr_accessor :success_count
3296
+
3297
+ # Operation last update time. If the operation is done, this is also the finish
3298
+ # time.
3299
+ # Corresponds to the JSON property `updateTime`
3300
+ # @return [String]
3301
+ attr_accessor :update_time
3302
+
3303
+ def initialize(**args)
3304
+ update!(**args)
3305
+ end
3306
+
3307
+ # Update properties of this object
3308
+ def update!(**args)
3309
+ @create_time = args[:create_time] if args.key?(:create_time)
3310
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
3311
+ @success_count = args[:success_count] if args.key?(:success_count)
3312
+ @update_time = args[:update_time] if args.key?(:update_time)
3313
+ end
3314
+ end
3315
+
3316
+ # Request message for PurgeProducts method.
3317
+ class GoogleCloudRetailV2alphaPurgeProductsRequest
3318
+ include Google::Apis::Core::Hashable
3319
+
3320
+ # Required. The filter string to specify the products to be deleted with a
3321
+ # length limit of 5,000 characters. Empty string filter is not allowed. "*"
3322
+ # implies delete all items in a branch. The eligible fields for filtering are: *
3323
+ # `availability`: Double quoted Product.availability string. * `create_time` :
3324
+ # in ISO 8601 "zulu" format. Supported syntax: * Comparators (">", "<", ">=", "<=
3325
+ # ", "="). Examples: * create_time <= "2015-02-13T17:05:46Z" * availability = "
3326
+ # IN_STOCK” * Conjunctions ("AND") Examples: * create_time <= "2015-02-13T17:05:
3327
+ # 46Z" AND availability = "PREORDER" * Disjunctions ("OR") Examples: *
3328
+ # create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK" * Can
3329
+ # support nested queries. Examples: * (create_time <= "2015-02-13T17:05:46Z" AND
3330
+ # availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND
3331
+ # availability = "IN_STOCK") * Filter Limits: * Filter should not contain more
3332
+ # than 6 conditions. * Max nesting depth should not exceed 2 levels. Examples
3333
+ # queries: * Delete back order products created before a timestamp. create_time <
3334
+ # = "2015-02-13T17:05:46Z" OR availability = "BACKORDER”
3335
+ # Corresponds to the JSON property `filter`
3336
+ # @return [String]
3337
+ attr_accessor :filter
3338
+
3339
+ # Actually perform the purge. If `force` is set to false, the method will return
3340
+ # the expected purge count without deleting any products.
3341
+ # Corresponds to the JSON property `force`
3342
+ # @return [Boolean]
3343
+ attr_accessor :force
3344
+ alias_method :force?, :force
3345
+
3346
+ def initialize(**args)
3347
+ update!(**args)
3348
+ end
3349
+
3350
+ # Update properties of this object
3351
+ def update!(**args)
3352
+ @filter = args[:filter] if args.key?(:filter)
3353
+ @force = args[:force] if args.key?(:force)
3354
+ end
3355
+ end
3356
+
3357
+ # Response of the PurgeProductsRequest. If the long running operation is
3358
+ # successfully done, then this message is returned by the google.longrunning.
3359
+ # Operations.response field.
3360
+ class GoogleCloudRetailV2alphaPurgeProductsResponse
3361
+ include Google::Apis::Core::Hashable
3362
+
3363
+ # The total count of products purged as a result of the operation.
3364
+ # Corresponds to the JSON property `purgeCount`
3365
+ # @return [Fixnum]
3366
+ attr_accessor :purge_count
3367
+
3368
+ # A sample of the product names that will be deleted. Only populated if `force`
3369
+ # is set to false. A max of 100 names will be returned and the names are chosen
3370
+ # at random.
3371
+ # Corresponds to the JSON property `purgeSample`
3372
+ # @return [Array<String>]
3373
+ attr_accessor :purge_sample
3374
+
3375
+ def initialize(**args)
3376
+ update!(**args)
3377
+ end
3378
+
3379
+ # Update properties of this object
3380
+ def update!(**args)
3381
+ @purge_count = args[:purge_count] if args.key?(:purge_count)
3382
+ @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
3383
+ end
3384
+ end
3385
+
3096
3386
  # Request message for PurgeUserEvents method.
3097
3387
  class GoogleCloudRetailV2alphaPurgeUserEventsRequest
3098
3388
  include Google::Apis::Core::Hashable
@@ -3804,12 +4094,13 @@ module Google
3804
4094
  # @return [String]
3805
4095
  attr_accessor :branch
3806
4096
 
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.
4097
+ # The default filter that is applied when a user performs a search without
4098
+ # checking any filters on the search page. The filter applied to every search
4099
+ # request when quality improvement such as query expansion is needed. For
4100
+ # example, if a query does not have enough results, an expanded query with
4101
+ # SearchRequest.canonical_filter will be returned as a supplement of the
4102
+ # original query. This field is strongly recommended to achieve high search
4103
+ # quality. See SearchRequest.filter for more details about filter syntax.
3813
4104
  # Corresponds to the JSON property `canonicalFilter`
3814
4105
  # @return [String]
3815
4106
  attr_accessor :canonical_filter
@@ -4808,15 +5099,21 @@ module Google
4808
5099
  class GoogleCloudRetailV2alphaUserEvent
4809
5100
  include Google::Apis::Core::Hashable
4810
5101
 
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.
5102
+ # Extra user event features to include in the recommendation model. If you
5103
+ # provide custom attributes for ingested user events, also include them in the
5104
+ # user events that you associate with prediction requests. Custom attribute
5105
+ # formatting must be consistent between imported events and events provided with
5106
+ # prediction requests. This lets the Retail API use those custom attributes when
5107
+ # training models and serving predictions, which helps improve recommendation
5108
+ # quality. This field needs to pass all below criteria, otherwise an
5109
+ # INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string
5110
+ # with a length limit of 5,000 characters. * For text attributes, at most 400
5111
+ # values are allowed. Empty values are not allowed. Each value must be a UTF-8
5112
+ # encoded string with a length limit of 256 characters. * For number attributes,
5113
+ # at most 400 values are allowed. For product recommendations, an example of
5114
+ # extra user information is traffic_channel, which is how a user arrives at the
5115
+ # site. Users can arrive at the site by coming to the site directly, coming
5116
+ # through Google search, or in other ways.
4820
5117
  # Corresponds to the JSON property `attributes`
4821
5118
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
4822
5119
  attr_accessor :attributes
@@ -5114,13 +5411,12 @@ module Google
5114
5411
  attr_accessor :direct_user_request
5115
5412
  alias_method :direct_user_request?, :direct_user_request
5116
5413
 
5117
- # The end user's IP address. Required for getting SearchResponse.
5118
- # sponsored_results. This field is used to extract location information for
5119
- # personalization. This field must be either an IPv4 address (e.g. "104.133.9.80"
5120
- # ) or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334").
5121
- # Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when
5122
- # using the JavaScript tag in UserEventService.CollectUserEvent or if
5123
- # direct_user_request is set.
5414
+ # The end user's IP address. This field is used to extract location information
5415
+ # for personalization. This field must be either an IPv4 address (e.g. "104.133.
5416
+ # 9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334").
5417
+ # Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when:
5418
+ # * setting SearchRequest.user_info. * using the JavaScript tag in
5419
+ # UserEventService.CollectUserEvent or if direct_user_request is set.
5124
5420
  # Corresponds to the JSON property `ipAddress`
5125
5421
  # @return [String]
5126
5422
  attr_accessor :ip_address
@@ -5136,8 +5432,9 @@ module Google
5136
5432
  attr_accessor :user_agent
5137
5433
 
5138
5434
  # Highly recommended for logged-in users. Unique identifier for logged-in user,
5139
- # such as a user name. The field must be a UTF-8 encoded string with a length
5140
- # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
5435
+ # such as a user name. Always use a hashed value for this ID. The field must be
5436
+ # a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
5437
+ # INVALID_ARGUMENT error is returned.
5141
5438
  # Corresponds to the JSON property `userId`
5142
5439
  # @return [String]
5143
5440
  attr_accessor :user_id
@@ -5184,6 +5481,35 @@ module Google
5184
5481
  end
5185
5482
  end
5186
5483
 
5484
+ # Metadata related to the progress of the AddLocalInventories operation.
5485
+ # Currently empty because there is no meaningful metadata populated from the
5486
+ # AddLocalInventories method.
5487
+ class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
5488
+ include Google::Apis::Core::Hashable
5489
+
5490
+ def initialize(**args)
5491
+ update!(**args)
5492
+ end
5493
+
5494
+ # Update properties of this object
5495
+ def update!(**args)
5496
+ end
5497
+ end
5498
+
5499
+ # Response of the AddLocalInventories API. Currently empty because there is no
5500
+ # meaningful response populated from the AddLocalInventories method.
5501
+ class GoogleCloudRetailV2betaAddLocalInventoriesResponse
5502
+ include Google::Apis::Core::Hashable
5503
+
5504
+ def initialize(**args)
5505
+ update!(**args)
5506
+ end
5507
+
5508
+ # Update properties of this object
5509
+ def update!(**args)
5510
+ end
5511
+ end
5512
+
5187
5513
  # Configuration of destination for Export related errors.
5188
5514
  class GoogleCloudRetailV2betaExportErrorsConfig
5189
5515
  include Google::Apis::Core::Hashable
@@ -5351,8 +5677,7 @@ module Google
5351
5677
  # @return [String]
5352
5678
  attr_accessor :notification_pubsub_topic
5353
5679
 
5354
- # Id of the request / operation. This is parroting back the requestId that was
5355
- # passed in the request.
5680
+ # Deprecated. This field is never set.
5356
5681
  # Corresponds to the JSON property `requestId`
5357
5682
  # @return [String]
5358
5683
  attr_accessor :request_id
@@ -5540,6 +5865,35 @@ module Google
5540
5865
  end
5541
5866
  end
5542
5867
 
5868
+ # Metadata related to the progress of the RemoveLocalInventories operation.
5869
+ # Currently empty because there is no meaningful metadata populated from the
5870
+ # RemoveLocalInventories method.
5871
+ class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
5872
+ include Google::Apis::Core::Hashable
5873
+
5874
+ def initialize(**args)
5875
+ update!(**args)
5876
+ end
5877
+
5878
+ # Update properties of this object
5879
+ def update!(**args)
5880
+ end
5881
+ end
5882
+
5883
+ # Response of the RemoveLocalInventories API. Currently empty because there is
5884
+ # no meaningful response populated from the RemoveLocalInventories method.
5885
+ class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
5886
+ include Google::Apis::Core::Hashable
5887
+
5888
+ def initialize(**args)
5889
+ update!(**args)
5890
+ end
5891
+
5892
+ # Update properties of this object
5893
+ def update!(**args)
5894
+ end
5895
+ end
5896
+
5543
5897
  # Metadata related to the progress of the SetInventory operation. Currently
5544
5898
  # empty because there is no meaningful metadata populated from the SetInventory
5545
5899
  # method.
@@ -5686,8 +6040,7 @@ module Google
5686
6040
  # A generic empty message that you can re-use to avoid defining duplicated empty
5687
6041
  # messages in your APIs. A typical example is to use it as the request or the
5688
6042
  # 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 ````.
6043
+ # protobuf.Empty) returns (google.protobuf.Empty); `
5691
6044
  class GoogleProtobufEmpty
5692
6045
  include Google::Apis::Core::Hashable
5693
6046