google-apis-retail_v2beta 0.32.0 → 0.33.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: 927f28b74740703f73d5b7f2b2b6d104a6da7c9227b1f383dfd49331c679f35c
|
4
|
+
data.tar.gz: 5d672d37634e5af90d09ba14813436923ab5535159bb5e8e1bb407294d256bbd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7cd7d2791d54ce7d5ef13c620d7ee4498232107e8a55c0912190b18b84f5898dd368f12c2fa6fcd2536b6b6b2546329f6a32497a7995d2e7b336edabf2ca0ff8
|
7
|
+
data.tar.gz: a1158999331cb622b456921103fd53d9d306a087c8e0ba965123532744b5a4e689f8dae25e6a84fe91669fe1b50550a847778cd158c7ccc6348ef8330e520ecc
|
data/CHANGELOG.md
CHANGED
@@ -373,8 +373,7 @@ module Google
|
|
373
373
|
# @return [String]
|
374
374
|
attr_accessor :notification_pubsub_topic
|
375
375
|
|
376
|
-
#
|
377
|
-
# passed in the request.
|
376
|
+
# Deprecated. This field is never set.
|
378
377
|
# Corresponds to the JSON property `requestId`
|
379
378
|
# @return [String]
|
380
379
|
attr_accessor :request_id
|
@@ -843,8 +842,7 @@ module Google
|
|
843
842
|
# @return [String]
|
844
843
|
attr_accessor :notification_pubsub_topic
|
845
844
|
|
846
|
-
#
|
847
|
-
# passed in the request.
|
845
|
+
# Deprecated. This field is never set.
|
848
846
|
# Corresponds to the JSON property `requestId`
|
849
847
|
# @return [String]
|
850
848
|
attr_accessor :request_id
|
@@ -1398,7 +1396,9 @@ module Google
|
|
1398
1396
|
# analytics/answer/3437719. * `user_event_ga4`: This feature is in private
|
1399
1397
|
# preview. Please contact the support team for importing Google Analytics 4
|
1400
1398
|
# events. The schema is available here: https://support.google.com/analytics/
|
1401
|
-
# answer/7029846.
|
1399
|
+
# answer/7029846. Supported values for auto-completion imports: * `suggestions` (
|
1400
|
+
# default): One JSON completion suggestion per line. * `denylist`: One JSON deny
|
1401
|
+
# suggestion per line. * `allowlist`: One JSON allow suggestion per line.
|
1402
1402
|
# Corresponds to the JSON property `dataSchema`
|
1403
1403
|
# @return [String]
|
1404
1404
|
attr_accessor :data_schema
|
@@ -1467,6 +1467,12 @@ module Google
|
|
1467
1467
|
# @return [String]
|
1468
1468
|
attr_accessor :display_name
|
1469
1469
|
|
1470
|
+
# Configures Merchant Center linking. Links contained in the config will be used
|
1471
|
+
# to sync data from a Merchant Center account to a Cloud Retail branch.
|
1472
|
+
# Corresponds to the JSON property `merchantCenterLinkingConfig`
|
1473
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaMerchantCenterLinkingConfig]
|
1474
|
+
attr_accessor :merchant_center_linking_config
|
1475
|
+
|
1470
1476
|
# Required. Immutable. The fully qualified resource name of the catalog.
|
1471
1477
|
# Corresponds to the JSON property `name`
|
1472
1478
|
# @return [String]
|
@@ -1485,6 +1491,7 @@ module Google
|
|
1485
1491
|
# Update properties of this object
|
1486
1492
|
def update!(**args)
|
1487
1493
|
@display_name = args[:display_name] if args.key?(:display_name)
|
1494
|
+
@merchant_center_linking_config = args[:merchant_center_linking_config] if args.key?(:merchant_center_linking_config)
|
1488
1495
|
@name = args[:name] if args.key?(:name)
|
1489
1496
|
@product_level_config = args[:product_level_config] if args.key?(:product_level_config)
|
1490
1497
|
end
|
@@ -1603,9 +1610,9 @@ module Google
|
|
1603
1610
|
class GoogleCloudRetailV2betaCompleteQueryResponse
|
1604
1611
|
include Google::Apis::Core::Hashable
|
1605
1612
|
|
1606
|
-
# A unique complete token. This should be included in the
|
1607
|
-
# resulting from this completion, which
|
1608
|
-
# model performance.
|
1613
|
+
# A unique complete token. This should be included in the UserEvent.
|
1614
|
+
# completion_detail for search events resulting from this completion, which
|
1615
|
+
# enables accurate attribution of complete model performance.
|
1609
1616
|
# Corresponds to the JSON property `attributionToken`
|
1610
1617
|
# @return [String]
|
1611
1618
|
attr_accessor :attribution_token
|
@@ -1645,7 +1652,9 @@ module Google
|
|
1645
1652
|
class GoogleCloudRetailV2betaCompleteQueryResponseCompletionResult
|
1646
1653
|
include Google::Apis::Core::Hashable
|
1647
1654
|
|
1648
|
-
#
|
1655
|
+
# Custom attributes for the suggestion term. * For "user-data", the attributes
|
1656
|
+
# are additional custom attributes ingested through BigQuery. * For "cloud-
|
1657
|
+
# retail", the attributes are product attributes generated by Cloud Retail.
|
1649
1658
|
# Corresponds to the JSON property `attributes`
|
1650
1659
|
# @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
|
1651
1660
|
attr_accessor :attributes
|
@@ -1685,6 +1694,103 @@ module Google
|
|
1685
1694
|
end
|
1686
1695
|
end
|
1687
1696
|
|
1697
|
+
# Catalog level autocomplete config for customers to customize autocomplete
|
1698
|
+
# feature's settings.
|
1699
|
+
class GoogleCloudRetailV2betaCompletionConfig
|
1700
|
+
include Google::Apis::Core::Hashable
|
1701
|
+
|
1702
|
+
# The input config source for completion data.
|
1703
|
+
# Corresponds to the JSON property `allowlistInputConfig`
|
1704
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig]
|
1705
|
+
attr_accessor :allowlist_input_config
|
1706
|
+
|
1707
|
+
# If set to true, the auto learning function is enabled. Auto learning uses user
|
1708
|
+
# data to generate suggestions using ML techniques. Default value is false. Only
|
1709
|
+
# after enabling auto learning can users use `cloud-retail` data in
|
1710
|
+
# CompleteQueryRequest.
|
1711
|
+
# Corresponds to the JSON property `autoLearning`
|
1712
|
+
# @return [Boolean]
|
1713
|
+
attr_accessor :auto_learning
|
1714
|
+
alias_method :auto_learning?, :auto_learning
|
1715
|
+
|
1716
|
+
# The input config source for completion data.
|
1717
|
+
# Corresponds to the JSON property `denylistInputConfig`
|
1718
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig]
|
1719
|
+
attr_accessor :denylist_input_config
|
1720
|
+
|
1721
|
+
# Output only. LRO corresponding to the latest allowlist import. Can use
|
1722
|
+
# GetOperation API to retrieve the latest state of the Long Running Operation.
|
1723
|
+
# Corresponds to the JSON property `lastAllowlistImportOperation`
|
1724
|
+
# @return [String]
|
1725
|
+
attr_accessor :last_allowlist_import_operation
|
1726
|
+
|
1727
|
+
# Output only. LRO corresponding to the latest denylist import. Can use
|
1728
|
+
# GetOperation API to retrieve the latest state of the Long Running Operation.
|
1729
|
+
# Corresponds to the JSON property `lastDenylistImportOperation`
|
1730
|
+
# @return [String]
|
1731
|
+
attr_accessor :last_denylist_import_operation
|
1732
|
+
|
1733
|
+
# Output only. Name of the LRO corresponding to the latest suggestion terms list
|
1734
|
+
# import. Can use GetOperation API to retrieve the latest state of the Long
|
1735
|
+
# Running Operation.
|
1736
|
+
# Corresponds to the JSON property `lastSuggestionsImportOperation`
|
1737
|
+
# @return [String]
|
1738
|
+
attr_accessor :last_suggestions_import_operation
|
1739
|
+
|
1740
|
+
# Specifies the matching order for autocomplete suggestions, e.g., a query
|
1741
|
+
# consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes",
|
1742
|
+
# whereas a query of 'red s' with 'exact-prefix' specified would suggest "red
|
1743
|
+
# shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default
|
1744
|
+
# value: 'exact-prefix'.
|
1745
|
+
# Corresponds to the JSON property `matchingOrder`
|
1746
|
+
# @return [String]
|
1747
|
+
attr_accessor :matching_order
|
1748
|
+
|
1749
|
+
# The maximum number of autocomplete suggestions returned per term. The maximum
|
1750
|
+
# allowed max suggestions is 20. Default value is 20. If left unset or set to 0,
|
1751
|
+
# then will fallback to default value.
|
1752
|
+
# Corresponds to the JSON property `maxSuggestions`
|
1753
|
+
# @return [Fixnum]
|
1754
|
+
attr_accessor :max_suggestions
|
1755
|
+
|
1756
|
+
# The minimum number of characters needed to be typed in order to get
|
1757
|
+
# suggestions. Default value is 2. If left unset or set to 0, then will fallback
|
1758
|
+
# to default value.
|
1759
|
+
# Corresponds to the JSON property `minPrefixLength`
|
1760
|
+
# @return [Fixnum]
|
1761
|
+
attr_accessor :min_prefix_length
|
1762
|
+
|
1763
|
+
# Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
|
1764
|
+
# completionConfig
|
1765
|
+
# Corresponds to the JSON property `name`
|
1766
|
+
# @return [String]
|
1767
|
+
attr_accessor :name
|
1768
|
+
|
1769
|
+
# The input config source for completion data.
|
1770
|
+
# Corresponds to the JSON property `suggestionsInputConfig`
|
1771
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig]
|
1772
|
+
attr_accessor :suggestions_input_config
|
1773
|
+
|
1774
|
+
def initialize(**args)
|
1775
|
+
update!(**args)
|
1776
|
+
end
|
1777
|
+
|
1778
|
+
# Update properties of this object
|
1779
|
+
def update!(**args)
|
1780
|
+
@allowlist_input_config = args[:allowlist_input_config] if args.key?(:allowlist_input_config)
|
1781
|
+
@auto_learning = args[:auto_learning] if args.key?(:auto_learning)
|
1782
|
+
@denylist_input_config = args[:denylist_input_config] if args.key?(:denylist_input_config)
|
1783
|
+
@last_allowlist_import_operation = args[:last_allowlist_import_operation] if args.key?(:last_allowlist_import_operation)
|
1784
|
+
@last_denylist_import_operation = args[:last_denylist_import_operation] if args.key?(:last_denylist_import_operation)
|
1785
|
+
@last_suggestions_import_operation = args[:last_suggestions_import_operation] if args.key?(:last_suggestions_import_operation)
|
1786
|
+
@matching_order = args[:matching_order] if args.key?(:matching_order)
|
1787
|
+
@max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
|
1788
|
+
@min_prefix_length = args[:min_prefix_length] if args.key?(:min_prefix_length)
|
1789
|
+
@name = args[:name] if args.key?(:name)
|
1790
|
+
@suggestions_input_config = args[:suggestions_input_config] if args.key?(:suggestions_input_config)
|
1791
|
+
end
|
1792
|
+
end
|
1793
|
+
|
1688
1794
|
# The input config source for completion data.
|
1689
1795
|
class GoogleCloudRetailV2betaCompletionDataInputConfig
|
1690
1796
|
include Google::Apis::Core::Hashable
|
@@ -2290,8 +2396,7 @@ module Google
|
|
2290
2396
|
# @return [String]
|
2291
2397
|
attr_accessor :notification_pubsub_topic
|
2292
2398
|
|
2293
|
-
#
|
2294
|
-
# passed in the request.
|
2399
|
+
# Deprecated. This field is never set.
|
2295
2400
|
# Corresponds to the JSON property `requestId`
|
2296
2401
|
# @return [String]
|
2297
2402
|
attr_accessor :request_id
|
@@ -2351,11 +2456,7 @@ module Google
|
|
2351
2456
|
# @return [String]
|
2352
2457
|
attr_accessor :reconciliation_mode
|
2353
2458
|
|
2354
|
-
#
|
2355
|
-
# Ensures idempotency and used for request deduplication. Server-generated if
|
2356
|
-
# unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
|
2357
|
-
# 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
|
2358
|
-
# when ImportProductsRequest.reconciliation_mode is set to `FULL`.
|
2459
|
+
# Deprecated. This field has no effect.
|
2359
2460
|
# Corresponds to the JSON property `requestId`
|
2360
2461
|
# @return [String]
|
2361
2462
|
attr_accessor :request_id
|
@@ -2606,6 +2707,87 @@ module Google
|
|
2606
2707
|
end
|
2607
2708
|
end
|
2608
2709
|
|
2710
|
+
# Represents a link between a Merchant Center account and a branch. Once a link
|
2711
|
+
# is established, products from the linked merchant center account will be
|
2712
|
+
# streamed to the linked branch.
|
2713
|
+
class GoogleCloudRetailV2betaMerchantCenterLink
|
2714
|
+
include Google::Apis::Core::Hashable
|
2715
|
+
|
2716
|
+
# The branch id (e.g. 0/1/2) within this catalog that products from
|
2717
|
+
# merchant_center_account_id are streamed to. When updating this field, an empty
|
2718
|
+
# value will use the currently configured default branch. However, changing the
|
2719
|
+
# default branch later on won't change the linked branch here. A single branch
|
2720
|
+
# id can only have one linked merchant center account id.
|
2721
|
+
# Corresponds to the JSON property `branchId`
|
2722
|
+
# @return [String]
|
2723
|
+
attr_accessor :branch_id
|
2724
|
+
|
2725
|
+
# String representing the destination to import for, all if left empty. List of
|
2726
|
+
# possible values can be found here. [https://support.google.com/merchants/
|
2727
|
+
# answer/7501026] List of allowed string values: "Shopping_ads", "
|
2728
|
+
# Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings"
|
2729
|
+
# , "Free_local_listings" NOTE: The string values are case sensitive.
|
2730
|
+
# Corresponds to the JSON property `destinations`
|
2731
|
+
# @return [Array<String>]
|
2732
|
+
attr_accessor :destinations
|
2733
|
+
|
2734
|
+
# Language of the title/description and other string attributes. Use language
|
2735
|
+
# tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO
|
2736
|
+
# 639-1. This specifies the language of offers in Merchant Center that will be
|
2737
|
+
# accepted. If empty no language filtering will be performed.
|
2738
|
+
# Corresponds to the JSON property `languageCode`
|
2739
|
+
# @return [String]
|
2740
|
+
attr_accessor :language_code
|
2741
|
+
|
2742
|
+
# Required. The linked [Merchant center account id](https://developers.google.
|
2743
|
+
# com/shopping-content/guides/accountstatuses). The account must be a standalone
|
2744
|
+
# account or a sub-account of a MCA.
|
2745
|
+
# Corresponds to the JSON property `merchantCenterAccountId`
|
2746
|
+
# @return [Fixnum]
|
2747
|
+
attr_accessor :merchant_center_account_id
|
2748
|
+
|
2749
|
+
# Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code.
|
2750
|
+
# List of values can be found [here](https://www.iana.org/assignments/language-
|
2751
|
+
# subtag-registry/language-subtag-registry) under the `region` tag. If left
|
2752
|
+
# blank no region filtering will be performed. Example value: `US`.
|
2753
|
+
# Corresponds to the JSON property `regionCode`
|
2754
|
+
# @return [String]
|
2755
|
+
attr_accessor :region_code
|
2756
|
+
|
2757
|
+
def initialize(**args)
|
2758
|
+
update!(**args)
|
2759
|
+
end
|
2760
|
+
|
2761
|
+
# Update properties of this object
|
2762
|
+
def update!(**args)
|
2763
|
+
@branch_id = args[:branch_id] if args.key?(:branch_id)
|
2764
|
+
@destinations = args[:destinations] if args.key?(:destinations)
|
2765
|
+
@language_code = args[:language_code] if args.key?(:language_code)
|
2766
|
+
@merchant_center_account_id = args[:merchant_center_account_id] if args.key?(:merchant_center_account_id)
|
2767
|
+
@region_code = args[:region_code] if args.key?(:region_code)
|
2768
|
+
end
|
2769
|
+
end
|
2770
|
+
|
2771
|
+
# Configures Merchant Center linking. Links contained in the config will be used
|
2772
|
+
# to sync data from a Merchant Center account to a Cloud Retail branch.
|
2773
|
+
class GoogleCloudRetailV2betaMerchantCenterLinkingConfig
|
2774
|
+
include Google::Apis::Core::Hashable
|
2775
|
+
|
2776
|
+
# Links between Merchant Center accounts and branches.
|
2777
|
+
# Corresponds to the JSON property `links`
|
2778
|
+
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaMerchantCenterLink>]
|
2779
|
+
attr_accessor :links
|
2780
|
+
|
2781
|
+
def initialize(**args)
|
2782
|
+
update!(**args)
|
2783
|
+
end
|
2784
|
+
|
2785
|
+
# Update properties of this object
|
2786
|
+
def update!(**args)
|
2787
|
+
@links = args[:links] if args.key?(:links)
|
2788
|
+
end
|
2789
|
+
end
|
2790
|
+
|
2609
2791
|
# Request message for Predict method.
|
2610
2792
|
class GoogleCloudRetailV2betaPredictRequest
|
2611
2793
|
include Google::Apis::Core::Hashable
|
@@ -5540,8 +5722,7 @@ module Google
|
|
5540
5722
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
5541
5723
|
# messages in your APIs. A typical example is to use it as the request or the
|
5542
5724
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
5543
|
-
# protobuf.Empty) returns (google.protobuf.Empty); `
|
5544
|
-
# `Empty` is empty JSON object ````.
|
5725
|
+
# protobuf.Empty) returns (google.protobuf.Empty); `
|
5545
5726
|
class GoogleProtobufEmpty
|
5546
5727
|
include Google::Apis::Core::Hashable
|
5547
5728
|
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module RetailV2beta
|
18
18
|
# Version of the google-apis-retail_v2beta gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.33.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 = "20220319"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -400,6 +400,12 @@ module Google
|
|
400
400
|
include Google::Apis::Core::JsonObjectSupport
|
401
401
|
end
|
402
402
|
|
403
|
+
class GoogleCloudRetailV2betaCompletionConfig
|
404
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
405
|
+
|
406
|
+
include Google::Apis::Core::JsonObjectSupport
|
407
|
+
end
|
408
|
+
|
403
409
|
class GoogleCloudRetailV2betaCompletionDataInputConfig
|
404
410
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
405
411
|
|
@@ -568,6 +574,18 @@ module Google
|
|
568
574
|
include Google::Apis::Core::JsonObjectSupport
|
569
575
|
end
|
570
576
|
|
577
|
+
class GoogleCloudRetailV2betaMerchantCenterLink
|
578
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
579
|
+
|
580
|
+
include Google::Apis::Core::JsonObjectSupport
|
581
|
+
end
|
582
|
+
|
583
|
+
class GoogleCloudRetailV2betaMerchantCenterLinkingConfig
|
584
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
585
|
+
|
586
|
+
include Google::Apis::Core::JsonObjectSupport
|
587
|
+
end
|
588
|
+
|
571
589
|
class GoogleCloudRetailV2betaPredictRequest
|
572
590
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
573
591
|
|
@@ -1396,6 +1414,8 @@ module Google
|
|
1396
1414
|
# @private
|
1397
1415
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1398
1416
|
property :display_name, as: 'displayName'
|
1417
|
+
property :merchant_center_linking_config, as: 'merchantCenterLinkingConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaMerchantCenterLinkingConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaMerchantCenterLinkingConfig::Representation
|
1418
|
+
|
1399
1419
|
property :name, as: 'name'
|
1400
1420
|
property :product_level_config, as: 'productLevelConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductLevelConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductLevelConfig::Representation
|
1401
1421
|
|
@@ -1449,6 +1469,26 @@ module Google
|
|
1449
1469
|
end
|
1450
1470
|
end
|
1451
1471
|
|
1472
|
+
class GoogleCloudRetailV2betaCompletionConfig
|
1473
|
+
# @private
|
1474
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1475
|
+
property :allowlist_input_config, as: 'allowlistInputConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig::Representation
|
1476
|
+
|
1477
|
+
property :auto_learning, as: 'autoLearning'
|
1478
|
+
property :denylist_input_config, as: 'denylistInputConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig::Representation
|
1479
|
+
|
1480
|
+
property :last_allowlist_import_operation, as: 'lastAllowlistImportOperation'
|
1481
|
+
property :last_denylist_import_operation, as: 'lastDenylistImportOperation'
|
1482
|
+
property :last_suggestions_import_operation, as: 'lastSuggestionsImportOperation'
|
1483
|
+
property :matching_order, as: 'matchingOrder'
|
1484
|
+
property :max_suggestions, as: 'maxSuggestions'
|
1485
|
+
property :min_prefix_length, as: 'minPrefixLength'
|
1486
|
+
property :name, as: 'name'
|
1487
|
+
property :suggestions_input_config, as: 'suggestionsInputConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig::Representation
|
1488
|
+
|
1489
|
+
end
|
1490
|
+
end
|
1491
|
+
|
1452
1492
|
class GoogleCloudRetailV2betaCompletionDataInputConfig
|
1453
1493
|
# @private
|
1454
1494
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1714,6 +1754,25 @@ module Google
|
|
1714
1754
|
end
|
1715
1755
|
end
|
1716
1756
|
|
1757
|
+
class GoogleCloudRetailV2betaMerchantCenterLink
|
1758
|
+
# @private
|
1759
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1760
|
+
property :branch_id, as: 'branchId'
|
1761
|
+
collection :destinations, as: 'destinations'
|
1762
|
+
property :language_code, as: 'languageCode'
|
1763
|
+
property :merchant_center_account_id, :numeric_string => true, as: 'merchantCenterAccountId'
|
1764
|
+
property :region_code, as: 'regionCode'
|
1765
|
+
end
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
class GoogleCloudRetailV2betaMerchantCenterLinkingConfig
|
1769
|
+
# @private
|
1770
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1771
|
+
collection :links, as: 'links', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaMerchantCenterLink, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaMerchantCenterLink::Representation
|
1772
|
+
|
1773
|
+
end
|
1774
|
+
end
|
1775
|
+
|
1717
1776
|
class GoogleCloudRetailV2betaPredictRequest
|
1718
1777
|
# @private
|
1719
1778
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -156,6 +156,37 @@ module Google
|
|
156
156
|
execute_or_queue_command(command, &block)
|
157
157
|
end
|
158
158
|
|
159
|
+
# Gets a CompletionConfig.
|
160
|
+
# @param [String] name
|
161
|
+
# Required. Full CompletionConfig resource name. Format: projects/`
|
162
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
|
163
|
+
# @param [String] fields
|
164
|
+
# Selector specifying which fields to include in a partial response.
|
165
|
+
# @param [String] quota_user
|
166
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
167
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
168
|
+
# @param [Google::Apis::RequestOptions] options
|
169
|
+
# Request-specific options
|
170
|
+
#
|
171
|
+
# @yield [result, err] Result & error if block supplied
|
172
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig] parsed result object
|
173
|
+
# @yieldparam err [StandardError] error object if request failed
|
174
|
+
#
|
175
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig]
|
176
|
+
#
|
177
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
178
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
179
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
180
|
+
def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
181
|
+
command = make_simple_command(:get, 'v2beta/{+name}', options)
|
182
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation
|
183
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
|
184
|
+
command.params['name'] = name unless name.nil?
|
185
|
+
command.query['fields'] = fields unless fields.nil?
|
186
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
187
|
+
execute_or_queue_command(command, &block)
|
188
|
+
end
|
189
|
+
|
159
190
|
# Get which branch is currently default branch set by CatalogService.
|
160
191
|
# SetDefaultBranch method under a specified parent catalog.
|
161
192
|
# @param [String] catalog
|
@@ -365,6 +396,46 @@ module Google
|
|
365
396
|
execute_or_queue_command(command, &block)
|
366
397
|
end
|
367
398
|
|
399
|
+
# Updates the CompletionConfigs.
|
400
|
+
# @param [String] name
|
401
|
+
# Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
|
402
|
+
# completionConfig
|
403
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig] google_cloud_retail_v2beta_completion_config_object
|
404
|
+
# @param [String] update_mask
|
405
|
+
# Indicates which fields in the provided CompletionConfig to update. The
|
406
|
+
# following are the only supported fields: * CompletionConfig.matching_order *
|
407
|
+
# CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length *
|
408
|
+
# CompletionConfig.auto_learning If not set, all supported fields are updated.
|
409
|
+
# @param [String] fields
|
410
|
+
# Selector specifying which fields to include in a partial response.
|
411
|
+
# @param [String] quota_user
|
412
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
413
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
414
|
+
# @param [Google::Apis::RequestOptions] options
|
415
|
+
# Request-specific options
|
416
|
+
#
|
417
|
+
# @yield [result, err] Result & error if block supplied
|
418
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig] parsed result object
|
419
|
+
# @yieldparam err [StandardError] error object if request failed
|
420
|
+
#
|
421
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig]
|
422
|
+
#
|
423
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
424
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
425
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
426
|
+
def update_project_location_catalog_completion_config(name, google_cloud_retail_v2beta_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
427
|
+
command = make_simple_command(:patch, 'v2beta/{+name}', options)
|
428
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation
|
429
|
+
command.request_object = google_cloud_retail_v2beta_completion_config_object
|
430
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation
|
431
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
|
432
|
+
command.params['name'] = name unless name.nil?
|
433
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
434
|
+
command.query['fields'] = fields unless fields.nil?
|
435
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
436
|
+
execute_or_queue_command(command, &block)
|
437
|
+
end
|
438
|
+
|
368
439
|
# Adds the specified CatalogAttribute to the AttributesConfig. If the
|
369
440
|
# CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
|
370
441
|
# @param [String] attributes_config
|
@@ -905,9 +976,11 @@ module Google
|
|
905
976
|
execute_or_queue_command(command, &block)
|
906
977
|
end
|
907
978
|
|
908
|
-
# Bulk import of processed completion dataset. Request processing
|
909
|
-
#
|
910
|
-
#
|
979
|
+
# Bulk import of processed completion dataset. Request processing is
|
980
|
+
# asynchronous. Partial updating is not supported. The operation is successfully
|
981
|
+
# finished only after the imported suggestions are indexed successfully and
|
982
|
+
# ready for serving. The process takes hours. This feature is only available for
|
983
|
+
# users who have Retail Search enabled. Please submit a form [here](https://
|
911
984
|
# cloud.google.com/contact) to contact cloud sales if you are interested in
|
912
985
|
# using Retail Search.
|
913
986
|
# @param [String] parent
|
@@ -1214,7 +1287,8 @@ module Google
|
|
1214
1287
|
# Makes a recommendation prediction.
|
1215
1288
|
# @param [String] placement
|
1216
1289
|
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
1217
|
-
# catalogs/default_catalog/placements/*`
|
1290
|
+
# catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
|
1291
|
+
# catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
|
1218
1292
|
# placement. Before you can request predictions from your model, you must create
|
1219
1293
|
# at least one placement for it. For more information, see [Managing placements](
|
1220
1294
|
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
@@ -1255,9 +1329,10 @@ module Google
|
|
1255
1329
|
# to contact cloud sales if you are interested in using Retail Search.
|
1256
1330
|
# @param [String] placement
|
1257
1331
|
# Required. The resource name of the search engine placement, such as `projects/*
|
1258
|
-
# /locations/global/catalogs/default_catalog/placements/default_search
|
1259
|
-
#
|
1260
|
-
#
|
1332
|
+
# /locations/global/catalogs/default_catalog/placements/default_search` or `
|
1333
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1334
|
+
# default_serving_config` This field is used to identify the serving
|
1335
|
+
# configuration name and the set of models that will be used to make the search.
|
1261
1336
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
|
1262
1337
|
# @param [String] fields
|
1263
1338
|
# Selector specifying which fields to include in a partial response.
|
@@ -1512,6 +1587,46 @@ module Google
|
|
1512
1587
|
execute_or_queue_command(command, &block)
|
1513
1588
|
end
|
1514
1589
|
|
1590
|
+
# Makes a recommendation prediction.
|
1591
|
+
# @param [String] placement
|
1592
|
+
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
1593
|
+
# catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
|
1594
|
+
# catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
|
1595
|
+
# placement. Before you can request predictions from your model, you must create
|
1596
|
+
# at least one placement for it. For more information, see [Managing placements](
|
1597
|
+
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
1598
|
+
# The full list of available placements can be seen at https://console.cloud.
|
1599
|
+
# google.com/recommendation/catalogs/default_catalog/placements
|
1600
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest] google_cloud_retail_v2beta_predict_request_object
|
1601
|
+
# @param [String] fields
|
1602
|
+
# Selector specifying which fields to include in a partial response.
|
1603
|
+
# @param [String] quota_user
|
1604
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1605
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1606
|
+
# @param [Google::Apis::RequestOptions] options
|
1607
|
+
# Request-specific options
|
1608
|
+
#
|
1609
|
+
# @yield [result, err] Result & error if block supplied
|
1610
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse] parsed result object
|
1611
|
+
# @yieldparam err [StandardError] error object if request failed
|
1612
|
+
#
|
1613
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse]
|
1614
|
+
#
|
1615
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1616
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1617
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1618
|
+
def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1619
|
+
command = make_simple_command(:post, 'v2beta/{+placement}:predict', options)
|
1620
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest::Representation
|
1621
|
+
command.request_object = google_cloud_retail_v2beta_predict_request_object
|
1622
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse::Representation
|
1623
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse
|
1624
|
+
command.params['placement'] = placement unless placement.nil?
|
1625
|
+
command.query['fields'] = fields unless fields.nil?
|
1626
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1627
|
+
execute_or_queue_command(command, &block)
|
1628
|
+
end
|
1629
|
+
|
1515
1630
|
# Disables a Control on the specified ServingConfig. The control is removed from
|
1516
1631
|
# the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
|
1517
1632
|
# the ServingConfig.
|
@@ -1549,6 +1664,45 @@ module Google
|
|
1549
1664
|
execute_or_queue_command(command, &block)
|
1550
1665
|
end
|
1551
1666
|
|
1667
|
+
# Performs a search. This feature is only available for users who have Retail
|
1668
|
+
# Search enabled. Please submit a form [here](https://cloud.google.com/contact)
|
1669
|
+
# to contact cloud sales if you are interested in using Retail Search.
|
1670
|
+
# @param [String] placement
|
1671
|
+
# Required. The resource name of the search engine placement, such as `projects/*
|
1672
|
+
# /locations/global/catalogs/default_catalog/placements/default_search` or `
|
1673
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1674
|
+
# default_serving_config` This field is used to identify the serving
|
1675
|
+
# configuration name and the set of models that will be used to make the search.
|
1676
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
|
1677
|
+
# @param [String] fields
|
1678
|
+
# Selector specifying which fields to include in a partial response.
|
1679
|
+
# @param [String] quota_user
|
1680
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1681
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1682
|
+
# @param [Google::Apis::RequestOptions] options
|
1683
|
+
# Request-specific options
|
1684
|
+
#
|
1685
|
+
# @yield [result, err] Result & error if block supplied
|
1686
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse] parsed result object
|
1687
|
+
# @yieldparam err [StandardError] error object if request failed
|
1688
|
+
#
|
1689
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse]
|
1690
|
+
#
|
1691
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1692
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1693
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1694
|
+
def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1695
|
+
command = make_simple_command(:post, 'v2beta/{+placement}:search', options)
|
1696
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest::Representation
|
1697
|
+
command.request_object = google_cloud_retail_v2beta_search_request_object
|
1698
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse::Representation
|
1699
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse
|
1700
|
+
command.params['placement'] = placement unless placement.nil?
|
1701
|
+
command.query['fields'] = fields unless fields.nil?
|
1702
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1703
|
+
execute_or_queue_command(command, &block)
|
1704
|
+
end
|
1705
|
+
|
1552
1706
|
# Writes a single user event from the browser. This uses a GET request to due to
|
1553
1707
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
1554
1708
|
# only by the Retail API JavaScript pixel and Google Tag Manager. Users should
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-retail_v2beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.33.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-03-
|
11
|
+
date: 2022-03-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.33.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|