google-apis-retail_v2beta 0.28.0 → 0.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 02b6586f000f86cc93e11b5d076cc0b7b641eef61594465c6327a0091e8b1909
4
- data.tar.gz: dd20fdf5ea5967348dfc0e621ab1ac790fbf7fa87e9e149a3df20dbb375a087f
3
+ metadata.gz: 4728dc0b1ed77a4e3bf7d513cfb92adf723b47ef5ad8d703ee2bce8e55ae7e48
4
+ data.tar.gz: 5854f2bd791423414f15a7e488b15368532fdea6e47336dfcd8440d895a1f4bb
5
5
  SHA512:
6
- metadata.gz: a79e6a3ee1a0d481ca8a57d9e6993068a974f312a2933113888c309e54d72d939e416c717e6e6cfc8a316e7dc5b54b0627ea0abd4e1ecaff9041a8809d078507
7
- data.tar.gz: b758269f1d180056a7fdd7739559548942f832929e1276194883cd04c3dea7d35a7bd6124defcc09ec91dbb7d561ec2dbc99dd343f2c35b0e0afccf365c3b5d9
6
+ metadata.gz: 041ebfef9f76cdaa823dea82e36064e78f22b1ba22e1105b2aa27c74d0e4b35bab1a9d1bca75b1ae73550bb66a7006e1653bd5519019608a58bb92cbf7cce380
7
+ data.tar.gz: a6e2a57b1d318f25cdd33ca116dc969acd5dfa0592a272906c4d7d3dcd56b7b9c7a393aed35fb1428101944f70efcb6351b52ccb5720d811cde30509df74e82c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2beta
2
2
 
3
+ ### v0.29.0 (2022-02-24)
4
+
5
+ * Regenerated from discovery document revision 20220217
6
+
3
7
  ### v0.28.0 (2022-02-12)
4
8
 
5
9
  * Regenerated from discovery document revision 20220210
@@ -333,9 +333,9 @@ module Google
333
333
  class GoogleCloudRetailV2ImportErrorsConfig
334
334
  include Google::Apis::Core::Hashable
335
335
 
336
- # Google Cloud Storage path for import errors. This must be an empty, existing
337
- # Cloud Storage bucket. Import errors will be written to a file in this bucket,
338
- # one per line, as a JSON-encoded `google.rpc.Status` message.
336
+ # Google Cloud Storage prefix for import errors. This must be an empty, existing
337
+ # Cloud Storage directory. Import errors will be written to sharded files in
338
+ # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
339
339
  # Corresponds to the JSON property `gcsPrefix`
340
340
  # @return [String]
341
341
  attr_accessor :gcs_prefix
@@ -803,9 +803,9 @@ module Google
803
803
  class GoogleCloudRetailV2alphaImportErrorsConfig
804
804
  include Google::Apis::Core::Hashable
805
805
 
806
- # Google Cloud Storage path for import errors. This must be an empty, existing
807
- # Cloud Storage bucket. Import errors will be written to a file in this bucket,
808
- # one per line, as a JSON-encoded `google.rpc.Status` message.
806
+ # Google Cloud Storage prefix for import errors. This must be an empty, existing
807
+ # Cloud Storage directory. Import errors will be written to sharded files in
808
+ # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
809
809
  # Corresponds to the JSON property `gcsPrefix`
810
810
  # @return [String]
811
811
  attr_accessor :gcs_prefix
@@ -1117,6 +1117,26 @@ module Google
1117
1117
  end
1118
1118
  end
1119
1119
 
1120
+ # Request for CatalogService.AddCatalogAttribute method.
1121
+ class GoogleCloudRetailV2betaAddCatalogAttributeRequest
1122
+ include Google::Apis::Core::Hashable
1123
+
1124
+ # Catalog level attribute config for an attribute. For example, if customers
1125
+ # want to enable/disable facet for a specific attribute.
1126
+ # Corresponds to the JSON property `catalogAttribute`
1127
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute]
1128
+ attr_accessor :catalog_attribute
1129
+
1130
+ def initialize(**args)
1131
+ update!(**args)
1132
+ end
1133
+
1134
+ # Update properties of this object
1135
+ def update!(**args)
1136
+ @catalog_attribute = args[:catalog_attribute] if args.key?(:catalog_attribute)
1137
+ end
1138
+ end
1139
+
1120
1140
  # Request for AddControl method.
1121
1141
  class GoogleCloudRetailV2betaAddControlRequest
1122
1142
  include Google::Apis::Core::Hashable
@@ -1222,6 +1242,42 @@ module Google
1222
1242
  end
1223
1243
  end
1224
1244
 
1245
+ # Catalog level attribute config.
1246
+ class GoogleCloudRetailV2betaAttributesConfig
1247
+ include Google::Apis::Core::Hashable
1248
+
1249
+ # Output only. The AttributeConfigLevel used for this catalog.
1250
+ # Corresponds to the JSON property `attributeConfigLevel`
1251
+ # @return [String]
1252
+ attr_accessor :attribute_config_level
1253
+
1254
+ # Enable attribute(s) config at catalog level. For example, indexable,
1255
+ # dynamic_facetable, or searchable for each attribute. The key is catalog
1256
+ # attribute's name. For example: `color`, `brands`, `attributes.custom_attribute`
1257
+ # , such as `attributes.xyz`. The maximum number of catalog attributes allowed
1258
+ # in a request is 1000.
1259
+ # Corresponds to the JSON property `catalogAttributes`
1260
+ # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute>]
1261
+ attr_accessor :catalog_attributes
1262
+
1263
+ # Required. Immutable. The fully qualified resource name of the attribute config.
1264
+ # Format: "projects/*/locations/*/catalogs/*/attributesConfig"
1265
+ # Corresponds to the JSON property `name`
1266
+ # @return [String]
1267
+ attr_accessor :name
1268
+
1269
+ def initialize(**args)
1270
+ update!(**args)
1271
+ end
1272
+
1273
+ # Update properties of this object
1274
+ def update!(**args)
1275
+ @attribute_config_level = args[:attribute_config_level] if args.key?(:attribute_config_level)
1276
+ @catalog_attributes = args[:catalog_attributes] if args.key?(:catalog_attributes)
1277
+ @name = args[:name] if args.key?(:name)
1278
+ end
1279
+ end
1280
+
1225
1281
  # An intended audience of the Product for whom it's sold.
1226
1282
  class GoogleCloudRetailV2betaAudience
1227
1283
  include Google::Apis::Core::Hashable
@@ -1366,6 +1422,72 @@ module Google
1366
1422
  end
1367
1423
  end
1368
1424
 
1425
+ # Catalog level attribute config for an attribute. For example, if customers
1426
+ # want to enable/disable facet for a specific attribute.
1427
+ class GoogleCloudRetailV2betaCatalogAttribute
1428
+ include Google::Apis::Core::Hashable
1429
+
1430
+ # If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet.
1431
+ # Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option
1432
+ # is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
1433
+ # Corresponds to the JSON property `dynamicFacetableOption`
1434
+ # @return [String]
1435
+ attr_accessor :dynamic_facetable_option
1436
+
1437
+ # Output only. Indicates whether this attribute has been used by any products. `
1438
+ # True` if at least one Product is using this attribute in Product.attributes.
1439
+ # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
1440
+ # AddCatalogAttribute, ImportCatalogAttributes, or UpdateAttributesConfig APIs.
1441
+ # This field is `False` for pre-loaded CatalogAttributes. After catalog changes,
1442
+ # it takes about 10 minutes for this field to update.
1443
+ # Corresponds to the JSON property `inUse`
1444
+ # @return [Boolean]
1445
+ attr_accessor :in_use
1446
+ alias_method :in_use?, :in_use
1447
+
1448
+ # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
1449
+ # if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered,
1450
+ # faceted, or boosted in SearchService.Search.
1451
+ # Corresponds to the JSON property `indexableOption`
1452
+ # @return [String]
1453
+ attr_accessor :indexable_option
1454
+
1455
+ # Required. Attribute name. For example: `color`, `brands`, `attributes.
1456
+ # custom_attribute`, such as `attributes.xyz`.
1457
+ # Corresponds to the JSON property `key`
1458
+ # @return [String]
1459
+ attr_accessor :key
1460
+
1461
+ # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
1462
+ # if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
1463
+ # SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
1464
+ # attribute values will not be searchable by text queries in SearchService.
1465
+ # Search, as there are no text values associated to numerical attributes.
1466
+ # Corresponds to the JSON property `searchableOption`
1467
+ # @return [String]
1468
+ attr_accessor :searchable_option
1469
+
1470
+ # Output only. The type of this attribute. This is derived from the attribute in
1471
+ # Product.attributes.
1472
+ # Corresponds to the JSON property `type`
1473
+ # @return [String]
1474
+ attr_accessor :type
1475
+
1476
+ def initialize(**args)
1477
+ update!(**args)
1478
+ end
1479
+
1480
+ # Update properties of this object
1481
+ def update!(**args)
1482
+ @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
1483
+ @in_use = args[:in_use] if args.key?(:in_use)
1484
+ @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
1485
+ @key = args[:key] if args.key?(:key)
1486
+ @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
1487
+ @type = args[:type] if args.key?(:type)
1488
+ end
1489
+ end
1490
+
1369
1491
  # The color information of a Product.
1370
1492
  class GoogleCloudRetailV2betaColorInfo
1371
1493
  include Google::Apis::Core::Hashable
@@ -1724,8 +1846,9 @@ module Google
1724
1846
  alias_method :searchable?, :searchable
1725
1847
 
1726
1848
  # The textual values of this custom attribute. For example, `["yellow", "green"]`
1727
- # when the key is "color". Exactly one of text or numbers should be set.
1728
- # Otherwise, an INVALID_ARGUMENT error is returned.
1849
+ # when the key is "color". Empty string is not allowed. Otherwise, an
1850
+ # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
1851
+ # set. Otherwise, an INVALID_ARGUMENT error is returned.
1729
1852
  # Corresponds to the JSON property `text`
1730
1853
  # @return [Array<String>]
1731
1854
  attr_accessor :text
@@ -2043,9 +2166,9 @@ module Google
2043
2166
  class GoogleCloudRetailV2betaImportErrorsConfig
2044
2167
  include Google::Apis::Core::Hashable
2045
2168
 
2046
- # Google Cloud Storage path for import errors. This must be an empty, existing
2047
- # Cloud Storage bucket. Import errors will be written to a file in this bucket,
2048
- # one per line, as a JSON-encoded `google.rpc.Status` message.
2169
+ # Google Cloud Storage prefix for import errors. This must be an empty, existing
2170
+ # Cloud Storage directory. Import errors will be written to sharded files in
2171
+ # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
2049
2172
  # Corresponds to the JSON property `gcsPrefix`
2050
2173
  # @return [String]
2051
2174
  attr_accessor :gcs_prefix
@@ -2688,9 +2811,9 @@ module Google
2688
2811
  # be a UTF-8 encoded string with a length limit of 128 characters. * For
2689
2812
  # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
2690
2813
  # `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
2691
- # values are allowed. Empty values are not allowed. Each value must be a UTF-8
2692
- # encoded string with a length limit of 256 characters. * For number attributes,
2693
- # at most 400 values are allowed.
2814
+ # values are allowed. Empty values are not allowed. Each value must be a non-
2815
+ # empty UTF-8 encoded string with a length limit of 256 characters. * For number
2816
+ # attributes, at most 400 values are allowed.
2694
2817
  # Corresponds to the JSON property `attributes`
2695
2818
  # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
2696
2819
  attr_accessor :attributes
@@ -3399,6 +3522,25 @@ module Google
3399
3522
  end
3400
3523
  end
3401
3524
 
3525
+ # Request for CatalogService.RemoveCatalogAttribute method.
3526
+ class GoogleCloudRetailV2betaRemoveCatalogAttributeRequest
3527
+ include Google::Apis::Core::Hashable
3528
+
3529
+ # Required. The attribute name key of the CatalogAttribute to remove.
3530
+ # Corresponds to the JSON property `key`
3531
+ # @return [String]
3532
+ attr_accessor :key
3533
+
3534
+ def initialize(**args)
3535
+ update!(**args)
3536
+ end
3537
+
3538
+ # Update properties of this object
3539
+ def update!(**args)
3540
+ @key = args[:key] if args.key?(:key)
3541
+ end
3542
+ end
3543
+
3402
3544
  # Request for RemoveControl method.
3403
3545
  class GoogleCloudRetailV2betaRemoveControlRequest
3404
3546
  include Google::Apis::Core::Hashable
@@ -3502,6 +3644,34 @@ module Google
3502
3644
  end
3503
3645
  end
3504
3646
 
3647
+ # Request for CatalogService.ReplaceCatalogAttribute method.
3648
+ class GoogleCloudRetailV2betaReplaceCatalogAttributeRequest
3649
+ include Google::Apis::Core::Hashable
3650
+
3651
+ # Catalog level attribute config for an attribute. For example, if customers
3652
+ # want to enable/disable facet for a specific attribute.
3653
+ # Corresponds to the JSON property `catalogAttribute`
3654
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute]
3655
+ attr_accessor :catalog_attribute
3656
+
3657
+ # Indicates which fields in the provided CatalogAttribute to update. The
3658
+ # following are NOT supported: * CatalogAttribute.key If not set, all supported
3659
+ # fields are updated.
3660
+ # Corresponds to the JSON property `updateMask`
3661
+ # @return [String]
3662
+ attr_accessor :update_mask
3663
+
3664
+ def initialize(**args)
3665
+ update!(**args)
3666
+ end
3667
+
3668
+ # Update properties of this object
3669
+ def update!(**args)
3670
+ @catalog_attribute = args[:catalog_attribute] if args.key?(:catalog_attribute)
3671
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
3672
+ end
3673
+ end
3674
+
3505
3675
  # A rule is a condition-action pair * A condition defines when a rule is to be
3506
3676
  # triggered. * An action specifies what occurs on that trigger. Currently only
3507
3677
  # boost rules are supported. Currently only supported by the search endpoint.
@@ -4553,7 +4723,7 @@ module Google
4553
4723
 
4554
4724
  # Condition boost specifications. If a product matches multiple conditions in
4555
4725
  # the specifications, boost scores from these specifications are all applied and
4556
- # combined in a non-linear way. Maximum number of specifications is 10. Notice
4726
+ # combined in a non-linear way. Maximum number of specifications is 100. Notice
4557
4727
  # that if both ServingConfig.boost_control_ids and [SearchRequest.boost_spec]
4558
4728
  # are set, the boost conditions from both places are evaluated. If a search
4559
4729
  # request matches multiple boost conditions, the final boost score is equal to
@@ -4667,7 +4837,7 @@ module Google
4667
4837
  attr_accessor :price_reranking_level
4668
4838
 
4669
4839
  # Condition redirect specifications. Only the first triggered redirect action is
4670
- # applied, even if multiple apply. Maximum number of specifications is 100. Can
4840
+ # applied, even if multiple apply. Maximum number of specifications is 1000. Can
4671
4841
  # only be set if solution_types is SOLUTION_TYPE_SEARCH.
4672
4842
  # Corresponds to the JSON property `redirectControlIds`
4673
4843
  # @return [Array<String>]
@@ -4726,11 +4896,20 @@ module Google
4726
4896
  include Google::Apis::Core::Hashable
4727
4897
 
4728
4898
  # The final component of the resource name of a branch. This field must be one
4729
- # of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
4899
+ # of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned. If there
4900
+ # are no sufficient active products in the targeted branch and force is not set,
4901
+ # a FAILED_PRECONDITION error is returned.
4730
4902
  # Corresponds to the JSON property `branchId`
4731
4903
  # @return [String]
4732
4904
  attr_accessor :branch_id
4733
4905
 
4906
+ # If set to true, it permits switching to a branch with branch_id even if it has
4907
+ # no sufficient active products.
4908
+ # Corresponds to the JSON property `force`
4909
+ # @return [Boolean]
4910
+ attr_accessor :force
4911
+ alias_method :force?, :force
4912
+
4734
4913
  # Some note on this request, this can be retrieved by CatalogService.
4735
4914
  # GetDefaultBranch before next valid default branch set occurs. This field must
4736
4915
  # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
@@ -4746,6 +4925,7 @@ module Google
4746
4925
  # Update properties of this object
4747
4926
  def update!(**args)
4748
4927
  @branch_id = args[:branch_id] if args.key?(:branch_id)
4928
+ @force = args[:force] if args.key?(:force)
4749
4929
  @note = args[:note] if args.key?(:note)
4750
4930
  end
4751
4931
  end
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2beta
18
18
  # Version of the google-apis-retail_v2beta gem
19
- GEM_VERSION = "0.28.0"
19
+ GEM_VERSION = "0.29.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 = "20220210"
25
+ REVISION = "20220217"
26
26
  end
27
27
  end
28
28
  end
@@ -304,6 +304,12 @@ module Google
304
304
  include Google::Apis::Core::JsonObjectSupport
305
305
  end
306
306
 
307
+ class GoogleCloudRetailV2betaAddCatalogAttributeRequest
308
+ class Representation < Google::Apis::Core::JsonRepresentation; end
309
+
310
+ include Google::Apis::Core::JsonObjectSupport
311
+ end
312
+
307
313
  class GoogleCloudRetailV2betaAddControlRequest
308
314
  class Representation < Google::Apis::Core::JsonRepresentation; end
309
315
 
@@ -328,6 +334,12 @@ module Google
328
334
  include Google::Apis::Core::JsonObjectSupport
329
335
  end
330
336
 
337
+ class GoogleCloudRetailV2betaAttributesConfig
338
+ class Representation < Google::Apis::Core::JsonRepresentation; end
339
+
340
+ include Google::Apis::Core::JsonObjectSupport
341
+ end
342
+
331
343
  class GoogleCloudRetailV2betaAudience
332
344
  class Representation < Google::Apis::Core::JsonRepresentation; end
333
345
 
@@ -346,6 +358,12 @@ module Google
346
358
  include Google::Apis::Core::JsonObjectSupport
347
359
  end
348
360
 
361
+ class GoogleCloudRetailV2betaCatalogAttribute
362
+ class Representation < Google::Apis::Core::JsonRepresentation; end
363
+
364
+ include Google::Apis::Core::JsonObjectSupport
365
+ end
366
+
349
367
  class GoogleCloudRetailV2betaColorInfo
350
368
  class Representation < Google::Apis::Core::JsonRepresentation; end
351
369
 
@@ -652,6 +670,12 @@ module Google
652
670
  include Google::Apis::Core::JsonObjectSupport
653
671
  end
654
672
 
673
+ class GoogleCloudRetailV2betaRemoveCatalogAttributeRequest
674
+ class Representation < Google::Apis::Core::JsonRepresentation; end
675
+
676
+ include Google::Apis::Core::JsonObjectSupport
677
+ end
678
+
655
679
  class GoogleCloudRetailV2betaRemoveControlRequest
656
680
  class Representation < Google::Apis::Core::JsonRepresentation; end
657
681
 
@@ -676,6 +700,12 @@ module Google
676
700
  include Google::Apis::Core::JsonObjectSupport
677
701
  end
678
702
 
703
+ class GoogleCloudRetailV2betaReplaceCatalogAttributeRequest
704
+ class Representation < Google::Apis::Core::JsonRepresentation; end
705
+
706
+ include Google::Apis::Core::JsonObjectSupport
707
+ end
708
+
679
709
  class GoogleCloudRetailV2betaRule
680
710
  class Representation < Google::Apis::Core::JsonRepresentation; end
681
711
 
@@ -1264,6 +1294,14 @@ module Google
1264
1294
  end
1265
1295
  end
1266
1296
 
1297
+ class GoogleCloudRetailV2betaAddCatalogAttributeRequest
1298
+ # @private
1299
+ class Representation < Google::Apis::Core::JsonRepresentation
1300
+ property :catalog_attribute, as: 'catalogAttribute', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute::Representation
1301
+
1302
+ end
1303
+ end
1304
+
1267
1305
  class GoogleCloudRetailV2betaAddControlRequest
1268
1306
  # @private
1269
1307
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1293,6 +1331,16 @@ module Google
1293
1331
  end
1294
1332
  end
1295
1333
 
1334
+ class GoogleCloudRetailV2betaAttributesConfig
1335
+ # @private
1336
+ class Representation < Google::Apis::Core::JsonRepresentation
1337
+ property :attribute_config_level, as: 'attributeConfigLevel'
1338
+ hash :catalog_attributes, as: 'catalogAttributes', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute::Representation
1339
+
1340
+ property :name, as: 'name'
1341
+ end
1342
+ end
1343
+
1296
1344
  class GoogleCloudRetailV2betaAudience
1297
1345
  # @private
1298
1346
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1324,6 +1372,18 @@ module Google
1324
1372
  end
1325
1373
  end
1326
1374
 
1375
+ class GoogleCloudRetailV2betaCatalogAttribute
1376
+ # @private
1377
+ class Representation < Google::Apis::Core::JsonRepresentation
1378
+ property :dynamic_facetable_option, as: 'dynamicFacetableOption'
1379
+ property :in_use, as: 'inUse'
1380
+ property :indexable_option, as: 'indexableOption'
1381
+ property :key, as: 'key'
1382
+ property :searchable_option, as: 'searchableOption'
1383
+ property :type, as: 'type'
1384
+ end
1385
+ end
1386
+
1327
1387
  class GoogleCloudRetailV2betaColorInfo
1328
1388
  # @private
1329
1389
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1833,6 +1893,13 @@ module Google
1833
1893
  end
1834
1894
  end
1835
1895
 
1896
+ class GoogleCloudRetailV2betaRemoveCatalogAttributeRequest
1897
+ # @private
1898
+ class Representation < Google::Apis::Core::JsonRepresentation
1899
+ property :key, as: 'key'
1900
+ end
1901
+ end
1902
+
1836
1903
  class GoogleCloudRetailV2betaRemoveControlRequest
1837
1904
  # @private
1838
1905
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1862,6 +1929,15 @@ module Google
1862
1929
  end
1863
1930
  end
1864
1931
 
1932
+ class GoogleCloudRetailV2betaReplaceCatalogAttributeRequest
1933
+ # @private
1934
+ class Representation < Google::Apis::Core::JsonRepresentation
1935
+ property :catalog_attribute, as: 'catalogAttribute', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttribute::Representation
1936
+
1937
+ property :update_mask, as: 'updateMask'
1938
+ end
1939
+ end
1940
+
1865
1941
  class GoogleCloudRetailV2betaRule
1866
1942
  # @private
1867
1943
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2131,6 +2207,7 @@ module Google
2131
2207
  # @private
2132
2208
  class Representation < Google::Apis::Core::JsonRepresentation
2133
2209
  property :branch_id, as: 'branchId'
2210
+ property :force, as: 'force'
2134
2211
  property :note, as: 'note'
2135
2212
  end
2136
2213
  end
@@ -123,6 +123,37 @@ module Google
123
123
  execute_or_queue_command(command, &block)
124
124
  end
125
125
 
126
+ # Gets an AttributesConfig.
127
+ # @param [String] name
128
+ # Required. Full AttributesConfig resource name. Format: projects/`
129
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig
130
+ # @param [String] fields
131
+ # Selector specifying which fields to include in a partial response.
132
+ # @param [String] quota_user
133
+ # Available to use for quota purposes for server-side applications. Can be any
134
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
135
+ # @param [Google::Apis::RequestOptions] options
136
+ # Request-specific options
137
+ #
138
+ # @yield [result, err] Result & error if block supplied
139
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig] parsed result object
140
+ # @yieldparam err [StandardError] error object if request failed
141
+ #
142
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig]
143
+ #
144
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
145
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
146
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
147
+ def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block)
148
+ command = make_simple_command(:get, 'v2beta/{+name}', options)
149
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
150
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
151
+ command.params['name'] = name unless name.nil?
152
+ command.query['fields'] = fields unless fields.nil?
153
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
154
+ execute_or_queue_command(command, &block)
155
+ end
156
+
126
157
  # Get which branch is currently default branch set by CatalogService.
127
158
  # SetDefaultBranch method under a specified parent catalog.
128
159
  # @param [String] catalog
@@ -287,6 +318,157 @@ module Google
287
318
  execute_or_queue_command(command, &block)
288
319
  end
289
320
 
321
+ # Updates the AttributesConfig. The catalog attributes in the request will be
322
+ # updated in the catalog, or inserted if they do not exist. Existing catalog
323
+ # attributes not included in the request will remain unchanged. Attributes that
324
+ # are assigned to products, but do not exist at the catalog level, are always
325
+ # included in the response. The product attribute is assigned default values for
326
+ # missing catalog attribute fields, e.g., searchable and dynamic facetable
327
+ # options.
328
+ # @param [String] name
329
+ # Required. Immutable. The fully qualified resource name of the attribute config.
330
+ # Format: "projects/*/locations/*/catalogs/*/attributesConfig"
331
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig] google_cloud_retail_v2beta_attributes_config_object
332
+ # @param [String] update_mask
333
+ # Indicates which fields in the provided AttributesConfig to update. The
334
+ # following is the only supported field: * AttributesConfig.catalog_attributes
335
+ # If not set, all supported fields are updated.
336
+ # @param [String] fields
337
+ # Selector specifying which fields to include in a partial response.
338
+ # @param [String] quota_user
339
+ # Available to use for quota purposes for server-side applications. Can be any
340
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
341
+ # @param [Google::Apis::RequestOptions] options
342
+ # Request-specific options
343
+ #
344
+ # @yield [result, err] Result & error if block supplied
345
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig] parsed result object
346
+ # @yieldparam err [StandardError] error object if request failed
347
+ #
348
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig]
349
+ #
350
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
351
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
352
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
353
+ def update_project_location_catalog_attributes_config(name, google_cloud_retail_v2beta_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
354
+ command = make_simple_command(:patch, 'v2beta/{+name}', options)
355
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
356
+ command.request_object = google_cloud_retail_v2beta_attributes_config_object
357
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
358
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
359
+ command.params['name'] = name unless name.nil?
360
+ command.query['updateMask'] = update_mask unless update_mask.nil?
361
+ command.query['fields'] = fields unless fields.nil?
362
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
363
+ execute_or_queue_command(command, &block)
364
+ end
365
+
366
+ # Adds the specified CatalogAttribute to the AttributesConfig. If the
367
+ # CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
368
+ # @param [String] attributes_config
369
+ # Required. Full AttributesConfig resource name. Format: projects/`
370
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig
371
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddCatalogAttributeRequest] google_cloud_retail_v2beta_add_catalog_attribute_request_object
372
+ # @param [String] fields
373
+ # Selector specifying which fields to include in a partial response.
374
+ # @param [String] quota_user
375
+ # Available to use for quota purposes for server-side applications. Can be any
376
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
377
+ # @param [Google::Apis::RequestOptions] options
378
+ # Request-specific options
379
+ #
380
+ # @yield [result, err] Result & error if block supplied
381
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig] parsed result object
382
+ # @yieldparam err [StandardError] error object if request failed
383
+ #
384
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig]
385
+ #
386
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
387
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
388
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
389
+ def add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
390
+ command = make_simple_command(:post, 'v2beta/{+attributesConfig}:addCatalogAttribute', options)
391
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddCatalogAttributeRequest::Representation
392
+ command.request_object = google_cloud_retail_v2beta_add_catalog_attribute_request_object
393
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
394
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
395
+ command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
396
+ command.query['fields'] = fields unless fields.nil?
397
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
398
+ execute_or_queue_command(command, &block)
399
+ end
400
+
401
+ # Removes the specified CatalogAttribute from the AttributesConfig. If the
402
+ # CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
403
+ # @param [String] attributes_config
404
+ # Required. Full AttributesConfig resource name. Format: projects/`
405
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig
406
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveCatalogAttributeRequest] google_cloud_retail_v2beta_remove_catalog_attribute_request_object
407
+ # @param [String] fields
408
+ # Selector specifying which fields to include in a partial response.
409
+ # @param [String] quota_user
410
+ # Available to use for quota purposes for server-side applications. Can be any
411
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
412
+ # @param [Google::Apis::RequestOptions] options
413
+ # Request-specific options
414
+ #
415
+ # @yield [result, err] Result & error if block supplied
416
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig] parsed result object
417
+ # @yieldparam err [StandardError] error object if request failed
418
+ #
419
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig]
420
+ #
421
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
422
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
423
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
424
+ def remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
425
+ command = make_simple_command(:post, 'v2beta/{+attributesConfig}:removeCatalogAttribute', options)
426
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveCatalogAttributeRequest::Representation
427
+ command.request_object = google_cloud_retail_v2beta_remove_catalog_attribute_request_object
428
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
429
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
430
+ command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
431
+ command.query['fields'] = fields unless fields.nil?
432
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
433
+ execute_or_queue_command(command, &block)
434
+ end
435
+
436
+ # Replaces the specified CatalogAttribute in the AttributesConfig by updating
437
+ # the catalog attribute with the same CatalogAttribute.key. If the
438
+ # CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.
439
+ # @param [String] attributes_config
440
+ # Required. Full AttributesConfig resource name. Format: projects/`
441
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig
442
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaReplaceCatalogAttributeRequest] google_cloud_retail_v2beta_replace_catalog_attribute_request_object
443
+ # @param [String] fields
444
+ # Selector specifying which fields to include in a partial response.
445
+ # @param [String] quota_user
446
+ # Available to use for quota purposes for server-side applications. Can be any
447
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
448
+ # @param [Google::Apis::RequestOptions] options
449
+ # Request-specific options
450
+ #
451
+ # @yield [result, err] Result & error if block supplied
452
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig] parsed result object
453
+ # @yieldparam err [StandardError] error object if request failed
454
+ #
455
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig]
456
+ #
457
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
458
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
459
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
460
+ def replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
461
+ command = make_simple_command(:post, 'v2beta/{+attributesConfig}:replaceCatalogAttribute', options)
462
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaReplaceCatalogAttributeRequest::Representation
463
+ command.request_object = google_cloud_retail_v2beta_replace_catalog_attribute_request_object
464
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation
465
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
466
+ command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
467
+ command.query['fields'] = fields unless fields.nil?
468
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
469
+ execute_or_queue_command(command, &block)
470
+ end
471
+
290
472
  # Gets the latest state of a long-running operation. Clients can use this method
291
473
  # to poll the operation result at intervals as recommended by the API service.
292
474
  # @param [String] name
@@ -682,7 +864,7 @@ module Google
682
864
  # CreateProduct or UpdateProduct request. If no inventory fields are set in
683
865
  # CreateProductRequest.product, then any pre-existing inventory information for
684
866
  # this product will be used. If no inventory fields are set in
685
- # UpdateProductRequest.set_mask, then any existing inventory information will be
867
+ # SetInventoryRequest.set_mask, then any existing inventory information will be
686
868
  # preserved. Pre-existing inventory information can only be updated with
687
869
  # SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
688
870
  # is only available for users who have Retail Search enabled. Please submit a
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.28.0
4
+ version: 0.29.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-02-14 00:00:00.000000000 Z
11
+ date: 2022-02-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.28.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.29.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
63
63
  post_install_message:
64
64
  rdoc_options: []