google-apis-retail_v2alpha 0.19.0 → 0.23.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: c73d8cd80dd129bd29b3ef560fee850ecb2c4ede024d6522ef1280a5a8a8f796
|
4
|
+
data.tar.gz: 3bd3a36842da663394e8f9400c664aba3a2f7e453c4e9c4dde4b12ae710bb9c6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d9666df79784271cd7abda394c85937b3e1490f5155f5040026d38492ea4c0369d35e849cad4cb32325fe923f8b72bc3c96e1393a43c309814c1f4533a4ba5fd
|
7
|
+
data.tar.gz: b68de91975b8a6b89a2547027009764311eb60a6c3acbd3563f6e3aefafc3b12a0aa8aa87b79a9ae533a5a5a5a578362fc8dbad48f809ec665ab1cefca8911fa
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,21 @@
|
|
1
1
|
# Release history for google-apis-retail_v2alpha
|
2
2
|
|
3
|
+
### v0.23.0 (2021-12-09)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20211203
|
6
|
+
|
7
|
+
### v0.22.0 (2021-11-17)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20211116
|
10
|
+
|
11
|
+
### v0.21.0 (2021-11-10)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20211104
|
14
|
+
|
15
|
+
### v0.20.0 (2021-11-03)
|
16
|
+
|
17
|
+
* Regenerated from discovery document revision 20211028
|
18
|
+
|
3
19
|
### v0.19.0 (2021-10-26)
|
4
20
|
|
5
21
|
* Regenerated from discovery document revision 20211021
|
@@ -657,7 +657,7 @@ module Google
|
|
657
657
|
# or the region IDs for "same-day-delivery" to be added for this type. Duplicate
|
658
658
|
# IDs will be automatically ignored. At least 1 value is required, and a maximum
|
659
659
|
# of 2000 values are allowed. Each value must be a string with a length limit of
|
660
|
-
# 10 characters, matching the pattern [a-zA-Z0-9_-]
|
660
|
+
# 10 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "
|
661
661
|
# REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total
|
662
662
|
# number of place IDs exceeds 2000 for this type after adding, then the update
|
663
663
|
# will be rejected.
|
@@ -703,6 +703,86 @@ module Google
|
|
703
703
|
end
|
704
704
|
end
|
705
705
|
|
706
|
+
# Metadata related to the progress of the AddLocalInventories operation.
|
707
|
+
# Currently empty because there is no meaningful metadata populated from the
|
708
|
+
# AddLocalInventories method.
|
709
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
|
710
|
+
include Google::Apis::Core::Hashable
|
711
|
+
|
712
|
+
def initialize(**args)
|
713
|
+
update!(**args)
|
714
|
+
end
|
715
|
+
|
716
|
+
# Update properties of this object
|
717
|
+
def update!(**args)
|
718
|
+
end
|
719
|
+
end
|
720
|
+
|
721
|
+
# Request message for AddLocalInventories method.
|
722
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
|
723
|
+
include Google::Apis::Core::Hashable
|
724
|
+
|
725
|
+
# Indicates which inventory fields in the provided list of LocalInventory to
|
726
|
+
# update. The field is updated to the provided value. If a field is set while
|
727
|
+
# the place does not have a previous local inventory, the local inventory at
|
728
|
+
# that store is created. If a field is set while the value of that field is not
|
729
|
+
# provided, the original field value, if it exists, is deleted. If the mask is
|
730
|
+
# not set or set with empty paths, all inventory fields will be updated. If an
|
731
|
+
# unsupported or unknown field is provided, an INVALID_ARGUMENT error is
|
732
|
+
# returned and the entire update will be ignored.
|
733
|
+
# Corresponds to the JSON property `addMask`
|
734
|
+
# @return [String]
|
735
|
+
attr_accessor :add_mask
|
736
|
+
|
737
|
+
# The time when the inventory updates are issued. Used to prevent out-of-order
|
738
|
+
# updates on local inventory fields. If not provided, the internal system time
|
739
|
+
# will be used.
|
740
|
+
# Corresponds to the JSON property `addTime`
|
741
|
+
# @return [String]
|
742
|
+
attr_accessor :add_time
|
743
|
+
|
744
|
+
# If set to true, and the Product is not found, the local inventory will still
|
745
|
+
# be processed and retained for at most 1 day and processed once the Product is
|
746
|
+
# created. If set to false, a NOT_FOUND error is returned if the Product is not
|
747
|
+
# found.
|
748
|
+
# Corresponds to the JSON property `allowMissing`
|
749
|
+
# @return [Boolean]
|
750
|
+
attr_accessor :allow_missing
|
751
|
+
alias_method :allow_missing?, :allow_missing
|
752
|
+
|
753
|
+
# Required. A list of inventory information at difference places. Each place is
|
754
|
+
# identified by its place ID. At most 3000 inventories are allowed per request.
|
755
|
+
# Corresponds to the JSON property `localInventories`
|
756
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory>]
|
757
|
+
attr_accessor :local_inventories
|
758
|
+
|
759
|
+
def initialize(**args)
|
760
|
+
update!(**args)
|
761
|
+
end
|
762
|
+
|
763
|
+
# Update properties of this object
|
764
|
+
def update!(**args)
|
765
|
+
@add_mask = args[:add_mask] if args.key?(:add_mask)
|
766
|
+
@add_time = args[:add_time] if args.key?(:add_time)
|
767
|
+
@allow_missing = args[:allow_missing] if args.key?(:allow_missing)
|
768
|
+
@local_inventories = args[:local_inventories] if args.key?(:local_inventories)
|
769
|
+
end
|
770
|
+
end
|
771
|
+
|
772
|
+
# Response of the AddLocalInventories API. Currently empty because there is no
|
773
|
+
# meaningful response populated from the AddLocalInventories method.
|
774
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
|
775
|
+
include Google::Apis::Core::Hashable
|
776
|
+
|
777
|
+
def initialize(**args)
|
778
|
+
update!(**args)
|
779
|
+
end
|
780
|
+
|
781
|
+
# Update properties of this object
|
782
|
+
def update!(**args)
|
783
|
+
end
|
784
|
+
end
|
785
|
+
|
706
786
|
# An intended audience of the Product for whom it's sold.
|
707
787
|
class GoogleCloudRetailV2alphaAudience
|
708
788
|
include Google::Apis::Core::Hashable
|
@@ -1042,9 +1122,8 @@ module Google
|
|
1042
1122
|
alias_method :indexable?, :indexable
|
1043
1123
|
|
1044
1124
|
# The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
|
1045
|
-
# the key is "lengths_cm".
|
1046
|
-
# INVALID_ARGUMENT error is returned.
|
1047
|
-
# set. Otherwise, an INVALID_ARGUMENT error is returned.
|
1125
|
+
# the key is "lengths_cm". Exactly one of text or numbers should be set.
|
1126
|
+
# Otherwise, an INVALID_ARGUMENT error is returned.
|
1048
1127
|
# Corresponds to the JSON property `numbers`
|
1049
1128
|
# @return [Array<Float>]
|
1050
1129
|
attr_accessor :numbers
|
@@ -1058,11 +1137,8 @@ module Google
|
|
1058
1137
|
alias_method :searchable?, :searchable
|
1059
1138
|
|
1060
1139
|
# The textual values of this custom attribute. For example, `["yellow", "green"]`
|
1061
|
-
# when the key is "color".
|
1062
|
-
#
|
1063
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of
|
1064
|
-
# text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is
|
1065
|
-
# returned.
|
1140
|
+
# when the key is "color". Exactly one of text or numbers should be set.
|
1141
|
+
# Otherwise, an INVALID_ARGUMENT error is returned.
|
1066
1142
|
# Corresponds to the JSON property `text`
|
1067
1143
|
# @return [Array<String>]
|
1068
1144
|
attr_accessor :text
|
@@ -1190,7 +1266,7 @@ module Google
|
|
1190
1266
|
# The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
|
1191
1267
|
# in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
|
1192
1268
|
# maximum of 3000 values are allowed. Each value must be a string with a length
|
1193
|
-
# limit of 30 characters, matching the pattern [a-zA-Z0-9_-]
|
1269
|
+
# limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1"
|
1194
1270
|
# or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
|
1195
1271
|
# Corresponds to the JSON property `placeIds`
|
1196
1272
|
# @return [Array<String>]
|
@@ -1480,8 +1556,8 @@ module Google
|
|
1480
1556
|
|
1481
1557
|
# Unique identifier provided by client, within the ancestor dataset scope.
|
1482
1558
|
# Ensures idempotency and used for request deduplication. Server-generated if
|
1483
|
-
# unspecified. Up to 128 characters long and must match the pattern:
|
1484
|
-
# 9_]
|
1559
|
+
# unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
|
1560
|
+
# 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
|
1485
1561
|
# when ImportProductsRequest.reconciliation_mode is set to `FULL`.
|
1486
1562
|
# Corresponds to the JSON property `requestId`
|
1487
1563
|
# @return [String]
|
@@ -1692,6 +1768,46 @@ module Google
|
|
1692
1768
|
end
|
1693
1769
|
end
|
1694
1770
|
|
1771
|
+
# The inventory information at a place (e.g. a store) identified by a place ID.
|
1772
|
+
class GoogleCloudRetailV2alphaLocalInventory
|
1773
|
+
include Google::Apis::Core::Hashable
|
1774
|
+
|
1775
|
+
# Additional local inventory attributes, for example, store name, promotion tags,
|
1776
|
+
# etc. This field needs to pass all below criteria, otherwise an
|
1777
|
+
# INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The
|
1778
|
+
# key must be a UTF-8 encoded string with a length limit of 32 characters. * The
|
1779
|
+
# key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or
|
1780
|
+
# KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or
|
1781
|
+
# number). * The max number of values per attribute is 10. * For text values,
|
1782
|
+
# the length limit is 64 UTF-8 characters. * The attribute does not support
|
1783
|
+
# search. The `searchable` field should be unset or set to false. * The max
|
1784
|
+
# summed total bytes of custom attribute keys and values per product is 5MiB.
|
1785
|
+
# Corresponds to the JSON property `attributes`
|
1786
|
+
# @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
|
1787
|
+
attr_accessor :attributes
|
1788
|
+
|
1789
|
+
# The place ID for the current set of inventory information.
|
1790
|
+
# Corresponds to the JSON property `placeId`
|
1791
|
+
# @return [String]
|
1792
|
+
attr_accessor :place_id
|
1793
|
+
|
1794
|
+
# The price information of a Product.
|
1795
|
+
# Corresponds to the JSON property `priceInfo`
|
1796
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo]
|
1797
|
+
attr_accessor :price_info
|
1798
|
+
|
1799
|
+
def initialize(**args)
|
1800
|
+
update!(**args)
|
1801
|
+
end
|
1802
|
+
|
1803
|
+
# Update properties of this object
|
1804
|
+
def update!(**args)
|
1805
|
+
@attributes = args[:attributes] if args.key?(:attributes)
|
1806
|
+
@place_id = args[:place_id] if args.key?(:place_id)
|
1807
|
+
@price_info = args[:price_info] if args.key?(:price_info)
|
1808
|
+
end
|
1809
|
+
end
|
1810
|
+
|
1695
1811
|
# Represents a link between a Merchant Center account and a branch. Once a link
|
1696
1812
|
# is established, products from the linked merchant center account will be
|
1697
1813
|
# streamed to the linked branch.
|
@@ -1709,13 +1825,21 @@ module Google
|
|
1709
1825
|
|
1710
1826
|
# String representing the destination to import for, all if left empty. List of
|
1711
1827
|
# possible values can be found here. [https://support.google.com/merchants/
|
1712
|
-
# answer/7501026] List of allowed string values: "
|
1713
|
-
#
|
1714
|
-
#
|
1828
|
+
# answer/7501026] List of allowed string values: "Shopping_ads", "
|
1829
|
+
# Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings"
|
1830
|
+
# , "Free_local_listings" NOTE: The string values are case sensitive.
|
1715
1831
|
# Corresponds to the JSON property `destinations`
|
1716
1832
|
# @return [Array<String>]
|
1717
1833
|
attr_accessor :destinations
|
1718
1834
|
|
1835
|
+
# Language of the title/description and other string attributes. Use language
|
1836
|
+
# tags defined by BCP 47. ISO 639-1. This specifies the language of offers in
|
1837
|
+
# Merchant Center that will be accepted. If empty no language filtering will be
|
1838
|
+
# performed.
|
1839
|
+
# Corresponds to the JSON property `languageCode`
|
1840
|
+
# @return [String]
|
1841
|
+
attr_accessor :language_code
|
1842
|
+
|
1719
1843
|
# Required. The linked [Merchant center account id](https://developers.google.
|
1720
1844
|
# com/shopping-content/guides/accountstatuses). The account must be a standalone
|
1721
1845
|
# account or a sub-account of a MCA.
|
@@ -1723,6 +1847,14 @@ module Google
|
|
1723
1847
|
# @return [Fixnum]
|
1724
1848
|
attr_accessor :merchant_center_account_id
|
1725
1849
|
|
1850
|
+
# Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code.
|
1851
|
+
# List of values can be found here under the `region` tag. [https://www.iana.org/
|
1852
|
+
# assignments/language-subtag-registry/language-subtag-registry]. If left blank
|
1853
|
+
# no region filtering will be performed. Ex. `US`.
|
1854
|
+
# Corresponds to the JSON property `regionCode`
|
1855
|
+
# @return [String]
|
1856
|
+
attr_accessor :region_code
|
1857
|
+
|
1726
1858
|
def initialize(**args)
|
1727
1859
|
update!(**args)
|
1728
1860
|
end
|
@@ -1731,7 +1863,9 @@ module Google
|
|
1731
1863
|
def update!(**args)
|
1732
1864
|
@branch_id = args[:branch_id] if args.key?(:branch_id)
|
1733
1865
|
@destinations = args[:destinations] if args.key?(:destinations)
|
1866
|
+
@language_code = args[:language_code] if args.key?(:language_code)
|
1734
1867
|
@merchant_center_account_id = args[:merchant_center_account_id] if args.key?(:merchant_center_account_id)
|
1868
|
+
@region_code = args[:region_code] if args.key?(:region_code)
|
1735
1869
|
end
|
1736
1870
|
end
|
1737
1871
|
|
@@ -2042,8 +2176,11 @@ module Google
|
|
2042
2176
|
# :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
|
2043
2177
|
# INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
|
2044
2178
|
# be a UTF-8 encoded string with a length limit of 128 characters. * For
|
2045
|
-
# indexable attribute, the key must match the pattern: a-zA-Z0-9
|
2046
|
-
# key0LikeThis or KEY_1_LIKE_THIS
|
2179
|
+
# indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
|
2180
|
+
# `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400
|
2181
|
+
# values are allowed. Empty values are not allowed. Each value must be a UTF-8
|
2182
|
+
# encoded string with a length limit of 256 characters. * For number attributes,
|
2183
|
+
# at most 400 values are allowed.
|
2047
2184
|
# Corresponds to the JSON property `attributes`
|
2048
2185
|
# @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
|
2049
2186
|
attr_accessor :attributes
|
@@ -2054,9 +2191,9 @@ module Google
|
|
2054
2191
|
attr_accessor :audience
|
2055
2192
|
|
2056
2193
|
# The online availability of the Product. Default to Availability.IN_STOCK.
|
2057
|
-
# Google Merchant Center
|
2058
|
-
# merchants/answer/6324448). Schema.org
|
2059
|
-
# schema.org/availability).
|
2194
|
+
# Corresponding properties: Google Merchant Center property [availability](https:
|
2195
|
+
# //support.google.com/merchants/answer/6324448). Schema.org property [Offer.
|
2196
|
+
# availability](https://schema.org/availability).
|
2060
2197
|
# Corresponds to the JSON property `availability`
|
2061
2198
|
# @return [String]
|
2062
2199
|
attr_accessor :availability
|
@@ -2073,9 +2210,9 @@ module Google
|
|
2073
2210
|
|
2074
2211
|
# The brands of the product. A maximum of 30 brands are allowed. Each brand must
|
2075
2212
|
# be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
|
2076
|
-
# an INVALID_ARGUMENT error is returned.
|
2077
|
-
# https://support.google.com/merchants/answer/
|
2078
|
-
# Product.brand](https://schema.org/brand).
|
2213
|
+
# an INVALID_ARGUMENT error is returned. Corresponding properties: Google
|
2214
|
+
# Merchant Center property [brand](https://support.google.com/merchants/answer/
|
2215
|
+
# 6324351). Schema.org property [Product.brand](https://schema.org/brand).
|
2079
2216
|
# Corresponds to the JSON property `brands`
|
2080
2217
|
# @return [Array<String>]
|
2081
2218
|
attr_accessor :brands
|
@@ -2092,10 +2229,10 @@ module Google
|
|
2092
2229
|
# INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
|
2093
2230
|
# Empty values are not allowed. Each value must be a UTF-8 encoded string with
|
2094
2231
|
# a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
|
2095
|
-
# returned. Google Merchant Center property
|
2096
|
-
# property [Product.category] (https://
|
2097
|
-
# mc_google_product_category]: https://support.google.com/
|
2098
|
-
# 6324436
|
2232
|
+
# returned. Corresponding properties: Google Merchant Center property
|
2233
|
+
# google_product_category. Schema.org property [Product.category] (https://
|
2234
|
+
# schema.org/category). [mc_google_product_category]: https://support.google.com/
|
2235
|
+
# merchants/answer/6324436
|
2099
2236
|
# Corresponds to the JSON property `categories`
|
2100
2237
|
# @return [Array<String>]
|
2101
2238
|
attr_accessor :categories
|
@@ -2115,19 +2252,19 @@ module Google
|
|
2115
2252
|
# The condition of the product. Strongly encouraged to use the standard values: "
|
2116
2253
|
# new", "refurbished", "used". A maximum of 5 values are allowed per Product.
|
2117
2254
|
# Each value must be a UTF-8 encoded string with a length limit of 128
|
2118
|
-
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
2119
|
-
# Center property [condition](https://support.google.
|
2120
|
-
# 6324469). Schema.org property [Offer.itemCondition](https
|
2121
|
-
# itemCondition).
|
2255
|
+
# characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding
|
2256
|
+
# properties: Google Merchant Center property [condition](https://support.google.
|
2257
|
+
# com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https:
|
2258
|
+
# //schema.org/itemCondition).
|
2122
2259
|
# Corresponds to the JSON property `conditions`
|
2123
2260
|
# @return [Array<String>]
|
2124
2261
|
attr_accessor :conditions
|
2125
2262
|
|
2126
2263
|
# Product description. This field must be a UTF-8 encoded string with a length
|
2127
2264
|
# limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
2128
|
-
# Google Merchant Center property [description](https
|
2129
|
-
# merchants/answer/6324468).
|
2130
|
-
# schema.org/description).
|
2265
|
+
# Corresponding properties: Google Merchant Center property [description](https:/
|
2266
|
+
# /support.google.com/merchants/answer/6324468). Schema.org property [Product.
|
2267
|
+
# description](https://schema.org/description).
|
2131
2268
|
# Corresponds to the JSON property `description`
|
2132
2269
|
# @return [String]
|
2133
2270
|
attr_accessor :description
|
@@ -2137,8 +2274,8 @@ module Google
|
|
2137
2274
|
# expire_time. However, the product can still be retrieved by ProductService.
|
2138
2275
|
# GetProduct and ProductService.ListProducts. expire_time must be later than
|
2139
2276
|
# available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
|
2140
|
-
# Google Merchant Center property [expiration_date](
|
2141
|
-
# merchants/answer/6324499).
|
2277
|
+
# Corresponding properties: Google Merchant Center property [expiration_date](
|
2278
|
+
# https://support.google.com/merchants/answer/6324499).
|
2142
2279
|
# Corresponds to the JSON property `expireTime`
|
2143
2280
|
# @return [String]
|
2144
2281
|
attr_accessor :expire_time
|
@@ -2153,12 +2290,13 @@ module Google
|
|
2153
2290
|
# The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
|
2154
2291
|
# encoded string with a length limit of 128 characters. Otherwise, an
|
2155
2292
|
# INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,
|
2156
|
-
# an INVALID_ARGUMENT error is returned.
|
2157
|
-
# https://support.google.com/merchants/answer/
|
2158
|
-
#
|
2159
|
-
#
|
2160
|
-
# https://schema.org/gtin13) or [Product.gtin14](
|
2161
|
-
# the value is not a valid GTIN, an
|
2293
|
+
# an INVALID_ARGUMENT error is returned. Corresponding properties: Google
|
2294
|
+
# Merchant Center property [gtin](https://support.google.com/merchants/answer/
|
2295
|
+
# 6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [
|
2296
|
+
# Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/
|
2297
|
+
# gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](
|
2298
|
+
# https://schema.org/gtin14). If the value is not a valid GTIN, an
|
2299
|
+
# INVALID_ARGUMENT error is returned.
|
2162
2300
|
# Corresponds to the JSON property `gtin`
|
2163
2301
|
# @return [String]
|
2164
2302
|
attr_accessor :gtin
|
@@ -2167,27 +2305,28 @@ module Google
|
|
2167
2305
|
# example, this field is "id_1", if name is `projects/*/locations/global/
|
2168
2306
|
# catalogs/default_catalog/branches/default_branch/products/id_1`. This field
|
2169
2307
|
# must be a UTF-8 encoded string with a length limit of 128 characters.
|
2170
|
-
# Otherwise, an INVALID_ARGUMENT error is returned.
|
2171
|
-
# property [id](https://support.google.com/merchants/
|
2172
|
-
#
|
2308
|
+
# Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
|
2309
|
+
# Google Merchant Center property [id](https://support.google.com/merchants/
|
2310
|
+
# answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
|
2173
2311
|
# Corresponds to the JSON property `id`
|
2174
2312
|
# @return [String]
|
2175
2313
|
attr_accessor :id
|
2176
2314
|
|
2177
2315
|
# Product images for the product.Highly recommended to put the main image to the
|
2178
|
-
# first. A maximum of 300 images are allowed.
|
2179
|
-
# image_link](https://support.google.com/merchants/
|
2180
|
-
# property [Product.image](https://schema.org/image).
|
2316
|
+
# first. A maximum of 300 images are allowed. Corresponding properties: Google
|
2317
|
+
# Merchant Center property [image_link](https://support.google.com/merchants/
|
2318
|
+
# answer/6324350). Schema.org property [Product.image](https://schema.org/image).
|
2181
2319
|
# Corresponds to the JSON property `images`
|
2182
2320
|
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImage>]
|
2183
2321
|
attr_accessor :images
|
2184
2322
|
|
2185
2323
|
# Language of the title/description and other string attributes. Use language
|
2186
|
-
# tags defined by BCP 47. For
|
2187
|
-
#
|
2188
|
-
#
|
2189
|
-
#
|
2190
|
-
# field is in use. It
|
2324
|
+
# tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For
|
2325
|
+
# product prediction, this field is ignored and the model automatically detects
|
2326
|
+
# the text language. The Product can include text in different languages, but
|
2327
|
+
# duplicating Products to provide text in multiple languages can result in
|
2328
|
+
# degraded model performance. For product search this field is in use. It
|
2329
|
+
# defaults to "en-US" if unset.
|
2191
2330
|
# Corresponds to the JSON property `languageCode`
|
2192
2331
|
# @return [String]
|
2193
2332
|
attr_accessor :language_code
|
@@ -2195,9 +2334,9 @@ module Google
|
|
2195
2334
|
# The material of the product. For example, "leather", "wooden". A maximum of 20
|
2196
2335
|
# values are allowed. Each value must be a UTF-8 encoded string with a length
|
2197
2336
|
# limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
2198
|
-
# Google Merchant Center property [material](https://
|
2199
|
-
# merchants/answer/6324410). Schema.org property [Product.
|
2200
|
-
# schema.org/material).
|
2337
|
+
# Corresponding properties: Google Merchant Center property [material](https://
|
2338
|
+
# support.google.com/merchants/answer/6324410). Schema.org property [Product.
|
2339
|
+
# material](https://schema.org/material).
|
2201
2340
|
# Corresponds to the JSON property `materials`
|
2202
2341
|
# @return [Array<String>]
|
2203
2342
|
attr_accessor :materials
|
@@ -2211,9 +2350,10 @@ module Google
|
|
2211
2350
|
# The pattern or graphic print of the product. For example, "striped", "polka
|
2212
2351
|
# dot", "paisley". A maximum of 20 values are allowed per Product. Each value
|
2213
2352
|
# must be a UTF-8 encoded string with a length limit of 128 characters.
|
2214
|
-
# Otherwise, an INVALID_ARGUMENT error is returned.
|
2215
|
-
# property [pattern](https://support.google.com/merchants/
|
2216
|
-
# Schema.org property [Product.pattern](https://schema.org/
|
2353
|
+
# Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
|
2354
|
+
# Google Merchant Center property [pattern](https://support.google.com/merchants/
|
2355
|
+
# answer/6324483). Schema.org property [Product.pattern](https://schema.org/
|
2356
|
+
# pattern).
|
2217
2357
|
# Corresponds to the JSON property `patterns`
|
2218
2358
|
# @return [Array<String>]
|
2219
2359
|
attr_accessor :patterns
|
@@ -2228,10 +2368,9 @@ module Google
|
|
2228
2368
|
# can only be empty or set to the same value as id. For VARIANT Products, this
|
2229
2369
|
# field cannot be empty. A maximum of 2,000 products are allowed to share the
|
2230
2370
|
# same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.
|
2231
|
-
# Google Merchant Center
|
2232
|
-
# merchants/answer/6324507). Schema.org
|
2233
|
-
# https://schema.org/inProductGroupWithID).
|
2234
|
-
# can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).
|
2371
|
+
# Corresponding properties: Google Merchant Center property [item_group_id](
|
2372
|
+
# https://support.google.com/merchants/answer/6324507). Schema.org property [
|
2373
|
+
# Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
|
2235
2374
|
# Corresponds to the JSON property `primaryProductId`
|
2236
2375
|
# @return [String]
|
2237
2376
|
attr_accessor :primary_product_id
|
@@ -2280,10 +2419,11 @@ module Google
|
|
2280
2419
|
# system and size type are empty, while size value is "32 inches". A maximum of
|
2281
2420
|
# 20 values are allowed per Product. Each value must be a UTF-8 encoded string
|
2282
2421
|
# with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
|
2283
|
-
# returned. Google Merchant Center property [size](
|
2284
|
-
# merchants/answer/6324492), [size_type](https://
|
2285
|
-
# answer/6324497) and [size_system](https://
|
2286
|
-
# 6324502). Schema.org property [Product.
|
2422
|
+
# returned. Corresponding properties: Google Merchant Center property [size](
|
2423
|
+
# https://support.google.com/merchants/answer/6324492), [size_type](https://
|
2424
|
+
# support.google.com/merchants/answer/6324497), and [size_system](https://
|
2425
|
+
# support.google.com/merchants/answer/6324502). Schema.org property [Product.
|
2426
|
+
# size](https://schema.org/size).
|
2287
2427
|
# Corresponds to the JSON property `sizes`
|
2288
2428
|
# @return [Array<String>]
|
2289
2429
|
attr_accessor :sizes
|
@@ -2292,17 +2432,18 @@ module Google
|
|
2292
2432
|
# Product. This value must be a UTF-8 encoded string with a length limit of 1,
|
2293
2433
|
# 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can
|
2294
2434
|
# be used for filtering recommendation results by passing the tag as part of the
|
2295
|
-
# PredictRequest.filter. Google Merchant Center
|
2296
|
-
# https://support.google.com/merchants/answer/
|
2435
|
+
# PredictRequest.filter. Corresponding properties: Google Merchant Center
|
2436
|
+
# property [custom_label_0–4](https://support.google.com/merchants/answer/
|
2437
|
+
# 6324473).
|
2297
2438
|
# Corresponds to the JSON property `tags`
|
2298
2439
|
# @return [Array<String>]
|
2299
2440
|
attr_accessor :tags
|
2300
2441
|
|
2301
2442
|
# Required. Product title. This field must be a UTF-8 encoded string with a
|
2302
2443
|
# length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
|
2303
|
-
# returned. Google Merchant Center property [title](
|
2304
|
-
# merchants/answer/6324415). Schema.org property [
|
2305
|
-
# org/name).
|
2444
|
+
# returned. Corresponding properties: Google Merchant Center property [title](
|
2445
|
+
# https://support.google.com/merchants/answer/6324415). Schema.org property [
|
2446
|
+
# Product.name](https://schema.org/name).
|
2306
2447
|
# Corresponds to the JSON property `title`
|
2307
2448
|
# @return [String]
|
2308
2449
|
attr_accessor :title
|
@@ -2328,9 +2469,9 @@ module Google
|
|
2328
2469
|
# recommended to provide a valid uri for the product, otherwise the service
|
2329
2470
|
# performance could be significantly degraded. This field must be a UTF-8
|
2330
2471
|
# encoded string with a length limit of 5,000 characters. Otherwise, an
|
2331
|
-
# INVALID_ARGUMENT error is returned. Google Merchant
|
2332
|
-
# https://support.google.com/merchants/answer/6324416).
|
2333
|
-
# Offer.url](https://schema.org/url).
|
2472
|
+
# INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant
|
2473
|
+
# Center property [link](https://support.google.com/merchants/answer/6324416).
|
2474
|
+
# Schema.org property [Offer.url](https://schema.org/url).
|
2334
2475
|
# Corresponds to the JSON property `uri`
|
2335
2476
|
# @return [String]
|
2336
2477
|
attr_accessor :uri
|
@@ -2472,15 +2613,15 @@ module Google
|
|
2472
2613
|
include Google::Apis::Core::Hashable
|
2473
2614
|
|
2474
2615
|
# The type of Products allowed to be ingested into the catalog. Acceptable
|
2475
|
-
# values are: * `primary` (default): You can
|
2476
|
-
#
|
2477
|
-
#
|
2478
|
-
#
|
2479
|
-
#
|
2480
|
-
#
|
2481
|
-
#
|
2482
|
-
#
|
2483
|
-
#
|
2616
|
+
# values are: * `primary` (default): You can ingest Products of all types. When
|
2617
|
+
# ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
|
2618
|
+
# `variant`: You can only ingest Product.Type.VARIANT Products. This means
|
2619
|
+
# Product.primary_product_id cannot be empty. If this field is set to an invalid
|
2620
|
+
# value other than these, an INVALID_ARGUMENT error is returned. If this field
|
2621
|
+
# is `variant` and merchant_center_product_id_field is `itemGroupId`, an
|
2622
|
+
# INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
|
2623
|
+
# google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
|
2624
|
+
# details.
|
2484
2625
|
# Corresponds to the JSON property `ingestionProductType`
|
2485
2626
|
# @return [String]
|
2486
2627
|
attr_accessor :ingestion_product_type
|
@@ -2515,8 +2656,8 @@ module Google
|
|
2515
2656
|
include Google::Apis::Core::Hashable
|
2516
2657
|
|
2517
2658
|
# ID of the promotion. For example, "free gift". The value value must be a UTF-8
|
2518
|
-
# encoded string with a length limit of 128 characters, and match the pattern:
|
2519
|
-
# zA-Z
|
2659
|
+
# encoded string with a length limit of 128 characters, and match the pattern: `
|
2660
|
+
# a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an
|
2520
2661
|
# INVALID_ARGUMENT error is returned. Google Merchant Center property [promotion]
|
2521
2662
|
# (https://support.google.com/merchants/answer/7050148).
|
2522
2663
|
# Corresponds to the JSON property `promotionId`
|
@@ -2777,7 +2918,7 @@ module Google
|
|
2777
2918
|
# or the region IDs for "same-day-delivery", to be removed for this type. At
|
2778
2919
|
# least 1 value is required, and a maximum of 2000 values are allowed. Each
|
2779
2920
|
# value must be a string with a length limit of 10 characters, matching the
|
2780
|
-
# pattern [a-zA-Z0-9_-]
|
2921
|
+
# pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
|
2781
2922
|
# INVALID_ARGUMENT error is returned.
|
2782
2923
|
# Corresponds to the JSON property `placeIds`
|
2783
2924
|
# @return [Array<String>]
|
@@ -2828,6 +2969,73 @@ module Google
|
|
2828
2969
|
end
|
2829
2970
|
end
|
2830
2971
|
|
2972
|
+
# Metadata related to the progress of the RemoveLocalInventories operation.
|
2973
|
+
# Currently empty because there is no meaningful metadata populated from the
|
2974
|
+
# RemoveLocalInventories method.
|
2975
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
|
2976
|
+
include Google::Apis::Core::Hashable
|
2977
|
+
|
2978
|
+
def initialize(**args)
|
2979
|
+
update!(**args)
|
2980
|
+
end
|
2981
|
+
|
2982
|
+
# Update properties of this object
|
2983
|
+
def update!(**args)
|
2984
|
+
end
|
2985
|
+
end
|
2986
|
+
|
2987
|
+
# Request message for RemoveLocalInventories method.
|
2988
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
|
2989
|
+
include Google::Apis::Core::Hashable
|
2990
|
+
|
2991
|
+
# If set to true, and the Product is not found, the local inventory removal
|
2992
|
+
# request will still be processed and retained for at most 1 day and processed
|
2993
|
+
# once the Product is created. If set to false, a NOT_FOUND error is returned if
|
2994
|
+
# the Product is not found.
|
2995
|
+
# Corresponds to the JSON property `allowMissing`
|
2996
|
+
# @return [Boolean]
|
2997
|
+
attr_accessor :allow_missing
|
2998
|
+
alias_method :allow_missing?, :allow_missing
|
2999
|
+
|
3000
|
+
# Required. A list of place IDs to have their inventory deleted. At most 3000
|
3001
|
+
# place IDs are allowed per request.
|
3002
|
+
# Corresponds to the JSON property `placeIds`
|
3003
|
+
# @return [Array<String>]
|
3004
|
+
attr_accessor :place_ids
|
3005
|
+
|
3006
|
+
# The time when the inventory deletions are issued. Used to prevent out-of-order
|
3007
|
+
# updates and deletions on local inventory fields. If not provided, the internal
|
3008
|
+
# system time will be used.
|
3009
|
+
# Corresponds to the JSON property `removeTime`
|
3010
|
+
# @return [String]
|
3011
|
+
attr_accessor :remove_time
|
3012
|
+
|
3013
|
+
def initialize(**args)
|
3014
|
+
update!(**args)
|
3015
|
+
end
|
3016
|
+
|
3017
|
+
# Update properties of this object
|
3018
|
+
def update!(**args)
|
3019
|
+
@allow_missing = args[:allow_missing] if args.key?(:allow_missing)
|
3020
|
+
@place_ids = args[:place_ids] if args.key?(:place_ids)
|
3021
|
+
@remove_time = args[:remove_time] if args.key?(:remove_time)
|
3022
|
+
end
|
3023
|
+
end
|
3024
|
+
|
3025
|
+
# Response of the RemoveLocalInventories API. Currently empty because there is
|
3026
|
+
# no meaningful response populated from the RemoveLocalInventories method.
|
3027
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
|
3028
|
+
include Google::Apis::Core::Hashable
|
3029
|
+
|
3030
|
+
def initialize(**args)
|
3031
|
+
update!(**args)
|
3032
|
+
end
|
3033
|
+
|
3034
|
+
# Update properties of this object
|
3035
|
+
def update!(**args)
|
3036
|
+
end
|
3037
|
+
end
|
3038
|
+
|
2831
3039
|
# Request message for SearchService.Search method.
|
2832
3040
|
class GoogleCloudRetailV2alphaSearchRequest
|
2833
3041
|
include Google::Apis::Core::Hashable
|
@@ -2948,24 +3156,26 @@ module Google
|
|
2948
3156
|
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo]
|
2949
3157
|
attr_accessor :user_info
|
2950
3158
|
|
2951
|
-
# The keys to fetch and rollup the matching variant Products attributes
|
2952
|
-
#
|
2953
|
-
#
|
2954
|
-
#
|
2955
|
-
#
|
2956
|
-
# fulfillmentId". E.g., in "
|
2957
|
-
# fulfillment type and "store123" is
|
2958
|
-
#
|
2959
|
-
#
|
2960
|
-
#
|
2961
|
-
#
|
2962
|
-
#
|
2963
|
-
#
|
2964
|
-
#
|
2965
|
-
#
|
2966
|
-
#
|
2967
|
-
# FulfillmentInfo.type "
|
2968
|
-
#
|
3159
|
+
# The keys to fetch and rollup the matching variant Products attributes,
|
3160
|
+
# FulfillmentInfo or LocalInventorys attributes. The attributes from all the
|
3161
|
+
# matching variant Products or LocalInventorys are merged and de-duplicated.
|
3162
|
+
# Notice that rollup attributes will lead to extra query latency. Maximum number
|
3163
|
+
# of keys is 30. For FulfillmentInfo, a fulfillment type and a fulfillment ID
|
3164
|
+
# must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "
|
3165
|
+
# pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is
|
3166
|
+
# the store ID. Supported keys are: * colorFamilies * price * originalPrice *
|
3167
|
+
# discount * variantId * inventory(place_id,price) * inventory(place_id,
|
3168
|
+
# original_price) * inventory(place_id,attributes.key), where key is any key in
|
3169
|
+
# the Product.inventories.attributes map. * attributes.key, where key is any key
|
3170
|
+
# in the Product.attributes map. * pickupInStore.id, where id is any
|
3171
|
+
# FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
|
3172
|
+
# shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
|
3173
|
+
# type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
|
3174
|
+
# place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
|
3175
|
+
# where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
|
3176
|
+
# delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
|
3177
|
+
# for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
|
3178
|
+
# any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
|
2969
3179
|
# customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
|
2970
3180
|
# FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
|
2971
3181
|
# FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
|
@@ -3184,9 +3394,10 @@ module Google
|
|
3184
3394
|
# colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
|
3185
3395
|
# * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
|
3186
3396
|
# customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
|
3187
|
-
# customFulfillment4" * "customFulfillment5" *
|
3188
|
-
#
|
3189
|
-
# price)"
|
3397
|
+
# customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.
|
3398
|
+
# key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "
|
3399
|
+
# attributes.key" * "inventory(place_id,price)" * "inventory(place_id,
|
3400
|
+
# original_price)" * "inventory(place_id,attributes.key)"
|
3190
3401
|
# Corresponds to the JSON property `key`
|
3191
3402
|
# @return [String]
|
3192
3403
|
attr_accessor :key
|
@@ -3285,6 +3496,12 @@ module Google
|
|
3285
3496
|
class GoogleCloudRetailV2alphaSearchResponse
|
3286
3497
|
include Google::Apis::Core::Hashable
|
3287
3498
|
|
3499
|
+
# The fully qualified resource name of applied [controls](https://cloud.google.
|
3500
|
+
# com/retail/docs/serving-control-rules).
|
3501
|
+
# Corresponds to the JSON property `appliedControls`
|
3502
|
+
# @return [Array<String>]
|
3503
|
+
attr_accessor :applied_controls
|
3504
|
+
|
3288
3505
|
# A unique search token. This should be included in the UserEvent logs resulting
|
3289
3506
|
# from this search, which enables accurate attribution of search model
|
3290
3507
|
# performance.
|
@@ -3339,6 +3556,7 @@ module Google
|
|
3339
3556
|
|
3340
3557
|
# Update properties of this object
|
3341
3558
|
def update!(**args)
|
3559
|
+
@applied_controls = args[:applied_controls] if args.key?(:applied_controls)
|
3342
3560
|
@attribution_token = args[:attribution_token] if args.key?(:attribution_token)
|
3343
3561
|
@corrected_query = args[:corrected_query] if args.key?(:corrected_query)
|
3344
3562
|
@facets = args[:facets] if args.key?(:facets)
|
@@ -3606,17 +3824,90 @@ module Google
|
|
3606
3824
|
end
|
3607
3825
|
end
|
3608
3826
|
|
3827
|
+
# Metadata related to the progress of the SetLocalInventories operation.
|
3828
|
+
# Currently empty because there is no meaningful metadata populated from the
|
3829
|
+
# SetLocalInventories method.
|
3830
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
|
3831
|
+
include Google::Apis::Core::Hashable
|
3832
|
+
|
3833
|
+
def initialize(**args)
|
3834
|
+
update!(**args)
|
3835
|
+
end
|
3836
|
+
|
3837
|
+
# Update properties of this object
|
3838
|
+
def update!(**args)
|
3839
|
+
end
|
3840
|
+
end
|
3841
|
+
|
3842
|
+
# Request message for SetLocalInventories method.
|
3843
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesRequest
|
3844
|
+
include Google::Apis::Core::Hashable
|
3845
|
+
|
3846
|
+
# If set to true, and the Product is not found, the local inventory will still
|
3847
|
+
# be processed and retained for at most 1 day and processed once the Product is
|
3848
|
+
# created. If set to false, a NOT_FOUND error is returned if the Product is not
|
3849
|
+
# found.
|
3850
|
+
# Corresponds to the JSON property `allowMissing`
|
3851
|
+
# @return [Boolean]
|
3852
|
+
attr_accessor :allow_missing
|
3853
|
+
alias_method :allow_missing?, :allow_missing
|
3854
|
+
|
3855
|
+
# A list of inventory information at difference places. Each place is identified
|
3856
|
+
# by its place ID. For example, if `place1` and `place2` are stored, and this
|
3857
|
+
# list is `[place1, place3]` with a fresher set timestamp, then the stored
|
3858
|
+
# places will become `place1` and `place3`. An empty list removes all existing
|
3859
|
+
# places with staler fields. At most 3000 inventories are allowed per request.
|
3860
|
+
# Corresponds to the JSON property `localInventories`
|
3861
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory>]
|
3862
|
+
attr_accessor :local_inventories
|
3863
|
+
|
3864
|
+
# The time when the inventory updates are issued. Used to prevent out-of-order
|
3865
|
+
# updates on local inventory fields. If not provided, the internal system time
|
3866
|
+
# will be used.
|
3867
|
+
# Corresponds to the JSON property `setTime`
|
3868
|
+
# @return [String]
|
3869
|
+
attr_accessor :set_time
|
3870
|
+
|
3871
|
+
def initialize(**args)
|
3872
|
+
update!(**args)
|
3873
|
+
end
|
3874
|
+
|
3875
|
+
# Update properties of this object
|
3876
|
+
def update!(**args)
|
3877
|
+
@allow_missing = args[:allow_missing] if args.key?(:allow_missing)
|
3878
|
+
@local_inventories = args[:local_inventories] if args.key?(:local_inventories)
|
3879
|
+
@set_time = args[:set_time] if args.key?(:set_time)
|
3880
|
+
end
|
3881
|
+
end
|
3882
|
+
|
3883
|
+
# Response of the SetLocalInventories API. Currently empty because there is no
|
3884
|
+
# meaningful response populated from the SetLocalInventories method.
|
3885
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
|
3886
|
+
include Google::Apis::Core::Hashable
|
3887
|
+
|
3888
|
+
def initialize(**args)
|
3889
|
+
update!(**args)
|
3890
|
+
end
|
3891
|
+
|
3892
|
+
# Update properties of this object
|
3893
|
+
def update!(**args)
|
3894
|
+
end
|
3895
|
+
end
|
3896
|
+
|
3609
3897
|
# UserEvent captures all metadata information Retail API needs to know about how
|
3610
3898
|
# end users interact with customers' website.
|
3611
3899
|
class GoogleCloudRetailV2alphaUserEvent
|
3612
3900
|
include Google::Apis::Core::Hashable
|
3613
3901
|
|
3614
|
-
# Extra user event features to include in the recommendation model.
|
3615
|
-
#
|
3616
|
-
#
|
3617
|
-
#
|
3618
|
-
#
|
3619
|
-
#
|
3902
|
+
# Extra user event features to include in the recommendation model. This field
|
3903
|
+
# needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
|
3904
|
+
# returned: * The key must be a UTF-8 encoded string with a length limit of 5,
|
3905
|
+
# 000 characters. * For text attributes, at most 400 values are allowed. Empty
|
3906
|
+
# values are not allowed. Each value must be a UTF-8 encoded string with a
|
3907
|
+
# length limit of 256 characters. * For number attributes, at most 400 values
|
3908
|
+
# are allowed. For product recommendation, an example of extra user information
|
3909
|
+
# is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
|
3910
|
+
# site by coming to the site directly, or coming through Google search, and etc.
|
3620
3911
|
# Corresponds to the JSON property `attributes`
|
3621
3912
|
# @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
|
3622
3913
|
attr_accessor :attributes
|
@@ -3658,12 +3949,11 @@ module Google
|
|
3658
3949
|
|
3659
3950
|
# Required. User event type. Allowed values are: * `add-to-cart`: Products being
|
3660
3951
|
# added to cart. * `category-page-view`: Special pages such as sale or promotion
|
3661
|
-
# pages viewed. * `
|
3662
|
-
#
|
3663
|
-
#
|
3664
|
-
#
|
3665
|
-
#
|
3666
|
-
# User viewing a shopping cart.
|
3952
|
+
# pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-
|
3953
|
+
# view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user.
|
3954
|
+
# * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-
|
3955
|
+
# complete`: User finishing a purchase. * `search`: Product search. * `shopping-
|
3956
|
+
# cart-page-view`: User viewing a shopping cart.
|
3667
3957
|
# Corresponds to the JSON property `eventType`
|
3668
3958
|
# @return [String]
|
3669
3959
|
attr_accessor :event_type
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module RetailV2alpha
|
18
18
|
# Version of the google-apis-retail_v2alpha gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.23.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.4.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20211203"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -178,6 +178,24 @@ module Google
|
|
178
178
|
include Google::Apis::Core::JsonObjectSupport
|
179
179
|
end
|
180
180
|
|
181
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
|
182
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
|
+
|
184
|
+
include Google::Apis::Core::JsonObjectSupport
|
185
|
+
end
|
186
|
+
|
187
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
|
188
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
189
|
+
|
190
|
+
include Google::Apis::Core::JsonObjectSupport
|
191
|
+
end
|
192
|
+
|
193
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
|
194
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
195
|
+
|
196
|
+
include Google::Apis::Core::JsonObjectSupport
|
197
|
+
end
|
198
|
+
|
181
199
|
class GoogleCloudRetailV2alphaAudience
|
182
200
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
201
|
|
@@ -352,6 +370,12 @@ module Google
|
|
352
370
|
include Google::Apis::Core::JsonObjectSupport
|
353
371
|
end
|
354
372
|
|
373
|
+
class GoogleCloudRetailV2alphaLocalInventory
|
374
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
375
|
+
|
376
|
+
include Google::Apis::Core::JsonObjectSupport
|
377
|
+
end
|
378
|
+
|
355
379
|
class GoogleCloudRetailV2alphaMerchantCenterLink
|
356
380
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
357
381
|
|
@@ -496,6 +520,24 @@ module Google
|
|
496
520
|
include Google::Apis::Core::JsonObjectSupport
|
497
521
|
end
|
498
522
|
|
523
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
|
524
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
525
|
+
|
526
|
+
include Google::Apis::Core::JsonObjectSupport
|
527
|
+
end
|
528
|
+
|
529
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
|
530
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
531
|
+
|
532
|
+
include Google::Apis::Core::JsonObjectSupport
|
533
|
+
end
|
534
|
+
|
535
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
|
536
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
537
|
+
|
538
|
+
include Google::Apis::Core::JsonObjectSupport
|
539
|
+
end
|
540
|
+
|
499
541
|
class GoogleCloudRetailV2alphaSearchRequest
|
500
542
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
501
543
|
|
@@ -592,6 +634,24 @@ module Google
|
|
592
634
|
include Google::Apis::Core::JsonObjectSupport
|
593
635
|
end
|
594
636
|
|
637
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
|
638
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
639
|
+
|
640
|
+
include Google::Apis::Core::JsonObjectSupport
|
641
|
+
end
|
642
|
+
|
643
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesRequest
|
644
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
645
|
+
|
646
|
+
include Google::Apis::Core::JsonObjectSupport
|
647
|
+
end
|
648
|
+
|
649
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
|
650
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
651
|
+
|
652
|
+
include Google::Apis::Core::JsonObjectSupport
|
653
|
+
end
|
654
|
+
|
595
655
|
class GoogleCloudRetailV2alphaUserEvent
|
596
656
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
597
657
|
|
@@ -982,6 +1042,29 @@ module Google
|
|
982
1042
|
end
|
983
1043
|
end
|
984
1044
|
|
1045
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
|
1046
|
+
# @private
|
1047
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1048
|
+
end
|
1049
|
+
end
|
1050
|
+
|
1051
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesRequest
|
1052
|
+
# @private
|
1053
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1054
|
+
property :add_mask, as: 'addMask'
|
1055
|
+
property :add_time, as: 'addTime'
|
1056
|
+
property :allow_missing, as: 'allowMissing'
|
1057
|
+
collection :local_inventories, as: 'localInventories', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory::Representation
|
1058
|
+
|
1059
|
+
end
|
1060
|
+
end
|
1061
|
+
|
1062
|
+
class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
|
1063
|
+
# @private
|
1064
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1065
|
+
end
|
1066
|
+
end
|
1067
|
+
|
985
1068
|
class GoogleCloudRetailV2alphaAudience
|
986
1069
|
# @private
|
987
1070
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1257,12 +1340,25 @@ module Google
|
|
1257
1340
|
end
|
1258
1341
|
end
|
1259
1342
|
|
1343
|
+
class GoogleCloudRetailV2alphaLocalInventory
|
1344
|
+
# @private
|
1345
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1346
|
+
hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
|
1347
|
+
|
1348
|
+
property :place_id, as: 'placeId'
|
1349
|
+
property :price_info, as: 'priceInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo::Representation
|
1350
|
+
|
1351
|
+
end
|
1352
|
+
end
|
1353
|
+
|
1260
1354
|
class GoogleCloudRetailV2alphaMerchantCenterLink
|
1261
1355
|
# @private
|
1262
1356
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1263
1357
|
property :branch_id, as: 'branchId'
|
1264
1358
|
collection :destinations, as: 'destinations'
|
1359
|
+
property :language_code, as: 'languageCode'
|
1265
1360
|
property :merchant_center_account_id, :numeric_string => true, as: 'merchantCenterAccountId'
|
1361
|
+
property :region_code, as: 'regionCode'
|
1266
1362
|
end
|
1267
1363
|
end
|
1268
1364
|
|
@@ -1506,6 +1602,27 @@ module Google
|
|
1506
1602
|
end
|
1507
1603
|
end
|
1508
1604
|
|
1605
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
|
1606
|
+
# @private
|
1607
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1608
|
+
end
|
1609
|
+
end
|
1610
|
+
|
1611
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
|
1612
|
+
# @private
|
1613
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1614
|
+
property :allow_missing, as: 'allowMissing'
|
1615
|
+
collection :place_ids, as: 'placeIds'
|
1616
|
+
property :remove_time, as: 'removeTime'
|
1617
|
+
end
|
1618
|
+
end
|
1619
|
+
|
1620
|
+
class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
|
1621
|
+
# @private
|
1622
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1623
|
+
end
|
1624
|
+
end
|
1625
|
+
|
1509
1626
|
class GoogleCloudRetailV2alphaSearchRequest
|
1510
1627
|
# @private
|
1511
1628
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1594,6 +1711,7 @@ module Google
|
|
1594
1711
|
class GoogleCloudRetailV2alphaSearchResponse
|
1595
1712
|
# @private
|
1596
1713
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1714
|
+
collection :applied_controls, as: 'appliedControls'
|
1597
1715
|
property :attribution_token, as: 'attributionToken'
|
1598
1716
|
property :corrected_query, as: 'correctedQuery'
|
1599
1717
|
collection :facets, as: 'facets', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet::Representation
|
@@ -1679,6 +1797,28 @@ module Google
|
|
1679
1797
|
end
|
1680
1798
|
end
|
1681
1799
|
|
1800
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
|
1801
|
+
# @private
|
1802
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1803
|
+
end
|
1804
|
+
end
|
1805
|
+
|
1806
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesRequest
|
1807
|
+
# @private
|
1808
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1809
|
+
property :allow_missing, as: 'allowMissing'
|
1810
|
+
collection :local_inventories, as: 'localInventories', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory::Representation
|
1811
|
+
|
1812
|
+
property :set_time, as: 'setTime'
|
1813
|
+
end
|
1814
|
+
end
|
1815
|
+
|
1816
|
+
class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
|
1817
|
+
# @private
|
1818
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1819
|
+
end
|
1820
|
+
end
|
1821
|
+
|
1682
1822
|
class GoogleCloudRetailV2alphaUserEvent
|
1683
1823
|
# @private
|
1684
1824
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -67,10 +67,10 @@ module Google
|
|
67
67
|
# cloud-retail, contact Cloud Retail support team first.
|
68
68
|
# @param [String] device_type
|
69
69
|
# The device type context for completion suggestions. It is useful to apply
|
70
|
-
# different suggestions on different device types, e.g. DESKTOP
|
71
|
-
# is empty, the suggestions are across all device types. Supported formats: *
|
72
|
-
# UNKNOWN_DEVICE_TYPE * DESKTOP * MOBILE * A customized string starts with
|
73
|
-
# OTHER_
|
70
|
+
# different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If
|
71
|
+
# it is empty, the suggestions are across all device types. Supported formats: *
|
72
|
+
# `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
|
73
|
+
# `OTHER_`, e.g. `OTHER_IPHONE`.
|
74
74
|
# @param [Array<String>, String] language_codes
|
75
75
|
# The list of languages of the query. This is the BCP-47 language code, such as "
|
76
76
|
# en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages]
|
@@ -367,6 +367,52 @@ module Google
|
|
367
367
|
execute_or_queue_command(command, &block)
|
368
368
|
end
|
369
369
|
|
370
|
+
# Updates local inventory information for a Product at a list of places, while
|
371
|
+
# respecting the last update timestamps of each inventory field. This process is
|
372
|
+
# asynchronous and does not require the Product to exist before updating
|
373
|
+
# inventory information. If the request is valid, the update will be enqueued
|
374
|
+
# and processed downstream. As a consequence, when a response is returned,
|
375
|
+
# updates are not immediately manifested in the Product queried by GetProduct or
|
376
|
+
# ListProducts. Local inventory information can only be modified using this
|
377
|
+
# method. CreateProduct and UpdateProduct has no effect on local inventories.
|
378
|
+
# This feature is only available for users who have Retail Search enabled.
|
379
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact Cloud
|
380
|
+
# sales if you are interested in using Retail Search.
|
381
|
+
# @param [String] product
|
382
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
383
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
384
|
+
# the caller does not have permission to access the Product, regardless of
|
385
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
386
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest] google_cloud_retail_v2alpha_add_local_inventories_request_object
|
387
|
+
# @param [String] fields
|
388
|
+
# Selector specifying which fields to include in a partial response.
|
389
|
+
# @param [String] quota_user
|
390
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
391
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
392
|
+
# @param [Google::Apis::RequestOptions] options
|
393
|
+
# Request-specific options
|
394
|
+
#
|
395
|
+
# @yield [result, err] Result & error if block supplied
|
396
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
397
|
+
# @yieldparam err [StandardError] error object if request failed
|
398
|
+
#
|
399
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
400
|
+
#
|
401
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
402
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
403
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
404
|
+
def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
405
|
+
command = make_simple_command(:post, 'v2alpha/{+product}:addLocalInventories', options)
|
406
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest::Representation
|
407
|
+
command.request_object = google_cloud_retail_v2alpha_add_local_inventories_request_object
|
408
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
409
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
410
|
+
command.params['product'] = product unless product.nil?
|
411
|
+
command.query['fields'] = fields unless fields.nil?
|
412
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
413
|
+
execute_or_queue_command(command, &block)
|
414
|
+
end
|
415
|
+
|
370
416
|
# Creates a Product.
|
371
417
|
# @param [String] parent
|
372
418
|
# Required. The parent catalog resource name, such as `projects/*/locations/
|
@@ -679,6 +725,50 @@ module Google
|
|
679
725
|
execute_or_queue_command(command, &block)
|
680
726
|
end
|
681
727
|
|
728
|
+
# Remove local inventory information for a Product at a list of places at a
|
729
|
+
# removal timestamp. This process is asynchronous. If the request is valid, the
|
730
|
+
# removal will be enqueued and processed downstream. As a consequence, when a
|
731
|
+
# response is returned, removals are not immediately manifested in the Product
|
732
|
+
# queried by GetProduct or ListProducts. Local inventory information can only be
|
733
|
+
# removed using this method. CreateProduct and UpdateProduct has no effect on
|
734
|
+
# local inventories. This feature is only available for users who have Retail
|
735
|
+
# Search enabled. Please submit a form [here](https://cloud.google.com/contact)
|
736
|
+
# to contact Cloud sales if you are interested in using Retail Search.
|
737
|
+
# @param [String] product
|
738
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
739
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
740
|
+
# the caller does not have permission to access the Product, regardless of
|
741
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
742
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest] google_cloud_retail_v2alpha_remove_local_inventories_request_object
|
743
|
+
# @param [String] fields
|
744
|
+
# Selector specifying which fields to include in a partial response.
|
745
|
+
# @param [String] quota_user
|
746
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
747
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
748
|
+
# @param [Google::Apis::RequestOptions] options
|
749
|
+
# Request-specific options
|
750
|
+
#
|
751
|
+
# @yield [result, err] Result & error if block supplied
|
752
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
753
|
+
# @yieldparam err [StandardError] error object if request failed
|
754
|
+
#
|
755
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
756
|
+
#
|
757
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
758
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
759
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
760
|
+
def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
761
|
+
command = make_simple_command(:post, 'v2alpha/{+product}:removeLocalInventories', options)
|
762
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest::Representation
|
763
|
+
command.request_object = google_cloud_retail_v2alpha_remove_local_inventories_request_object
|
764
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
765
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
766
|
+
command.params['product'] = product unless product.nil?
|
767
|
+
command.query['fields'] = fields unless fields.nil?
|
768
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
769
|
+
execute_or_queue_command(command, &block)
|
770
|
+
end
|
771
|
+
|
682
772
|
# Updates inventory information for a Product while respecting the last update
|
683
773
|
# timestamps of each inventory field. This process is asynchronous and does not
|
684
774
|
# require the Product to exist before updating fulfillment information. If the
|
@@ -731,6 +821,59 @@ module Google
|
|
731
821
|
execute_or_queue_command(command, &block)
|
732
822
|
end
|
733
823
|
|
824
|
+
# Set local inventory information for a Product with the provided list of places
|
825
|
+
# at a set timestamp. If a place in the provided list does not exist, the place
|
826
|
+
# will be created. If a place in the provided list already exists, it will be
|
827
|
+
# updated while respecting the last update timestamps of each inventory field.
|
828
|
+
# If an existing place is not in the provided list, it will be removed. This
|
829
|
+
# process is asynchronous. If the request is valid, the set operation will be
|
830
|
+
# enqueued and processed downstream. As a consequence, when a response is
|
831
|
+
# returned, set operations are not immediately manifested in the Product queried
|
832
|
+
# by GetProduct or ListProducts. When applying the set operation, this process
|
833
|
+
# takes a snapshot of currently existing places and their corresponding
|
834
|
+
# timestamps to determine the places to update. Avoid concurrent
|
835
|
+
# AddLocalInventories and RemoveLocalInventories calls, since they can introduce
|
836
|
+
# asynchronous updates that could be missed by the set operation. Local
|
837
|
+
# inventory information can only be updated with this method and other local
|
838
|
+
# inventory-specific methods. CreateProduct and UpdateProduct has no effect on
|
839
|
+
# local inventories. This feature is only available for users who have Retail
|
840
|
+
# Search enabled. Please submit a form [here](https://cloud.google.com/contact)
|
841
|
+
# to contact Cloud sales if you are interested in using Retail Search.
|
842
|
+
# @param [String] product
|
843
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
844
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
845
|
+
# the caller does not have permission to access the Product, regardless of
|
846
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
847
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetLocalInventoriesRequest] google_cloud_retail_v2alpha_set_local_inventories_request_object
|
848
|
+
# @param [String] fields
|
849
|
+
# Selector specifying which fields to include in a partial response.
|
850
|
+
# @param [String] quota_user
|
851
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
852
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
853
|
+
# @param [Google::Apis::RequestOptions] options
|
854
|
+
# Request-specific options
|
855
|
+
#
|
856
|
+
# @yield [result, err] Result & error if block supplied
|
857
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
858
|
+
# @yieldparam err [StandardError] error object if request failed
|
859
|
+
#
|
860
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
861
|
+
#
|
862
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
863
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
864
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
865
|
+
def set_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_set_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
866
|
+
command = make_simple_command(:post, 'v2alpha/{+product}:setLocalInventories', options)
|
867
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetLocalInventoriesRequest::Representation
|
868
|
+
command.request_object = google_cloud_retail_v2alpha_set_local_inventories_request_object
|
869
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
870
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
871
|
+
command.params['product'] = product unless product.nil?
|
872
|
+
command.query['fields'] = fields unless fields.nil?
|
873
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
874
|
+
execute_or_queue_command(command, &block)
|
875
|
+
end
|
876
|
+
|
734
877
|
# Bulk import of processed completion dataset. Request processing may be
|
735
878
|
# synchronous. Partial updating is not supported. This feature is only available
|
736
879
|
# for users who have Retail Search enabled. Please submit a form [here](https://
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-retail_v2alpha
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.23.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: 2021-
|
11
|
+
date: 2021-12-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.23.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|