google-apis-retail_v2beta 0.30.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
@@ -1,5 +1,17 @@
|
|
1
1
|
# Release history for google-apis-retail_v2beta
|
2
2
|
|
3
|
+
### v0.33.0 (2022-03-24)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20220319
|
6
|
+
|
7
|
+
### v0.32.0 (2022-03-16)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20220310
|
10
|
+
|
11
|
+
### v0.31.0 (2022-03-09)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20220303
|
14
|
+
|
3
15
|
### v0.30.0 (2022-03-04)
|
4
16
|
|
5
17
|
* Regenerated from discovery document revision 20220224
|
@@ -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
|
@@ -950,6 +948,74 @@ module Google
|
|
950
948
|
end
|
951
949
|
end
|
952
950
|
|
951
|
+
# Metadata related to the progress of the PurgeProducts operation. This will be
|
952
|
+
# returned by the google.longrunning.Operation.metadata field.
|
953
|
+
class GoogleCloudRetailV2alphaPurgeProductsMetadata
|
954
|
+
include Google::Apis::Core::Hashable
|
955
|
+
|
956
|
+
# Operation create time.
|
957
|
+
# Corresponds to the JSON property `createTime`
|
958
|
+
# @return [String]
|
959
|
+
attr_accessor :create_time
|
960
|
+
|
961
|
+
# Count of entries that encountered errors while processing.
|
962
|
+
# Corresponds to the JSON property `failureCount`
|
963
|
+
# @return [Fixnum]
|
964
|
+
attr_accessor :failure_count
|
965
|
+
|
966
|
+
# Count of entries that were deleted successfully.
|
967
|
+
# Corresponds to the JSON property `successCount`
|
968
|
+
# @return [Fixnum]
|
969
|
+
attr_accessor :success_count
|
970
|
+
|
971
|
+
# Operation last update time. If the operation is done, this is also the finish
|
972
|
+
# time.
|
973
|
+
# Corresponds to the JSON property `updateTime`
|
974
|
+
# @return [String]
|
975
|
+
attr_accessor :update_time
|
976
|
+
|
977
|
+
def initialize(**args)
|
978
|
+
update!(**args)
|
979
|
+
end
|
980
|
+
|
981
|
+
# Update properties of this object
|
982
|
+
def update!(**args)
|
983
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
984
|
+
@failure_count = args[:failure_count] if args.key?(:failure_count)
|
985
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
986
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
987
|
+
end
|
988
|
+
end
|
989
|
+
|
990
|
+
# Response of the PurgeProductsRequest. If the long running operation is
|
991
|
+
# successfully done, then this message is returned by the google.longrunning.
|
992
|
+
# Operations.response field.
|
993
|
+
class GoogleCloudRetailV2alphaPurgeProductsResponse
|
994
|
+
include Google::Apis::Core::Hashable
|
995
|
+
|
996
|
+
# The total count of products purged as a result of the operation.
|
997
|
+
# Corresponds to the JSON property `purgeCount`
|
998
|
+
# @return [Fixnum]
|
999
|
+
attr_accessor :purge_count
|
1000
|
+
|
1001
|
+
# A sample of the product names that will be deleted. Only populated if `force`
|
1002
|
+
# is set to false. A max of 100 names will be returned and the names are chosen
|
1003
|
+
# at random.
|
1004
|
+
# Corresponds to the JSON property `purgeSample`
|
1005
|
+
# @return [Array<String>]
|
1006
|
+
attr_accessor :purge_sample
|
1007
|
+
|
1008
|
+
def initialize(**args)
|
1009
|
+
update!(**args)
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
# Update properties of this object
|
1013
|
+
def update!(**args)
|
1014
|
+
@purge_count = args[:purge_count] if args.key?(:purge_count)
|
1015
|
+
@purge_sample = args[:purge_sample] if args.key?(:purge_sample)
|
1016
|
+
end
|
1017
|
+
end
|
1018
|
+
|
953
1019
|
# Response of the PurgeUserEventsRequest. If the long running operation is
|
954
1020
|
# successfully done, then this message is returned by the google.longrunning.
|
955
1021
|
# Operations.response field.
|
@@ -1330,7 +1396,9 @@ module Google
|
|
1330
1396
|
# analytics/answer/3437719. * `user_event_ga4`: This feature is in private
|
1331
1397
|
# preview. Please contact the support team for importing Google Analytics 4
|
1332
1398
|
# events. The schema is available here: https://support.google.com/analytics/
|
1333
|
-
# 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.
|
1334
1402
|
# Corresponds to the JSON property `dataSchema`
|
1335
1403
|
# @return [String]
|
1336
1404
|
attr_accessor :data_schema
|
@@ -1351,11 +1419,11 @@ module Google
|
|
1351
1419
|
# Represents a whole or partial calendar date, such as a birthday. The time of
|
1352
1420
|
# day and time zone are either specified elsewhere or are insignificant. The
|
1353
1421
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
1354
|
-
# following: * A full date, with non-zero year, month, and day values * A month
|
1355
|
-
# and day, with a zero year (
|
1356
|
-
# zero month and a zero day * A year and month, with a zero day (
|
1357
|
-
# card expiration date) Related types: * google.type.
|
1358
|
-
# DateTime * google.protobuf.Timestamp
|
1422
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
1423
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
1424
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
1425
|
+
# example, a credit card expiration date). Related types: * google.type.
|
1426
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
1359
1427
|
# Corresponds to the JSON property `partitionDate`
|
1360
1428
|
# @return [Google::Apis::RetailV2beta::GoogleTypeDate]
|
1361
1429
|
attr_accessor :partition_date
|
@@ -1399,6 +1467,12 @@ module Google
|
|
1399
1467
|
# @return [String]
|
1400
1468
|
attr_accessor :display_name
|
1401
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
|
+
|
1402
1476
|
# Required. Immutable. The fully qualified resource name of the catalog.
|
1403
1477
|
# Corresponds to the JSON property `name`
|
1404
1478
|
# @return [String]
|
@@ -1417,6 +1491,7 @@ module Google
|
|
1417
1491
|
# Update properties of this object
|
1418
1492
|
def update!(**args)
|
1419
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)
|
1420
1495
|
@name = args[:name] if args.key?(:name)
|
1421
1496
|
@product_level_config = args[:product_level_config] if args.key?(:product_level_config)
|
1422
1497
|
end
|
@@ -1535,9 +1610,9 @@ module Google
|
|
1535
1610
|
class GoogleCloudRetailV2betaCompleteQueryResponse
|
1536
1611
|
include Google::Apis::Core::Hashable
|
1537
1612
|
|
1538
|
-
# A unique complete token. This should be included in the
|
1539
|
-
# resulting from this completion, which
|
1540
|
-
# 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.
|
1541
1616
|
# Corresponds to the JSON property `attributionToken`
|
1542
1617
|
# @return [String]
|
1543
1618
|
attr_accessor :attribution_token
|
@@ -1577,7 +1652,9 @@ module Google
|
|
1577
1652
|
class GoogleCloudRetailV2betaCompleteQueryResponseCompletionResult
|
1578
1653
|
include Google::Apis::Core::Hashable
|
1579
1654
|
|
1580
|
-
#
|
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.
|
1581
1658
|
# Corresponds to the JSON property `attributes`
|
1582
1659
|
# @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
|
1583
1660
|
attr_accessor :attributes
|
@@ -1617,6 +1694,103 @@ module Google
|
|
1617
1694
|
end
|
1618
1695
|
end
|
1619
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
|
+
|
1620
1794
|
# The input config source for completion data.
|
1621
1795
|
class GoogleCloudRetailV2betaCompletionDataInputConfig
|
1622
1796
|
include Google::Apis::Core::Hashable
|
@@ -1794,6 +1968,14 @@ module Google
|
|
1794
1968
|
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule]
|
1795
1969
|
attr_accessor :rule
|
1796
1970
|
|
1971
|
+
# Required. Specifies the use case for the control. Affects what condition
|
1972
|
+
# fields can be set. Only settable by search controls. Will default to
|
1973
|
+
# SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
|
1974
|
+
# search_solution_use_case per control.
|
1975
|
+
# Corresponds to the JSON property `searchSolutionUseCase`
|
1976
|
+
# @return [Array<String>]
|
1977
|
+
attr_accessor :search_solution_use_case
|
1978
|
+
|
1797
1979
|
# Required. Immutable. The solution types that the serving config is used for.
|
1798
1980
|
# Currently we support setting only one type of solution at creation time. Only `
|
1799
1981
|
# SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
|
@@ -1813,6 +1995,7 @@ module Google
|
|
1813
1995
|
@facet_spec = args[:facet_spec] if args.key?(:facet_spec)
|
1814
1996
|
@name = args[:name] if args.key?(:name)
|
1815
1997
|
@rule = args[:rule] if args.key?(:rule)
|
1998
|
+
@search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
|
1816
1999
|
@solution_types = args[:solution_types] if args.key?(:solution_types)
|
1817
2000
|
end
|
1818
2001
|
end
|
@@ -2080,7 +2263,10 @@ module Google
|
|
2080
2263
|
end
|
2081
2264
|
end
|
2082
2265
|
|
2083
|
-
# Product
|
2266
|
+
# Product image. Recommendations AI and Retail Search do not use product images
|
2267
|
+
# to improve prediction and search results. However, product images can be
|
2268
|
+
# returned in results, and are shown in prediction or search previews in the
|
2269
|
+
# console.
|
2084
2270
|
class GoogleCloudRetailV2betaImage
|
2085
2271
|
include Google::Apis::Core::Hashable
|
2086
2272
|
|
@@ -2210,8 +2396,7 @@ module Google
|
|
2210
2396
|
# @return [String]
|
2211
2397
|
attr_accessor :notification_pubsub_topic
|
2212
2398
|
|
2213
|
-
#
|
2214
|
-
# passed in the request.
|
2399
|
+
# Deprecated. This field is never set.
|
2215
2400
|
# Corresponds to the JSON property `requestId`
|
2216
2401
|
# @return [String]
|
2217
2402
|
attr_accessor :request_id
|
@@ -2271,11 +2456,7 @@ module Google
|
|
2271
2456
|
# @return [String]
|
2272
2457
|
attr_accessor :reconciliation_mode
|
2273
2458
|
|
2274
|
-
#
|
2275
|
-
# Ensures idempotency and used for request deduplication. Server-generated if
|
2276
|
-
# unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
|
2277
|
-
# 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
|
2278
|
-
# when ImportProductsRequest.reconciliation_mode is set to `FULL`.
|
2459
|
+
# Deprecated. This field has no effect.
|
2279
2460
|
# Corresponds to the JSON property `requestId`
|
2280
2461
|
# @return [String]
|
2281
2462
|
attr_accessor :request_id
|
@@ -2526,6 +2707,87 @@ module Google
|
|
2526
2707
|
end
|
2527
2708
|
end
|
2528
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
|
+
|
2529
2791
|
# Request message for Predict method.
|
2530
2792
|
class GoogleCloudRetailV2betaPredictRequest
|
2531
2793
|
include Google::Apis::Core::Hashable
|
@@ -2542,9 +2804,11 @@ module Google
|
|
2542
2804
|
# do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "
|
2543
2805
|
# Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-
|
2544
2806
|
# "promotional") * filterOutOfStockItems If your filter blocks all prediction
|
2545
|
-
# results,
|
2546
|
-
#
|
2547
|
-
# PredictRequest.params
|
2807
|
+
# results, the API will return generic (unfiltered) popular products. If you
|
2808
|
+
# only want results strictly matching the filters, set `strictFiltering` to True
|
2809
|
+
# in `PredictRequest.params` to receive empty results instead. Note that the API
|
2810
|
+
# will never return items with storageStatus of "EXPIRED" or "DELETED"
|
2811
|
+
# regardless of filter choices.
|
2548
2812
|
# Corresponds to the JSON property `filter`
|
2549
2813
|
# @return [String]
|
2550
2814
|
attr_accessor :filter
|
@@ -2951,7 +3215,7 @@ module Google
|
|
2951
3215
|
# @return [String]
|
2952
3216
|
attr_accessor :id
|
2953
3217
|
|
2954
|
-
# Product images for the product.
|
3218
|
+
# Product images for the product. We highly recommend putting the main image
|
2955
3219
|
# first. A maximum of 300 images are allowed. Corresponding properties: Google
|
2956
3220
|
# Merchant Center property [image_link](https://support.google.com/merchants/
|
2957
3221
|
# answer/6324350). Schema.org property [Product.image](https://schema.org/image).
|
@@ -4019,12 +4283,13 @@ module Google
|
|
4019
4283
|
# @return [String]
|
4020
4284
|
attr_accessor :branch
|
4021
4285
|
|
4022
|
-
# The filter
|
4023
|
-
#
|
4024
|
-
#
|
4025
|
-
#
|
4026
|
-
#
|
4027
|
-
#
|
4286
|
+
# The default filter that is applied when a user performs a search without
|
4287
|
+
# checking any filters on the search page. The filter applied to every search
|
4288
|
+
# request when quality improvement such as query expansion is needed. For
|
4289
|
+
# example, if a query does not have enough results, an expanded query with
|
4290
|
+
# SearchRequest.canonical_filter will be returned as a supplement of the
|
4291
|
+
# original query. This field is strongly recommended to achieve high search
|
4292
|
+
# quality. See SearchRequest.filter for more details about filter syntax.
|
4028
4293
|
# Corresponds to the JSON property `canonicalFilter`
|
4029
4294
|
# @return [String]
|
4030
4295
|
attr_accessor :canonical_filter
|
@@ -5014,15 +5279,21 @@ module Google
|
|
5014
5279
|
class GoogleCloudRetailV2betaUserEvent
|
5015
5280
|
include Google::Apis::Core::Hashable
|
5016
5281
|
|
5017
|
-
# Extra user event features to include in the recommendation model.
|
5018
|
-
#
|
5019
|
-
#
|
5020
|
-
#
|
5021
|
-
#
|
5022
|
-
#
|
5023
|
-
#
|
5024
|
-
#
|
5025
|
-
#
|
5282
|
+
# Extra user event features to include in the recommendation model. If you
|
5283
|
+
# provide custom attributes for ingested user events, also include them in the
|
5284
|
+
# user events that you associate with prediction requests. Custom attribute
|
5285
|
+
# formatting must be consistent between imported events and events provided with
|
5286
|
+
# prediction requests. This lets the Retail API use those custom attributes when
|
5287
|
+
# training models and serving predictions, which helps improve recommendation
|
5288
|
+
# quality. This field needs to pass all below criteria, otherwise an
|
5289
|
+
# INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string
|
5290
|
+
# with a length limit of 5,000 characters. * For text attributes, at most 400
|
5291
|
+
# values are allowed. Empty values are not allowed. Each value must be a UTF-8
|
5292
|
+
# encoded string with a length limit of 256 characters. * For number attributes,
|
5293
|
+
# at most 400 values are allowed. For product recommendations, an example of
|
5294
|
+
# extra user information is traffic_channel, which is how a user arrives at the
|
5295
|
+
# site. Users can arrive at the site by coming to the site directly, coming
|
5296
|
+
# through Google search, or in other ways.
|
5026
5297
|
# Corresponds to the JSON property `attributes`
|
5027
5298
|
# @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
|
5028
5299
|
attr_accessor :attributes
|
@@ -5451,8 +5722,7 @@ module Google
|
|
5451
5722
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
5452
5723
|
# messages in your APIs. A typical example is to use it as the request or the
|
5453
5724
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
5454
|
-
# protobuf.Empty) returns (google.protobuf.Empty); `
|
5455
|
-
# `Empty` is empty JSON object ````.
|
5725
|
+
# protobuf.Empty) returns (google.protobuf.Empty); `
|
5456
5726
|
class GoogleProtobufEmpty
|
5457
5727
|
include Google::Apis::Core::Hashable
|
5458
5728
|
|
@@ -5507,11 +5777,11 @@ module Google
|
|
5507
5777
|
# Represents a whole or partial calendar date, such as a birthday. The time of
|
5508
5778
|
# day and time zone are either specified elsewhere or are insignificant. The
|
5509
5779
|
# date is relative to the Gregorian Calendar. This can represent one of the
|
5510
|
-
# following: * A full date, with non-zero year, month, and day values * A month
|
5511
|
-
# and day, with a zero year (
|
5512
|
-
# zero month and a zero day * A year and month, with a zero day (
|
5513
|
-
# card expiration date) Related types: * google.type.
|
5514
|
-
# DateTime * google.protobuf.Timestamp
|
5780
|
+
# following: * A full date, with non-zero year, month, and day values. * A month
|
5781
|
+
# and day, with a zero year (for example, an anniversary). * A year on its own,
|
5782
|
+
# with a zero month and a zero day. * A year and month, with a zero day (for
|
5783
|
+
# example, a credit card expiration date). Related types: * google.type.
|
5784
|
+
# TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
|
5515
5785
|
class GoogleTypeDate
|
5516
5786
|
include Google::Apis::Core::Hashable
|
5517
5787
|
|
@@ -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
|
@@ -244,6 +244,18 @@ module Google
|
|
244
244
|
include Google::Apis::Core::JsonObjectSupport
|
245
245
|
end
|
246
246
|
|
247
|
+
class GoogleCloudRetailV2alphaPurgeProductsMetadata
|
248
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
249
|
+
|
250
|
+
include Google::Apis::Core::JsonObjectSupport
|
251
|
+
end
|
252
|
+
|
253
|
+
class GoogleCloudRetailV2alphaPurgeProductsResponse
|
254
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
255
|
+
|
256
|
+
include Google::Apis::Core::JsonObjectSupport
|
257
|
+
end
|
258
|
+
|
247
259
|
class GoogleCloudRetailV2alphaPurgeUserEventsResponse
|
248
260
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
249
261
|
|
@@ -388,6 +400,12 @@ module Google
|
|
388
400
|
include Google::Apis::Core::JsonObjectSupport
|
389
401
|
end
|
390
402
|
|
403
|
+
class GoogleCloudRetailV2betaCompletionConfig
|
404
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
405
|
+
|
406
|
+
include Google::Apis::Core::JsonObjectSupport
|
407
|
+
end
|
408
|
+
|
391
409
|
class GoogleCloudRetailV2betaCompletionDataInputConfig
|
392
410
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
393
411
|
|
@@ -556,6 +574,18 @@ module Google
|
|
556
574
|
include Google::Apis::Core::JsonObjectSupport
|
557
575
|
end
|
558
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
|
+
|
559
589
|
class GoogleCloudRetailV2betaPredictRequest
|
560
590
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
561
591
|
|
@@ -1230,6 +1260,24 @@ module Google
|
|
1230
1260
|
end
|
1231
1261
|
end
|
1232
1262
|
|
1263
|
+
class GoogleCloudRetailV2alphaPurgeProductsMetadata
|
1264
|
+
# @private
|
1265
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1266
|
+
property :create_time, as: 'createTime'
|
1267
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
1268
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
1269
|
+
property :update_time, as: 'updateTime'
|
1270
|
+
end
|
1271
|
+
end
|
1272
|
+
|
1273
|
+
class GoogleCloudRetailV2alphaPurgeProductsResponse
|
1274
|
+
# @private
|
1275
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1276
|
+
property :purge_count, :numeric_string => true, as: 'purgeCount'
|
1277
|
+
collection :purge_sample, as: 'purgeSample'
|
1278
|
+
end
|
1279
|
+
end
|
1280
|
+
|
1233
1281
|
class GoogleCloudRetailV2alphaPurgeUserEventsResponse
|
1234
1282
|
# @private
|
1235
1283
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1366,6 +1414,8 @@ module Google
|
|
1366
1414
|
# @private
|
1367
1415
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1368
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
|
+
|
1369
1419
|
property :name, as: 'name'
|
1370
1420
|
property :product_level_config, as: 'productLevelConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductLevelConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductLevelConfig::Representation
|
1371
1421
|
|
@@ -1419,6 +1469,26 @@ module Google
|
|
1419
1469
|
end
|
1420
1470
|
end
|
1421
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
|
+
|
1422
1492
|
class GoogleCloudRetailV2betaCompletionDataInputConfig
|
1423
1493
|
# @private
|
1424
1494
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1472,6 +1542,7 @@ module Google
|
|
1472
1542
|
property :name, as: 'name'
|
1473
1543
|
property :rule, as: 'rule', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule::Representation
|
1474
1544
|
|
1545
|
+
collection :search_solution_use_case, as: 'searchSolutionUseCase'
|
1475
1546
|
collection :solution_types, as: 'solutionTypes'
|
1476
1547
|
end
|
1477
1548
|
end
|
@@ -1683,6 +1754,25 @@ module Google
|
|
1683
1754
|
end
|
1684
1755
|
end
|
1685
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
|
+
|
1686
1776
|
class GoogleCloudRetailV2betaPredictRequest
|
1687
1777
|
# @private
|
1688
1778
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -72,10 +72,12 @@ module Google
|
|
72
72
|
# `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
|
73
73
|
# `OTHER_`, e.g. `OTHER_IPHONE`.
|
74
74
|
# @param [Array<String>, String] language_codes
|
75
|
-
# The
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
75
|
+
# The language filters applied to the output suggestions. If set, it should
|
76
|
+
# contain the language of the query. If not set, suggestions are returned
|
77
|
+
# without considering language restrictions. This is the BCP-47 language code,
|
78
|
+
# such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying
|
79
|
+
# Languages](https://tools.ietf.org/html/bcp47). The maximum number of language
|
80
|
+
# codes is 3.
|
79
81
|
# @param [Fixnum] max_suggestions
|
80
82
|
# Completion max suggestions. If left unset or set to 0, then will fallback to
|
81
83
|
# the configured value CompletionConfig.max_suggestions. The maximum allowed max
|
@@ -84,12 +86,12 @@ module Google
|
|
84
86
|
# Required. The query used to generate suggestions. The maximum number of
|
85
87
|
# allowed characters is 255.
|
86
88
|
# @param [String] visitor_id
|
87
|
-
# A unique identifier for tracking visitors. For example, this
|
88
|
-
# implemented with an HTTP cookie, which should be able to uniquely
|
89
|
-
# visitor on a single device. This unique identifier should not
|
90
|
-
# visitor logs in or out of the website. The field must be a UTF-8
|
91
|
-
# string with a length limit of 128 characters. Otherwise, an
|
92
|
-
# error is returned.
|
89
|
+
# Required field. A unique identifier for tracking visitors. For example, this
|
90
|
+
# could be implemented with an HTTP cookie, which should be able to uniquely
|
91
|
+
# identify a visitor on a single device. This unique identifier should not
|
92
|
+
# change if the visitor logs in or out of the website. The field must be a UTF-8
|
93
|
+
# encoded string with a length limit of 128 characters. Otherwise, an
|
94
|
+
# INVALID_ARGUMENT error is returned.
|
93
95
|
# @param [String] fields
|
94
96
|
# Selector specifying which fields to include in a partial response.
|
95
97
|
# @param [String] quota_user
|
@@ -154,6 +156,37 @@ module Google
|
|
154
156
|
execute_or_queue_command(command, &block)
|
155
157
|
end
|
156
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
|
+
|
157
190
|
# Get which branch is currently default branch set by CatalogService.
|
158
191
|
# SetDefaultBranch method under a specified parent catalog.
|
159
192
|
# @param [String] catalog
|
@@ -363,6 +396,46 @@ module Google
|
|
363
396
|
execute_or_queue_command(command, &block)
|
364
397
|
end
|
365
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
|
+
|
366
439
|
# Adds the specified CatalogAttribute to the AttributesConfig. If the
|
367
440
|
# CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
|
368
441
|
# @param [String] attributes_config
|
@@ -903,9 +976,11 @@ module Google
|
|
903
976
|
execute_or_queue_command(command, &block)
|
904
977
|
end
|
905
978
|
|
906
|
-
# Bulk import of processed completion dataset. Request processing
|
907
|
-
#
|
908
|
-
#
|
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://
|
909
984
|
# cloud.google.com/contact) to contact cloud sales if you are interested in
|
910
985
|
# using Retail Search.
|
911
986
|
# @param [String] parent
|
@@ -1212,7 +1287,8 @@ module Google
|
|
1212
1287
|
# Makes a recommendation prediction.
|
1213
1288
|
# @param [String] placement
|
1214
1289
|
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
1215
|
-
# 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
|
1216
1292
|
# placement. Before you can request predictions from your model, you must create
|
1217
1293
|
# at least one placement for it. For more information, see [Managing placements](
|
1218
1294
|
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
@@ -1253,9 +1329,10 @@ module Google
|
|
1253
1329
|
# to contact cloud sales if you are interested in using Retail Search.
|
1254
1330
|
# @param [String] placement
|
1255
1331
|
# Required. The resource name of the search engine placement, such as `projects/*
|
1256
|
-
# /locations/global/catalogs/default_catalog/placements/default_search
|
1257
|
-
#
|
1258
|
-
#
|
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.
|
1259
1336
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
|
1260
1337
|
# @param [String] fields
|
1261
1338
|
# Selector specifying which fields to include in a partial response.
|
@@ -1510,6 +1587,46 @@ module Google
|
|
1510
1587
|
execute_or_queue_command(command, &block)
|
1511
1588
|
end
|
1512
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
|
+
|
1513
1630
|
# Disables a Control on the specified ServingConfig. The control is removed from
|
1514
1631
|
# the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
|
1515
1632
|
# the ServingConfig.
|
@@ -1547,6 +1664,45 @@ module Google
|
|
1547
1664
|
execute_or_queue_command(command, &block)
|
1548
1665
|
end
|
1549
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
|
+
|
1550
1706
|
# Writes a single user event from the browser. This uses a GET request to due to
|
1551
1707
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
1552
1708
|
# only by the Retail API JavaScript pixel and Google Tag Manager. Users should
|
@@ -1669,13 +1825,14 @@ module Google
|
|
1669
1825
|
execute_or_queue_command(command, &block)
|
1670
1826
|
end
|
1671
1827
|
|
1672
|
-
#
|
1673
|
-
#
|
1674
|
-
#
|
1828
|
+
# Starts a user event rejoin operation with latest product catalog. Events will
|
1829
|
+
# not be annotated with detailed product information if product is missing from
|
1830
|
+
# the catalog at the time the user event is ingested, and these events are
|
1675
1831
|
# stored as unjoined events with a limited usage on training and serving. This
|
1676
|
-
#
|
1832
|
+
# method can be used to start a join operation on specified events with latest
|
1677
1833
|
# version of product catalog. It can also be used to correct events joined with
|
1678
|
-
# wrong product catalog.
|
1834
|
+
# the wrong product catalog. A rejoin operation can take hours or days to
|
1835
|
+
# complete.
|
1679
1836
|
# @param [String] parent
|
1680
1837
|
# Required. The parent catalog resource name, such as `projects/1234/locations/
|
1681
1838
|
# global/catalogs/default_catalog`.
|
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: []
|