google-apis-retail_v2 0.48.0 → 0.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/retail_v2/classes.rb +322 -14
- data/lib/google/apis/retail_v2/gem_version.rb +2 -2
- data/lib/google/apis/retail_v2/representations.rb +107 -0
- data/lib/google/apis/retail_v2/service.rb +217 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0c62a4567121d5e75859b186c3628cb98f5279306a8e601852e37228d0e98c16
|
4
|
+
data.tar.gz: 4cadc51f7f526c50a16762fb92b28dd70daf268fbec5253077d5534db7da89cc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0750dc060f2a765b70f9f94275ef1378933f730c86c0055297437b3e1999a9e66b38b0ab290fee709b99e0d95d6bb02ec4b45d38a99af0e1314a1fef241c5119
|
7
|
+
data.tar.gz: 20ac0cb800b15e1ae7d6258a44bfa6039e5936e9a75bd3fbd712ed8ef9733e49826611697cd393623ab870d26b3d1734ccc91a28d2d60f748d1f0830049eddc6
|
data/CHANGELOG.md
CHANGED
@@ -279,6 +279,26 @@ module Google
|
|
279
279
|
end
|
280
280
|
end
|
281
281
|
|
282
|
+
# Request for CatalogService.AddCatalogAttribute method.
|
283
|
+
class GoogleCloudRetailV2AddCatalogAttributeRequest
|
284
|
+
include Google::Apis::Core::Hashable
|
285
|
+
|
286
|
+
# Catalog level attribute config for an attribute. For example, if customers
|
287
|
+
# want to enable/disable facet for a specific attribute.
|
288
|
+
# Corresponds to the JSON property `catalogAttribute`
|
289
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute]
|
290
|
+
attr_accessor :catalog_attribute
|
291
|
+
|
292
|
+
def initialize(**args)
|
293
|
+
update!(**args)
|
294
|
+
end
|
295
|
+
|
296
|
+
# Update properties of this object
|
297
|
+
def update!(**args)
|
298
|
+
@catalog_attribute = args[:catalog_attribute] if args.key?(:catalog_attribute)
|
299
|
+
end
|
300
|
+
end
|
301
|
+
|
282
302
|
# Metadata related to the progress of the AddFulfillmentPlaces operation.
|
283
303
|
# Currently empty because there is no meaningful metadata populated from the
|
284
304
|
# ProductService.AddFulfillmentPlaces method.
|
@@ -446,6 +466,42 @@ module Google
|
|
446
466
|
end
|
447
467
|
end
|
448
468
|
|
469
|
+
# Catalog level attribute config.
|
470
|
+
class GoogleCloudRetailV2AttributesConfig
|
471
|
+
include Google::Apis::Core::Hashable
|
472
|
+
|
473
|
+
# Output only. The AttributeConfigLevel used for this catalog.
|
474
|
+
# Corresponds to the JSON property `attributeConfigLevel`
|
475
|
+
# @return [String]
|
476
|
+
attr_accessor :attribute_config_level
|
477
|
+
|
478
|
+
# Enable attribute(s) config at catalog level. For example, indexable,
|
479
|
+
# dynamic_facetable, or searchable for each attribute. The key is catalog
|
480
|
+
# attribute's name. For example: `color`, `brands`, `attributes.custom_attribute`
|
481
|
+
# , such as `attributes.xyz`. The maximum number of catalog attributes allowed
|
482
|
+
# in a request is 1000.
|
483
|
+
# Corresponds to the JSON property `catalogAttributes`
|
484
|
+
# @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute>]
|
485
|
+
attr_accessor :catalog_attributes
|
486
|
+
|
487
|
+
# Required. Immutable. The fully qualified resource name of the attribute config.
|
488
|
+
# Format: `projects/*/locations/*/catalogs/*/attributesConfig`
|
489
|
+
# Corresponds to the JSON property `name`
|
490
|
+
# @return [String]
|
491
|
+
attr_accessor :name
|
492
|
+
|
493
|
+
def initialize(**args)
|
494
|
+
update!(**args)
|
495
|
+
end
|
496
|
+
|
497
|
+
# Update properties of this object
|
498
|
+
def update!(**args)
|
499
|
+
@attribute_config_level = args[:attribute_config_level] if args.key?(:attribute_config_level)
|
500
|
+
@catalog_attributes = args[:catalog_attributes] if args.key?(:catalog_attributes)
|
501
|
+
@name = args[:name] if args.key?(:name)
|
502
|
+
end
|
503
|
+
end
|
504
|
+
|
449
505
|
# An intended audience of the Product for whom it's sold.
|
450
506
|
class GoogleCloudRetailV2Audience
|
451
507
|
include Google::Apis::Core::Hashable
|
@@ -495,12 +551,11 @@ module Google
|
|
495
551
|
# recommendations-ai/docs/upload-catalog#mc). Supported values for user events
|
496
552
|
# imports: * `user_event` (default): One JSON UserEvent per line. * `
|
497
553
|
# user_event_ga360`: The schema is available here: https://support.google.com/
|
498
|
-
# analytics/answer/3437719. * `user_event_ga4`:
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
# suggestion per line. * `allowlist`: One JSON allow suggestion per line.
|
554
|
+
# analytics/answer/3437719. * `user_event_ga4`: The schema is available here:
|
555
|
+
# https://support.google.com/analytics/answer/7029846. Supported values for auto-
|
556
|
+
# completion imports: * `suggestions` (default): One JSON completion suggestion
|
557
|
+
# per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One
|
558
|
+
# JSON allow suggestion per line.
|
504
559
|
# Corresponds to the JSON property `dataSchema`
|
505
560
|
# @return [String]
|
506
561
|
attr_accessor :data_schema
|
@@ -592,6 +647,79 @@ module Google
|
|
592
647
|
end
|
593
648
|
end
|
594
649
|
|
650
|
+
# Catalog level attribute config for an attribute. For example, if customers
|
651
|
+
# want to enable/disable facet for a specific attribute.
|
652
|
+
class GoogleCloudRetailV2CatalogAttribute
|
653
|
+
include Google::Apis::Core::Hashable
|
654
|
+
|
655
|
+
# If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet.
|
656
|
+
# Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option
|
657
|
+
# is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
|
658
|
+
# Corresponds to the JSON property `dynamicFacetableOption`
|
659
|
+
# @return [String]
|
660
|
+
attr_accessor :dynamic_facetable_option
|
661
|
+
|
662
|
+
# Output only. Indicates whether this attribute has been used by any products. `
|
663
|
+
# True` if at least one Product is using this attribute in Product.attributes.
|
664
|
+
# Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
|
665
|
+
# CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
|
666
|
+
# CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
|
667
|
+
# loaded CatalogAttributes. Only pre-loaded CatalogAttributes that are neither
|
668
|
+
# in use by products nor predefined can be deleted. CatalogAttributes that are
|
669
|
+
# either in use by products or are predefined cannot be deleted; however, their
|
670
|
+
# configuration properties will reset to default values upon removal request.
|
671
|
+
# After catalog changes, it takes about 10 minutes for this field to update.
|
672
|
+
# Corresponds to the JSON property `inUse`
|
673
|
+
# @return [Boolean]
|
674
|
+
attr_accessor :in_use
|
675
|
+
alias_method :in_use?, :in_use
|
676
|
+
|
677
|
+
# When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
|
678
|
+
# if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered,
|
679
|
+
# faceted, or boosted in SearchService.Search.
|
680
|
+
# Corresponds to the JSON property `indexableOption`
|
681
|
+
# @return [String]
|
682
|
+
attr_accessor :indexable_option
|
683
|
+
|
684
|
+
# Required. Attribute name. For example: `color`, `brands`, `attributes.
|
685
|
+
# custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute
|
686
|
+
# name can contain only alpha-numeric characters and underscores. For example,
|
687
|
+
# an attribute named `attributes.abc_xyz` can be indexed, but an attribute named
|
688
|
+
# `attributes.abc-xyz` cannot be indexed.
|
689
|
+
# Corresponds to the JSON property `key`
|
690
|
+
# @return [String]
|
691
|
+
attr_accessor :key
|
692
|
+
|
693
|
+
# When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
|
694
|
+
# if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
|
695
|
+
# SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
|
696
|
+
# attribute values will not be searchable by text queries in SearchService.
|
697
|
+
# Search, as there are no text values associated to numerical attributes.
|
698
|
+
# Corresponds to the JSON property `searchableOption`
|
699
|
+
# @return [String]
|
700
|
+
attr_accessor :searchable_option
|
701
|
+
|
702
|
+
# Output only. The type of this attribute. This is derived from the attribute in
|
703
|
+
# Product.attributes.
|
704
|
+
# Corresponds to the JSON property `type`
|
705
|
+
# @return [String]
|
706
|
+
attr_accessor :type
|
707
|
+
|
708
|
+
def initialize(**args)
|
709
|
+
update!(**args)
|
710
|
+
end
|
711
|
+
|
712
|
+
# Update properties of this object
|
713
|
+
def update!(**args)
|
714
|
+
@dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
|
715
|
+
@in_use = args[:in_use] if args.key?(:in_use)
|
716
|
+
@indexable_option = args[:indexable_option] if args.key?(:indexable_option)
|
717
|
+
@key = args[:key] if args.key?(:key)
|
718
|
+
@searchable_option = args[:searchable_option] if args.key?(:searchable_option)
|
719
|
+
@type = args[:type] if args.key?(:type)
|
720
|
+
end
|
721
|
+
end
|
722
|
+
|
595
723
|
# The color information of a Product.
|
596
724
|
class GoogleCloudRetailV2ColorInfo
|
597
725
|
include Google::Apis::Core::Hashable
|
@@ -721,6 +849,105 @@ module Google
|
|
721
849
|
end
|
722
850
|
end
|
723
851
|
|
852
|
+
# Catalog level autocomplete config for customers to customize autocomplete
|
853
|
+
# feature's settings.
|
854
|
+
class GoogleCloudRetailV2CompletionConfig
|
855
|
+
include Google::Apis::Core::Hashable
|
856
|
+
|
857
|
+
# The input config source for completion data.
|
858
|
+
# Corresponds to the JSON property `allowlistInputConfig`
|
859
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
|
860
|
+
attr_accessor :allowlist_input_config
|
861
|
+
|
862
|
+
# If set to true, the auto learning function is enabled. Auto learning uses user
|
863
|
+
# data to generate suggestions using ML techniques. Default value is false. Only
|
864
|
+
# after enabling auto learning can users use `cloud-retail` data in
|
865
|
+
# CompleteQueryRequest.
|
866
|
+
# Corresponds to the JSON property `autoLearning`
|
867
|
+
# @return [Boolean]
|
868
|
+
attr_accessor :auto_learning
|
869
|
+
alias_method :auto_learning?, :auto_learning
|
870
|
+
|
871
|
+
# The input config source for completion data.
|
872
|
+
# Corresponds to the JSON property `denylistInputConfig`
|
873
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
|
874
|
+
attr_accessor :denylist_input_config
|
875
|
+
|
876
|
+
# Output only. Name of the LRO corresponding to the latest allowlist import. Can
|
877
|
+
# use GetOperation API to retrieve the latest state of the Long Running
|
878
|
+
# Operation.
|
879
|
+
# Corresponds to the JSON property `lastAllowlistImportOperation`
|
880
|
+
# @return [String]
|
881
|
+
attr_accessor :last_allowlist_import_operation
|
882
|
+
|
883
|
+
# Output only. Name of the LRO corresponding to the latest denylist import. Can
|
884
|
+
# use GetOperation API to retrieve the latest state of the Long Running
|
885
|
+
# Operation.
|
886
|
+
# Corresponds to the JSON property `lastDenylistImportOperation`
|
887
|
+
# @return [String]
|
888
|
+
attr_accessor :last_denylist_import_operation
|
889
|
+
|
890
|
+
# Output only. Name of the LRO corresponding to the latest suggestion terms list
|
891
|
+
# import. Can use GetOperation API to retrieve the latest state of the Long
|
892
|
+
# Running Operation.
|
893
|
+
# Corresponds to the JSON property `lastSuggestionsImportOperation`
|
894
|
+
# @return [String]
|
895
|
+
attr_accessor :last_suggestions_import_operation
|
896
|
+
|
897
|
+
# Specifies the matching order for autocomplete suggestions, e.g., a query
|
898
|
+
# consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes",
|
899
|
+
# whereas a query of 'red s' with 'exact-prefix' specified would suggest "red
|
900
|
+
# shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default
|
901
|
+
# value: 'exact-prefix'.
|
902
|
+
# Corresponds to the JSON property `matchingOrder`
|
903
|
+
# @return [String]
|
904
|
+
attr_accessor :matching_order
|
905
|
+
|
906
|
+
# The maximum number of autocomplete suggestions returned per term. Default
|
907
|
+
# value is 20. If left unset or set to 0, then will fallback to default value.
|
908
|
+
# Value range is 1 to 20.
|
909
|
+
# Corresponds to the JSON property `maxSuggestions`
|
910
|
+
# @return [Fixnum]
|
911
|
+
attr_accessor :max_suggestions
|
912
|
+
|
913
|
+
# The minimum number of characters needed to be typed in order to get
|
914
|
+
# suggestions. Default value is 2. If left unset or set to 0, then will fallback
|
915
|
+
# to default value. Value range is 1 to 20.
|
916
|
+
# Corresponds to the JSON property `minPrefixLength`
|
917
|
+
# @return [Fixnum]
|
918
|
+
attr_accessor :min_prefix_length
|
919
|
+
|
920
|
+
# Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/
|
921
|
+
# completionConfig`
|
922
|
+
# Corresponds to the JSON property `name`
|
923
|
+
# @return [String]
|
924
|
+
attr_accessor :name
|
925
|
+
|
926
|
+
# The input config source for completion data.
|
927
|
+
# Corresponds to the JSON property `suggestionsInputConfig`
|
928
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig]
|
929
|
+
attr_accessor :suggestions_input_config
|
930
|
+
|
931
|
+
def initialize(**args)
|
932
|
+
update!(**args)
|
933
|
+
end
|
934
|
+
|
935
|
+
# Update properties of this object
|
936
|
+
def update!(**args)
|
937
|
+
@allowlist_input_config = args[:allowlist_input_config] if args.key?(:allowlist_input_config)
|
938
|
+
@auto_learning = args[:auto_learning] if args.key?(:auto_learning)
|
939
|
+
@denylist_input_config = args[:denylist_input_config] if args.key?(:denylist_input_config)
|
940
|
+
@last_allowlist_import_operation = args[:last_allowlist_import_operation] if args.key?(:last_allowlist_import_operation)
|
941
|
+
@last_denylist_import_operation = args[:last_denylist_import_operation] if args.key?(:last_denylist_import_operation)
|
942
|
+
@last_suggestions_import_operation = args[:last_suggestions_import_operation] if args.key?(:last_suggestions_import_operation)
|
943
|
+
@matching_order = args[:matching_order] if args.key?(:matching_order)
|
944
|
+
@max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
|
945
|
+
@min_prefix_length = args[:min_prefix_length] if args.key?(:min_prefix_length)
|
946
|
+
@name = args[:name] if args.key?(:name)
|
947
|
+
@suggestions_input_config = args[:suggestions_input_config] if args.key?(:suggestions_input_config)
|
948
|
+
end
|
949
|
+
end
|
950
|
+
|
724
951
|
# The input config source for completion data.
|
725
952
|
class GoogleCloudRetailV2CompletionDataInputConfig
|
726
953
|
include Google::Apis::Core::Hashable
|
@@ -1120,11 +1347,9 @@ module Google
|
|
1120
1347
|
# the import is finished, a notification will be sent to specified Pub/Sub topic.
|
1121
1348
|
# The message data will be JSON string of a Operation. Format of the Pub/Sub
|
1122
1349
|
# topic is `projects/`project`/topics/`topic``. It has to be within the same
|
1123
|
-
# project as ImportProductsRequest.parent. Make sure that
|
1124
|
-
#
|
1125
|
-
#
|
1126
|
-
# the topic. Only supported when ImportProductsRequest.reconciliation_mode is
|
1127
|
-
# set to `FULL`.
|
1350
|
+
# project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-
|
1351
|
+
# retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission
|
1352
|
+
# on the topic.
|
1128
1353
|
# Corresponds to the JSON property `notificationPubsubTopic`
|
1129
1354
|
# @return [String]
|
1130
1355
|
attr_accessor :notification_pubsub_topic
|
@@ -1748,7 +1973,7 @@ module Google
|
|
1748
1973
|
|
1749
1974
|
# The id of the collection members when type is Type.COLLECTION. Non-existent
|
1750
1975
|
# product ids are allowed. The type of the members must be either Type.PRIMARY
|
1751
|
-
# or Type.VARIANT otherwise
|
1976
|
+
# or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set
|
1752
1977
|
# it for other types. A maximum of 1000 values are allowed. Otherwise, an
|
1753
1978
|
# INVALID_ARGUMENT error is return.
|
1754
1979
|
# Corresponds to the JSON property `collectionMemberIds`
|
@@ -2400,6 +2625,25 @@ module Google
|
|
2400
2625
|
end
|
2401
2626
|
end
|
2402
2627
|
|
2628
|
+
# Request for CatalogService.RemoveCatalogAttribute method.
|
2629
|
+
class GoogleCloudRetailV2RemoveCatalogAttributeRequest
|
2630
|
+
include Google::Apis::Core::Hashable
|
2631
|
+
|
2632
|
+
# Required. The attribute name key of the CatalogAttribute to remove.
|
2633
|
+
# Corresponds to the JSON property `key`
|
2634
|
+
# @return [String]
|
2635
|
+
attr_accessor :key
|
2636
|
+
|
2637
|
+
def initialize(**args)
|
2638
|
+
update!(**args)
|
2639
|
+
end
|
2640
|
+
|
2641
|
+
# Update properties of this object
|
2642
|
+
def update!(**args)
|
2643
|
+
@key = args[:key] if args.key?(:key)
|
2644
|
+
end
|
2645
|
+
end
|
2646
|
+
|
2403
2647
|
# Metadata related to the progress of the RemoveFulfillmentPlaces operation.
|
2404
2648
|
# Currently empty because there is no meaningful metadata populated from the
|
2405
2649
|
# ProductService.RemoveFulfillmentPlaces method.
|
@@ -3010,6 +3254,13 @@ module Google
|
|
3010
3254
|
# @return [Array<String>]
|
3011
3255
|
attr_accessor :restricted_values
|
3012
3256
|
|
3257
|
+
# Returns the min and max value for each numerical facet intervals. Ignored for
|
3258
|
+
# textual facets.
|
3259
|
+
# Corresponds to the JSON property `returnMinMax`
|
3260
|
+
# @return [Boolean]
|
3261
|
+
attr_accessor :return_min_max
|
3262
|
+
alias_method :return_min_max?, :return_min_max
|
3263
|
+
|
3013
3264
|
def initialize(**args)
|
3014
3265
|
update!(**args)
|
3015
3266
|
end
|
@@ -3024,6 +3275,7 @@ module Google
|
|
3024
3275
|
@prefixes = args[:prefixes] if args.key?(:prefixes)
|
3025
3276
|
@query = args[:query] if args.key?(:query)
|
3026
3277
|
@restricted_values = args[:restricted_values] if args.key?(:restricted_values)
|
3278
|
+
@return_min_max = args[:return_min_max] if args.key?(:return_min_max)
|
3027
3279
|
end
|
3028
3280
|
end
|
3029
3281
|
|
@@ -3226,6 +3478,18 @@ module Google
|
|
3226
3478
|
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2Interval]
|
3227
3479
|
attr_accessor :interval
|
3228
3480
|
|
3481
|
+
# The maximum value in the FacetValue.interval. Only supported on numerical
|
3482
|
+
# facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
|
3483
|
+
# Corresponds to the JSON property `maxValue`
|
3484
|
+
# @return [Float]
|
3485
|
+
attr_accessor :max_value
|
3486
|
+
|
3487
|
+
# The minimum value in the FacetValue.interval. Only supported on numerical
|
3488
|
+
# facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
|
3489
|
+
# Corresponds to the JSON property `minValue`
|
3490
|
+
# @return [Float]
|
3491
|
+
attr_accessor :min_value
|
3492
|
+
|
3229
3493
|
# Text value of a facet, such as "Black" for facet "colorFamilies".
|
3230
3494
|
# Corresponds to the JSON property `value`
|
3231
3495
|
# @return [String]
|
@@ -3239,6 +3503,8 @@ module Google
|
|
3239
3503
|
def update!(**args)
|
3240
3504
|
@count = args[:count] if args.key?(:count)
|
3241
3505
|
@interval = args[:interval] if args.key?(:interval)
|
3506
|
+
@max_value = args[:max_value] if args.key?(:max_value)
|
3507
|
+
@min_value = args[:min_value] if args.key?(:min_value)
|
3242
3508
|
@value = args[:value] if args.key?(:value)
|
3243
3509
|
end
|
3244
3510
|
end
|
@@ -3294,6 +3560,15 @@ module Google
|
|
3294
3560
|
# @return [Hash<String,String>]
|
3295
3561
|
attr_accessor :matching_variant_fields
|
3296
3562
|
|
3563
|
+
# Specifies previous events related to this product for this user based on
|
3564
|
+
# UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set
|
3565
|
+
# only when SearchRequest.PersonalizationSpec.mode is SearchRequest.
|
3566
|
+
# PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that
|
3567
|
+
# this product has been purchased before.
|
3568
|
+
# Corresponds to the JSON property `personalLabels`
|
3569
|
+
# @return [Array<String>]
|
3570
|
+
attr_accessor :personal_labels
|
3571
|
+
|
3297
3572
|
# Product captures all metadata information of items to be recommended or
|
3298
3573
|
# searched.
|
3299
3574
|
# Corresponds to the JSON property `product`
|
@@ -3326,6 +3601,7 @@ module Google
|
|
3326
3601
|
@id = args[:id] if args.key?(:id)
|
3327
3602
|
@matching_variant_count = args[:matching_variant_count] if args.key?(:matching_variant_count)
|
3328
3603
|
@matching_variant_fields = args[:matching_variant_fields] if args.key?(:matching_variant_fields)
|
3604
|
+
@personal_labels = args[:personal_labels] if args.key?(:personal_labels)
|
3329
3605
|
@product = args[:product] if args.key?(:product)
|
3330
3606
|
@variant_rollup_values = args[:variant_rollup_values] if args.key?(:variant_rollup_values)
|
3331
3607
|
end
|
@@ -4101,6 +4377,11 @@ module Google
|
|
4101
4377
|
# @return [Fixnum]
|
4102
4378
|
attr_accessor :success_count
|
4103
4379
|
|
4380
|
+
# Metadata related to transform user events operation.
|
4381
|
+
# Corresponds to the JSON property `transformedUserEventsMetadata`
|
4382
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaTransformedUserEventsMetadata]
|
4383
|
+
attr_accessor :transformed_user_events_metadata
|
4384
|
+
|
4104
4385
|
# Operation last update time. If the operation is done, this is also the finish
|
4105
4386
|
# time.
|
4106
4387
|
# Corresponds to the JSON property `updateTime`
|
@@ -4118,6 +4399,7 @@ module Google
|
|
4118
4399
|
@notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
|
4119
4400
|
@request_id = args[:request_id] if args.key?(:request_id)
|
4120
4401
|
@success_count = args[:success_count] if args.key?(:success_count)
|
4402
|
+
@transformed_user_events_metadata = args[:transformed_user_events_metadata] if args.key?(:transformed_user_events_metadata)
|
4121
4403
|
@update_time = args[:update_time] if args.key?(:update_time)
|
4122
4404
|
end
|
4123
4405
|
end
|
@@ -4204,8 +4486,8 @@ module Google
|
|
4204
4486
|
attr_accessor :data_state
|
4205
4487
|
|
4206
4488
|
# Required. The display name of the model. Should be human readable, used to
|
4207
|
-
# display Recommendation Models in the Retail
|
4208
|
-
# string with limit of 1024 characters.
|
4489
|
+
# display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8
|
4490
|
+
# encoded string with limit of 1024 characters.
|
4209
4491
|
# Corresponds to the JSON property `displayName`
|
4210
4492
|
# @return [String]
|
4211
4493
|
attr_accessor :display_name
|
@@ -4679,6 +4961,32 @@ module Google
|
|
4679
4961
|
end
|
4680
4962
|
end
|
4681
4963
|
|
4964
|
+
# Metadata related to transform user events operation.
|
4965
|
+
class GoogleCloudRetailV2alphaTransformedUserEventsMetadata
|
4966
|
+
include Google::Apis::Core::Hashable
|
4967
|
+
|
4968
|
+
# Count of entries in the source user events BigQuery table.
|
4969
|
+
# Corresponds to the JSON property `sourceEventsCount`
|
4970
|
+
# @return [Fixnum]
|
4971
|
+
attr_accessor :source_events_count
|
4972
|
+
|
4973
|
+
# Count of entries in the transformed user events BigQuery table, which could be
|
4974
|
+
# different from the actually imported number of user events.
|
4975
|
+
# Corresponds to the JSON property `transformedEventsCount`
|
4976
|
+
# @return [Fixnum]
|
4977
|
+
attr_accessor :transformed_events_count
|
4978
|
+
|
4979
|
+
def initialize(**args)
|
4980
|
+
update!(**args)
|
4981
|
+
end
|
4982
|
+
|
4983
|
+
# Update properties of this object
|
4984
|
+
def update!(**args)
|
4985
|
+
@source_events_count = args[:source_events_count] if args.key?(:source_events_count)
|
4986
|
+
@transformed_events_count = args[:transformed_events_count] if args.key?(:transformed_events_count)
|
4987
|
+
end
|
4988
|
+
end
|
4989
|
+
|
4682
4990
|
# Metadata associated with a tune operation.
|
4683
4991
|
class GoogleCloudRetailV2alphaTuneModelMetadata
|
4684
4992
|
include Google::Apis::Core::Hashable
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module RetailV2
|
18
18
|
# Version of the google-apis-retail_v2 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.49.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.9.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20220729"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -64,6 +64,12 @@ module Google
|
|
64
64
|
include Google::Apis::Core::JsonObjectSupport
|
65
65
|
end
|
66
66
|
|
67
|
+
class GoogleCloudRetailV2AddCatalogAttributeRequest
|
68
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
69
|
+
|
70
|
+
include Google::Apis::Core::JsonObjectSupport
|
71
|
+
end
|
72
|
+
|
67
73
|
class GoogleCloudRetailV2AddFulfillmentPlacesMetadata
|
68
74
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
69
75
|
|
@@ -100,6 +106,12 @@ module Google
|
|
100
106
|
include Google::Apis::Core::JsonObjectSupport
|
101
107
|
end
|
102
108
|
|
109
|
+
class GoogleCloudRetailV2AttributesConfig
|
110
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
111
|
+
|
112
|
+
include Google::Apis::Core::JsonObjectSupport
|
113
|
+
end
|
114
|
+
|
103
115
|
class GoogleCloudRetailV2Audience
|
104
116
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
105
117
|
|
@@ -118,6 +130,12 @@ module Google
|
|
118
130
|
include Google::Apis::Core::JsonObjectSupport
|
119
131
|
end
|
120
132
|
|
133
|
+
class GoogleCloudRetailV2CatalogAttribute
|
134
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
135
|
+
|
136
|
+
include Google::Apis::Core::JsonObjectSupport
|
137
|
+
end
|
138
|
+
|
121
139
|
class GoogleCloudRetailV2ColorInfo
|
122
140
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
123
141
|
|
@@ -142,6 +160,12 @@ module Google
|
|
142
160
|
include Google::Apis::Core::JsonObjectSupport
|
143
161
|
end
|
144
162
|
|
163
|
+
class GoogleCloudRetailV2CompletionConfig
|
164
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
165
|
+
|
166
|
+
include Google::Apis::Core::JsonObjectSupport
|
167
|
+
end
|
168
|
+
|
145
169
|
class GoogleCloudRetailV2CompletionDataInputConfig
|
146
170
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
147
171
|
|
@@ -370,6 +394,12 @@ module Google
|
|
370
394
|
include Google::Apis::Core::JsonObjectSupport
|
371
395
|
end
|
372
396
|
|
397
|
+
class GoogleCloudRetailV2RemoveCatalogAttributeRequest
|
398
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
399
|
+
|
400
|
+
include Google::Apis::Core::JsonObjectSupport
|
401
|
+
end
|
402
|
+
|
373
403
|
class GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata
|
374
404
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
375
405
|
|
@@ -742,6 +772,12 @@ module Google
|
|
742
772
|
include Google::Apis::Core::JsonObjectSupport
|
743
773
|
end
|
744
774
|
|
775
|
+
class GoogleCloudRetailV2alphaTransformedUserEventsMetadata
|
776
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
777
|
+
|
778
|
+
include Google::Apis::Core::JsonObjectSupport
|
779
|
+
end
|
780
|
+
|
745
781
|
class GoogleCloudRetailV2alphaTuneModelMetadata
|
746
782
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
747
783
|
|
@@ -1015,6 +1051,14 @@ module Google
|
|
1015
1051
|
end
|
1016
1052
|
end
|
1017
1053
|
|
1054
|
+
class GoogleCloudRetailV2AddCatalogAttributeRequest
|
1055
|
+
# @private
|
1056
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1057
|
+
property :catalog_attribute, as: 'catalogAttribute', class: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute::Representation
|
1058
|
+
|
1059
|
+
end
|
1060
|
+
end
|
1061
|
+
|
1018
1062
|
class GoogleCloudRetailV2AddFulfillmentPlacesMetadata
|
1019
1063
|
# @private
|
1020
1064
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1060,6 +1104,16 @@ module Google
|
|
1060
1104
|
end
|
1061
1105
|
end
|
1062
1106
|
|
1107
|
+
class GoogleCloudRetailV2AttributesConfig
|
1108
|
+
# @private
|
1109
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1110
|
+
property :attribute_config_level, as: 'attributeConfigLevel'
|
1111
|
+
hash :catalog_attributes, as: 'catalogAttributes', class: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute::Representation
|
1112
|
+
|
1113
|
+
property :name, as: 'name'
|
1114
|
+
end
|
1115
|
+
end
|
1116
|
+
|
1063
1117
|
class GoogleCloudRetailV2Audience
|
1064
1118
|
# @private
|
1065
1119
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1091,6 +1145,18 @@ module Google
|
|
1091
1145
|
end
|
1092
1146
|
end
|
1093
1147
|
|
1148
|
+
class GoogleCloudRetailV2CatalogAttribute
|
1149
|
+
# @private
|
1150
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1151
|
+
property :dynamic_facetable_option, as: 'dynamicFacetableOption'
|
1152
|
+
property :in_use, as: 'inUse'
|
1153
|
+
property :indexable_option, as: 'indexableOption'
|
1154
|
+
property :key, as: 'key'
|
1155
|
+
property :searchable_option, as: 'searchableOption'
|
1156
|
+
property :type, as: 'type'
|
1157
|
+
end
|
1158
|
+
end
|
1159
|
+
|
1094
1160
|
class GoogleCloudRetailV2ColorInfo
|
1095
1161
|
# @private
|
1096
1162
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1126,6 +1192,26 @@ module Google
|
|
1126
1192
|
end
|
1127
1193
|
end
|
1128
1194
|
|
1195
|
+
class GoogleCloudRetailV2CompletionConfig
|
1196
|
+
# @private
|
1197
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1198
|
+
property :allowlist_input_config, as: 'allowlistInputConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig::Representation
|
1199
|
+
|
1200
|
+
property :auto_learning, as: 'autoLearning'
|
1201
|
+
property :denylist_input_config, as: 'denylistInputConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig::Representation
|
1202
|
+
|
1203
|
+
property :last_allowlist_import_operation, as: 'lastAllowlistImportOperation'
|
1204
|
+
property :last_denylist_import_operation, as: 'lastDenylistImportOperation'
|
1205
|
+
property :last_suggestions_import_operation, as: 'lastSuggestionsImportOperation'
|
1206
|
+
property :matching_order, as: 'matchingOrder'
|
1207
|
+
property :max_suggestions, as: 'maxSuggestions'
|
1208
|
+
property :min_prefix_length, as: 'minPrefixLength'
|
1209
|
+
property :name, as: 'name'
|
1210
|
+
property :suggestions_input_config, as: 'suggestionsInputConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig::Representation
|
1211
|
+
|
1212
|
+
end
|
1213
|
+
end
|
1214
|
+
|
1129
1215
|
class GoogleCloudRetailV2CompletionDataInputConfig
|
1130
1216
|
# @private
|
1131
1217
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1519,6 +1605,13 @@ module Google
|
|
1519
1605
|
end
|
1520
1606
|
end
|
1521
1607
|
|
1608
|
+
class GoogleCloudRetailV2RemoveCatalogAttributeRequest
|
1609
|
+
# @private
|
1610
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1611
|
+
property :key, as: 'key'
|
1612
|
+
end
|
1613
|
+
end
|
1614
|
+
|
1522
1615
|
class GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata
|
1523
1616
|
# @private
|
1524
1617
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1642,6 +1735,7 @@ module Google
|
|
1642
1735
|
collection :prefixes, as: 'prefixes'
|
1643
1736
|
property :query, as: 'query'
|
1644
1737
|
collection :restricted_values, as: 'restrictedValues'
|
1738
|
+
property :return_min_max, as: 'returnMinMax'
|
1645
1739
|
end
|
1646
1740
|
end
|
1647
1741
|
|
@@ -1703,6 +1797,8 @@ module Google
|
|
1703
1797
|
property :count, :numeric_string => true, as: 'count'
|
1704
1798
|
property :interval, as: 'interval', class: Google::Apis::RetailV2::GoogleCloudRetailV2Interval, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Interval::Representation
|
1705
1799
|
|
1800
|
+
property :max_value, as: 'maxValue'
|
1801
|
+
property :min_value, as: 'minValue'
|
1706
1802
|
property :value, as: 'value'
|
1707
1803
|
end
|
1708
1804
|
end
|
@@ -1721,6 +1817,7 @@ module Google
|
|
1721
1817
|
property :id, as: 'id'
|
1722
1818
|
property :matching_variant_count, as: 'matchingVariantCount'
|
1723
1819
|
hash :matching_variant_fields, as: 'matchingVariantFields'
|
1820
|
+
collection :personal_labels, as: 'personalLabels'
|
1724
1821
|
property :product, as: 'product', class: Google::Apis::RetailV2::GoogleCloudRetailV2Product, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Product::Representation
|
1725
1822
|
|
1726
1823
|
hash :variant_rollup_values, as: 'variantRollupValues'
|
@@ -1929,6 +2026,8 @@ module Google
|
|
1929
2026
|
property :notification_pubsub_topic, as: 'notificationPubsubTopic'
|
1930
2027
|
property :request_id, as: 'requestId'
|
1931
2028
|
property :success_count, :numeric_string => true, as: 'successCount'
|
2029
|
+
property :transformed_user_events_metadata, as: 'transformedUserEventsMetadata', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaTransformedUserEventsMetadata, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaTransformedUserEventsMetadata::Representation
|
2030
|
+
|
1932
2031
|
property :update_time, as: 'updateTime'
|
1933
2032
|
end
|
1934
2033
|
end
|
@@ -2101,6 +2200,14 @@ module Google
|
|
2101
2200
|
end
|
2102
2201
|
end
|
2103
2202
|
|
2203
|
+
class GoogleCloudRetailV2alphaTransformedUserEventsMetadata
|
2204
|
+
# @private
|
2205
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2206
|
+
property :source_events_count, :numeric_string => true, as: 'sourceEventsCount'
|
2207
|
+
property :transformed_events_count, :numeric_string => true, as: 'transformedEventsCount'
|
2208
|
+
end
|
2209
|
+
end
|
2210
|
+
|
2104
2211
|
class GoogleCloudRetailV2alphaTuneModelMetadata
|
2105
2212
|
# @private
|
2106
2213
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -126,6 +126,68 @@ module Google
|
|
126
126
|
execute_or_queue_command(command, &block)
|
127
127
|
end
|
128
128
|
|
129
|
+
# Gets an AttributesConfig.
|
130
|
+
# @param [String] name
|
131
|
+
# Required. Full AttributesConfig resource name. Format: `projects/`
|
132
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig`
|
133
|
+
# @param [String] fields
|
134
|
+
# Selector specifying which fields to include in a partial response.
|
135
|
+
# @param [String] quota_user
|
136
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
137
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
138
|
+
# @param [Google::Apis::RequestOptions] options
|
139
|
+
# Request-specific options
|
140
|
+
#
|
141
|
+
# @yield [result, err] Result & error if block supplied
|
142
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] parsed result object
|
143
|
+
# @yieldparam err [StandardError] error object if request failed
|
144
|
+
#
|
145
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig]
|
146
|
+
#
|
147
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
148
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
149
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
150
|
+
def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
151
|
+
command = make_simple_command(:get, 'v2/{+name}', options)
|
152
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
153
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
|
154
|
+
command.params['name'] = name unless name.nil?
|
155
|
+
command.query['fields'] = fields unless fields.nil?
|
156
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
157
|
+
execute_or_queue_command(command, &block)
|
158
|
+
end
|
159
|
+
|
160
|
+
# Gets a CompletionConfig.
|
161
|
+
# @param [String] name
|
162
|
+
# Required. Full CompletionConfig resource name. Format: projects/`
|
163
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
|
164
|
+
# @param [String] fields
|
165
|
+
# Selector specifying which fields to include in a partial response.
|
166
|
+
# @param [String] quota_user
|
167
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
168
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
169
|
+
# @param [Google::Apis::RequestOptions] options
|
170
|
+
# Request-specific options
|
171
|
+
#
|
172
|
+
# @yield [result, err] Result & error if block supplied
|
173
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig] parsed result object
|
174
|
+
# @yieldparam err [StandardError] error object if request failed
|
175
|
+
#
|
176
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig]
|
177
|
+
#
|
178
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
179
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
180
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
181
|
+
def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
182
|
+
command = make_simple_command(:get, 'v2/{+name}', options)
|
183
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation
|
184
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig
|
185
|
+
command.params['name'] = name unless name.nil?
|
186
|
+
command.query['fields'] = fields unless fields.nil?
|
187
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
188
|
+
execute_or_queue_command(command, &block)
|
189
|
+
end
|
190
|
+
|
129
191
|
# Get which branch is currently default branch set by CatalogService.
|
130
192
|
# SetDefaultBranch method under a specified parent catalog.
|
131
193
|
# @param [String] catalog
|
@@ -290,6 +352,161 @@ module Google
|
|
290
352
|
execute_or_queue_command(command, &block)
|
291
353
|
end
|
292
354
|
|
355
|
+
# Updates the AttributesConfig. The catalog attributes in the request will be
|
356
|
+
# updated in the catalog, or inserted if they do not exist. Existing catalog
|
357
|
+
# attributes not included in the request will remain unchanged. Attributes that
|
358
|
+
# are assigned to products, but do not exist at the catalog level, are always
|
359
|
+
# included in the response. The product attribute is assigned default values for
|
360
|
+
# missing catalog attribute fields, e.g., searchable and dynamic facetable
|
361
|
+
# options.
|
362
|
+
# @param [String] name
|
363
|
+
# Required. Immutable. The fully qualified resource name of the attribute config.
|
364
|
+
# Format: `projects/*/locations/*/catalogs/*/attributesConfig`
|
365
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] google_cloud_retail_v2_attributes_config_object
|
366
|
+
# @param [String] update_mask
|
367
|
+
# Indicates which fields in the provided AttributesConfig to update. The
|
368
|
+
# following is the only supported field: * AttributesConfig.catalog_attributes
|
369
|
+
# If not set, all supported fields are updated.
|
370
|
+
# @param [String] fields
|
371
|
+
# Selector specifying which fields to include in a partial response.
|
372
|
+
# @param [String] quota_user
|
373
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
374
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
375
|
+
# @param [Google::Apis::RequestOptions] options
|
376
|
+
# Request-specific options
|
377
|
+
#
|
378
|
+
# @yield [result, err] Result & error if block supplied
|
379
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] parsed result object
|
380
|
+
# @yieldparam err [StandardError] error object if request failed
|
381
|
+
#
|
382
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig]
|
383
|
+
#
|
384
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
385
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
386
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
387
|
+
def update_project_location_catalog_attributes_config(name, google_cloud_retail_v2_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
388
|
+
command = make_simple_command(:patch, 'v2/{+name}', options)
|
389
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
390
|
+
command.request_object = google_cloud_retail_v2_attributes_config_object
|
391
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
392
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
|
393
|
+
command.params['name'] = name unless name.nil?
|
394
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
395
|
+
command.query['fields'] = fields unless fields.nil?
|
396
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
397
|
+
execute_or_queue_command(command, &block)
|
398
|
+
end
|
399
|
+
|
400
|
+
# Updates the CompletionConfigs.
|
401
|
+
# @param [String] name
|
402
|
+
# Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/
|
403
|
+
# completionConfig`
|
404
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig] google_cloud_retail_v2_completion_config_object
|
405
|
+
# @param [String] update_mask
|
406
|
+
# Indicates which fields in the provided CompletionConfig to update. The
|
407
|
+
# following are the only supported fields: * CompletionConfig.matching_order *
|
408
|
+
# CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length *
|
409
|
+
# CompletionConfig.auto_learning If not set, all supported fields are updated.
|
410
|
+
# @param [String] fields
|
411
|
+
# Selector specifying which fields to include in a partial response.
|
412
|
+
# @param [String] quota_user
|
413
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
414
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
415
|
+
# @param [Google::Apis::RequestOptions] options
|
416
|
+
# Request-specific options
|
417
|
+
#
|
418
|
+
# @yield [result, err] Result & error if block supplied
|
419
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig] parsed result object
|
420
|
+
# @yieldparam err [StandardError] error object if request failed
|
421
|
+
#
|
422
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig]
|
423
|
+
#
|
424
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
425
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
426
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
427
|
+
def update_project_location_catalog_completion_config(name, google_cloud_retail_v2_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
428
|
+
command = make_simple_command(:patch, 'v2/{+name}', options)
|
429
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation
|
430
|
+
command.request_object = google_cloud_retail_v2_completion_config_object
|
431
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation
|
432
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig
|
433
|
+
command.params['name'] = name unless name.nil?
|
434
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
435
|
+
command.query['fields'] = fields unless fields.nil?
|
436
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
437
|
+
execute_or_queue_command(command, &block)
|
438
|
+
end
|
439
|
+
|
440
|
+
# Adds the specified CatalogAttribute to the AttributesConfig. If the
|
441
|
+
# CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
|
442
|
+
# @param [String] attributes_config
|
443
|
+
# Required. Full AttributesConfig resource name. Format: `projects/`
|
444
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig`
|
445
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2AddCatalogAttributeRequest] google_cloud_retail_v2_add_catalog_attribute_request_object
|
446
|
+
# @param [String] fields
|
447
|
+
# Selector specifying which fields to include in a partial response.
|
448
|
+
# @param [String] quota_user
|
449
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
450
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
451
|
+
# @param [Google::Apis::RequestOptions] options
|
452
|
+
# Request-specific options
|
453
|
+
#
|
454
|
+
# @yield [result, err] Result & error if block supplied
|
455
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] parsed result object
|
456
|
+
# @yieldparam err [StandardError] error object if request failed
|
457
|
+
#
|
458
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig]
|
459
|
+
#
|
460
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
461
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
462
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
463
|
+
def add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
464
|
+
command = make_simple_command(:post, 'v2/{+attributesConfig}:addCatalogAttribute', options)
|
465
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AddCatalogAttributeRequest::Representation
|
466
|
+
command.request_object = google_cloud_retail_v2_add_catalog_attribute_request_object
|
467
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
468
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
|
469
|
+
command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
|
470
|
+
command.query['fields'] = fields unless fields.nil?
|
471
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
472
|
+
execute_or_queue_command(command, &block)
|
473
|
+
end
|
474
|
+
|
475
|
+
# Removes the specified CatalogAttribute from the AttributesConfig. If the
|
476
|
+
# CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
|
477
|
+
# @param [String] attributes_config
|
478
|
+
# Required. Full AttributesConfig resource name. Format: `projects/`
|
479
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig`
|
480
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2RemoveCatalogAttributeRequest] google_cloud_retail_v2_remove_catalog_attribute_request_object
|
481
|
+
# @param [String] fields
|
482
|
+
# Selector specifying which fields to include in a partial response.
|
483
|
+
# @param [String] quota_user
|
484
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
485
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
486
|
+
# @param [Google::Apis::RequestOptions] options
|
487
|
+
# Request-specific options
|
488
|
+
#
|
489
|
+
# @yield [result, err] Result & error if block supplied
|
490
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] parsed result object
|
491
|
+
# @yieldparam err [StandardError] error object if request failed
|
492
|
+
#
|
493
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig]
|
494
|
+
#
|
495
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
496
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
497
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
498
|
+
def remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
499
|
+
command = make_simple_command(:post, 'v2/{+attributesConfig}:removeCatalogAttribute', options)
|
500
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2RemoveCatalogAttributeRequest::Representation
|
501
|
+
command.request_object = google_cloud_retail_v2_remove_catalog_attribute_request_object
|
502
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
503
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
|
504
|
+
command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
|
505
|
+
command.query['fields'] = fields unless fields.nil?
|
506
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
507
|
+
execute_or_queue_command(command, &block)
|
508
|
+
end
|
509
|
+
|
293
510
|
# Gets the latest state of a long-running operation. Clients can use this method
|
294
511
|
# to poll the operation result at intervals as recommended by the API service.
|
295
512
|
# @param [String] name
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-retail_v2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.49.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-08-
|
11
|
+
date: 2022-08-08 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_v2/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.49.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|