google-apis-retail_v2beta 0.26.0 → 0.29.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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4728dc0b1ed77a4e3bf7d513cfb92adf723b47ef5ad8d703ee2bce8e55ae7e48
|
4
|
+
data.tar.gz: 5854f2bd791423414f15a7e488b15368532fdea6e47336dfcd8440d895a1f4bb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 041ebfef9f76cdaa823dea82e36064e78f22b1ba22e1105b2aa27c74d0e4b35bab1a9d1bca75b1ae73550bb66a7006e1653bd5519019608a58bb92cbf7cce380
|
7
|
+
data.tar.gz: a6e2a57b1d318f25cdd33ca116dc969acd5dfa0592a272906c4d7d3dcd56b7b9c7a393aed35fb1428101944f70efcb6351b52ccb5720d811cde30509df74e82c
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,17 @@
|
|
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
|
+
|
7
|
+
### v0.28.0 (2022-02-12)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20220210
|
10
|
+
|
11
|
+
### v0.27.0 (2022-02-03)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20220127
|
14
|
+
|
3
15
|
### v0.26.0 (2022-01-27)
|
4
16
|
|
5
17
|
* Regenerated from discovery document revision 20220121
|
@@ -333,9 +333,9 @@ module Google
|
|
333
333
|
class GoogleCloudRetailV2ImportErrorsConfig
|
334
334
|
include Google::Apis::Core::Hashable
|
335
335
|
|
336
|
-
# Google Cloud Storage
|
337
|
-
# Cloud Storage
|
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
|
807
|
-
# Cloud Storage
|
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
|
@@ -1270,7 +1326,11 @@ module Google
|
|
1270
1326
|
# Importing catalog data from Merchant Center](https://cloud.google.com/retail/
|
1271
1327
|
# recommendations-ai/docs/upload-catalog#mc). Supported values for user events
|
1272
1328
|
# imports: * `user_event` (default): One JSON UserEvent per line. * `
|
1273
|
-
# user_event_ga360`:
|
1329
|
+
# user_event_ga360`: The schema is available here: https://support.google.com/
|
1330
|
+
# analytics/answer/3437719. * `user_event_ga4`: This feature is in private
|
1331
|
+
# preview. Please contact the support team for importing Google Analytics 4
|
1332
|
+
# events. The schema is available here: https://support.google.com/analytics/
|
1333
|
+
# answer/7029846.
|
1274
1334
|
# Corresponds to the JSON property `dataSchema`
|
1275
1335
|
# @return [String]
|
1276
1336
|
attr_accessor :data_schema
|
@@ -1292,10 +1352,10 @@ module Google
|
|
1292
1352
|
# day and time zone are either specified elsewhere or are insignificant. The
|
1293
1353
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
1294
1354
|
# following: * A full date, with non-zero year, month, and day values * A month
|
1295
|
-
# and day
|
1296
|
-
#
|
1297
|
-
#
|
1298
|
-
# google.protobuf.Timestamp
|
1355
|
+
# and day, with a zero year (e.g., an anniversary) * A year on its own, with a
|
1356
|
+
# zero month and a zero day * A year and month, with a zero day (e.g., a credit
|
1357
|
+
# card expiration date) Related types: * google.type.TimeOfDay * google.type.
|
1358
|
+
# DateTime * google.protobuf.Timestamp
|
1299
1359
|
# Corresponds to the JSON property `partitionDate`
|
1300
1360
|
# @return [Google::Apis::RetailV2beta::GoogleTypeDate]
|
1301
1361
|
attr_accessor :partition_date
|
@@ -1362,6 +1422,72 @@ module Google
|
|
1362
1422
|
end
|
1363
1423
|
end
|
1364
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
|
+
|
1365
1491
|
# The color information of a Product.
|
1366
1492
|
class GoogleCloudRetailV2betaColorInfo
|
1367
1493
|
include Google::Apis::Core::Hashable
|
@@ -1691,10 +1817,12 @@ module Google
|
|
1691
1817
|
class GoogleCloudRetailV2betaCustomAttribute
|
1692
1818
|
include Google::Apis::Core::Hashable
|
1693
1819
|
|
1694
|
-
#
|
1695
|
-
#
|
1696
|
-
#
|
1697
|
-
#
|
1820
|
+
# This field will only be used when AttributesConfig.attribute_config_level of
|
1821
|
+
# the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
|
1822
|
+
# values are indexed, so that it can be filtered, faceted or boosted in
|
1823
|
+
# SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.
|
1824
|
+
# filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more
|
1825
|
+
# details.
|
1698
1826
|
# Corresponds to the JSON property `indexable`
|
1699
1827
|
# @return [Boolean]
|
1700
1828
|
attr_accessor :indexable
|
@@ -1707,17 +1835,20 @@ module Google
|
|
1707
1835
|
# @return [Array<Float>]
|
1708
1836
|
attr_accessor :numbers
|
1709
1837
|
|
1710
|
-
#
|
1711
|
-
#
|
1712
|
-
# text
|
1838
|
+
# This field will only be used when AttributesConfig.attribute_config_level of
|
1839
|
+
# the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
|
1840
|
+
# values are searchable by text queries in SearchService.Search. This field is
|
1841
|
+
# ignored in a UserEvent. Only set if type text is set. Otherwise, a
|
1842
|
+
# INVALID_ARGUMENT error is returned.
|
1713
1843
|
# Corresponds to the JSON property `searchable`
|
1714
1844
|
# @return [Boolean]
|
1715
1845
|
attr_accessor :searchable
|
1716
1846
|
alias_method :searchable?, :searchable
|
1717
1847
|
|
1718
1848
|
# The textual values of this custom attribute. For example, `["yellow", "green"]`
|
1719
|
-
# when the key is "color".
|
1720
|
-
#
|
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.
|
1721
1852
|
# Corresponds to the JSON property `text`
|
1722
1853
|
# @return [Array<String>]
|
1723
1854
|
attr_accessor :text
|
@@ -2035,9 +2166,9 @@ module Google
|
|
2035
2166
|
class GoogleCloudRetailV2betaImportErrorsConfig
|
2036
2167
|
include Google::Apis::Core::Hashable
|
2037
2168
|
|
2038
|
-
# Google Cloud Storage
|
2039
|
-
# Cloud Storage
|
2040
|
-
# 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.
|
2041
2172
|
# Corresponds to the JSON property `gcsPrefix`
|
2042
2173
|
# @return [String]
|
2043
2174
|
attr_accessor :gcs_prefix
|
@@ -2680,9 +2811,9 @@ module Google
|
|
2680
2811
|
# be a UTF-8 encoded string with a length limit of 128 characters. * For
|
2681
2812
|
# indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
|
2682
2813
|
# `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
|
2683
|
-
# values are allowed. Empty values are not allowed. Each value must be a
|
2684
|
-
# encoded string with a length limit of 256 characters. * For number
|
2685
|
-
# 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.
|
2686
2817
|
# Corresponds to the JSON property `attributes`
|
2687
2818
|
# @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
|
2688
2819
|
attr_accessor :attributes
|
@@ -2837,7 +2968,7 @@ module Google
|
|
2837
2968
|
|
2838
2969
|
# The material of the product. For example, "leather", "wooden". A maximum of 20
|
2839
2970
|
# values are allowed. Each value must be a UTF-8 encoded string with a length
|
2840
|
-
# limit of
|
2971
|
+
# limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
2841
2972
|
# Corresponding properties: Google Merchant Center property [material](https://
|
2842
2973
|
# support.google.com/merchants/answer/6324410). Schema.org property [Product.
|
2843
2974
|
# material](https://schema.org/material).
|
@@ -2880,7 +3011,8 @@ module Google
|
|
2880
3011
|
attr_accessor :primary_product_id
|
2881
3012
|
|
2882
3013
|
# The promotions applied to the product. A maximum of 10 values are allowed per
|
2883
|
-
# Product.
|
3014
|
+
# Product. Only Promotion.promotion_id will be used, other fields will be
|
3015
|
+
# ignored if set.
|
2884
3016
|
# Corresponds to the JSON property `promotions`
|
2885
3017
|
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPromotion>]
|
2886
3018
|
attr_accessor :promotions
|
@@ -3159,7 +3291,7 @@ module Google
|
|
3159
3291
|
class GoogleCloudRetailV2betaPromotion
|
3160
3292
|
include Google::Apis::Core::Hashable
|
3161
3293
|
|
3162
|
-
# ID of the promotion. For example, "free gift". The value
|
3294
|
+
# ID of the promotion. For example, "free gift". The value must be a UTF-8
|
3163
3295
|
# encoded string with a length limit of 128 characters, and match the pattern: `
|
3164
3296
|
# a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
|
3165
3297
|
# INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
|
@@ -3390,6 +3522,25 @@ module Google
|
|
3390
3522
|
end
|
3391
3523
|
end
|
3392
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
|
+
|
3393
3544
|
# Request for RemoveControl method.
|
3394
3545
|
class GoogleCloudRetailV2betaRemoveControlRequest
|
3395
3546
|
include Google::Apis::Core::Hashable
|
@@ -3493,6 +3644,34 @@ module Google
|
|
3493
3644
|
end
|
3494
3645
|
end
|
3495
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
|
+
|
3496
3675
|
# A rule is a condition-action pair * A condition defines when a rule is to be
|
3497
3676
|
# triggered. * An action specifies what occurs on that trigger. Currently only
|
3498
3677
|
# boost rules are supported. Currently only supported by the search endpoint.
|
@@ -3911,6 +4090,11 @@ module Google
|
|
3911
4090
|
# @return [String]
|
3912
4091
|
attr_accessor :page_token
|
3913
4092
|
|
4093
|
+
# The specification for personalization.
|
4094
|
+
# Corresponds to the JSON property `personalizationSpec`
|
4095
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestPersonalizationSpec]
|
4096
|
+
attr_accessor :personalization_spec
|
4097
|
+
|
3914
4098
|
# Raw search query.
|
3915
4099
|
# Corresponds to the JSON property `query`
|
3916
4100
|
# @return [String]
|
@@ -3989,6 +4173,7 @@ module Google
|
|
3989
4173
|
@page_categories = args[:page_categories] if args.key?(:page_categories)
|
3990
4174
|
@page_size = args[:page_size] if args.key?(:page_size)
|
3991
4175
|
@page_token = args[:page_token] if args.key?(:page_token)
|
4176
|
+
@personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
|
3992
4177
|
@query = args[:query] if args.key?(:query)
|
3993
4178
|
@query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
|
3994
4179
|
@search_mode = args[:search_mode] if args.key?(:search_mode)
|
@@ -4009,6 +4194,14 @@ module Google
|
|
4009
4194
|
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec>]
|
4010
4195
|
attr_accessor :condition_boost_specs
|
4011
4196
|
|
4197
|
+
# Whether to skip boostspec validation. If this field is set to true, invalid
|
4198
|
+
# BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.
|
4199
|
+
# condition_boost_specs will still be applied.
|
4200
|
+
# Corresponds to the JSON property `skipBoostSpecValidation`
|
4201
|
+
# @return [Boolean]
|
4202
|
+
attr_accessor :skip_boost_spec_validation
|
4203
|
+
alias_method :skip_boost_spec_validation?, :skip_boost_spec_validation
|
4204
|
+
|
4012
4205
|
def initialize(**args)
|
4013
4206
|
update!(**args)
|
4014
4207
|
end
|
@@ -4016,6 +4209,7 @@ module Google
|
|
4016
4209
|
# Update properties of this object
|
4017
4210
|
def update!(**args)
|
4018
4211
|
@condition_boost_specs = args[:condition_boost_specs] if args.key?(:condition_boost_specs)
|
4212
|
+
@skip_boost_spec_validation = args[:skip_boost_spec_validation] if args.key?(:skip_boost_spec_validation)
|
4019
4213
|
end
|
4020
4214
|
end
|
4021
4215
|
|
@@ -4238,6 +4432,25 @@ module Google
|
|
4238
4432
|
end
|
4239
4433
|
end
|
4240
4434
|
|
4435
|
+
# The specification for personalization.
|
4436
|
+
class GoogleCloudRetailV2betaSearchRequestPersonalizationSpec
|
4437
|
+
include Google::Apis::Core::Hashable
|
4438
|
+
|
4439
|
+
# Defaults to Mode.AUTO.
|
4440
|
+
# Corresponds to the JSON property `mode`
|
4441
|
+
# @return [String]
|
4442
|
+
attr_accessor :mode
|
4443
|
+
|
4444
|
+
def initialize(**args)
|
4445
|
+
update!(**args)
|
4446
|
+
end
|
4447
|
+
|
4448
|
+
# Update properties of this object
|
4449
|
+
def update!(**args)
|
4450
|
+
@mode = args[:mode] if args.key?(:mode)
|
4451
|
+
end
|
4452
|
+
end
|
4453
|
+
|
4241
4454
|
# Specification to determine under which conditions query expansion should occur.
|
4242
4455
|
class GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec
|
4243
4456
|
include Google::Apis::Core::Hashable
|
@@ -4294,6 +4507,12 @@ module Google
|
|
4294
4507
|
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacet>]
|
4295
4508
|
attr_accessor :facets
|
4296
4509
|
|
4510
|
+
# The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied
|
4511
|
+
# during serving.
|
4512
|
+
# Corresponds to the JSON property `invalidConditionBoostSpecs`
|
4513
|
+
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec>]
|
4514
|
+
attr_accessor :invalid_condition_boost_specs
|
4515
|
+
|
4297
4516
|
# A token that can be sent as SearchRequest.page_token to retrieve the next page.
|
4298
4517
|
# If this field is omitted, there are no subsequent pages.
|
4299
4518
|
# Corresponds to the JSON property `nextPageToken`
|
@@ -4335,6 +4554,7 @@ module Google
|
|
4335
4554
|
@attribution_token = args[:attribution_token] if args.key?(:attribution_token)
|
4336
4555
|
@corrected_query = args[:corrected_query] if args.key?(:corrected_query)
|
4337
4556
|
@facets = args[:facets] if args.key?(:facets)
|
4557
|
+
@invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs)
|
4338
4558
|
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
4339
4559
|
@query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
|
4340
4560
|
@redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
|
@@ -4503,7 +4723,7 @@ module Google
|
|
4503
4723
|
|
4504
4724
|
# Condition boost specifications. If a product matches multiple conditions in
|
4505
4725
|
# the specifications, boost scores from these specifications are all applied and
|
4506
|
-
# combined in a non-linear way. Maximum number of specifications is
|
4726
|
+
# combined in a non-linear way. Maximum number of specifications is 100. Notice
|
4507
4727
|
# that if both ServingConfig.boost_control_ids and [SearchRequest.boost_spec]
|
4508
4728
|
# are set, the boost conditions from both places are evaluated. If a search
|
4509
4729
|
# request matches multiple boost conditions, the final boost score is equal to
|
@@ -4617,7 +4837,7 @@ module Google
|
|
4617
4837
|
attr_accessor :price_reranking_level
|
4618
4838
|
|
4619
4839
|
# Condition redirect specifications. Only the first triggered redirect action is
|
4620
|
-
# applied, even if multiple apply. Maximum number of specifications is
|
4840
|
+
# applied, even if multiple apply. Maximum number of specifications is 1000. Can
|
4621
4841
|
# only be set if solution_types is SOLUTION_TYPE_SEARCH.
|
4622
4842
|
# Corresponds to the JSON property `redirectControlIds`
|
4623
4843
|
# @return [Array<String>]
|
@@ -4676,11 +4896,20 @@ module Google
|
|
4676
4896
|
include Google::Apis::Core::Hashable
|
4677
4897
|
|
4678
4898
|
# The final component of the resource name of a branch. This field must be one
|
4679
|
-
# 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.
|
4680
4902
|
# Corresponds to the JSON property `branchId`
|
4681
4903
|
# @return [String]
|
4682
4904
|
attr_accessor :branch_id
|
4683
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
|
+
|
4684
4913
|
# Some note on this request, this can be retrieved by CatalogService.
|
4685
4914
|
# GetDefaultBranch before next valid default branch set occurs. This field must
|
4686
4915
|
# be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
|
@@ -4696,6 +4925,7 @@ module Google
|
|
4696
4925
|
# Update properties of this object
|
4697
4926
|
def update!(**args)
|
4698
4927
|
@branch_id = args[:branch_id] if args.key?(:branch_id)
|
4928
|
+
@force = args[:force] if args.key?(:force)
|
4699
4929
|
@note = args[:note] if args.key?(:note)
|
4700
4930
|
end
|
4701
4931
|
end
|
@@ -5274,10 +5504,10 @@ module Google
|
|
5274
5504
|
# day and time zone are either specified elsewhere or are insignificant. The
|
5275
5505
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
5276
5506
|
# following: * A full date, with non-zero year, month, and day values * A month
|
5277
|
-
# and day
|
5278
|
-
#
|
5279
|
-
#
|
5280
|
-
# google.protobuf.Timestamp
|
5507
|
+
# and day, with a zero year (e.g., an anniversary) * A year on its own, with a
|
5508
|
+
# zero month and a zero day * A year and month, with a zero day (e.g., a credit
|
5509
|
+
# card expiration date) Related types: * google.type.TimeOfDay * google.type.
|
5510
|
+
# DateTime * google.protobuf.Timestamp
|
5281
5511
|
class GoogleTypeDate
|
5282
5512
|
include Google::Apis::Core::Hashable
|
5283
5513
|
|
@@ -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.
|
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 = "
|
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
|
|
@@ -766,6 +796,12 @@ module Google
|
|
766
796
|
include Google::Apis::Core::JsonObjectSupport
|
767
797
|
end
|
768
798
|
|
799
|
+
class GoogleCloudRetailV2betaSearchRequestPersonalizationSpec
|
800
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
801
|
+
|
802
|
+
include Google::Apis::Core::JsonObjectSupport
|
803
|
+
end
|
804
|
+
|
769
805
|
class GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec
|
770
806
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
771
807
|
|
@@ -1258,6 +1294,14 @@ module Google
|
|
1258
1294
|
end
|
1259
1295
|
end
|
1260
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
|
+
|
1261
1305
|
class GoogleCloudRetailV2betaAddControlRequest
|
1262
1306
|
# @private
|
1263
1307
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1287,6 +1331,16 @@ module Google
|
|
1287
1331
|
end
|
1288
1332
|
end
|
1289
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
|
+
|
1290
1344
|
class GoogleCloudRetailV2betaAudience
|
1291
1345
|
# @private
|
1292
1346
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1318,6 +1372,18 @@ module Google
|
|
1318
1372
|
end
|
1319
1373
|
end
|
1320
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
|
+
|
1321
1387
|
class GoogleCloudRetailV2betaColorInfo
|
1322
1388
|
# @private
|
1323
1389
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1827,6 +1893,13 @@ module Google
|
|
1827
1893
|
end
|
1828
1894
|
end
|
1829
1895
|
|
1896
|
+
class GoogleCloudRetailV2betaRemoveCatalogAttributeRequest
|
1897
|
+
# @private
|
1898
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1899
|
+
property :key, as: 'key'
|
1900
|
+
end
|
1901
|
+
end
|
1902
|
+
|
1830
1903
|
class GoogleCloudRetailV2betaRemoveControlRequest
|
1831
1904
|
# @private
|
1832
1905
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1856,6 +1929,15 @@ module Google
|
|
1856
1929
|
end
|
1857
1930
|
end
|
1858
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
|
+
|
1859
1941
|
class GoogleCloudRetailV2betaRule
|
1860
1942
|
# @private
|
1861
1943
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1960,6 +2042,8 @@ module Google
|
|
1960
2042
|
collection :page_categories, as: 'pageCategories'
|
1961
2043
|
property :page_size, as: 'pageSize'
|
1962
2044
|
property :page_token, as: 'pageToken'
|
2045
|
+
property :personalization_spec, as: 'personalizationSpec', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestPersonalizationSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestPersonalizationSpec::Representation
|
2046
|
+
|
1963
2047
|
property :query, as: 'query'
|
1964
2048
|
property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec::Representation
|
1965
2049
|
|
@@ -1976,6 +2060,7 @@ module Google
|
|
1976
2060
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1977
2061
|
collection :condition_boost_specs, as: 'conditionBoostSpecs', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec::Representation
|
1978
2062
|
|
2063
|
+
property :skip_boost_spec_validation, as: 'skipBoostSpecValidation'
|
1979
2064
|
end
|
1980
2065
|
end
|
1981
2066
|
|
@@ -2019,6 +2104,13 @@ module Google
|
|
2019
2104
|
end
|
2020
2105
|
end
|
2021
2106
|
|
2107
|
+
class GoogleCloudRetailV2betaSearchRequestPersonalizationSpec
|
2108
|
+
# @private
|
2109
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2110
|
+
property :mode, as: 'mode'
|
2111
|
+
end
|
2112
|
+
end
|
2113
|
+
|
2022
2114
|
class GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec
|
2023
2115
|
# @private
|
2024
2116
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2035,6 +2127,8 @@ module Google
|
|
2035
2127
|
property :corrected_query, as: 'correctedQuery'
|
2036
2128
|
collection :facets, as: 'facets', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacet, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseFacet::Representation
|
2037
2129
|
|
2130
|
+
collection :invalid_condition_boost_specs, as: 'invalidConditionBoostSpecs', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpecConditionBoostSpec::Representation
|
2131
|
+
|
2038
2132
|
property :next_page_token, as: 'nextPageToken'
|
2039
2133
|
property :query_expansion_info, as: 'queryExpansionInfo', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseQueryExpansionInfo, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponseQueryExpansionInfo::Representation
|
2040
2134
|
|
@@ -2113,6 +2207,7 @@ module Google
|
|
2113
2207
|
# @private
|
2114
2208
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2115
2209
|
property :branch_id, as: 'branchId'
|
2210
|
+
property :force, as: 'force'
|
2116
2211
|
property :note, as: 'note'
|
2117
2212
|
end
|
2118
2213
|
end
|
@@ -123,11 +123,39 @@ 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
|
-
# SetDefaultBranch method under a specified parent catalog.
|
128
|
-
# available for users who have Retail Search enabled. Please submit a form [here]
|
129
|
-
# (https://cloud.google.com/contact) to contact cloud sales if you are
|
130
|
-
# interested in using Retail Search.
|
158
|
+
# SetDefaultBranch method under a specified parent catalog.
|
131
159
|
# @param [String] catalog
|
132
160
|
# The parent catalog resource name, such as `projects/*/locations/global/
|
133
161
|
# catalogs/default_catalog`.
|
@@ -256,9 +284,7 @@ module Google
|
|
256
284
|
# PredictionService will only return product IDs from branch `newBranch`. *
|
257
285
|
# SearchService will only return product IDs from branch `newBranch` (if branch
|
258
286
|
# is not explicitly set). * UserEventService will only join events with products
|
259
|
-
# from branch `newBranch`.
|
260
|
-
# Retail Search enabled. Please submit a form [here](https://cloud.google.com/
|
261
|
-
# contact) to contact cloud sales if you are interested in using Retail Search.
|
287
|
+
# from branch `newBranch`.
|
262
288
|
# @param [String] catalog
|
263
289
|
# Full resource name of the catalog, such as `projects/*/locations/global/
|
264
290
|
# catalogs/default_catalog`.
|
@@ -292,6 +318,157 @@ module Google
|
|
292
318
|
execute_or_queue_command(command, &block)
|
293
319
|
end
|
294
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
|
+
|
295
472
|
# Gets the latest state of a long-running operation. Clients can use this method
|
296
473
|
# to poll the operation result at intervals as recommended by the API service.
|
297
474
|
# @param [String] name
|
@@ -687,7 +864,7 @@ module Google
|
|
687
864
|
# CreateProduct or UpdateProduct request. If no inventory fields are set in
|
688
865
|
# CreateProductRequest.product, then any pre-existing inventory information for
|
689
866
|
# this product will be used. If no inventory fields are set in
|
690
|
-
#
|
867
|
+
# SetInventoryRequest.set_mask, then any existing inventory information will be
|
691
868
|
# preserved. Pre-existing inventory information can only be updated with
|
692
869
|
# SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
|
693
870
|
# is only available for users who have Retail Search enabled. Please submit a
|
@@ -1642,6 +1819,83 @@ module Google
|
|
1642
1819
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1643
1820
|
execute_or_queue_command(command, &block)
|
1644
1821
|
end
|
1822
|
+
|
1823
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
1824
|
+
# to poll the operation result at intervals as recommended by the API service.
|
1825
|
+
# @param [String] name
|
1826
|
+
# The name of the operation resource.
|
1827
|
+
# @param [String] fields
|
1828
|
+
# Selector specifying which fields to include in a partial response.
|
1829
|
+
# @param [String] quota_user
|
1830
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1831
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1832
|
+
# @param [Google::Apis::RequestOptions] options
|
1833
|
+
# Request-specific options
|
1834
|
+
#
|
1835
|
+
# @yield [result, err] Result & error if block supplied
|
1836
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
|
1837
|
+
# @yieldparam err [StandardError] error object if request failed
|
1838
|
+
#
|
1839
|
+
# @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
|
1840
|
+
#
|
1841
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1842
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1843
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1844
|
+
def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1845
|
+
command = make_simple_command(:get, 'v2beta/{+name}', options)
|
1846
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
|
1847
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
|
1848
|
+
command.params['name'] = name unless name.nil?
|
1849
|
+
command.query['fields'] = fields unless fields.nil?
|
1850
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1851
|
+
execute_or_queue_command(command, &block)
|
1852
|
+
end
|
1853
|
+
|
1854
|
+
# Lists operations that match the specified filter in the request. If the server
|
1855
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
1856
|
+
# binding allows API services to override the binding to use different resource
|
1857
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
1858
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
1859
|
+
# service configuration. For backwards compatibility, the default name includes
|
1860
|
+
# the operations collection id, however overriding users must ensure the name
|
1861
|
+
# binding is the parent resource, without the operations collection id.
|
1862
|
+
# @param [String] name
|
1863
|
+
# The name of the operation's parent resource.
|
1864
|
+
# @param [String] filter
|
1865
|
+
# The standard list filter.
|
1866
|
+
# @param [Fixnum] page_size
|
1867
|
+
# The standard list page size.
|
1868
|
+
# @param [String] page_token
|
1869
|
+
# The standard list page token.
|
1870
|
+
# @param [String] fields
|
1871
|
+
# Selector specifying which fields to include in a partial response.
|
1872
|
+
# @param [String] quota_user
|
1873
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1874
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1875
|
+
# @param [Google::Apis::RequestOptions] options
|
1876
|
+
# Request-specific options
|
1877
|
+
#
|
1878
|
+
# @yield [result, err] Result & error if block supplied
|
1879
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse] parsed result object
|
1880
|
+
# @yieldparam err [StandardError] error object if request failed
|
1881
|
+
#
|
1882
|
+
# @return [Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse]
|
1883
|
+
#
|
1884
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1885
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1886
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1887
|
+
def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1888
|
+
command = make_simple_command(:get, 'v2beta/{+name}/operations', options)
|
1889
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse::Representation
|
1890
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
|
1891
|
+
command.params['name'] = name unless name.nil?
|
1892
|
+
command.query['filter'] = filter unless filter.nil?
|
1893
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1894
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1895
|
+
command.query['fields'] = fields unless fields.nil?
|
1896
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1897
|
+
execute_or_queue_command(command, &block)
|
1898
|
+
end
|
1645
1899
|
|
1646
1900
|
protected
|
1647
1901
|
|
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.
|
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-
|
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.
|
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: []
|