google-apis-retail_v2alpha 0.27.0 → 0.30.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: e063d9dbc9d57e5e5167021c4f4699971eb55a1483a25bc31bd55de7074b5ddc
|
4
|
+
data.tar.gz: 842cbfd5e27502afd8c0e56772aeffb7274fa30f3d47f36dc82e44bde7b6d0af
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f9336b3c25a5f36ea3c41dc3fee2cb87cf932a7512269552aa018b70c208836cfbc6f5e96f3779937ba6eddebfe085217de9069cf42ed0ffdae72ed949a61b1e
|
7
|
+
data.tar.gz: 77cce5deb4146d7e14327153703190eb03b0f55709791263e0d97522352a79886a75ef6d989249c11e09af5adea5dd1a330f1357d176a0ff8e57b6a12f30b5b2
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,17 @@
|
|
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
|
+
|
7
|
+
### v0.29.0 (2022-02-12)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20220210
|
10
|
+
|
11
|
+
### v0.28.0 (2022-02-03)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20220127
|
14
|
+
|
3
15
|
### v0.27.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
|
@@ -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
|
@@ -851,7 +907,11 @@ module Google
|
|
851
907
|
# Importing catalog data from Merchant Center](https://cloud.google.com/retail/
|
852
908
|
# recommendations-ai/docs/upload-catalog#mc). Supported values for user events
|
853
909
|
# imports: * `user_event` (default): One JSON UserEvent per line. * `
|
854
|
-
# user_event_ga360`:
|
910
|
+
# user_event_ga360`: The schema is available here: https://support.google.com/
|
911
|
+
# analytics/answer/3437719. * `user_event_ga4`: This feature is in private
|
912
|
+
# preview. Please contact the support team for importing Google Analytics 4
|
913
|
+
# events. The schema is available here: https://support.google.com/analytics/
|
914
|
+
# answer/7029846.
|
855
915
|
# Corresponds to the JSON property `dataSchema`
|
856
916
|
# @return [String]
|
857
917
|
attr_accessor :data_schema
|
@@ -873,10 +933,10 @@ module Google
|
|
873
933
|
# day and time zone are either specified elsewhere or are insignificant. The
|
874
934
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
875
935
|
# following: * A full date, with non-zero year, month, and day values * A month
|
876
|
-
# and day
|
877
|
-
#
|
878
|
-
#
|
879
|
-
# google.protobuf.Timestamp
|
936
|
+
# and day, with a zero year (e.g., an anniversary) * A year on its own, with a
|
937
|
+
# zero month and a zero day * A year and month, with a zero day (e.g., a credit
|
938
|
+
# card expiration date) Related types: * google.type.TimeOfDay * google.type.
|
939
|
+
# DateTime * google.protobuf.Timestamp
|
880
940
|
# Corresponds to the JSON property `partitionDate`
|
881
941
|
# @return [Google::Apis::RetailV2alpha::GoogleTypeDate]
|
882
942
|
attr_accessor :partition_date
|
@@ -950,6 +1010,72 @@ module Google
|
|
950
1010
|
end
|
951
1011
|
end
|
952
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
|
+
|
953
1079
|
# The color information of a Product.
|
954
1080
|
class GoogleCloudRetailV2alphaColorInfo
|
955
1081
|
include Google::Apis::Core::Hashable
|
@@ -1279,10 +1405,12 @@ module Google
|
|
1279
1405
|
class GoogleCloudRetailV2alphaCustomAttribute
|
1280
1406
|
include Google::Apis::Core::Hashable
|
1281
1407
|
|
1282
|
-
#
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1408
|
+
# This field will only be used when AttributesConfig.attribute_config_level of
|
1409
|
+
# the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
|
1410
|
+
# values are indexed, so that it can be filtered, faceted or boosted in
|
1411
|
+
# SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.
|
1412
|
+
# filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more
|
1413
|
+
# details.
|
1286
1414
|
# Corresponds to the JSON property `indexable`
|
1287
1415
|
# @return [Boolean]
|
1288
1416
|
attr_accessor :indexable
|
@@ -1295,17 +1423,20 @@ module Google
|
|
1295
1423
|
# @return [Array<Float>]
|
1296
1424
|
attr_accessor :numbers
|
1297
1425
|
|
1298
|
-
#
|
1299
|
-
#
|
1300
|
-
# text
|
1426
|
+
# This field will only be used when AttributesConfig.attribute_config_level of
|
1427
|
+
# the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
|
1428
|
+
# values are searchable by text queries in SearchService.Search. This field is
|
1429
|
+
# ignored in a UserEvent. Only set if type text is set. Otherwise, a
|
1430
|
+
# INVALID_ARGUMENT error is returned.
|
1301
1431
|
# Corresponds to the JSON property `searchable`
|
1302
1432
|
# @return [Boolean]
|
1303
1433
|
attr_accessor :searchable
|
1304
1434
|
alias_method :searchable?, :searchable
|
1305
1435
|
|
1306
1436
|
# The textual values of this custom attribute. For example, `["yellow", "green"]`
|
1307
|
-
# when the key is "color".
|
1308
|
-
#
|
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.
|
1309
1440
|
# Corresponds to the JSON property `text`
|
1310
1441
|
# @return [Array<String>]
|
1311
1442
|
attr_accessor :text
|
@@ -1623,9 +1754,9 @@ module Google
|
|
1623
1754
|
class GoogleCloudRetailV2alphaImportErrorsConfig
|
1624
1755
|
include Google::Apis::Core::Hashable
|
1625
1756
|
|
1626
|
-
# Google Cloud Storage
|
1627
|
-
# Cloud Storage
|
1628
|
-
# 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.
|
1629
1760
|
# Corresponds to the JSON property `gcsPrefix`
|
1630
1761
|
# @return [String]
|
1631
1762
|
attr_accessor :gcs_prefix
|
@@ -2053,9 +2184,9 @@ module Google
|
|
2053
2184
|
attr_accessor :destinations
|
2054
2185
|
|
2055
2186
|
# Language of the title/description and other string attributes. Use language
|
2056
|
-
# tags defined by BCP 47.
|
2057
|
-
#
|
2058
|
-
# performed.
|
2187
|
+
# tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO
|
2188
|
+
# 639-1. This specifies the language of offers in Merchant Center that will be
|
2189
|
+
# accepted. If empty no language filtering will be performed.
|
2059
2190
|
# Corresponds to the JSON property `languageCode`
|
2060
2191
|
# @return [String]
|
2061
2192
|
attr_accessor :language_code
|
@@ -2068,9 +2199,9 @@ module Google
|
|
2068
2199
|
attr_accessor :merchant_center_account_id
|
2069
2200
|
|
2070
2201
|
# Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code.
|
2071
|
-
# List of values can be found here
|
2072
|
-
#
|
2073
|
-
# no region filtering will be performed.
|
2202
|
+
# List of values can be found [here](https://www.iana.org/assignments/language-
|
2203
|
+
# subtag-registry/language-subtag-registry) under the `region` tag. If left
|
2204
|
+
# blank no region filtering will be performed. Example value: `US`.
|
2074
2205
|
# Corresponds to the JSON property `regionCode`
|
2075
2206
|
# @return [String]
|
2076
2207
|
attr_accessor :region_code
|
@@ -2398,9 +2529,9 @@ module Google
|
|
2398
2529
|
# be a UTF-8 encoded string with a length limit of 128 characters. * For
|
2399
2530
|
# indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
|
2400
2531
|
# `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
|
2401
|
-
# values are allowed. Empty values are not allowed. Each value must be a
|
2402
|
-
# encoded string with a length limit of 256 characters. * For number
|
2403
|
-
# 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.
|
2404
2535
|
# Corresponds to the JSON property `attributes`
|
2405
2536
|
# @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
|
2406
2537
|
attr_accessor :attributes
|
@@ -2555,7 +2686,7 @@ module Google
|
|
2555
2686
|
|
2556
2687
|
# The material of the product. For example, "leather", "wooden". A maximum of 20
|
2557
2688
|
# values are allowed. Each value must be a UTF-8 encoded string with a length
|
2558
|
-
# limit of
|
2689
|
+
# limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
2559
2690
|
# Corresponding properties: Google Merchant Center property [material](https://
|
2560
2691
|
# support.google.com/merchants/answer/6324410). Schema.org property [Product.
|
2561
2692
|
# material](https://schema.org/material).
|
@@ -2598,7 +2729,8 @@ module Google
|
|
2598
2729
|
attr_accessor :primary_product_id
|
2599
2730
|
|
2600
2731
|
# The promotions applied to the product. A maximum of 10 values are allowed per
|
2601
|
-
# Product.
|
2732
|
+
# Product. Only Promotion.promotion_id will be used, other fields will be
|
2733
|
+
# ignored if set.
|
2602
2734
|
# Corresponds to the JSON property `promotions`
|
2603
2735
|
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPromotion>]
|
2604
2736
|
attr_accessor :promotions
|
@@ -2877,7 +3009,7 @@ module Google
|
|
2877
3009
|
class GoogleCloudRetailV2alphaPromotion
|
2878
3010
|
include Google::Apis::Core::Hashable
|
2879
3011
|
|
2880
|
-
# ID of the promotion. For example, "free gift". The value
|
3012
|
+
# ID of the promotion. For example, "free gift". The value must be a UTF-8
|
2881
3013
|
# encoded string with a length limit of 128 characters, and match the pattern: `
|
2882
3014
|
# a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
|
2883
3015
|
# INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
|
@@ -3108,6 +3240,25 @@ module Google
|
|
3108
3240
|
end
|
3109
3241
|
end
|
3110
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
|
+
|
3111
3262
|
# Request for RemoveControl method.
|
3112
3263
|
class GoogleCloudRetailV2alphaRemoveControlRequest
|
3113
3264
|
include Google::Apis::Core::Hashable
|
@@ -3278,6 +3429,34 @@ module Google
|
|
3278
3429
|
end
|
3279
3430
|
end
|
3280
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
|
+
|
3281
3460
|
# A rule is a condition-action pair * A condition defines when a rule is to be
|
3282
3461
|
# triggered. * An action specifies what occurs on that trigger. Currently only
|
3283
3462
|
# boost rules are supported. Currently only supported by the search endpoint.
|
@@ -3696,6 +3875,11 @@ module Google
|
|
3696
3875
|
# @return [String]
|
3697
3876
|
attr_accessor :page_token
|
3698
3877
|
|
3878
|
+
# The specification for personalization.
|
3879
|
+
# Corresponds to the JSON property `personalizationSpec`
|
3880
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec]
|
3881
|
+
attr_accessor :personalization_spec
|
3882
|
+
|
3699
3883
|
# Raw search query.
|
3700
3884
|
# Corresponds to the JSON property `query`
|
3701
3885
|
# @return [String]
|
@@ -3782,6 +3966,7 @@ module Google
|
|
3782
3966
|
@page_categories = args[:page_categories] if args.key?(:page_categories)
|
3783
3967
|
@page_size = args[:page_size] if args.key?(:page_size)
|
3784
3968
|
@page_token = args[:page_token] if args.key?(:page_token)
|
3969
|
+
@personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
|
3785
3970
|
@query = args[:query] if args.key?(:query)
|
3786
3971
|
@query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
|
3787
3972
|
@relevance_threshold = args[:relevance_threshold] if args.key?(:relevance_threshold)
|
@@ -3803,6 +3988,14 @@ module Google
|
|
3803
3988
|
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec>]
|
3804
3989
|
attr_accessor :condition_boost_specs
|
3805
3990
|
|
3991
|
+
# Whether to skip boostspec validation. If this field is set to true, invalid
|
3992
|
+
# BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.
|
3993
|
+
# condition_boost_specs will still be applied.
|
3994
|
+
# Corresponds to the JSON property `skipBoostSpecValidation`
|
3995
|
+
# @return [Boolean]
|
3996
|
+
attr_accessor :skip_boost_spec_validation
|
3997
|
+
alias_method :skip_boost_spec_validation?, :skip_boost_spec_validation
|
3998
|
+
|
3806
3999
|
def initialize(**args)
|
3807
4000
|
update!(**args)
|
3808
4001
|
end
|
@@ -3810,6 +4003,7 @@ module Google
|
|
3810
4003
|
# Update properties of this object
|
3811
4004
|
def update!(**args)
|
3812
4005
|
@condition_boost_specs = args[:condition_boost_specs] if args.key?(:condition_boost_specs)
|
4006
|
+
@skip_boost_spec_validation = args[:skip_boost_spec_validation] if args.key?(:skip_boost_spec_validation)
|
3813
4007
|
end
|
3814
4008
|
end
|
3815
4009
|
|
@@ -4032,6 +4226,25 @@ module Google
|
|
4032
4226
|
end
|
4033
4227
|
end
|
4034
4228
|
|
4229
|
+
# The specification for personalization.
|
4230
|
+
class GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec
|
4231
|
+
include Google::Apis::Core::Hashable
|
4232
|
+
|
4233
|
+
# Defaults to Mode.AUTO.
|
4234
|
+
# Corresponds to the JSON property `mode`
|
4235
|
+
# @return [String]
|
4236
|
+
attr_accessor :mode
|
4237
|
+
|
4238
|
+
def initialize(**args)
|
4239
|
+
update!(**args)
|
4240
|
+
end
|
4241
|
+
|
4242
|
+
# Update properties of this object
|
4243
|
+
def update!(**args)
|
4244
|
+
@mode = args[:mode] if args.key?(:mode)
|
4245
|
+
end
|
4246
|
+
end
|
4247
|
+
|
4035
4248
|
# Specification to determine under which conditions query expansion should occur.
|
4036
4249
|
class GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec
|
4037
4250
|
include Google::Apis::Core::Hashable
|
@@ -4088,6 +4301,12 @@ module Google
|
|
4088
4301
|
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet>]
|
4089
4302
|
attr_accessor :facets
|
4090
4303
|
|
4304
|
+
# The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied
|
4305
|
+
# during serving.
|
4306
|
+
# Corresponds to the JSON property `invalidConditionBoostSpecs`
|
4307
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec>]
|
4308
|
+
attr_accessor :invalid_condition_boost_specs
|
4309
|
+
|
4091
4310
|
# A token that can be sent as SearchRequest.page_token to retrieve the next page.
|
4092
4311
|
# If this field is omitted, there are no subsequent pages.
|
4093
4312
|
# Corresponds to the JSON property `nextPageToken`
|
@@ -4129,6 +4348,7 @@ module Google
|
|
4129
4348
|
@attribution_token = args[:attribution_token] if args.key?(:attribution_token)
|
4130
4349
|
@corrected_query = args[:corrected_query] if args.key?(:corrected_query)
|
4131
4350
|
@facets = args[:facets] if args.key?(:facets)
|
4351
|
+
@invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs)
|
4132
4352
|
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
4133
4353
|
@query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
|
4134
4354
|
@redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
|
@@ -4297,7 +4517,7 @@ module Google
|
|
4297
4517
|
|
4298
4518
|
# Condition boost specifications. If a product matches multiple conditions in
|
4299
4519
|
# the specifications, boost scores from these specifications are all applied and
|
4300
|
-
# combined in a non-linear way. Maximum number of specifications is
|
4520
|
+
# combined in a non-linear way. Maximum number of specifications is 100. Notice
|
4301
4521
|
# that if both ServingConfig.boost_control_ids and [SearchRequest.boost_spec]
|
4302
4522
|
# are set, the boost conditions from both places are evaluated. If a search
|
4303
4523
|
# request matches multiple boost conditions, the final boost score is equal to
|
@@ -4411,7 +4631,7 @@ module Google
|
|
4411
4631
|
attr_accessor :price_reranking_level
|
4412
4632
|
|
4413
4633
|
# Condition redirect specifications. Only the first triggered redirect action is
|
4414
|
-
# applied, even if multiple apply. Maximum number of specifications is
|
4634
|
+
# applied, even if multiple apply. Maximum number of specifications is 1000. Can
|
4415
4635
|
# only be set if solution_types is SOLUTION_TYPE_SEARCH.
|
4416
4636
|
# Corresponds to the JSON property `redirectControlIds`
|
4417
4637
|
# @return [Array<String>]
|
@@ -4470,11 +4690,20 @@ module Google
|
|
4470
4690
|
include Google::Apis::Core::Hashable
|
4471
4691
|
|
4472
4692
|
# The final component of the resource name of a branch. This field must be one
|
4473
|
-
# 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.
|
4474
4696
|
# Corresponds to the JSON property `branchId`
|
4475
4697
|
# @return [String]
|
4476
4698
|
attr_accessor :branch_id
|
4477
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
|
+
|
4478
4707
|
# Some note on this request, this can be retrieved by CatalogService.
|
4479
4708
|
# GetDefaultBranch before next valid default branch set occurs. This field must
|
4480
4709
|
# be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
|
@@ -4490,6 +4719,7 @@ module Google
|
|
4490
4719
|
# Update properties of this object
|
4491
4720
|
def update!(**args)
|
4492
4721
|
@branch_id = args[:branch_id] if args.key?(:branch_id)
|
4722
|
+
@force = args[:force] if args.key?(:force)
|
4493
4723
|
@note = args[:note] if args.key?(:note)
|
4494
4724
|
end
|
4495
4725
|
end
|
@@ -5077,9 +5307,9 @@ module Google
|
|
5077
5307
|
class GoogleCloudRetailV2betaImportErrorsConfig
|
5078
5308
|
include Google::Apis::Core::Hashable
|
5079
5309
|
|
5080
|
-
# Google Cloud Storage
|
5081
|
-
# Cloud Storage
|
5082
|
-
# 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.
|
5083
5313
|
# Corresponds to the JSON property `gcsPrefix`
|
5084
5314
|
# @return [String]
|
5085
5315
|
attr_accessor :gcs_prefix
|
@@ -5509,10 +5739,10 @@ module Google
|
|
5509
5739
|
# day and time zone are either specified elsewhere or are insignificant. The
|
5510
5740
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
5511
5741
|
# following: * A full date, with non-zero year, month, and day values * A month
|
5512
|
-
# and day
|
5513
|
-
#
|
5514
|
-
#
|
5515
|
-
# google.protobuf.Timestamp
|
5742
|
+
# and day, with a zero year (e.g., an anniversary) * A year on its own, with a
|
5743
|
+
# zero month and a zero day * A year and month, with a zero day (e.g., a credit
|
5744
|
+
# card expiration date) Related types: * google.type.TimeOfDay * google.type.
|
5745
|
+
# DateTime * google.protobuf.Timestamp
|
5516
5746
|
class GoogleTypeDate
|
5517
5747
|
include Google::Apis::Core::Hashable
|
5518
5748
|
|
@@ -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.
|
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 = "
|
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
|
|
@@ -676,6 +706,12 @@ module Google
|
|
676
706
|
include Google::Apis::Core::JsonObjectSupport
|
677
707
|
end
|
678
708
|
|
709
|
+
class GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec
|
710
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
711
|
+
|
712
|
+
include Google::Apis::Core::JsonObjectSupport
|
713
|
+
end
|
714
|
+
|
679
715
|
class GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec
|
680
716
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
681
717
|
|
@@ -1110,6 +1146,14 @@ module Google
|
|
1110
1146
|
end
|
1111
1147
|
end
|
1112
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
|
+
|
1113
1157
|
class GoogleCloudRetailV2alphaAddControlRequest
|
1114
1158
|
# @private
|
1115
1159
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1162,6 +1206,16 @@ module Google
|
|
1162
1206
|
end
|
1163
1207
|
end
|
1164
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
|
+
|
1165
1219
|
class GoogleCloudRetailV2alphaAudience
|
1166
1220
|
# @private
|
1167
1221
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1195,6 +1249,18 @@ module Google
|
|
1195
1249
|
end
|
1196
1250
|
end
|
1197
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
|
+
|
1198
1264
|
class GoogleCloudRetailV2alphaColorInfo
|
1199
1265
|
# @private
|
1200
1266
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1735,6 +1801,13 @@ module Google
|
|
1735
1801
|
end
|
1736
1802
|
end
|
1737
1803
|
|
1804
|
+
class GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest
|
1805
|
+
# @private
|
1806
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1807
|
+
property :key, as: 'key'
|
1808
|
+
end
|
1809
|
+
end
|
1810
|
+
|
1738
1811
|
class GoogleCloudRetailV2alphaRemoveControlRequest
|
1739
1812
|
# @private
|
1740
1813
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1785,6 +1858,15 @@ module Google
|
|
1785
1858
|
end
|
1786
1859
|
end
|
1787
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
|
+
|
1788
1870
|
class GoogleCloudRetailV2alphaRule
|
1789
1871
|
# @private
|
1790
1872
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1889,6 +1971,8 @@ module Google
|
|
1889
1971
|
collection :page_categories, as: 'pageCategories'
|
1890
1972
|
property :page_size, as: 'pageSize'
|
1891
1973
|
property :page_token, as: 'pageToken'
|
1974
|
+
property :personalization_spec, as: 'personalizationSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec::Representation
|
1975
|
+
|
1892
1976
|
property :query, as: 'query'
|
1893
1977
|
property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec::Representation
|
1894
1978
|
|
@@ -1906,6 +1990,7 @@ module Google
|
|
1906
1990
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1907
1991
|
collection :condition_boost_specs, as: 'conditionBoostSpecs', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec::Representation
|
1908
1992
|
|
1993
|
+
property :skip_boost_spec_validation, as: 'skipBoostSpecValidation'
|
1909
1994
|
end
|
1910
1995
|
end
|
1911
1996
|
|
@@ -1949,6 +2034,13 @@ module Google
|
|
1949
2034
|
end
|
1950
2035
|
end
|
1951
2036
|
|
2037
|
+
class GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec
|
2038
|
+
# @private
|
2039
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2040
|
+
property :mode, as: 'mode'
|
2041
|
+
end
|
2042
|
+
end
|
2043
|
+
|
1952
2044
|
class GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec
|
1953
2045
|
# @private
|
1954
2046
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1965,6 +2057,8 @@ module Google
|
|
1965
2057
|
property :corrected_query, as: 'correctedQuery'
|
1966
2058
|
collection :facets, as: 'facets', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet::Representation
|
1967
2059
|
|
2060
|
+
collection :invalid_condition_boost_specs, as: 'invalidConditionBoostSpecs', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec::Representation
|
2061
|
+
|
1968
2062
|
property :next_page_token, as: 'nextPageToken'
|
1969
2063
|
property :query_expansion_info, as: 'queryExpansionInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo::Representation
|
1970
2064
|
|
@@ -2043,6 +2137,7 @@ module Google
|
|
2043
2137
|
# @private
|
2044
2138
|
class Representation < Google::Apis::Core::JsonRepresentation
|
2045
2139
|
property :branch_id, as: 'branchId'
|
2140
|
+
property :force, as: 'force'
|
2046
2141
|
property :note, as: 'note'
|
2047
2142
|
end
|
2048
2143
|
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::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
|
-
# 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::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
|
+
|
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
|
@@ -782,7 +959,7 @@ module Google
|
|
782
959
|
# CreateProduct or UpdateProduct request. If no inventory fields are set in
|
783
960
|
# CreateProductRequest.product, then any pre-existing inventory information for
|
784
961
|
# this product will be used. If no inventory fields are set in
|
785
|
-
#
|
962
|
+
# SetInventoryRequest.set_mask, then any existing inventory information will be
|
786
963
|
# preserved. Pre-existing inventory information can only be updated with
|
787
964
|
# SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
|
788
965
|
# is only available for users who have Retail Search enabled. Please submit a
|
@@ -1737,6 +1914,83 @@ module Google
|
|
1737
1914
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1738
1915
|
execute_or_queue_command(command, &block)
|
1739
1916
|
end
|
1917
|
+
|
1918
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
1919
|
+
# to poll the operation result at intervals as recommended by the API service.
|
1920
|
+
# @param [String] name
|
1921
|
+
# The name of the operation resource.
|
1922
|
+
# @param [String] fields
|
1923
|
+
# Selector specifying which fields to include in a partial response.
|
1924
|
+
# @param [String] quota_user
|
1925
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1926
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1927
|
+
# @param [Google::Apis::RequestOptions] options
|
1928
|
+
# Request-specific options
|
1929
|
+
#
|
1930
|
+
# @yield [result, err] Result & error if block supplied
|
1931
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
1932
|
+
# @yieldparam err [StandardError] error object if request failed
|
1933
|
+
#
|
1934
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
1935
|
+
#
|
1936
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1937
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1938
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1939
|
+
def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1940
|
+
command = make_simple_command(:get, 'v2alpha/{+name}', options)
|
1941
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
1942
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
1943
|
+
command.params['name'] = name unless name.nil?
|
1944
|
+
command.query['fields'] = fields unless fields.nil?
|
1945
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1946
|
+
execute_or_queue_command(command, &block)
|
1947
|
+
end
|
1948
|
+
|
1949
|
+
# Lists operations that match the specified filter in the request. If the server
|
1950
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
1951
|
+
# binding allows API services to override the binding to use different resource
|
1952
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
1953
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
1954
|
+
# service configuration. For backwards compatibility, the default name includes
|
1955
|
+
# the operations collection id, however overriding users must ensure the name
|
1956
|
+
# binding is the parent resource, without the operations collection id.
|
1957
|
+
# @param [String] name
|
1958
|
+
# The name of the operation's parent resource.
|
1959
|
+
# @param [String] filter
|
1960
|
+
# The standard list filter.
|
1961
|
+
# @param [Fixnum] page_size
|
1962
|
+
# The standard list page size.
|
1963
|
+
# @param [String] page_token
|
1964
|
+
# The standard list page token.
|
1965
|
+
# @param [String] fields
|
1966
|
+
# Selector specifying which fields to include in a partial response.
|
1967
|
+
# @param [String] quota_user
|
1968
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1969
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1970
|
+
# @param [Google::Apis::RequestOptions] options
|
1971
|
+
# Request-specific options
|
1972
|
+
#
|
1973
|
+
# @yield [result, err] Result & error if block supplied
|
1974
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
1975
|
+
# @yieldparam err [StandardError] error object if request failed
|
1976
|
+
#
|
1977
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse]
|
1978
|
+
#
|
1979
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1980
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1981
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1982
|
+
def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1983
|
+
command = make_simple_command(:get, 'v2alpha/{+name}/operations', options)
|
1984
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse::Representation
|
1985
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse
|
1986
|
+
command.params['name'] = name unless name.nil?
|
1987
|
+
command.query['filter'] = filter unless filter.nil?
|
1988
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1989
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1990
|
+
command.query['fields'] = fields unless fields.nil?
|
1991
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1992
|
+
execute_or_queue_command(command, &block)
|
1993
|
+
end
|
1740
1994
|
|
1741
1995
|
protected
|
1742
1996
|
|
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.
|
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-
|
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.
|
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: []
|