google-cloud-retail-v2 0.6.4 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -6
- data/lib/google/cloud/retail/v2/catalog_pb.rb +2 -4
- data/lib/google/cloud/retail/v2/catalog_service/client.rb +9 -9
- data/lib/google/cloud/retail/v2/catalog_service_pb.rb +3 -1
- data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb +0 -8
- data/lib/google/cloud/retail/v2/common_pb.rb +8 -5
- data/lib/google/cloud/retail/v2/completion_service/client.rb +20 -21
- data/lib/google/cloud/retail/v2/completion_service/operations.rb +3 -0
- data/lib/google/cloud/retail/v2/completion_service.rb +1 -2
- data/lib/google/cloud/retail/v2/completion_service_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +7 -7
- data/lib/google/cloud/retail/v2/import_config_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/prediction_service/client.rb +17 -4
- data/lib/google/cloud/retail/v2/prediction_service_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/product_pb.rb +3 -2
- data/lib/google/cloud/retail/v2/product_service/client.rb +337 -23
- data/lib/google/cloud/retail/v2/product_service/operations.rb +3 -0
- data/lib/google/cloud/retail/v2/product_service_pb.rb +29 -2
- data/lib/google/cloud/retail/v2/product_service_services_pb.rb +47 -9
- data/lib/google/cloud/retail/v2/promotion_pb.rb +22 -0
- data/lib/google/cloud/retail/v2/purge_config_pb.rb +3 -2
- data/lib/google/cloud/retail/v2/search_service/client.rb +56 -19
- data/lib/google/cloud/retail/v2/search_service.rb +1 -2
- data/lib/google/cloud/retail/v2/search_service_pb.rb +28 -3
- data/lib/google/cloud/retail/v2/search_service_services_pb.rb +2 -4
- data/lib/google/cloud/retail/v2/user_event_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/user_event_service/client.rb +4 -3
- data/lib/google/cloud/retail/v2/user_event_service/operations.rb +3 -0
- data/lib/google/cloud/retail/v2/user_event_service_pb.rb +3 -1
- data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +4 -3
- data/lib/google/cloud/retail/v2/version.rb +1 -1
- data/lib/google/cloud/retail/v2.rb +2 -0
- data/proto_docs/google/cloud/retail/v2/catalog.rb +8 -8
- data/proto_docs/google/cloud/retail/v2/catalog_service.rb +9 -0
- data/proto_docs/google/cloud/retail/v2/common.rb +100 -25
- data/proto_docs/google/cloud/retail/v2/completion_service.rb +28 -18
- data/proto_docs/google/cloud/retail/v2/import_config.rb +38 -23
- data/proto_docs/google/cloud/retail/v2/prediction_service.rb +19 -6
- data/proto_docs/google/cloud/retail/v2/product.rb +50 -41
- data/proto_docs/google/cloud/retail/v2/product_service.rb +154 -6
- data/proto_docs/google/cloud/retail/v2/promotion.rb +43 -0
- data/proto_docs/google/cloud/retail/v2/search_service.rb +162 -28
- data/proto_docs/google/cloud/retail/v2/user_event.rb +30 -14
- data/proto_docs/google/protobuf/any.rb +3 -3
- data/proto_docs/google/protobuf/struct.rb +2 -2
- metadata +14 -12
@@ -35,22 +35,21 @@ module Google
|
|
35
35
|
# The maximum number of allowed characters is 255.
|
36
36
|
# @!attribute [rw] visitor_id
|
37
37
|
# @return [::String]
|
38
|
-
# A unique identifier for tracking visitors. For example,
|
39
|
-
# implemented with an HTTP cookie, which should be able to
|
40
|
-
# a visitor on a single device. This unique identifier
|
41
|
-
# the visitor logs in or out of the website.
|
38
|
+
# Required field. A unique identifier for tracking visitors. For example,
|
39
|
+
# this could be implemented with an HTTP cookie, which should be able to
|
40
|
+
# uniquely identify a visitor on a single device. This unique identifier
|
41
|
+
# should not change if the visitor logs in or out of the website.
|
42
42
|
#
|
43
43
|
# The field must be a UTF-8 encoded string with a length limit of 128
|
44
44
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
45
45
|
# @!attribute [rw] language_codes
|
46
46
|
# @return [::Array<::String>]
|
47
|
-
# The
|
48
|
-
# the
|
49
|
-
#
|
50
|
-
# [Tags for
|
51
|
-
#
|
52
|
-
#
|
53
|
-
# Only "en-US" is currently supported.
|
47
|
+
# The language filters applied to the output suggestions. If set, it should
|
48
|
+
# contain the language of the query. If not set, suggestions are returned
|
49
|
+
# without considering language restrictions. This is the BCP-47 language
|
50
|
+
# code, such as "en-US" or "sr-Latn". For more information, see [Tags for
|
51
|
+
# Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
|
52
|
+
# number of language codes is 3.
|
54
53
|
# @!attribute [rw] device_type
|
55
54
|
# @return [::String]
|
56
55
|
# The device type context for completion suggestions.
|
@@ -79,9 +78,9 @@ module Google
|
|
79
78
|
#
|
80
79
|
# * user-data
|
81
80
|
#
|
82
|
-
# * cloud-retail
|
83
|
-
# This option requires
|
84
|
-
#
|
81
|
+
# * cloud-retail:
|
82
|
+
# This option requires enabling auto-learning function first. See
|
83
|
+
# [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
|
85
84
|
# @!attribute [rw] max_suggestions
|
86
85
|
# @return [::Integer]
|
87
86
|
# Completion max suggestions. If left unset or set to 0, then will fallback
|
@@ -102,9 +101,9 @@ module Google
|
|
102
101
|
# @!attribute [rw] attribution_token
|
103
102
|
# @return [::String]
|
104
103
|
# A unique complete token. This should be included in the
|
105
|
-
# {::Google::Cloud::Retail::V2::
|
106
|
-
# completion, which enables accurate
|
107
|
-
# performance.
|
104
|
+
# {::Google::Cloud::Retail::V2::UserEvent#completion_detail UserEvent.completion_detail}
|
105
|
+
# for search events resulting from this completion, which enables accurate
|
106
|
+
# attribution of complete model performance.
|
108
107
|
# @!attribute [rw] recent_search_results
|
109
108
|
# @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>]
|
110
109
|
# Matched recent searches of this user. The maximum number of recent searches
|
@@ -115,11 +114,15 @@ module Google
|
|
115
114
|
# {::Google::Cloud::Retail::V2::CompleteQueryRequest#visitor_id CompleteQueryRequest.visitor_id}
|
116
115
|
# field is set and {::Google::Cloud::Retail::V2::UserEvent UserEvent} is imported.
|
117
116
|
# The recent searches satisfy the follow rules:
|
117
|
+
#
|
118
118
|
# * They are ordered from latest to oldest.
|
119
|
+
#
|
119
120
|
# * They are matched with
|
120
121
|
# {::Google::Cloud::Retail::V2::CompleteQueryRequest#query CompleteQueryRequest.query}
|
121
122
|
# case insensitively.
|
123
|
+
#
|
122
124
|
# * They are transformed to lower cases.
|
125
|
+
#
|
123
126
|
# * They are UTF-8 safe.
|
124
127
|
#
|
125
128
|
# Recent searches are deduplicated. More recent searches will be reserved
|
@@ -134,7 +137,14 @@ module Google
|
|
134
137
|
# The suggestion for the query.
|
135
138
|
# @!attribute [rw] attributes
|
136
139
|
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
|
137
|
-
#
|
140
|
+
# Custom attributes for the suggestion term.
|
141
|
+
#
|
142
|
+
# * For "user-data", the attributes are additional custom attributes
|
143
|
+
# ingested through BigQuery.
|
144
|
+
#
|
145
|
+
# * For "cloud-retail", the attributes are product attributes generated
|
146
|
+
# by Cloud Retail. This is an experimental feature. Contact Retail Search
|
147
|
+
# support team if you are interested in enabling it.
|
138
148
|
class CompletionResult
|
139
149
|
include ::Google::Protobuf::MessageExts
|
140
150
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -51,6 +51,14 @@ module Google
|
|
51
51
|
# {::Google::Cloud::Retail::V2::UserEvent UserEvent} per line.
|
52
52
|
# * `user_event_ga360`: Using
|
53
53
|
# https://support.google.com/analytics/answer/3437719.
|
54
|
+
#
|
55
|
+
# Supported values for control imports:
|
56
|
+
#
|
57
|
+
# * 'control' (default): One JSON [Control][] per line.
|
58
|
+
#
|
59
|
+
# Supported values for catalog attribute imports:
|
60
|
+
#
|
61
|
+
# * 'catalog_attribute' (default): One CSV [CatalogAttribute][] per line.
|
54
62
|
class GcsSource
|
55
63
|
include ::Google::Protobuf::MessageExts
|
56
64
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -98,8 +106,19 @@ module Google
|
|
98
106
|
#
|
99
107
|
# * `user_event` (default): One JSON
|
100
108
|
# {::Google::Cloud::Retail::V2::UserEvent UserEvent} per line.
|
101
|
-
# * `user_event_ga360`:
|
109
|
+
# * `user_event_ga360`:
|
110
|
+
# The schema is available here:
|
102
111
|
# https://support.google.com/analytics/answer/3437719.
|
112
|
+
# * `user_event_ga4`: This feature is in private preview. Please contact the
|
113
|
+
# support team for importing Google Analytics 4 events.
|
114
|
+
# The schema is available here:
|
115
|
+
# https://support.google.com/analytics/answer/7029846.
|
116
|
+
#
|
117
|
+
# Supported values for auto-completion imports:
|
118
|
+
#
|
119
|
+
# * `suggestions` (default): One JSON completion suggestion per line.
|
120
|
+
# * `denylist`: One JSON deny suggestion per line.
|
121
|
+
# * `allowlist`: One JSON allow suggestion per line.
|
103
122
|
class BigQuerySource
|
104
123
|
include ::Google::Protobuf::MessageExts
|
105
124
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -128,9 +147,9 @@ module Google
|
|
128
147
|
# Configuration of destination for Import related errors.
|
129
148
|
# @!attribute [rw] gcs_prefix
|
130
149
|
# @return [::String]
|
131
|
-
# Google Cloud Storage
|
132
|
-
# existing Cloud Storage
|
133
|
-
# this
|
150
|
+
# Google Cloud Storage prefix for import errors. This must be an empty,
|
151
|
+
# existing Cloud Storage directory. Import errors will be written to
|
152
|
+
# sharded files in this directory, one per line, as a JSON-encoded
|
134
153
|
# `google.rpc.Status` message.
|
135
154
|
class ImportErrorsConfig
|
136
155
|
include ::Google::Protobuf::MessageExts
|
@@ -147,15 +166,7 @@ module Google
|
|
147
166
|
# If updateMask is specified, requires products.update permission.
|
148
167
|
# @!attribute [rw] request_id
|
149
168
|
# @return [::String]
|
150
|
-
#
|
151
|
-
# dataset scope. Ensures idempotency and used for request deduplication.
|
152
|
-
# Server-generated if unspecified. Up to 128 characters long and must match
|
153
|
-
# the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
|
154
|
-
# {::Google::Cloud::Retail::V2::ImportMetadata ImportMetadata}.
|
155
|
-
#
|
156
|
-
# Only supported when
|
157
|
-
# {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
|
158
|
-
# is set to `FULL`.
|
169
|
+
# Deprecated. This field has no effect.
|
159
170
|
# @!attribute [rw] input_config
|
160
171
|
# @return [::Google::Cloud::Retail::V2::ProductInputConfig]
|
161
172
|
# Required. The desired input location of the data.
|
@@ -173,11 +184,18 @@ module Google
|
|
173
184
|
# {::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
|
174
185
|
# @!attribute [rw] notification_pubsub_topic
|
175
186
|
# @return [::String]
|
176
|
-
# Pub/Sub topic for receiving notification. If this field is set,
|
187
|
+
# Full Pub/Sub topic name for receiving notification. If this field is set,
|
177
188
|
# when the import is finished, a notification will be sent to
|
178
189
|
# specified Pub/Sub topic. The message data will be JSON string of a
|
179
190
|
# {::Google::Longrunning::Operation Operation}.
|
180
|
-
#
|
191
|
+
#
|
192
|
+
# Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
|
193
|
+
# to be within the same project as
|
194
|
+
# {::Google::Cloud::Retail::V2::ImportProductsRequest#parent ImportProductsRequest.parent}.
|
195
|
+
# Make sure that both
|
196
|
+
# `cloud-retail-customer-data-access@system.gserviceaccount.com` and
|
197
|
+
# `service-<project number>@gcp-sa-retail.iam.gserviceaccount.com`
|
198
|
+
# have the `pubsub.topics.publish` IAM permission on the topic.
|
181
199
|
#
|
182
200
|
# Only supported when
|
183
201
|
# {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
|
@@ -198,16 +216,14 @@ module Google
|
|
198
216
|
# Calculates diff and replaces the entire product dataset. Existing
|
199
217
|
# products may be deleted if they are not present in the source location.
|
200
218
|
#
|
201
|
-
# Can only be while using
|
202
|
-
# {::Google::Cloud::Retail::V2::BigQuerySource BigQuerySource}.
|
219
|
+
# Can only be set while using
|
220
|
+
# {::Google::Cloud::Retail::V2::BigQuerySource BigQuerySource}. And the BigQuery
|
221
|
+
# dataset must be created in the data location "us (multiple regions in
|
222
|
+
# United States)", otherwise a PERMISSION_DENIED error is thrown.
|
203
223
|
#
|
204
224
|
# Add the IAM permission "BigQuery Data Viewer" for
|
205
225
|
# cloud-retail-customer-data-access@system.gserviceaccount.com before
|
206
226
|
# using this feature otherwise an error is thrown.
|
207
|
-
#
|
208
|
-
# This feature is only available for users who have Retail Search enabled.
|
209
|
-
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
210
|
-
# cloud sales if you are interested in using Retail Search.
|
211
227
|
FULL = 2
|
212
228
|
end
|
213
229
|
end
|
@@ -309,8 +325,7 @@ module Google
|
|
309
325
|
# Count of entries that encountered errors while processing.
|
310
326
|
# @!attribute [rw] request_id
|
311
327
|
# @return [::String]
|
312
|
-
#
|
313
|
-
# that was passed in the request.
|
328
|
+
# Deprecated. This field is never set.
|
314
329
|
# @!attribute [rw] notification_pubsub_topic
|
315
330
|
# @return [::String]
|
316
331
|
# Pub/Sub topic for receiving notification. If this field is set,
|
@@ -39,6 +39,16 @@ module Google
|
|
39
39
|
# they took to trigger the predict request. Note that this user event detail
|
40
40
|
# won't be ingested to userEvent logs. Thus, a separate userEvent write
|
41
41
|
# request is required for event logging.
|
42
|
+
#
|
43
|
+
# Don't set
|
44
|
+
# {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} or
|
45
|
+
# {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} to the same
|
46
|
+
# fixed ID for different users. If you are trying to receive non-personalized
|
47
|
+
# recommendations (not recommended; this can negatively impact model
|
48
|
+
# performance), instead set
|
49
|
+
# {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} to a
|
50
|
+
# random unique ID and leave
|
51
|
+
# {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset.
|
42
52
|
# @!attribute [rw] page_size
|
43
53
|
# @return [::Integer]
|
44
54
|
# Maximum number of results to return per page. Set this property
|
@@ -73,9 +83,12 @@ module Google
|
|
73
83
|
# * filterOutOfStockItems tag=(-"promotional")
|
74
84
|
# * filterOutOfStockItems
|
75
85
|
#
|
76
|
-
# If your filter blocks all prediction results,
|
77
|
-
#
|
78
|
-
# `strictFiltering` to
|
86
|
+
# If your filter blocks all prediction results, the API will return generic
|
87
|
+
# (unfiltered) popular products. If you only want results strictly matching
|
88
|
+
# the filters, set `strictFiltering` to True in `PredictRequest.params` to
|
89
|
+
# receive empty results instead.
|
90
|
+
# Note that the API will never return items with storageStatus of "EXPIRED"
|
91
|
+
# or "DELETED" regardless of filter choices.
|
79
92
|
# @!attribute [rw] validate_only
|
80
93
|
# @return [::Boolean]
|
81
94
|
# Use validate only mode for this prediction query. If set to true, a
|
@@ -116,7 +129,7 @@ module Google
|
|
116
129
|
# * Each resource can have multiple labels, up to a maximum of 64.
|
117
130
|
# * Each label must be a key-value pair.
|
118
131
|
# * Keys have a minimum length of 1 character and a maximum length of 63
|
119
|
-
# characters
|
132
|
+
# characters and cannot be empty. Values can be empty and have a maximum
|
120
133
|
# length of 63 characters.
|
121
134
|
# * Keys and values can contain only lowercase letters, numeric characters,
|
122
135
|
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
@@ -182,9 +195,9 @@ module Google
|
|
182
195
|
#
|
183
196
|
# Possible values:
|
184
197
|
#
|
185
|
-
# * `product`: JSON representation of the product.
|
198
|
+
# * `product`: JSON representation of the product. Is set if
|
186
199
|
# `returnProduct` is set to true in `PredictRequest.params`.
|
187
|
-
# * `score`: Prediction score in double value.
|
200
|
+
# * `score`: Prediction score in double value. Is set if
|
188
201
|
# `returnScore` is set to true in `PredictRequest.params`.
|
189
202
|
class PredictionResult
|
190
203
|
include ::Google::Protobuf::MessageExts
|
@@ -42,7 +42,7 @@ module Google
|
|
42
42
|
# {::Google::Cloud::Retail::V2::Product#publish_time publish_time}, otherwise an
|
43
43
|
# INVALID_ARGUMENT error is thrown.
|
44
44
|
#
|
45
|
-
# Google Merchant Center property
|
45
|
+
# Corresponding properties: Google Merchant Center property
|
46
46
|
# [expiration_date](https://support.google.com/merchants/answer/6324499).
|
47
47
|
# @!attribute [rw] ttl
|
48
48
|
# @return [::Google::Protobuf::Duration]
|
@@ -77,9 +77,9 @@ module Google
|
|
77
77
|
# This field must be a UTF-8 encoded string with a length limit of 128
|
78
78
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
79
79
|
#
|
80
|
-
# Google Merchant Center property
|
80
|
+
# Corresponding properties: Google Merchant Center property
|
81
81
|
# [id](https://support.google.com/merchants/answer/6324405). Schema.org
|
82
|
-
#
|
82
|
+
# property [Product.sku](https://schema.org/sku).
|
83
83
|
# @!attribute [rw] type
|
84
84
|
# @return [::Google::Cloud::Retail::V2::Product::Type]
|
85
85
|
# Immutable. The type of the product. Default to
|
@@ -101,21 +101,23 @@ module Google
|
|
101
101
|
# {::Google::Cloud::Retail::V2::Product Product}. Otherwise, an INVALID_ARGUMENT
|
102
102
|
# error is returned.
|
103
103
|
#
|
104
|
-
# Google Merchant Center
|
104
|
+
# Corresponding properties: Google Merchant Center property
|
105
105
|
# [item_group_id](https://support.google.com/merchants/answer/6324507).
|
106
|
-
# Schema.org
|
106
|
+
# Schema.org property
|
107
107
|
# [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
|
108
|
-
#
|
109
|
-
# This field must be enabled before it can be used. [Learn
|
110
|
-
# more](/recommendations-ai/docs/catalog#item-group-id).
|
111
108
|
# @!attribute [rw] collection_member_ids
|
112
109
|
# @return [::Array<::String>]
|
113
110
|
# The {::Google::Cloud::Retail::V2::Product#id id} of the collection members when
|
114
111
|
# {::Google::Cloud::Retail::V2::Product#type type} is
|
115
112
|
# {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}.
|
116
113
|
#
|
117
|
-
#
|
118
|
-
#
|
114
|
+
# Non-existent product ids are allowed.
|
115
|
+
# The {::Google::Cloud::Retail::V2::Product#type type} of the members must be
|
116
|
+
# either {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} or
|
117
|
+
# {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT} otherwise and
|
118
|
+
# INVALID_ARGUMENT error is thrown. Should not set it for other types. A
|
119
|
+
# maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is
|
120
|
+
# return.
|
119
121
|
# @!attribute [rw] gtin
|
120
122
|
# @return [::String]
|
121
123
|
# The Global Trade Item Number (GTIN) of the product.
|
@@ -126,13 +128,13 @@ module Google
|
|
126
128
|
# This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
|
127
129
|
# returned.
|
128
130
|
#
|
129
|
-
# Google Merchant Center property
|
131
|
+
# Corresponding properties: Google Merchant Center property
|
130
132
|
# [gtin](https://support.google.com/merchants/answer/6324461).
|
131
133
|
# Schema.org property
|
132
|
-
# [Product.isbn](https://schema.org/isbn)
|
133
|
-
# [Product.gtin8](https://schema.org/gtin8)
|
134
|
-
# [Product.gtin12](https://schema.org/gtin12)
|
135
|
-
# [Product.gtin13](https://schema.org/gtin13) or
|
134
|
+
# [Product.isbn](https://schema.org/isbn),
|
135
|
+
# [Product.gtin8](https://schema.org/gtin8),
|
136
|
+
# [Product.gtin12](https://schema.org/gtin12),
|
137
|
+
# [Product.gtin13](https://schema.org/gtin13), or
|
136
138
|
# [Product.gtin14](https://schema.org/gtin14).
|
137
139
|
#
|
138
140
|
# If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
|
@@ -166,7 +168,7 @@ module Google
|
|
166
168
|
# Each value must be a UTF-8 encoded string with a length limit of 5,000
|
167
169
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
168
170
|
#
|
169
|
-
# Google Merchant Center property
|
171
|
+
# Corresponding properties: Google Merchant Center property
|
170
172
|
# [google_product_category][mc_google_product_category]. Schema.org property
|
171
173
|
# [Product.category] (https://schema.org/category).
|
172
174
|
#
|
@@ -179,7 +181,7 @@ module Google
|
|
179
181
|
# This field must be a UTF-8 encoded string with a length limit of 1,000
|
180
182
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
181
183
|
#
|
182
|
-
# Google Merchant Center property
|
184
|
+
# Corresponding properties: Google Merchant Center property
|
183
185
|
# [title](https://support.google.com/merchants/answer/6324415). Schema.org
|
184
186
|
# property [Product.name](https://schema.org/name).
|
185
187
|
# @!attribute [rw] brands
|
@@ -190,7 +192,7 @@ module Google
|
|
190
192
|
# string with a length limit of 1,000 characters. Otherwise, an
|
191
193
|
# INVALID_ARGUMENT error is returned.
|
192
194
|
#
|
193
|
-
# Google Merchant Center property
|
195
|
+
# Corresponding properties: Google Merchant Center property
|
194
196
|
# [brand](https://support.google.com/merchants/answer/6324351). Schema.org
|
195
197
|
# property [Product.brand](https://schema.org/brand).
|
196
198
|
# @!attribute [rw] description
|
@@ -200,13 +202,13 @@ module Google
|
|
200
202
|
# This field must be a UTF-8 encoded string with a length limit of 5,000
|
201
203
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
202
204
|
#
|
203
|
-
# Google Merchant Center property
|
205
|
+
# Corresponding properties: Google Merchant Center property
|
204
206
|
# [description](https://support.google.com/merchants/answer/6324468).
|
205
|
-
#
|
207
|
+
# Schema.org property [Product.description](https://schema.org/description).
|
206
208
|
# @!attribute [rw] language_code
|
207
209
|
# @return [::String]
|
208
210
|
# Language of the title/description and other string attributes. Use language
|
209
|
-
# tags defined by [BCP 47]
|
211
|
+
# tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
|
210
212
|
#
|
211
213
|
# For product prediction, this field is ignored and the model automatically
|
212
214
|
# detects the text language. The {::Google::Cloud::Retail::V2::Product Product}
|
@@ -240,7 +242,12 @@ module Google
|
|
240
242
|
# * The key must be a UTF-8 encoded string with a length limit of 128
|
241
243
|
# characters.
|
242
244
|
# * For indexable attribute, the key must match the pattern:
|
243
|
-
# `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, key0LikeThis or
|
245
|
+
# `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, `key0LikeThis` or
|
246
|
+
# `KEY_1_LIKE_THIS`.
|
247
|
+
# * For text attributes, at most 400 values are allowed. Empty values are not
|
248
|
+
# allowed. Each value must be a non-empty UTF-8 encoded string with a
|
249
|
+
# length limit of 256 characters.
|
250
|
+
# * For number attributes, at most 400 values are allowed.
|
244
251
|
# @!attribute [rw] tags
|
245
252
|
# @return [::Array<::String>]
|
246
253
|
# Custom tags associated with the product.
|
@@ -254,13 +261,13 @@ module Google
|
|
254
261
|
# tag as part of the
|
255
262
|
# {::Google::Cloud::Retail::V2::PredictRequest#filter PredictRequest.filter}.
|
256
263
|
#
|
257
|
-
# Google Merchant Center property
|
264
|
+
# Corresponding properties: Google Merchant Center property
|
258
265
|
# [custom_label_0–4](https://support.google.com/merchants/answer/6324473).
|
259
266
|
# @!attribute [rw] price_info
|
260
267
|
# @return [::Google::Cloud::Retail::V2::PriceInfo]
|
261
268
|
# Product price and cost information.
|
262
269
|
#
|
263
|
-
# Google Merchant Center property
|
270
|
+
# Corresponding properties: Google Merchant Center property
|
264
271
|
# [price](https://support.google.com/merchants/answer/6324371).
|
265
272
|
# @!attribute [rw] rating
|
266
273
|
# @return [::Google::Cloud::Retail::V2::Rating]
|
@@ -276,9 +283,9 @@ module Google
|
|
276
283
|
# Default to
|
277
284
|
# {::Google::Cloud::Retail::V2::Product::Availability::IN_STOCK Availability.IN_STOCK}.
|
278
285
|
#
|
279
|
-
# Google Merchant Center
|
286
|
+
# Corresponding properties: Google Merchant Center property
|
280
287
|
# [availability](https://support.google.com/merchants/answer/6324448).
|
281
|
-
# Schema.org
|
288
|
+
# Schema.org property [Offer.availability](https://schema.org/availability).
|
282
289
|
# @!attribute [rw] available_quantity
|
283
290
|
# @return [::Google::Protobuf::Int32Value]
|
284
291
|
# The available quantity of the item.
|
@@ -300,17 +307,17 @@ module Google
|
|
300
307
|
# This field must be a UTF-8 encoded string with a length limit of 5,000
|
301
308
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
302
309
|
#
|
303
|
-
# Google Merchant Center property
|
310
|
+
# Corresponding properties: Google Merchant Center property
|
304
311
|
# [link](https://support.google.com/merchants/answer/6324416). Schema.org
|
305
312
|
# property [Offer.url](https://schema.org/url).
|
306
313
|
# @!attribute [rw] images
|
307
314
|
# @return [::Array<::Google::Cloud::Retail::V2::Image>]
|
308
|
-
# Product images for the product.
|
309
|
-
#
|
315
|
+
# Product images for the product. We highly recommend putting the main
|
316
|
+
# image first.
|
310
317
|
#
|
311
318
|
# A maximum of 300 images are allowed.
|
312
319
|
#
|
313
|
-
# Google Merchant Center property
|
320
|
+
# Corresponding properties: Google Merchant Center property
|
314
321
|
# [image_link](https://support.google.com/merchants/answer/6324350).
|
315
322
|
# Schema.org property [Product.image](https://schema.org/image).
|
316
323
|
# @!attribute [rw] audience
|
@@ -321,7 +328,7 @@ module Google
|
|
321
328
|
# @return [::Google::Cloud::Retail::V2::ColorInfo]
|
322
329
|
# The color of the product.
|
323
330
|
#
|
324
|
-
# Google Merchant Center property
|
331
|
+
# Corresponding properties: Google Merchant Center property
|
325
332
|
# [color](https://support.google.com/merchants/answer/6324487). Schema.org
|
326
333
|
# property [Product.color](https://schema.org/color).
|
327
334
|
# @!attribute [rw] sizes
|
@@ -339,9 +346,9 @@ module Google
|
|
339
346
|
# encoded string with a length limit of 128 characters. Otherwise, an
|
340
347
|
# INVALID_ARGUMENT error is returned.
|
341
348
|
#
|
342
|
-
# Google Merchant Center property
|
349
|
+
# Corresponding properties: Google Merchant Center property
|
343
350
|
# [size](https://support.google.com/merchants/answer/6324492),
|
344
|
-
# [size_type](https://support.google.com/merchants/answer/6324497) and
|
351
|
+
# [size_type](https://support.google.com/merchants/answer/6324497), and
|
345
352
|
# [size_system](https://support.google.com/merchants/answer/6324502).
|
346
353
|
# Schema.org property [Product.size](https://schema.org/size).
|
347
354
|
# @!attribute [rw] materials
|
@@ -349,10 +356,10 @@ module Google
|
|
349
356
|
# The material of the product. For example, "leather", "wooden".
|
350
357
|
#
|
351
358
|
# A maximum of 20 values are allowed. Each value must be a UTF-8 encoded
|
352
|
-
# string with a length limit of
|
359
|
+
# string with a length limit of 200 characters. Otherwise, an
|
353
360
|
# INVALID_ARGUMENT error is returned.
|
354
361
|
#
|
355
|
-
# Google Merchant Center property
|
362
|
+
# Corresponding properties: Google Merchant Center property
|
356
363
|
# [material](https://support.google.com/merchants/answer/6324410). Schema.org
|
357
364
|
# property [Product.material](https://schema.org/material).
|
358
365
|
# @!attribute [rw] patterns
|
@@ -365,7 +372,7 @@ module Google
|
|
365
372
|
# encoded string with a length limit of 128 characters. Otherwise, an
|
366
373
|
# INVALID_ARGUMENT error is returned.
|
367
374
|
#
|
368
|
-
# Google Merchant Center property
|
375
|
+
# Corresponding properties: Google Merchant Center property
|
369
376
|
# [pattern](https://support.google.com/merchants/answer/6324483). Schema.org
|
370
377
|
# property [Product.pattern](https://schema.org/pattern).
|
371
378
|
# @!attribute [rw] conditions
|
@@ -373,19 +380,21 @@ module Google
|
|
373
380
|
# The condition of the product. Strongly encouraged to use the standard
|
374
381
|
# values: "new", "refurbished", "used".
|
375
382
|
#
|
376
|
-
# A maximum of
|
383
|
+
# A maximum of 1 value is allowed per
|
377
384
|
# {::Google::Cloud::Retail::V2::Product Product}. Each value must be a UTF-8
|
378
385
|
# encoded string with a length limit of 128 characters. Otherwise, an
|
379
386
|
# INVALID_ARGUMENT error is returned.
|
380
387
|
#
|
381
|
-
# Google Merchant Center property
|
388
|
+
# Corresponding properties: Google Merchant Center property
|
382
389
|
# [condition](https://support.google.com/merchants/answer/6324469).
|
383
390
|
# Schema.org property
|
384
391
|
# [Offer.itemCondition](https://schema.org/itemCondition).
|
385
392
|
# @!attribute [rw] promotions
|
386
393
|
# @return [::Array<::Google::Cloud::Retail::V2::Promotion>]
|
387
394
|
# The promotions applied to the product. A maximum of 10 values are allowed
|
388
|
-
# per {::Google::Cloud::Retail::V2::Product Product}.
|
395
|
+
# per {::Google::Cloud::Retail::V2::Product Product}. Only
|
396
|
+
# {::Google::Cloud::Retail::V2::Promotion#promotion_id Promotion.promotion_id}
|
397
|
+
# will be used, other fields will be ignored if set.
|
389
398
|
# @!attribute [rw] publish_time
|
390
399
|
# @return [::Google::Protobuf::Timestamp]
|
391
400
|
# The timestamp when the product is published by the retailer for the first
|
@@ -447,11 +456,11 @@ module Google
|
|
447
456
|
# * {::Google::Cloud::Retail::V2::Product#name name}
|
448
457
|
# * {::Google::Cloud::Retail::V2::Product#color_info color_info}
|
449
458
|
#
|
450
|
-
#
|
459
|
+
# The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
|
451
460
|
# returned.
|
452
461
|
#
|
453
462
|
# Note: Returning more fields in
|
454
|
-
# {::Google::Cloud::Retail::V2::SearchResponse SearchResponse}
|
463
|
+
# {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} can increase
|
455
464
|
# response payload size and serving latency.
|
456
465
|
# @!attribute [r] variants
|
457
466
|
# @return [::Array<::Google::Cloud::Retail::V2::Product>]
|