google-apis-retail_v2alpha 0.29.0 → 0.30.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: 9807fdb6e6e39b68732e89fa390a54990ef198eb40ad7d414fdb91425377bcf2
4
- data.tar.gz: 13e2c7f0e8447c7f24c783145cee04b7a14dda9f2435ed1138bf8d95fc548cb4
3
+ metadata.gz: e063d9dbc9d57e5e5167021c4f4699971eb55a1483a25bc31bd55de7074b5ddc
4
+ data.tar.gz: 842cbfd5e27502afd8c0e56772aeffb7274fa30f3d47f36dc82e44bde7b6d0af
5
5
  SHA512:
6
- metadata.gz: c54e46a8009c145aa3682a772110497b082bc1bd67e50262ef4800db708020eb44569956896320497442e8896a76c7d2d0c30c4f19410014fc98907c8b5a6126
7
- data.tar.gz: 1f4210851ac96d3123ebabc4900c1d06d43753f0e69873b3153d9067ed14ff183f8c0df6f7fd77ae868cdf19c4e1939d02e9a611ef91e527db0acc291c5d3d8a
6
+ metadata.gz: f9336b3c25a5f36ea3c41dc3fee2cb87cf932a7512269552aa018b70c208836cfbc6f5e96f3779937ba6eddebfe085217de9069cf42ed0ffdae72ed949a61b1e
7
+ data.tar.gz: 77cce5deb4146d7e14327153703190eb03b0f55709791263e0d97522352a79886a75ef6d989249c11e09af5adea5dd1a330f1357d176a0ff8e57b6a12f30b5b2
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.30.0 (2022-02-24)
4
+
5
+ * Regenerated from discovery document revision 20220217
6
+
3
7
  ### v0.29.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
@@ -618,6 +618,26 @@ module Google
618
618
  end
619
619
  end
620
620
 
621
+ # Request for CatalogService.AddCatalogAttribute method.
622
+ class GoogleCloudRetailV2alphaAddCatalogAttributeRequest
623
+ include Google::Apis::Core::Hashable
624
+
625
+ # Catalog level attribute config for an attribute. For example, if customers
626
+ # want to enable/disable facet for a specific attribute.
627
+ # Corresponds to the JSON property `catalogAttribute`
628
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute]
629
+ attr_accessor :catalog_attribute
630
+
631
+ def initialize(**args)
632
+ update!(**args)
633
+ end
634
+
635
+ # Update properties of this object
636
+ def update!(**args)
637
+ @catalog_attribute = args[:catalog_attribute] if args.key?(:catalog_attribute)
638
+ end
639
+ end
640
+
621
641
  # Request for AddControl method.
622
642
  class GoogleCloudRetailV2alphaAddControlRequest
623
643
  include Google::Apis::Core::Hashable
@@ -803,6 +823,42 @@ module Google
803
823
  end
804
824
  end
805
825
 
826
+ # Catalog level attribute config.
827
+ class GoogleCloudRetailV2alphaAttributesConfig
828
+ include Google::Apis::Core::Hashable
829
+
830
+ # Output only. The AttributeConfigLevel used for this catalog.
831
+ # Corresponds to the JSON property `attributeConfigLevel`
832
+ # @return [String]
833
+ attr_accessor :attribute_config_level
834
+
835
+ # Enable attribute(s) config at catalog level. For example, indexable,
836
+ # dynamic_facetable, or searchable for each attribute. The key is catalog
837
+ # attribute's name. For example: `color`, `brands`, `attributes.custom_attribute`
838
+ # , such as `attributes.xyz`. The maximum number of catalog attributes allowed
839
+ # in a request is 1000.
840
+ # Corresponds to the JSON property `catalogAttributes`
841
+ # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute>]
842
+ attr_accessor :catalog_attributes
843
+
844
+ # Required. Immutable. The fully qualified resource name of the attribute config.
845
+ # Format: "projects/*/locations/*/catalogs/*/attributesConfig"
846
+ # Corresponds to the JSON property `name`
847
+ # @return [String]
848
+ attr_accessor :name
849
+
850
+ def initialize(**args)
851
+ update!(**args)
852
+ end
853
+
854
+ # Update properties of this object
855
+ def update!(**args)
856
+ @attribute_config_level = args[:attribute_config_level] if args.key?(:attribute_config_level)
857
+ @catalog_attributes = args[:catalog_attributes] if args.key?(:catalog_attributes)
858
+ @name = args[:name] if args.key?(:name)
859
+ end
860
+ end
861
+
806
862
  # An intended audience of the Product for whom it's sold.
807
863
  class GoogleCloudRetailV2alphaAudience
808
864
  include Google::Apis::Core::Hashable
@@ -954,6 +1010,72 @@ module Google
954
1010
  end
955
1011
  end
956
1012
 
1013
+ # Catalog level attribute config for an attribute. For example, if customers
1014
+ # want to enable/disable facet for a specific attribute.
1015
+ class GoogleCloudRetailV2alphaCatalogAttribute
1016
+ include Google::Apis::Core::Hashable
1017
+
1018
+ # If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet.
1019
+ # Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option
1020
+ # is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
1021
+ # Corresponds to the JSON property `dynamicFacetableOption`
1022
+ # @return [String]
1023
+ attr_accessor :dynamic_facetable_option
1024
+
1025
+ # Output only. Indicates whether this attribute has been used by any products. `
1026
+ # True` if at least one Product is using this attribute in Product.attributes.
1027
+ # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
1028
+ # AddCatalogAttribute, ImportCatalogAttributes, or UpdateAttributesConfig APIs.
1029
+ # This field is `False` for pre-loaded CatalogAttributes. After catalog changes,
1030
+ # it takes about 10 minutes for this field to update.
1031
+ # Corresponds to the JSON property `inUse`
1032
+ # @return [Boolean]
1033
+ attr_accessor :in_use
1034
+ alias_method :in_use?, :in_use
1035
+
1036
+ # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
1037
+ # if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered,
1038
+ # faceted, or boosted in SearchService.Search.
1039
+ # Corresponds to the JSON property `indexableOption`
1040
+ # @return [String]
1041
+ attr_accessor :indexable_option
1042
+
1043
+ # Required. Attribute name. For example: `color`, `brands`, `attributes.
1044
+ # custom_attribute`, such as `attributes.xyz`.
1045
+ # Corresponds to the JSON property `key`
1046
+ # @return [String]
1047
+ attr_accessor :key
1048
+
1049
+ # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
1050
+ # if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
1051
+ # SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
1052
+ # attribute values will not be searchable by text queries in SearchService.
1053
+ # Search, as there are no text values associated to numerical attributes.
1054
+ # Corresponds to the JSON property `searchableOption`
1055
+ # @return [String]
1056
+ attr_accessor :searchable_option
1057
+
1058
+ # Output only. The type of this attribute. This is derived from the attribute in
1059
+ # Product.attributes.
1060
+ # Corresponds to the JSON property `type`
1061
+ # @return [String]
1062
+ attr_accessor :type
1063
+
1064
+ def initialize(**args)
1065
+ update!(**args)
1066
+ end
1067
+
1068
+ # Update properties of this object
1069
+ def update!(**args)
1070
+ @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
1071
+ @in_use = args[:in_use] if args.key?(:in_use)
1072
+ @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
1073
+ @key = args[:key] if args.key?(:key)
1074
+ @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
1075
+ @type = args[:type] if args.key?(:type)
1076
+ end
1077
+ end
1078
+
957
1079
  # The color information of a Product.
958
1080
  class GoogleCloudRetailV2alphaColorInfo
959
1081
  include Google::Apis::Core::Hashable
@@ -1312,8 +1434,9 @@ module Google
1312
1434
  alias_method :searchable?, :searchable
1313
1435
 
1314
1436
  # The textual values of this custom attribute. For example, `["yellow", "green"]`
1315
- # when the key is "color". Exactly one of text or numbers should be set.
1316
- # Otherwise, an INVALID_ARGUMENT error is returned.
1437
+ # when the key is "color". Empty string is not allowed. Otherwise, an
1438
+ # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
1439
+ # set. Otherwise, an INVALID_ARGUMENT error is returned.
1317
1440
  # Corresponds to the JSON property `text`
1318
1441
  # @return [Array<String>]
1319
1442
  attr_accessor :text
@@ -1631,9 +1754,9 @@ module Google
1631
1754
  class GoogleCloudRetailV2alphaImportErrorsConfig
1632
1755
  include Google::Apis::Core::Hashable
1633
1756
 
1634
- # Google Cloud Storage path for import errors. This must be an empty, existing
1635
- # Cloud Storage bucket. Import errors will be written to a file in this bucket,
1636
- # one per line, as a JSON-encoded `google.rpc.Status` message.
1757
+ # Google Cloud Storage prefix for import errors. This must be an empty, existing
1758
+ # Cloud Storage directory. Import errors will be written to sharded files in
1759
+ # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
1637
1760
  # Corresponds to the JSON property `gcsPrefix`
1638
1761
  # @return [String]
1639
1762
  attr_accessor :gcs_prefix
@@ -2406,9 +2529,9 @@ module Google
2406
2529
  # be a UTF-8 encoded string with a length limit of 128 characters. * For
2407
2530
  # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
2408
2531
  # `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
2409
- # values are allowed. Empty values are not allowed. Each value must be a UTF-8
2410
- # encoded string with a length limit of 256 characters. * For number attributes,
2411
- # at most 400 values are allowed.
2532
+ # values are allowed. Empty values are not allowed. Each value must be a non-
2533
+ # empty UTF-8 encoded string with a length limit of 256 characters. * For number
2534
+ # attributes, at most 400 values are allowed.
2412
2535
  # Corresponds to the JSON property `attributes`
2413
2536
  # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
2414
2537
  attr_accessor :attributes
@@ -3117,6 +3240,25 @@ module Google
3117
3240
  end
3118
3241
  end
3119
3242
 
3243
+ # Request for CatalogService.RemoveCatalogAttribute method.
3244
+ class GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest
3245
+ include Google::Apis::Core::Hashable
3246
+
3247
+ # Required. The attribute name key of the CatalogAttribute to remove.
3248
+ # Corresponds to the JSON property `key`
3249
+ # @return [String]
3250
+ attr_accessor :key
3251
+
3252
+ def initialize(**args)
3253
+ update!(**args)
3254
+ end
3255
+
3256
+ # Update properties of this object
3257
+ def update!(**args)
3258
+ @key = args[:key] if args.key?(:key)
3259
+ end
3260
+ end
3261
+
3120
3262
  # Request for RemoveControl method.
3121
3263
  class GoogleCloudRetailV2alphaRemoveControlRequest
3122
3264
  include Google::Apis::Core::Hashable
@@ -3287,6 +3429,34 @@ module Google
3287
3429
  end
3288
3430
  end
3289
3431
 
3432
+ # Request for CatalogService.ReplaceCatalogAttribute method.
3433
+ class GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest
3434
+ include Google::Apis::Core::Hashable
3435
+
3436
+ # Catalog level attribute config for an attribute. For example, if customers
3437
+ # want to enable/disable facet for a specific attribute.
3438
+ # Corresponds to the JSON property `catalogAttribute`
3439
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute]
3440
+ attr_accessor :catalog_attribute
3441
+
3442
+ # Indicates which fields in the provided CatalogAttribute to update. The
3443
+ # following are NOT supported: * CatalogAttribute.key If not set, all supported
3444
+ # fields are updated.
3445
+ # Corresponds to the JSON property `updateMask`
3446
+ # @return [String]
3447
+ attr_accessor :update_mask
3448
+
3449
+ def initialize(**args)
3450
+ update!(**args)
3451
+ end
3452
+
3453
+ # Update properties of this object
3454
+ def update!(**args)
3455
+ @catalog_attribute = args[:catalog_attribute] if args.key?(:catalog_attribute)
3456
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
3457
+ end
3458
+ end
3459
+
3290
3460
  # A rule is a condition-action pair * A condition defines when a rule is to be
3291
3461
  # triggered. * An action specifies what occurs on that trigger. Currently only
3292
3462
  # boost rules are supported. Currently only supported by the search endpoint.
@@ -4347,7 +4517,7 @@ module Google
4347
4517
 
4348
4518
  # Condition boost specifications. If a product matches multiple conditions in
4349
4519
  # the specifications, boost scores from these specifications are all applied and
4350
- # combined in a non-linear way. Maximum number of specifications is 10. Notice
4520
+ # combined in a non-linear way. Maximum number of specifications is 100. Notice
4351
4521
  # that if both ServingConfig.boost_control_ids and [SearchRequest.boost_spec]
4352
4522
  # are set, the boost conditions from both places are evaluated. If a search
4353
4523
  # request matches multiple boost conditions, the final boost score is equal to
@@ -4461,7 +4631,7 @@ module Google
4461
4631
  attr_accessor :price_reranking_level
4462
4632
 
4463
4633
  # Condition redirect specifications. Only the first triggered redirect action is
4464
- # applied, even if multiple apply. Maximum number of specifications is 100. Can
4634
+ # applied, even if multiple apply. Maximum number of specifications is 1000. Can
4465
4635
  # only be set if solution_types is SOLUTION_TYPE_SEARCH.
4466
4636
  # Corresponds to the JSON property `redirectControlIds`
4467
4637
  # @return [Array<String>]
@@ -4520,11 +4690,20 @@ module Google
4520
4690
  include Google::Apis::Core::Hashable
4521
4691
 
4522
4692
  # The final component of the resource name of a branch. This field must be one
4523
- # of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
4693
+ # of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned. If there
4694
+ # are no sufficient active products in the targeted branch and force is not set,
4695
+ # a FAILED_PRECONDITION error is returned.
4524
4696
  # Corresponds to the JSON property `branchId`
4525
4697
  # @return [String]
4526
4698
  attr_accessor :branch_id
4527
4699
 
4700
+ # If set to true, it permits switching to a branch with branch_id even if it has
4701
+ # no sufficient active products.
4702
+ # Corresponds to the JSON property `force`
4703
+ # @return [Boolean]
4704
+ attr_accessor :force
4705
+ alias_method :force?, :force
4706
+
4528
4707
  # Some note on this request, this can be retrieved by CatalogService.
4529
4708
  # GetDefaultBranch before next valid default branch set occurs. This field must
4530
4709
  # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
@@ -4540,6 +4719,7 @@ module Google
4540
4719
  # Update properties of this object
4541
4720
  def update!(**args)
4542
4721
  @branch_id = args[:branch_id] if args.key?(:branch_id)
4722
+ @force = args[:force] if args.key?(:force)
4543
4723
  @note = args[:note] if args.key?(:note)
4544
4724
  end
4545
4725
  end
@@ -5127,9 +5307,9 @@ module Google
5127
5307
  class GoogleCloudRetailV2betaImportErrorsConfig
5128
5308
  include Google::Apis::Core::Hashable
5129
5309
 
5130
- # Google Cloud Storage path for import errors. This must be an empty, existing
5131
- # Cloud Storage bucket. Import errors will be written to a file in this bucket,
5132
- # one per line, as a JSON-encoded `google.rpc.Status` message.
5310
+ # Google Cloud Storage prefix for import errors. This must be an empty, existing
5311
+ # Cloud Storage directory. Import errors will be written to sharded files in
5312
+ # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
5133
5313
  # Corresponds to the JSON property `gcsPrefix`
5134
5314
  # @return [String]
5135
5315
  attr_accessor :gcs_prefix
@@ -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.29.0"
19
+ GEM_VERSION = "0.30.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
@@ -160,6 +160,12 @@ module Google
160
160
  include Google::Apis::Core::JsonObjectSupport
161
161
  end
162
162
 
163
+ class GoogleCloudRetailV2alphaAddCatalogAttributeRequest
164
+ class Representation < Google::Apis::Core::JsonRepresentation; end
165
+
166
+ include Google::Apis::Core::JsonObjectSupport
167
+ end
168
+
163
169
  class GoogleCloudRetailV2alphaAddControlRequest
164
170
  class Representation < Google::Apis::Core::JsonRepresentation; end
165
171
 
@@ -202,6 +208,12 @@ module Google
202
208
  include Google::Apis::Core::JsonObjectSupport
203
209
  end
204
210
 
211
+ class GoogleCloudRetailV2alphaAttributesConfig
212
+ class Representation < Google::Apis::Core::JsonRepresentation; end
213
+
214
+ include Google::Apis::Core::JsonObjectSupport
215
+ end
216
+
205
217
  class GoogleCloudRetailV2alphaAudience
206
218
  class Representation < Google::Apis::Core::JsonRepresentation; end
207
219
 
@@ -220,6 +232,12 @@ module Google
220
232
  include Google::Apis::Core::JsonObjectSupport
221
233
  end
222
234
 
235
+ class GoogleCloudRetailV2alphaCatalogAttribute
236
+ class Representation < Google::Apis::Core::JsonRepresentation; end
237
+
238
+ include Google::Apis::Core::JsonObjectSupport
239
+ end
240
+
223
241
  class GoogleCloudRetailV2alphaColorInfo
224
242
  class Representation < Google::Apis::Core::JsonRepresentation; end
225
243
 
@@ -544,6 +562,12 @@ module Google
544
562
  include Google::Apis::Core::JsonObjectSupport
545
563
  end
546
564
 
565
+ class GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest
566
+ class Representation < Google::Apis::Core::JsonRepresentation; end
567
+
568
+ include Google::Apis::Core::JsonObjectSupport
569
+ end
570
+
547
571
  class GoogleCloudRetailV2alphaRemoveControlRequest
548
572
  class Representation < Google::Apis::Core::JsonRepresentation; end
549
573
 
@@ -586,6 +610,12 @@ module Google
586
610
  include Google::Apis::Core::JsonObjectSupport
587
611
  end
588
612
 
613
+ class GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest
614
+ class Representation < Google::Apis::Core::JsonRepresentation; end
615
+
616
+ include Google::Apis::Core::JsonObjectSupport
617
+ end
618
+
589
619
  class GoogleCloudRetailV2alphaRule
590
620
  class Representation < Google::Apis::Core::JsonRepresentation; end
591
621
 
@@ -1116,6 +1146,14 @@ module Google
1116
1146
  end
1117
1147
  end
1118
1148
 
1149
+ class GoogleCloudRetailV2alphaAddCatalogAttributeRequest
1150
+ # @private
1151
+ class Representation < Google::Apis::Core::JsonRepresentation
1152
+ property :catalog_attribute, as: 'catalogAttribute', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute::Representation
1153
+
1154
+ end
1155
+ end
1156
+
1119
1157
  class GoogleCloudRetailV2alphaAddControlRequest
1120
1158
  # @private
1121
1159
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1168,6 +1206,16 @@ module Google
1168
1206
  end
1169
1207
  end
1170
1208
 
1209
+ class GoogleCloudRetailV2alphaAttributesConfig
1210
+ # @private
1211
+ class Representation < Google::Apis::Core::JsonRepresentation
1212
+ property :attribute_config_level, as: 'attributeConfigLevel'
1213
+ hash :catalog_attributes, as: 'catalogAttributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute::Representation
1214
+
1215
+ property :name, as: 'name'
1216
+ end
1217
+ end
1218
+
1171
1219
  class GoogleCloudRetailV2alphaAudience
1172
1220
  # @private
1173
1221
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1201,6 +1249,18 @@ module Google
1201
1249
  end
1202
1250
  end
1203
1251
 
1252
+ class GoogleCloudRetailV2alphaCatalogAttribute
1253
+ # @private
1254
+ class Representation < Google::Apis::Core::JsonRepresentation
1255
+ property :dynamic_facetable_option, as: 'dynamicFacetableOption'
1256
+ property :in_use, as: 'inUse'
1257
+ property :indexable_option, as: 'indexableOption'
1258
+ property :key, as: 'key'
1259
+ property :searchable_option, as: 'searchableOption'
1260
+ property :type, as: 'type'
1261
+ end
1262
+ end
1263
+
1204
1264
  class GoogleCloudRetailV2alphaColorInfo
1205
1265
  # @private
1206
1266
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1741,6 +1801,13 @@ module Google
1741
1801
  end
1742
1802
  end
1743
1803
 
1804
+ class GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest
1805
+ # @private
1806
+ class Representation < Google::Apis::Core::JsonRepresentation
1807
+ property :key, as: 'key'
1808
+ end
1809
+ end
1810
+
1744
1811
  class GoogleCloudRetailV2alphaRemoveControlRequest
1745
1812
  # @private
1746
1813
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1791,6 +1858,15 @@ module Google
1791
1858
  end
1792
1859
  end
1793
1860
 
1861
+ class GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest
1862
+ # @private
1863
+ class Representation < Google::Apis::Core::JsonRepresentation
1864
+ property :catalog_attribute, as: 'catalogAttribute', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute::Representation
1865
+
1866
+ property :update_mask, as: 'updateMask'
1867
+ end
1868
+ end
1869
+
1794
1870
  class GoogleCloudRetailV2alphaRule
1795
1871
  # @private
1796
1872
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2061,6 +2137,7 @@ module Google
2061
2137
  # @private
2062
2138
  class Representation < Google::Apis::Core::JsonRepresentation
2063
2139
  property :branch_id, as: 'branchId'
2140
+ property :force, as: 'force'
2064
2141
  property :note, as: 'note'
2065
2142
  end
2066
2143
  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::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig] parsed result object
140
+ # @yieldparam err [StandardError] error object if request failed
141
+ #
142
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig]
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, 'v2alpha/{+name}', options)
149
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
150
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
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::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig] google_cloud_retail_v2alpha_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::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig] parsed result object
346
+ # @yieldparam err [StandardError] error object if request failed
347
+ #
348
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig]
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_v2alpha_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
354
+ command = make_simple_command(:patch, 'v2alpha/{+name}', options)
355
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
356
+ command.request_object = google_cloud_retail_v2alpha_attributes_config_object
357
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
358
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
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::RetailV2alpha::GoogleCloudRetailV2alphaAddCatalogAttributeRequest] google_cloud_retail_v2alpha_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::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig] parsed result object
382
+ # @yieldparam err [StandardError] error object if request failed
383
+ #
384
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig]
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_v2alpha_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
390
+ command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:addCatalogAttribute', options)
391
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddCatalogAttributeRequest::Representation
392
+ command.request_object = google_cloud_retail_v2alpha_add_catalog_attribute_request_object
393
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
394
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
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::RetailV2alpha::GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest] google_cloud_retail_v2alpha_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::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig] parsed result object
417
+ # @yieldparam err [StandardError] error object if request failed
418
+ #
419
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig]
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_v2alpha_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
425
+ command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:removeCatalogAttribute', options)
426
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest::Representation
427
+ command.request_object = google_cloud_retail_v2alpha_remove_catalog_attribute_request_object
428
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
429
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
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::RetailV2alpha::GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest] google_cloud_retail_v2alpha_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::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig] parsed result object
453
+ # @yieldparam err [StandardError] error object if request failed
454
+ #
455
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig]
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_v2alpha_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
461
+ command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:replaceCatalogAttribute', options)
462
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest::Representation
463
+ command.request_object = google_cloud_retail_v2alpha_replace_catalog_attribute_request_object
464
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
465
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
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
@@ -777,7 +959,7 @@ module Google
777
959
  # CreateProduct or UpdateProduct request. If no inventory fields are set in
778
960
  # CreateProductRequest.product, then any pre-existing inventory information for
779
961
  # this product will be used. If no inventory fields are set in
780
- # UpdateProductRequest.set_mask, then any existing inventory information will be
962
+ # SetInventoryRequest.set_mask, then any existing inventory information will be
781
963
  # preserved. Pre-existing inventory information can only be updated with
782
964
  # SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
783
965
  # 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_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.29.0
4
+ version: 0.30.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_v2alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.29.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.30.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: []