@maxim_mazurok/gapi.client.retail-v2 0.0.20220811
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +3993 -0
- package/package.json +20 -0
- package/readme.md +68 -0
- package/tests.ts +1902 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,3993 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Retail API v2 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/recommendations
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://retail.googleapis.com/$discovery/rest?version=v2
|
|
13
|
+
// Revision: 20220811
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load Retail API v2 */
|
|
19
|
+
function load(urlOrObject: "https://retail.googleapis.com/$discovery/rest?version=v2"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "retail", version: "v2"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "retail", version: "v2", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace retail {
|
|
26
|
+
interface GoogleApiHttpBody {
|
|
27
|
+
/** The HTTP Content-Type header value specifying the content type of the body. */
|
|
28
|
+
contentType?: string;
|
|
29
|
+
/** The HTTP request/response body as raw binary. */
|
|
30
|
+
data?: string;
|
|
31
|
+
/** Application specific response metadata. Must be set in the first response for streaming APIs. */
|
|
32
|
+
extensions?: Array<{ [P in string]: any }>;
|
|
33
|
+
}
|
|
34
|
+
interface GoogleCloudRetailLoggingErrorContext {
|
|
35
|
+
/** The HTTP request which was processed when the error was triggered. */
|
|
36
|
+
httpRequest?: GoogleCloudRetailLoggingHttpRequestContext;
|
|
37
|
+
/** The location in the source code where the decision was made to report the error, usually the place where it was logged. */
|
|
38
|
+
reportLocation?: GoogleCloudRetailLoggingSourceLocation;
|
|
39
|
+
}
|
|
40
|
+
interface GoogleCloudRetailLoggingErrorLog {
|
|
41
|
+
/** A description of the context in which the error occurred. */
|
|
42
|
+
context?: GoogleCloudRetailLoggingErrorContext;
|
|
43
|
+
/** The error payload that is populated on LRO import APIs. */
|
|
44
|
+
importPayload?: GoogleCloudRetailLoggingImportErrorContext;
|
|
45
|
+
/** A message describing the error. */
|
|
46
|
+
message?: string;
|
|
47
|
+
/**
|
|
48
|
+
* The API request payload, represented as a protocol buffer. Most API request types are supported. For example:
|
|
49
|
+
* "type.googleapis.com/google.cloud.retail.v2.ProductService.CreateProductRequest" "type.googleapis.com/google.cloud.retail.v2.UserEventService.WriteUserEventRequest"
|
|
50
|
+
*/
|
|
51
|
+
requestPayload?: { [P in string]: any };
|
|
52
|
+
/**
|
|
53
|
+
* The API response payload, represented as a protocol buffer. This is used to log some "soft errors", where the response is valid but we consider there are some quality issues like
|
|
54
|
+
* unjoined events. The following API responses are supported and no PII is included: "google.cloud.retail.v2.PredictionService.Predict"
|
|
55
|
+
* "google.cloud.retail.v2.UserEventService.WriteUserEvent" "google.cloud.retail.v2.UserEventService.CollectUserEvent"
|
|
56
|
+
*/
|
|
57
|
+
responsePayload?: { [P in string]: any };
|
|
58
|
+
/** The service context in which this error has occurred. */
|
|
59
|
+
serviceContext?: GoogleCloudRetailLoggingServiceContext;
|
|
60
|
+
/** The RPC status associated with the error log. */
|
|
61
|
+
status?: GoogleRpcStatus;
|
|
62
|
+
}
|
|
63
|
+
interface GoogleCloudRetailLoggingHttpRequestContext {
|
|
64
|
+
/** The HTTP response status code for the request. */
|
|
65
|
+
responseStatusCode?: number;
|
|
66
|
+
}
|
|
67
|
+
interface GoogleCloudRetailLoggingImportErrorContext {
|
|
68
|
+
/** The detailed content which caused the error on importing a catalog item. */
|
|
69
|
+
catalogItem?: string;
|
|
70
|
+
/** Cloud Storage file path of the import source. Can be set for batch operation error. */
|
|
71
|
+
gcsPath?: string;
|
|
72
|
+
/** Line number of the content in file. Should be empty for permission or batch operation error. */
|
|
73
|
+
lineNumber?: string;
|
|
74
|
+
/** The operation resource name of the LRO. */
|
|
75
|
+
operationName?: string;
|
|
76
|
+
/** The detailed content which caused the error on importing a product. */
|
|
77
|
+
product?: string;
|
|
78
|
+
/** The detailed content which caused the error on importing a user event. */
|
|
79
|
+
userEvent?: string;
|
|
80
|
+
}
|
|
81
|
+
interface GoogleCloudRetailLoggingServiceContext {
|
|
82
|
+
/** An identifier of the service. For example, "retail.googleapis.com". */
|
|
83
|
+
service?: string;
|
|
84
|
+
}
|
|
85
|
+
interface GoogleCloudRetailLoggingSourceLocation {
|
|
86
|
+
/** Human-readable name of a function or method. For example, "google.cloud.retail.v2.UserEventService.ImportUserEvents". */
|
|
87
|
+
functionName?: string;
|
|
88
|
+
}
|
|
89
|
+
interface GoogleCloudRetailV2AddCatalogAttributeRequest {
|
|
90
|
+
/** Required. The CatalogAttribute to add. */
|
|
91
|
+
catalogAttribute?: GoogleCloudRetailV2CatalogAttribute;
|
|
92
|
+
}
|
|
93
|
+
// tslint:disable-next-line:no-empty-interface
|
|
94
|
+
interface GoogleCloudRetailV2AddFulfillmentPlacesMetadata {
|
|
95
|
+
}
|
|
96
|
+
interface GoogleCloudRetailV2AddFulfillmentPlacesRequest {
|
|
97
|
+
/** The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used. */
|
|
98
|
+
addTime?: string;
|
|
99
|
+
/**
|
|
100
|
+
* If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to
|
|
101
|
+
* false, a NOT_FOUND error is returned if the Product is not found.
|
|
102
|
+
*/
|
|
103
|
+
allowMissing?: boolean;
|
|
104
|
+
/**
|
|
105
|
+
* Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this type. Duplicate IDs will be automatically
|
|
106
|
+
* ignored. At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern
|
|
107
|
+
* `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total number of place IDs exceeds 2000 for this type after adding, then
|
|
108
|
+
* the update will be rejected.
|
|
109
|
+
*/
|
|
110
|
+
placeIds?: string[];
|
|
111
|
+
/**
|
|
112
|
+
* Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Supported values: * "pickup-in-store" *
|
|
113
|
+
* "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an
|
|
114
|
+
* invalid value other than these, an INVALID_ARGUMENT error is returned. This field directly corresponds to Product.fulfillment_info.type.
|
|
115
|
+
*/
|
|
116
|
+
type?: string;
|
|
117
|
+
}
|
|
118
|
+
// tslint:disable-next-line:no-empty-interface
|
|
119
|
+
interface GoogleCloudRetailV2AddFulfillmentPlacesResponse {
|
|
120
|
+
}
|
|
121
|
+
// tslint:disable-next-line:no-empty-interface
|
|
122
|
+
interface GoogleCloudRetailV2AddLocalInventoriesMetadata {
|
|
123
|
+
}
|
|
124
|
+
interface GoogleCloudRetailV2AddLocalInventoriesRequest {
|
|
125
|
+
/**
|
|
126
|
+
* Indicates which inventory fields in the provided list of LocalInventory to update. The field is updated to the provided value. If a field is set while the place does not have a
|
|
127
|
+
* previous local inventory, the local inventory at that store is created. If a field is set while the value of that field is not provided, the original field value, if it exists, is
|
|
128
|
+
* deleted. If the mask is not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned
|
|
129
|
+
* and the entire update will be ignored.
|
|
130
|
+
*/
|
|
131
|
+
addMask?: string;
|
|
132
|
+
/** The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used. */
|
|
133
|
+
addTime?: string;
|
|
134
|
+
/**
|
|
135
|
+
* If set to true, and the Product is not found, the local inventory will still be processed and retained for at most 1 day and processed once the Product is created. If set to false,
|
|
136
|
+
* a NOT_FOUND error is returned if the Product is not found.
|
|
137
|
+
*/
|
|
138
|
+
allowMissing?: boolean;
|
|
139
|
+
/** Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request. */
|
|
140
|
+
localInventories?: GoogleCloudRetailV2LocalInventory[];
|
|
141
|
+
}
|
|
142
|
+
// tslint:disable-next-line:no-empty-interface
|
|
143
|
+
interface GoogleCloudRetailV2AddLocalInventoriesResponse {
|
|
144
|
+
}
|
|
145
|
+
// tslint:disable-next-line:no-empty-interface
|
|
146
|
+
interface GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata {
|
|
147
|
+
}
|
|
148
|
+
// tslint:disable-next-line:no-empty-interface
|
|
149
|
+
interface GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse {
|
|
150
|
+
}
|
|
151
|
+
// tslint:disable-next-line:no-empty-interface
|
|
152
|
+
interface GoogleCloudRetailV2alphaAddLocalInventoriesMetadata {
|
|
153
|
+
}
|
|
154
|
+
// tslint:disable-next-line:no-empty-interface
|
|
155
|
+
interface GoogleCloudRetailV2alphaAddLocalInventoriesResponse {
|
|
156
|
+
}
|
|
157
|
+
interface GoogleCloudRetailV2alphaBigQueryOutputResult {
|
|
158
|
+
/** The ID of a BigQuery Dataset. */
|
|
159
|
+
datasetId?: string;
|
|
160
|
+
/** The ID of a BigQuery Table. */
|
|
161
|
+
tableId?: string;
|
|
162
|
+
}
|
|
163
|
+
interface GoogleCloudRetailV2alphaCreateModelMetadata {
|
|
164
|
+
/** The resource name of the model that this create applies to. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} */
|
|
165
|
+
model?: string;
|
|
166
|
+
}
|
|
167
|
+
interface GoogleCloudRetailV2alphaExportErrorsConfig {
|
|
168
|
+
/**
|
|
169
|
+
* Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a
|
|
170
|
+
* JSON-encoded `google.rpc.Status` message.
|
|
171
|
+
*/
|
|
172
|
+
gcsPrefix?: string;
|
|
173
|
+
}
|
|
174
|
+
interface GoogleCloudRetailV2alphaExportMetadata {
|
|
175
|
+
/** Operation create time. */
|
|
176
|
+
createTime?: string;
|
|
177
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
178
|
+
updateTime?: string;
|
|
179
|
+
}
|
|
180
|
+
interface GoogleCloudRetailV2alphaExportProductsResponse {
|
|
181
|
+
/** A sample of errors encountered while processing the request. */
|
|
182
|
+
errorSamples?: GoogleRpcStatus[];
|
|
183
|
+
/** This field is never set. */
|
|
184
|
+
errorsConfig?: GoogleCloudRetailV2alphaExportErrorsConfig;
|
|
185
|
+
/** Output result indicating where the data were exported to. */
|
|
186
|
+
outputResult?: GoogleCloudRetailV2alphaOutputResult;
|
|
187
|
+
}
|
|
188
|
+
interface GoogleCloudRetailV2alphaExportUserEventsResponse {
|
|
189
|
+
/** A sample of errors encountered while processing the request. */
|
|
190
|
+
errorSamples?: GoogleRpcStatus[];
|
|
191
|
+
/** This field is never set. */
|
|
192
|
+
errorsConfig?: GoogleCloudRetailV2alphaExportErrorsConfig;
|
|
193
|
+
/** Output result indicating where the data were exported to. */
|
|
194
|
+
outputResult?: GoogleCloudRetailV2alphaOutputResult;
|
|
195
|
+
}
|
|
196
|
+
interface GoogleCloudRetailV2alphaImportCompletionDataResponse {
|
|
197
|
+
/** A sample of errors encountered while processing the request. */
|
|
198
|
+
errorSamples?: GoogleRpcStatus[];
|
|
199
|
+
}
|
|
200
|
+
interface GoogleCloudRetailV2alphaImportErrorsConfig {
|
|
201
|
+
/**
|
|
202
|
+
* Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per
|
|
203
|
+
* line, as a JSON-encoded `google.rpc.Status` message.
|
|
204
|
+
*/
|
|
205
|
+
gcsPrefix?: string;
|
|
206
|
+
}
|
|
207
|
+
interface GoogleCloudRetailV2alphaImportMetadata {
|
|
208
|
+
/** Operation create time. */
|
|
209
|
+
createTime?: string;
|
|
210
|
+
/** Count of entries that encountered errors while processing. */
|
|
211
|
+
failureCount?: string;
|
|
212
|
+
/**
|
|
213
|
+
* Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON
|
|
214
|
+
* string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
|
|
215
|
+
*/
|
|
216
|
+
notificationPubsubTopic?: string;
|
|
217
|
+
/** Deprecated. This field is never set. */
|
|
218
|
+
requestId?: string;
|
|
219
|
+
/** Count of entries that were processed successfully. */
|
|
220
|
+
successCount?: string;
|
|
221
|
+
/** Metadata related to transform user events. */
|
|
222
|
+
transformedUserEventsMetadata?: GoogleCloudRetailV2alphaTransformedUserEventsMetadata;
|
|
223
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
224
|
+
updateTime?: string;
|
|
225
|
+
}
|
|
226
|
+
interface GoogleCloudRetailV2alphaImportProductsResponse {
|
|
227
|
+
/** A sample of errors encountered while processing the request. */
|
|
228
|
+
errorSamples?: GoogleRpcStatus[];
|
|
229
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
230
|
+
errorsConfig?: GoogleCloudRetailV2alphaImportErrorsConfig;
|
|
231
|
+
}
|
|
232
|
+
interface GoogleCloudRetailV2alphaImportUserEventsResponse {
|
|
233
|
+
/** A sample of errors encountered while processing the request. */
|
|
234
|
+
errorSamples?: GoogleRpcStatus[];
|
|
235
|
+
/** Echoes the destination for the complete errors if this field was set in the request. */
|
|
236
|
+
errorsConfig?: GoogleCloudRetailV2alphaImportErrorsConfig;
|
|
237
|
+
/** Aggregated statistics of user event import status. */
|
|
238
|
+
importSummary?: GoogleCloudRetailV2alphaUserEventImportSummary;
|
|
239
|
+
}
|
|
240
|
+
interface GoogleCloudRetailV2alphaModel {
|
|
241
|
+
/** Output only. Timestamp the Recommendation Model was created at. */
|
|
242
|
+
createTime?: string;
|
|
243
|
+
/**
|
|
244
|
+
* Output only. The state of data requirements for this model: DATA_OK and DATA_ERROR. Recommendation model cannot be trained if the data is in DATA_ERROR state. Recommendation model
|
|
245
|
+
* can have DATA_ERROR state even if serving state is ACTIVE: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
|
|
246
|
+
*/
|
|
247
|
+
dataState?: string;
|
|
248
|
+
/**
|
|
249
|
+
* Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8 encoded string with limit of
|
|
250
|
+
* 1024 characters.
|
|
251
|
+
*/
|
|
252
|
+
displayName?: string;
|
|
253
|
+
/** Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model. */
|
|
254
|
+
filteringOption?: string;
|
|
255
|
+
/** Output only. The timestamp when the latest successful tune finished. */
|
|
256
|
+
lastTuneTime?: string;
|
|
257
|
+
/**
|
|
258
|
+
* Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit
|
|
259
|
+
* of 50. recommendation_model_id has char limit of 40.
|
|
260
|
+
*/
|
|
261
|
+
name?: string;
|
|
262
|
+
/**
|
|
263
|
+
* Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default
|
|
264
|
+
* depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order`
|
|
265
|
+
*/
|
|
266
|
+
optimizationObjective?: string;
|
|
267
|
+
/** Optional. The page optimization config. */
|
|
268
|
+
pageOptimizationConfig?: GoogleCloudRetailV2alphaModelPageOptimizationConfig;
|
|
269
|
+
/** Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the TuneModel method. Default value is PERIODIC_TUNING_ENABLED. */
|
|
270
|
+
periodicTuningState?: string;
|
|
271
|
+
/** Output only. The list of valid serving configs associated with the PageOptimizationConfig. */
|
|
272
|
+
servingConfigLists?: GoogleCloudRetailV2alphaModelServingConfigList[];
|
|
273
|
+
/** Output only. The serving state of the model: ACTIVE, NOT_ACTIVE. */
|
|
274
|
+
servingState?: string;
|
|
275
|
+
/**
|
|
276
|
+
* Optional. The training state that the model is in (e.g. TRAINING or PAUSED). Since part of the cost of running the service is frequency of training - this can be used to determine
|
|
277
|
+
* when to train model in order to control cost. If not specified: the default value for CreateModel method is TRAINING. the default value for UpdateModel method is to keep the state
|
|
278
|
+
* the same as before.
|
|
279
|
+
*/
|
|
280
|
+
trainingState?: string;
|
|
281
|
+
/** Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on. */
|
|
282
|
+
tuningOperation?: string;
|
|
283
|
+
/**
|
|
284
|
+
* Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`,
|
|
285
|
+
* 'similar-items', 'buy-it-again', `recently-viewed`(readonly value).
|
|
286
|
+
*/
|
|
287
|
+
type?: string;
|
|
288
|
+
/** Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated. */
|
|
289
|
+
updateTime?: string;
|
|
290
|
+
}
|
|
291
|
+
interface GoogleCloudRetailV2alphaModelPageOptimizationConfig {
|
|
292
|
+
/**
|
|
293
|
+
* Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page
|
|
294
|
+
* optimization model is used on. Supported types: * `add-to-cart`: Products being added to cart. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed
|
|
295
|
+
* * `category-page-view`: Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `home-page-view` only allows models with type `recommended-for-you`. All other
|
|
296
|
+
* page_optimization_event_type allow all Model.types.
|
|
297
|
+
*/
|
|
298
|
+
pageOptimizationEventType?: string;
|
|
299
|
+
/** Required. A list of panel configurations. Limit = 5. */
|
|
300
|
+
panels?: GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel[];
|
|
301
|
+
/** Optional. How to restrict results across panels e.g. can the same ServingConfig be shown on multiple panels at once. If unspecified, default to `UNIQUE_MODEL_RESTRICTION`. */
|
|
302
|
+
restriction?: string;
|
|
303
|
+
}
|
|
304
|
+
interface GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate {
|
|
305
|
+
/**
|
|
306
|
+
* This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config`
|
|
307
|
+
* this would be 'my_candidate_config'
|
|
308
|
+
*/
|
|
309
|
+
servingConfigId?: string;
|
|
310
|
+
}
|
|
311
|
+
interface GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel {
|
|
312
|
+
/** Required. The candidates to consider on the panel. Limit = 10. */
|
|
313
|
+
candidates?: GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate[];
|
|
314
|
+
/** Required. The default candidate (in case the model fails at serving time, we can fall back to the default). */
|
|
315
|
+
defaultCandidate?: GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate;
|
|
316
|
+
/** Optional. The name to display for the panel. */
|
|
317
|
+
displayName?: string;
|
|
318
|
+
}
|
|
319
|
+
interface GoogleCloudRetailV2alphaModelServingConfigList {
|
|
320
|
+
/** Optional. A set of valid serving configs that may be used for PAGE_OPTIMIZATION. */
|
|
321
|
+
servingConfigIds?: string[];
|
|
322
|
+
}
|
|
323
|
+
interface GoogleCloudRetailV2alphaOutputResult {
|
|
324
|
+
/** Export result in BigQuery. */
|
|
325
|
+
bigqueryResult?: GoogleCloudRetailV2alphaBigQueryOutputResult[];
|
|
326
|
+
}
|
|
327
|
+
// tslint:disable-next-line:no-empty-interface
|
|
328
|
+
interface GoogleCloudRetailV2alphaPurgeMetadata {
|
|
329
|
+
}
|
|
330
|
+
interface GoogleCloudRetailV2alphaPurgeProductsMetadata {
|
|
331
|
+
/** Operation create time. */
|
|
332
|
+
createTime?: string;
|
|
333
|
+
/** Count of entries that encountered errors while processing. */
|
|
334
|
+
failureCount?: string;
|
|
335
|
+
/** Count of entries that were deleted successfully. */
|
|
336
|
+
successCount?: string;
|
|
337
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
338
|
+
updateTime?: string;
|
|
339
|
+
}
|
|
340
|
+
interface GoogleCloudRetailV2alphaPurgeProductsResponse {
|
|
341
|
+
/** The total count of products purged as a result of the operation. */
|
|
342
|
+
purgeCount?: string;
|
|
343
|
+
/** A sample of the product names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
|
|
344
|
+
purgeSample?: string[];
|
|
345
|
+
}
|
|
346
|
+
interface GoogleCloudRetailV2alphaPurgeUserEventsResponse {
|
|
347
|
+
/** The total count of events purged as a result of the operation. */
|
|
348
|
+
purgedEventsCount?: string;
|
|
349
|
+
}
|
|
350
|
+
// tslint:disable-next-line:no-empty-interface
|
|
351
|
+
interface GoogleCloudRetailV2alphaRejoinUserEventsMetadata {
|
|
352
|
+
}
|
|
353
|
+
interface GoogleCloudRetailV2alphaRejoinUserEventsResponse {
|
|
354
|
+
/** Number of user events that were joined with latest product catalog. */
|
|
355
|
+
rejoinedUserEventsCount?: string;
|
|
356
|
+
}
|
|
357
|
+
// tslint:disable-next-line:no-empty-interface
|
|
358
|
+
interface GoogleCloudRetailV2alphaRemoveFulfillmentPlacesMetadata {
|
|
359
|
+
}
|
|
360
|
+
// tslint:disable-next-line:no-empty-interface
|
|
361
|
+
interface GoogleCloudRetailV2alphaRemoveFulfillmentPlacesResponse {
|
|
362
|
+
}
|
|
363
|
+
// tslint:disable-next-line:no-empty-interface
|
|
364
|
+
interface GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata {
|
|
365
|
+
}
|
|
366
|
+
// tslint:disable-next-line:no-empty-interface
|
|
367
|
+
interface GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse {
|
|
368
|
+
}
|
|
369
|
+
// tslint:disable-next-line:no-empty-interface
|
|
370
|
+
interface GoogleCloudRetailV2alphaSetInventoryMetadata {
|
|
371
|
+
}
|
|
372
|
+
// tslint:disable-next-line:no-empty-interface
|
|
373
|
+
interface GoogleCloudRetailV2alphaSetInventoryResponse {
|
|
374
|
+
}
|
|
375
|
+
interface GoogleCloudRetailV2alphaTransformedUserEventsMetadata {
|
|
376
|
+
/** Count of entries in the source user events BigQuery table. */
|
|
377
|
+
sourceEventsCount?: string;
|
|
378
|
+
/** Count of entries in the transformed user events BigQuery table, which could be different from the actually imported number of user events. */
|
|
379
|
+
transformedEventsCount?: string;
|
|
380
|
+
}
|
|
381
|
+
interface GoogleCloudRetailV2alphaTuneModelMetadata {
|
|
382
|
+
/** The resource name of the model that this tune applies to. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} */
|
|
383
|
+
model?: string;
|
|
384
|
+
}
|
|
385
|
+
// tslint:disable-next-line:no-empty-interface
|
|
386
|
+
interface GoogleCloudRetailV2alphaTuneModelResponse {
|
|
387
|
+
}
|
|
388
|
+
interface GoogleCloudRetailV2alphaUserEventImportSummary {
|
|
389
|
+
/** Count of user events imported with complete existing catalog information. */
|
|
390
|
+
joinedEventsCount?: string;
|
|
391
|
+
/** Count of user events imported, but with catalog information not found in the imported catalog. */
|
|
392
|
+
unjoinedEventsCount?: string;
|
|
393
|
+
}
|
|
394
|
+
interface GoogleCloudRetailV2AttributesConfig {
|
|
395
|
+
/** Output only. The AttributeConfigLevel used for this catalog. */
|
|
396
|
+
attributeConfigLevel?: string;
|
|
397
|
+
/**
|
|
398
|
+
* Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute's name. For example: `color`,
|
|
399
|
+
* `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number of catalog attributes allowed in a request is 1000.
|
|
400
|
+
*/
|
|
401
|
+
catalogAttributes?: { [P in string]: GoogleCloudRetailV2CatalogAttribute };
|
|
402
|
+
/** Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig` */
|
|
403
|
+
name?: string;
|
|
404
|
+
}
|
|
405
|
+
interface GoogleCloudRetailV2Audience {
|
|
406
|
+
/**
|
|
407
|
+
* The age groups of the audience. Strongly encouraged to use the standard values: "newborn" (up to 3 months old), "infant" (3–12 months old), "toddler" (1–5 years old), "kids" (5–13
|
|
408
|
+
* years old), "adult" (typically teens or older). At most 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
|
|
409
|
+
* INVALID_ARGUMENT error is returned. Google Merchant Center property [age_group](https://support.google.com/merchants/answer/6324463). Schema.org property
|
|
410
|
+
* [Product.audience.suggestedMinAge](https://schema.org/suggestedMinAge) and [Product.audience.suggestedMaxAge](https://schema.org/suggestedMaxAge).
|
|
411
|
+
*/
|
|
412
|
+
ageGroups?: string[];
|
|
413
|
+
/**
|
|
414
|
+
* The genders of the audience. Strongly encouraged to use the standard values: "male", "female", "unisex". At most 5 values are allowed. Each value must be a UTF-8 encoded string with
|
|
415
|
+
* a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [gender](https://support.google.com/merchants/answer/6324479).
|
|
416
|
+
* Schema.org property [Product.audience.suggestedGender](https://schema.org/suggestedGender).
|
|
417
|
+
*/
|
|
418
|
+
genders?: string[];
|
|
419
|
+
}
|
|
420
|
+
// tslint:disable-next-line:no-empty-interface
|
|
421
|
+
interface GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata {
|
|
422
|
+
}
|
|
423
|
+
// tslint:disable-next-line:no-empty-interface
|
|
424
|
+
interface GoogleCloudRetailV2betaAddFulfillmentPlacesResponse {
|
|
425
|
+
}
|
|
426
|
+
// tslint:disable-next-line:no-empty-interface
|
|
427
|
+
interface GoogleCloudRetailV2betaAddLocalInventoriesMetadata {
|
|
428
|
+
}
|
|
429
|
+
// tslint:disable-next-line:no-empty-interface
|
|
430
|
+
interface GoogleCloudRetailV2betaAddLocalInventoriesResponse {
|
|
431
|
+
}
|
|
432
|
+
interface GoogleCloudRetailV2betaBigQueryOutputResult {
|
|
433
|
+
/** The ID of a BigQuery Dataset. */
|
|
434
|
+
datasetId?: string;
|
|
435
|
+
/** The ID of a BigQuery Table. */
|
|
436
|
+
tableId?: string;
|
|
437
|
+
}
|
|
438
|
+
interface GoogleCloudRetailV2betaExportErrorsConfig {
|
|
439
|
+
/**
|
|
440
|
+
* Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a
|
|
441
|
+
* JSON-encoded `google.rpc.Status` message.
|
|
442
|
+
*/
|
|
443
|
+
gcsPrefix?: string;
|
|
444
|
+
}
|
|
445
|
+
interface GoogleCloudRetailV2betaExportMetadata {
|
|
446
|
+
/** Operation create time. */
|
|
447
|
+
createTime?: string;
|
|
448
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
449
|
+
updateTime?: string;
|
|
450
|
+
}
|
|
451
|
+
interface GoogleCloudRetailV2betaExportProductsResponse {
|
|
452
|
+
/** A sample of errors encountered while processing the request. */
|
|
453
|
+
errorSamples?: GoogleRpcStatus[];
|
|
454
|
+
/** This field is never set. */
|
|
455
|
+
errorsConfig?: GoogleCloudRetailV2betaExportErrorsConfig;
|
|
456
|
+
/** Output result indicating where the data were exported to. */
|
|
457
|
+
outputResult?: GoogleCloudRetailV2betaOutputResult;
|
|
458
|
+
}
|
|
459
|
+
interface GoogleCloudRetailV2betaExportUserEventsResponse {
|
|
460
|
+
/** A sample of errors encountered while processing the request. */
|
|
461
|
+
errorSamples?: GoogleRpcStatus[];
|
|
462
|
+
/** This field is never set. */
|
|
463
|
+
errorsConfig?: GoogleCloudRetailV2betaExportErrorsConfig;
|
|
464
|
+
/** Output result indicating where the data were exported to. */
|
|
465
|
+
outputResult?: GoogleCloudRetailV2betaOutputResult;
|
|
466
|
+
}
|
|
467
|
+
interface GoogleCloudRetailV2betaImportCompletionDataResponse {
|
|
468
|
+
/** A sample of errors encountered while processing the request. */
|
|
469
|
+
errorSamples?: GoogleRpcStatus[];
|
|
470
|
+
}
|
|
471
|
+
interface GoogleCloudRetailV2betaImportErrorsConfig {
|
|
472
|
+
/**
|
|
473
|
+
* Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per
|
|
474
|
+
* line, as a JSON-encoded `google.rpc.Status` message.
|
|
475
|
+
*/
|
|
476
|
+
gcsPrefix?: string;
|
|
477
|
+
}
|
|
478
|
+
interface GoogleCloudRetailV2betaImportMetadata {
|
|
479
|
+
/** Operation create time. */
|
|
480
|
+
createTime?: string;
|
|
481
|
+
/** Count of entries that encountered errors while processing. */
|
|
482
|
+
failureCount?: string;
|
|
483
|
+
/**
|
|
484
|
+
* Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON
|
|
485
|
+
* string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
|
|
486
|
+
*/
|
|
487
|
+
notificationPubsubTopic?: string;
|
|
488
|
+
/** Deprecated. This field is never set. */
|
|
489
|
+
requestId?: string;
|
|
490
|
+
/** Count of entries that were processed successfully. */
|
|
491
|
+
successCount?: string;
|
|
492
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
493
|
+
updateTime?: string;
|
|
494
|
+
}
|
|
495
|
+
interface GoogleCloudRetailV2betaImportProductsResponse {
|
|
496
|
+
/** A sample of errors encountered while processing the request. */
|
|
497
|
+
errorSamples?: GoogleRpcStatus[];
|
|
498
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
499
|
+
errorsConfig?: GoogleCloudRetailV2betaImportErrorsConfig;
|
|
500
|
+
}
|
|
501
|
+
interface GoogleCloudRetailV2betaImportUserEventsResponse {
|
|
502
|
+
/** A sample of errors encountered while processing the request. */
|
|
503
|
+
errorSamples?: GoogleRpcStatus[];
|
|
504
|
+
/** Echoes the destination for the complete errors if this field was set in the request. */
|
|
505
|
+
errorsConfig?: GoogleCloudRetailV2betaImportErrorsConfig;
|
|
506
|
+
/** Aggregated statistics of user event import status. */
|
|
507
|
+
importSummary?: GoogleCloudRetailV2betaUserEventImportSummary;
|
|
508
|
+
}
|
|
509
|
+
interface GoogleCloudRetailV2betaOutputResult {
|
|
510
|
+
/** Export result in BigQuery. */
|
|
511
|
+
bigqueryResult?: GoogleCloudRetailV2betaBigQueryOutputResult[];
|
|
512
|
+
}
|
|
513
|
+
// tslint:disable-next-line:no-empty-interface
|
|
514
|
+
interface GoogleCloudRetailV2betaPurgeMetadata {
|
|
515
|
+
}
|
|
516
|
+
interface GoogleCloudRetailV2betaPurgeUserEventsResponse {
|
|
517
|
+
/** The total count of events purged as a result of the operation. */
|
|
518
|
+
purgedEventsCount?: string;
|
|
519
|
+
}
|
|
520
|
+
// tslint:disable-next-line:no-empty-interface
|
|
521
|
+
interface GoogleCloudRetailV2betaRejoinUserEventsMetadata {
|
|
522
|
+
}
|
|
523
|
+
interface GoogleCloudRetailV2betaRejoinUserEventsResponse {
|
|
524
|
+
/** Number of user events that were joined with latest product catalog. */
|
|
525
|
+
rejoinedUserEventsCount?: string;
|
|
526
|
+
}
|
|
527
|
+
// tslint:disable-next-line:no-empty-interface
|
|
528
|
+
interface GoogleCloudRetailV2betaRemoveFulfillmentPlacesMetadata {
|
|
529
|
+
}
|
|
530
|
+
// tslint:disable-next-line:no-empty-interface
|
|
531
|
+
interface GoogleCloudRetailV2betaRemoveFulfillmentPlacesResponse {
|
|
532
|
+
}
|
|
533
|
+
// tslint:disable-next-line:no-empty-interface
|
|
534
|
+
interface GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata {
|
|
535
|
+
}
|
|
536
|
+
// tslint:disable-next-line:no-empty-interface
|
|
537
|
+
interface GoogleCloudRetailV2betaRemoveLocalInventoriesResponse {
|
|
538
|
+
}
|
|
539
|
+
// tslint:disable-next-line:no-empty-interface
|
|
540
|
+
interface GoogleCloudRetailV2betaSetInventoryMetadata {
|
|
541
|
+
}
|
|
542
|
+
// tslint:disable-next-line:no-empty-interface
|
|
543
|
+
interface GoogleCloudRetailV2betaSetInventoryResponse {
|
|
544
|
+
}
|
|
545
|
+
interface GoogleCloudRetailV2betaUserEventImportSummary {
|
|
546
|
+
/** Count of user events imported with complete existing catalog information. */
|
|
547
|
+
joinedEventsCount?: string;
|
|
548
|
+
/** Count of user events imported, but with catalog information not found in the imported catalog. */
|
|
549
|
+
unjoinedEventsCount?: string;
|
|
550
|
+
}
|
|
551
|
+
interface GoogleCloudRetailV2BigQuerySource {
|
|
552
|
+
/**
|
|
553
|
+
* The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid
|
|
554
|
+
* Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported
|
|
555
|
+
* values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here:
|
|
556
|
+
* https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for
|
|
557
|
+
* auto-completion imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow
|
|
558
|
+
* suggestion per line.
|
|
559
|
+
*/
|
|
560
|
+
dataSchema?: string;
|
|
561
|
+
/** Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. */
|
|
562
|
+
datasetId?: string;
|
|
563
|
+
/**
|
|
564
|
+
* Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud
|
|
565
|
+
* Storage directory.
|
|
566
|
+
*/
|
|
567
|
+
gcsStagingDir?: string;
|
|
568
|
+
/** BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported in ImportProductsRequest. */
|
|
569
|
+
partitionDate?: GoogleTypeDate;
|
|
570
|
+
/** The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
571
|
+
projectId?: string;
|
|
572
|
+
/** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
|
|
573
|
+
tableId?: string;
|
|
574
|
+
}
|
|
575
|
+
interface GoogleCloudRetailV2Catalog {
|
|
576
|
+
/** Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
577
|
+
displayName?: string;
|
|
578
|
+
/** Required. Immutable. The fully qualified resource name of the catalog. */
|
|
579
|
+
name?: string;
|
|
580
|
+
/** Required. The product level configuration. */
|
|
581
|
+
productLevelConfig?: GoogleCloudRetailV2ProductLevelConfig;
|
|
582
|
+
}
|
|
583
|
+
interface GoogleCloudRetailV2CatalogAttribute {
|
|
584
|
+
/**
|
|
585
|
+
* If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED.
|
|
586
|
+
* Otherwise, an INVALID_ARGUMENT error is returned.
|
|
587
|
+
*/
|
|
588
|
+
dynamicFacetableOption?: string;
|
|
589
|
+
/**
|
|
590
|
+
* When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in
|
|
591
|
+
* SearchService.Search.
|
|
592
|
+
*/
|
|
593
|
+
indexableOption?: string;
|
|
594
|
+
/**
|
|
595
|
+
* Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is
|
|
596
|
+
* `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This
|
|
597
|
+
* field is `False` for pre-loaded CatalogAttributes. Only pre-loaded CatalogAttributes that are neither in use by products nor predefined can be deleted. CatalogAttributes that are
|
|
598
|
+
* either in use by products or are predefined cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it
|
|
599
|
+
* takes about 10 minutes for this field to update.
|
|
600
|
+
*/
|
|
601
|
+
inUse?: boolean;
|
|
602
|
+
/**
|
|
603
|
+
* Required. Attribute name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute name can contain only alpha-numeric
|
|
604
|
+
* characters and underscores. For example, an attribute named `attributes.abc_xyz` can be indexed, but an attribute named `attributes.abc-xyz` cannot be indexed.
|
|
605
|
+
*/
|
|
606
|
+
key?: string;
|
|
607
|
+
/**
|
|
608
|
+
* When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If
|
|
609
|
+
* SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to
|
|
610
|
+
* numerical attributes.
|
|
611
|
+
*/
|
|
612
|
+
searchableOption?: string;
|
|
613
|
+
/** Output only. The type of this attribute. This is derived from the attribute in Product.attributes. */
|
|
614
|
+
type?: string;
|
|
615
|
+
}
|
|
616
|
+
interface GoogleCloudRetailV2ColorInfo {
|
|
617
|
+
/**
|
|
618
|
+
* The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White",
|
|
619
|
+
* "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values. A maximum of 5 values are allowed.
|
|
620
|
+
* Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property
|
|
621
|
+
* [color](https://support.google.com/merchants/answer/6324487). Schema.org property [Product.color](https://schema.org/color).
|
|
622
|
+
*/
|
|
623
|
+
colorFamilies?: string[];
|
|
624
|
+
/**
|
|
625
|
+
* The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1
|
|
626
|
+
* color. May consider using single "Mixed" instead of multiple values. A maximum of 25 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128
|
|
627
|
+
* characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [color](https://support.google.com/merchants/answer/6324487). Schema.org property
|
|
628
|
+
* [Product.color](https://schema.org/color).
|
|
629
|
+
*/
|
|
630
|
+
colors?: string[];
|
|
631
|
+
}
|
|
632
|
+
interface GoogleCloudRetailV2CompleteQueryResponse {
|
|
633
|
+
/**
|
|
634
|
+
* A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete
|
|
635
|
+
* model performance.
|
|
636
|
+
*/
|
|
637
|
+
attributionToken?: string;
|
|
638
|
+
/** Results of the matching suggestions. The result list is ordered and the first result is top suggestion. */
|
|
639
|
+
completionResults?: GoogleCloudRetailV2CompleteQueryResponseCompletionResult[];
|
|
640
|
+
/**
|
|
641
|
+
* Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. Contact Retail Search support team if you are interested in
|
|
642
|
+
* enabling it. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are
|
|
643
|
+
* ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches
|
|
644
|
+
* are deduplicated. More recent searches will be reserved when duplication happens.
|
|
645
|
+
*/
|
|
646
|
+
recentSearchResults?: GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult[];
|
|
647
|
+
}
|
|
648
|
+
interface GoogleCloudRetailV2CompleteQueryResponseCompletionResult {
|
|
649
|
+
/**
|
|
650
|
+
* Custom attributes for the suggestion term. * For "user-data", the attributes are additional custom attributes ingested through BigQuery. * For "cloud-retail", the attributes are
|
|
651
|
+
* product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.
|
|
652
|
+
*/
|
|
653
|
+
attributes?: { [P in string]: GoogleCloudRetailV2CustomAttribute };
|
|
654
|
+
/** The suggestion for the query. */
|
|
655
|
+
suggestion?: string;
|
|
656
|
+
}
|
|
657
|
+
interface GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult {
|
|
658
|
+
/** The recent search query. */
|
|
659
|
+
recentSearch?: string;
|
|
660
|
+
}
|
|
661
|
+
interface GoogleCloudRetailV2CompletionConfig {
|
|
662
|
+
/** Output only. The source data for the latest import of the autocomplete allowlist phrases. */
|
|
663
|
+
allowlistInputConfig?: GoogleCloudRetailV2CompletionDataInputConfig;
|
|
664
|
+
/**
|
|
665
|
+
* If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto
|
|
666
|
+
* learning can users use `cloud-retail` data in CompleteQueryRequest.
|
|
667
|
+
*/
|
|
668
|
+
autoLearning?: boolean;
|
|
669
|
+
/** Output only. The source data for the latest import of the autocomplete denylist phrases. */
|
|
670
|
+
denylistInputConfig?: GoogleCloudRetailV2CompletionDataInputConfig;
|
|
671
|
+
/** Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. */
|
|
672
|
+
lastAllowlistImportOperation?: string;
|
|
673
|
+
/** Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. */
|
|
674
|
+
lastDenylistImportOperation?: string;
|
|
675
|
+
/** Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. */
|
|
676
|
+
lastSuggestionsImportOperation?: string;
|
|
677
|
+
/**
|
|
678
|
+
* Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s'
|
|
679
|
+
* with 'exact-prefix' specified would suggest "red shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default value: 'exact-prefix'.
|
|
680
|
+
*/
|
|
681
|
+
matchingOrder?: string;
|
|
682
|
+
/** The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. */
|
|
683
|
+
maxSuggestions?: number;
|
|
684
|
+
/**
|
|
685
|
+
* The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1
|
|
686
|
+
* to 20.
|
|
687
|
+
*/
|
|
688
|
+
minPrefixLength?: number;
|
|
689
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig` */
|
|
690
|
+
name?: string;
|
|
691
|
+
/** Output only. The source data for the latest import of the autocomplete suggestion phrases. */
|
|
692
|
+
suggestionsInputConfig?: GoogleCloudRetailV2CompletionDataInputConfig;
|
|
693
|
+
}
|
|
694
|
+
interface GoogleCloudRetailV2CompletionDataInputConfig {
|
|
695
|
+
/**
|
|
696
|
+
* Required. BigQuery input source. Add the IAM permission "BigQuery Data Viewer" for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise
|
|
697
|
+
* an error is thrown.
|
|
698
|
+
*/
|
|
699
|
+
bigQuerySource?: GoogleCloudRetailV2BigQuerySource;
|
|
700
|
+
}
|
|
701
|
+
interface GoogleCloudRetailV2CompletionDetail {
|
|
702
|
+
/** Completion attribution token in CompleteQueryResponse.attribution_token. */
|
|
703
|
+
completionAttributionToken?: string;
|
|
704
|
+
/** End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0. */
|
|
705
|
+
selectedPosition?: number;
|
|
706
|
+
/** End user selected CompleteQueryResponse.CompletionResult.suggestion. */
|
|
707
|
+
selectedSuggestion?: string;
|
|
708
|
+
}
|
|
709
|
+
interface GoogleCloudRetailV2CustomAttribute {
|
|
710
|
+
/**
|
|
711
|
+
* This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
|
|
712
|
+
* product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed,
|
|
713
|
+
* so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and
|
|
714
|
+
* SearchRequest.boost_spec for more details.
|
|
715
|
+
*/
|
|
716
|
+
indexable?: boolean;
|
|
717
|
+
/**
|
|
718
|
+
* The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT
|
|
719
|
+
* error is returned.
|
|
720
|
+
*/
|
|
721
|
+
numbers?: number[];
|
|
722
|
+
/**
|
|
723
|
+
* This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about
|
|
724
|
+
* product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are searchable
|
|
725
|
+
* by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
|
|
726
|
+
*/
|
|
727
|
+
searchable?: boolean;
|
|
728
|
+
/**
|
|
729
|
+
* The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
|
|
730
|
+
* returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
731
|
+
*/
|
|
732
|
+
text?: string[];
|
|
733
|
+
}
|
|
734
|
+
interface GoogleCloudRetailV2FulfillmentInfo {
|
|
735
|
+
/**
|
|
736
|
+
* The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A maximum of 3000 values are
|
|
737
|
+
* allowed. Each value must be a string with a length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT
|
|
738
|
+
* error is returned.
|
|
739
|
+
*/
|
|
740
|
+
placeIds?: string[];
|
|
741
|
+
/**
|
|
742
|
+
* The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names
|
|
743
|
+
* before rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" *
|
|
744
|
+
* "custom-type-4" * "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
|
|
745
|
+
*/
|
|
746
|
+
type?: string;
|
|
747
|
+
}
|
|
748
|
+
interface GoogleCloudRetailV2GcsSource {
|
|
749
|
+
/**
|
|
750
|
+
* The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid
|
|
751
|
+
* Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported
|
|
752
|
+
* values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719. Supported
|
|
753
|
+
* values for control imports: * 'control' (default): One JSON Control per line. Supported values for catalog attribute imports: * 'catalog_attribute' (default): One CSV
|
|
754
|
+
* CatalogAttribute per line.
|
|
755
|
+
*/
|
|
756
|
+
dataSchema?: string;
|
|
757
|
+
/**
|
|
758
|
+
* Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or
|
|
759
|
+
* a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product
|
|
760
|
+
* information](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.
|
|
761
|
+
*/
|
|
762
|
+
inputUris?: string[];
|
|
763
|
+
}
|
|
764
|
+
interface GoogleCloudRetailV2GetDefaultBranchResponse {
|
|
765
|
+
/** Full resource name of the branch id currently set as default branch. */
|
|
766
|
+
branch?: string;
|
|
767
|
+
/** This corresponds to SetDefaultBranchRequest.note field, when this branch was set as default. */
|
|
768
|
+
note?: string;
|
|
769
|
+
/** The time when this branch is set to default. */
|
|
770
|
+
setTime?: string;
|
|
771
|
+
}
|
|
772
|
+
interface GoogleCloudRetailV2Image {
|
|
773
|
+
/** Height of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
774
|
+
height?: number;
|
|
775
|
+
/**
|
|
776
|
+
* Required. URI of the image. This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant
|
|
777
|
+
* Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).
|
|
778
|
+
*/
|
|
779
|
+
uri?: string;
|
|
780
|
+
/** Width of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
781
|
+
width?: number;
|
|
782
|
+
}
|
|
783
|
+
interface GoogleCloudRetailV2ImportCompletionDataRequest {
|
|
784
|
+
/** Required. The desired input location of the data. */
|
|
785
|
+
inputConfig?: GoogleCloudRetailV2CompletionDataInputConfig;
|
|
786
|
+
/**
|
|
787
|
+
* Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON
|
|
788
|
+
* string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
|
|
789
|
+
*/
|
|
790
|
+
notificationPubsubTopic?: string;
|
|
791
|
+
}
|
|
792
|
+
interface GoogleCloudRetailV2ImportCompletionDataResponse {
|
|
793
|
+
/** A sample of errors encountered while processing the request. */
|
|
794
|
+
errorSamples?: GoogleRpcStatus[];
|
|
795
|
+
}
|
|
796
|
+
interface GoogleCloudRetailV2ImportErrorsConfig {
|
|
797
|
+
/**
|
|
798
|
+
* Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per
|
|
799
|
+
* line, as a JSON-encoded `google.rpc.Status` message.
|
|
800
|
+
*/
|
|
801
|
+
gcsPrefix?: string;
|
|
802
|
+
}
|
|
803
|
+
interface GoogleCloudRetailV2ImportMetadata {
|
|
804
|
+
/** Operation create time. */
|
|
805
|
+
createTime?: string;
|
|
806
|
+
/** Count of entries that encountered errors while processing. */
|
|
807
|
+
failureCount?: string;
|
|
808
|
+
/**
|
|
809
|
+
* Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will be JSON
|
|
810
|
+
* string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
|
|
811
|
+
*/
|
|
812
|
+
notificationPubsubTopic?: string;
|
|
813
|
+
/** Deprecated. This field is never set. */
|
|
814
|
+
requestId?: string;
|
|
815
|
+
/** Count of entries that were processed successfully. */
|
|
816
|
+
successCount?: string;
|
|
817
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
818
|
+
updateTime?: string;
|
|
819
|
+
}
|
|
820
|
+
interface GoogleCloudRetailV2ImportProductsRequest {
|
|
821
|
+
/** The desired location of errors incurred during the Import. */
|
|
822
|
+
errorsConfig?: GoogleCloudRetailV2ImportErrorsConfig;
|
|
823
|
+
/** Required. The desired input location of the data. */
|
|
824
|
+
inputConfig?: GoogleCloudRetailV2ProductInputConfig;
|
|
825
|
+
/**
|
|
826
|
+
* Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification will be sent to specified Pub/Sub topic. The message data will
|
|
827
|
+
* be JSON string of a Operation. Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has to be within the same project as ImportProductsRequest.parent. Make sure
|
|
828
|
+
* that `service-@gcp-sa-retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the topic.
|
|
829
|
+
*/
|
|
830
|
+
notificationPubsubTopic?: string;
|
|
831
|
+
/** The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
|
|
832
|
+
reconciliationMode?: string;
|
|
833
|
+
/** Deprecated. This field has no effect. */
|
|
834
|
+
requestId?: string;
|
|
835
|
+
/** Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields. */
|
|
836
|
+
updateMask?: string;
|
|
837
|
+
}
|
|
838
|
+
interface GoogleCloudRetailV2ImportProductsResponse {
|
|
839
|
+
/** A sample of errors encountered while processing the request. */
|
|
840
|
+
errorSamples?: GoogleRpcStatus[];
|
|
841
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
842
|
+
errorsConfig?: GoogleCloudRetailV2ImportErrorsConfig;
|
|
843
|
+
}
|
|
844
|
+
interface GoogleCloudRetailV2ImportUserEventsRequest {
|
|
845
|
+
/** The desired location of errors incurred during the Import. Cannot be set for inline user event imports. */
|
|
846
|
+
errorsConfig?: GoogleCloudRetailV2ImportErrorsConfig;
|
|
847
|
+
/** Required. The desired input location of the data. */
|
|
848
|
+
inputConfig?: GoogleCloudRetailV2UserEventInputConfig;
|
|
849
|
+
}
|
|
850
|
+
interface GoogleCloudRetailV2ImportUserEventsResponse {
|
|
851
|
+
/** A sample of errors encountered while processing the request. */
|
|
852
|
+
errorSamples?: GoogleRpcStatus[];
|
|
853
|
+
/** Echoes the destination for the complete errors if this field was set in the request. */
|
|
854
|
+
errorsConfig?: GoogleCloudRetailV2ImportErrorsConfig;
|
|
855
|
+
/** Aggregated statistics of user event import status. */
|
|
856
|
+
importSummary?: GoogleCloudRetailV2UserEventImportSummary;
|
|
857
|
+
}
|
|
858
|
+
interface GoogleCloudRetailV2Interval {
|
|
859
|
+
/** Exclusive upper bound. */
|
|
860
|
+
exclusiveMaximum?: number;
|
|
861
|
+
/** Exclusive lower bound. */
|
|
862
|
+
exclusiveMinimum?: number;
|
|
863
|
+
/** Inclusive upper bound. */
|
|
864
|
+
maximum?: number;
|
|
865
|
+
/** Inclusive lower bound. */
|
|
866
|
+
minimum?: number;
|
|
867
|
+
}
|
|
868
|
+
interface GoogleCloudRetailV2ListCatalogsResponse {
|
|
869
|
+
/** All the customer's Catalogs. */
|
|
870
|
+
catalogs?: GoogleCloudRetailV2Catalog[];
|
|
871
|
+
/** A token that can be sent as ListCatalogsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
872
|
+
nextPageToken?: string;
|
|
873
|
+
}
|
|
874
|
+
interface GoogleCloudRetailV2ListProductsResponse {
|
|
875
|
+
/** A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
876
|
+
nextPageToken?: string;
|
|
877
|
+
/** The Products. */
|
|
878
|
+
products?: GoogleCloudRetailV2Product[];
|
|
879
|
+
}
|
|
880
|
+
interface GoogleCloudRetailV2LocalInventory {
|
|
881
|
+
/**
|
|
882
|
+
* Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: *
|
|
883
|
+
* At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example,
|
|
884
|
+
* key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit
|
|
885
|
+
* is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and
|
|
886
|
+
* values per product is 5MiB.
|
|
887
|
+
*/
|
|
888
|
+
attributes?: { [P in string]: GoogleCloudRetailV2CustomAttribute };
|
|
889
|
+
/**
|
|
890
|
+
* Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have
|
|
891
|
+
* to map custom types to their display names before rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1"
|
|
892
|
+
* * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the
|
|
893
|
+
* elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
894
|
+
*/
|
|
895
|
+
fulfillmentTypes?: string[];
|
|
896
|
+
/** The place ID for the current set of inventory information. */
|
|
897
|
+
placeId?: string;
|
|
898
|
+
/** Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). */
|
|
899
|
+
priceInfo?: GoogleCloudRetailV2PriceInfo;
|
|
900
|
+
}
|
|
901
|
+
interface GoogleCloudRetailV2PredictRequest {
|
|
902
|
+
/**
|
|
903
|
+
* Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts
|
|
904
|
+
* predictions to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from
|
|
905
|
+
* the tag values by a space. `-"tagA"` is also supported and is equivalent to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1,000
|
|
906
|
+
* characters. Note: "Recently viewed" models don't support tag filtering at the moment. * filterOutOfStockItems. Restricts predictions to products that do not have a stockState value
|
|
907
|
+
* of OUT_OF_STOCK. Examples: * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-"promotional") * filterOutOfStockItems If your filter
|
|
908
|
+
* blocks all prediction results, the API will return generic (unfiltered) popular products. If you only want results strictly matching the filters, set `strictFiltering` to True in
|
|
909
|
+
* `PredictRequest.params` to receive empty results instead. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. If
|
|
910
|
+
* `filterSyntaxV2` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (colors:
|
|
911
|
+
* ANY("Red", "Blue")) AND NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones"))
|
|
912
|
+
*/
|
|
913
|
+
filter?: string;
|
|
914
|
+
/**
|
|
915
|
+
* The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys
|
|
916
|
+
* have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can
|
|
917
|
+
* contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a
|
|
918
|
+
* label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud
|
|
919
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
|
|
920
|
+
*/
|
|
921
|
+
labels?: { [P in string]: string };
|
|
922
|
+
/**
|
|
923
|
+
* Maximum number of results to return. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value
|
|
924
|
+
* is 100. Values above 100 will be coerced to 100.
|
|
925
|
+
*/
|
|
926
|
+
pageSize?: number;
|
|
927
|
+
/** This field is not used; leave it unset. */
|
|
928
|
+
pageToken?: string;
|
|
929
|
+
/**
|
|
930
|
+
* Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the
|
|
931
|
+
* `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the
|
|
932
|
+
* `results.metadata` field in the prediction response. The given 'score' indicates the probability of an product being clicked/purchased given the user's context and history. *
|
|
933
|
+
* `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction
|
|
934
|
+
* results. * `priceRerankLevel`: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking',
|
|
935
|
+
* 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. * `diversityLevel`: String. Default empty. If set to be non-empty,
|
|
936
|
+
* then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results
|
|
937
|
+
* based on product category. * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` field is interpreteted according to the new, attribute-based syntax.
|
|
938
|
+
*/
|
|
939
|
+
params?: { [P in string]: any };
|
|
940
|
+
/**
|
|
941
|
+
* Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent
|
|
942
|
+
* logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are
|
|
943
|
+
* trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave
|
|
944
|
+
* UserInfo.user_id unset.
|
|
945
|
+
*/
|
|
946
|
+
userEvent?: GoogleCloudRetailV2UserEvent;
|
|
947
|
+
/**
|
|
948
|
+
* Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used
|
|
949
|
+
* for testing the API, or if the model is not ready.
|
|
950
|
+
*/
|
|
951
|
+
validateOnly?: boolean;
|
|
952
|
+
}
|
|
953
|
+
interface GoogleCloudRetailV2PredictResponse {
|
|
954
|
+
/** A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. */
|
|
955
|
+
attributionToken?: string;
|
|
956
|
+
/** IDs of products in the request that were missing from the inventory. */
|
|
957
|
+
missingIds?: string[];
|
|
958
|
+
/** A list of recommended products. The order represents the ranking (from the most relevant product to the least). */
|
|
959
|
+
results?: GoogleCloudRetailV2PredictResponsePredictionResult[];
|
|
960
|
+
/** True if the validateOnly property was set in the request. */
|
|
961
|
+
validateOnly?: boolean;
|
|
962
|
+
}
|
|
963
|
+
interface GoogleCloudRetailV2PredictResponsePredictionResult {
|
|
964
|
+
/** ID of the recommended product */
|
|
965
|
+
id?: string;
|
|
966
|
+
/**
|
|
967
|
+
* Additional product metadata / annotations. Possible values: * `product`: JSON representation of the product. Is set if `returnProduct` is set to true in `PredictRequest.params`. *
|
|
968
|
+
* `score`: Prediction score in double value. Is set if `returnScore` is set to true in `PredictRequest.params`.
|
|
969
|
+
*/
|
|
970
|
+
metadata?: { [P in string]: any };
|
|
971
|
+
}
|
|
972
|
+
interface GoogleCloudRetailV2PriceInfo {
|
|
973
|
+
/**
|
|
974
|
+
* The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property
|
|
975
|
+
* [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).
|
|
976
|
+
*/
|
|
977
|
+
cost?: number;
|
|
978
|
+
/**
|
|
979
|
+
* The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is
|
|
980
|
+
* returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
|
|
981
|
+
*/
|
|
982
|
+
currencyCode?: string;
|
|
983
|
+
/**
|
|
984
|
+
* Price of the product without any discount. If zero, by default set to be the price. If set, original_price should be greater than or equal to price, otherwise an INVALID_ARGUMENT
|
|
985
|
+
* error is thrown.
|
|
986
|
+
*/
|
|
987
|
+
originalPrice?: number;
|
|
988
|
+
/** Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.price](https://schema.org/price). */
|
|
989
|
+
price?: number;
|
|
990
|
+
/**
|
|
991
|
+
* The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the
|
|
992
|
+
* original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search.
|
|
993
|
+
*/
|
|
994
|
+
priceEffectiveTime?: string;
|
|
995
|
+
/**
|
|
996
|
+
* The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is
|
|
997
|
+
* used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search.
|
|
998
|
+
*/
|
|
999
|
+
priceExpireTime?: string;
|
|
1000
|
+
/**
|
|
1001
|
+
* Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products.
|
|
1002
|
+
* Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.
|
|
1003
|
+
*/
|
|
1004
|
+
priceRange?: GoogleCloudRetailV2PriceInfoPriceRange;
|
|
1005
|
+
}
|
|
1006
|
+
interface GoogleCloudRetailV2PriceInfoPriceRange {
|
|
1007
|
+
/** The inclusive Product.pricing_info.original_price internal of all variant Product having the same Product.primary_product_id. */
|
|
1008
|
+
originalPrice?: GoogleCloudRetailV2Interval;
|
|
1009
|
+
/** The inclusive Product.pricing_info.price interval of all variant Product having the same Product.primary_product_id. */
|
|
1010
|
+
price?: GoogleCloudRetailV2Interval;
|
|
1011
|
+
}
|
|
1012
|
+
interface GoogleCloudRetailV2Product {
|
|
1013
|
+
/**
|
|
1014
|
+
* Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals
|
|
1015
|
+
* for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be
|
|
1016
|
+
* set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product,
|
|
1017
|
+
* or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field
|
|
1018
|
+
* needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128
|
|
1019
|
+
* characters. * For indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400 values are
|
|
1020
|
+
* allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are
|
|
1021
|
+
* allowed.
|
|
1022
|
+
*/
|
|
1023
|
+
attributes?: { [P in string]: GoogleCloudRetailV2CustomAttribute };
|
|
1024
|
+
/** The target group associated with a given audience (e.g. male, veterans, car owners, musicians, etc.) of the product. */
|
|
1025
|
+
audience?: GoogleCloudRetailV2Audience;
|
|
1026
|
+
/**
|
|
1027
|
+
* The online availability of the Product. Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property
|
|
1028
|
+
* [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).
|
|
1029
|
+
*/
|
|
1030
|
+
availability?: string;
|
|
1031
|
+
/** The available quantity of the item. */
|
|
1032
|
+
availableQuantity?: number;
|
|
1033
|
+
/** The timestamp when this Product becomes available for SearchService.Search. */
|
|
1034
|
+
availableTime?: string;
|
|
1035
|
+
/**
|
|
1036
|
+
* The brands of the product. A maximum of 30 brands are allowed. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT
|
|
1037
|
+
* error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property
|
|
1038
|
+
* [Product.brand](https://schema.org/brand).
|
|
1039
|
+
*/
|
|
1040
|
+
brands?: string[];
|
|
1041
|
+
/**
|
|
1042
|
+
* Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search /
|
|
1043
|
+
* recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other
|
|
1044
|
+
* character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented
|
|
1045
|
+
* as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is
|
|
1046
|
+
* returned. At most 250 values are allowed per Product. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an
|
|
1047
|
+
* INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property [Product.category]
|
|
1048
|
+
* (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436
|
|
1049
|
+
*/
|
|
1050
|
+
categories?: string[];
|
|
1051
|
+
/**
|
|
1052
|
+
* The id of the collection members when type is Type.COLLECTION. Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an
|
|
1053
|
+
* INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.
|
|
1054
|
+
*/
|
|
1055
|
+
collectionMemberIds?: string[];
|
|
1056
|
+
/**
|
|
1057
|
+
* The color of the product. Corresponding properties: Google Merchant Center property [color](https://support.google.com/merchants/answer/6324487). Schema.org property
|
|
1058
|
+
* [Product.color](https://schema.org/color).
|
|
1059
|
+
*/
|
|
1060
|
+
colorInfo?: GoogleCloudRetailV2ColorInfo;
|
|
1061
|
+
/**
|
|
1062
|
+
* The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per Product. Each value must be a UTF-8
|
|
1063
|
+
* encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property
|
|
1064
|
+
* [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition).
|
|
1065
|
+
*/
|
|
1066
|
+
conditions?: string[];
|
|
1067
|
+
/**
|
|
1068
|
+
* Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
|
|
1069
|
+
* Google Merchant Center property [description](https://support.google.com/merchants/answer/6324468). Schema.org property [Product.description](https://schema.org/description).
|
|
1070
|
+
*/
|
|
1071
|
+
description?: string;
|
|
1072
|
+
/**
|
|
1073
|
+
* The timestamp when this product becomes unavailable for SearchService.Search. If it is set, the Product is not available for SearchService.Search after expire_time. However, the
|
|
1074
|
+
* product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. expire_time must be later than available_time and publish_time, otherwise an
|
|
1075
|
+
* INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property [expiration_date](https://support.google.com/merchants/answer/6324499).
|
|
1076
|
+
*/
|
|
1077
|
+
expireTime?: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct FulfillmentInfo.type. Otherwise,
|
|
1080
|
+
* an INVALID_ARGUMENT error is returned.
|
|
1081
|
+
*/
|
|
1082
|
+
fulfillmentInfo?: GoogleCloudRetailV2FulfillmentInfo[];
|
|
1083
|
+
/**
|
|
1084
|
+
* The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is
|
|
1085
|
+
* returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property
|
|
1086
|
+
* [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [Product.gtin8](https://schema.org/gtin8),
|
|
1087
|
+
* [Product.gtin12](https://schema.org/gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an
|
|
1088
|
+
* INVALID_ARGUMENT error is returned.
|
|
1089
|
+
*/
|
|
1090
|
+
gtin?: string;
|
|
1091
|
+
/**
|
|
1092
|
+
* Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is
|
|
1093
|
+
* `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. This field must be a UTF-8 encoded string with a length limit of 128 characters.
|
|
1094
|
+
* Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [id](https://support.google.com/merchants/answer/6324405). Schema.org
|
|
1095
|
+
* property [Product.sku](https://schema.org/sku).
|
|
1096
|
+
*/
|
|
1097
|
+
id?: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property
|
|
1100
|
+
* [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).
|
|
1101
|
+
*/
|
|
1102
|
+
images?: GoogleCloudRetailV2Image[];
|
|
1103
|
+
/**
|
|
1104
|
+
* Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For product prediction, this
|
|
1105
|
+
* field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple
|
|
1106
|
+
* languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset.
|
|
1107
|
+
*/
|
|
1108
|
+
languageCode?: string;
|
|
1109
|
+
/**
|
|
1110
|
+
* The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters.
|
|
1111
|
+
* Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410).
|
|
1112
|
+
* Schema.org property [Product.material](https://schema.org/material).
|
|
1113
|
+
*/
|
|
1114
|
+
materials?: string[];
|
|
1115
|
+
/** Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. */
|
|
1116
|
+
name?: string;
|
|
1117
|
+
/**
|
|
1118
|
+
* The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded
|
|
1119
|
+
* string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property
|
|
1120
|
+
* [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern).
|
|
1121
|
+
*/
|
|
1122
|
+
patterns?: string[];
|
|
1123
|
+
/** Product price and cost information. Corresponding properties: Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). */
|
|
1124
|
+
priceInfo?: GoogleCloudRetailV2PriceInfo;
|
|
1125
|
+
/**
|
|
1126
|
+
* Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set
|
|
1127
|
+
* to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an
|
|
1128
|
+
* INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [item_group_id](https://support.google.com/merchants/answer/6324507). Schema.org
|
|
1129
|
+
* property [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
|
|
1130
|
+
*/
|
|
1131
|
+
primaryProductId?: string;
|
|
1132
|
+
/** The promotions applied to the product. A maximum of 10 values are allowed per Product. Only Promotion.promotion_id will be used, other fields will be ignored if set. */
|
|
1133
|
+
promotions?: GoogleCloudRetailV2Promotion[];
|
|
1134
|
+
/**
|
|
1135
|
+
* The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time,
|
|
1136
|
+
* given it purely describes product freshness regardless of when it is available on search and recommendation.
|
|
1137
|
+
*/
|
|
1138
|
+
publishTime?: string;
|
|
1139
|
+
/** The rating of this product. */
|
|
1140
|
+
rating?: GoogleCloudRetailV2Rating;
|
|
1141
|
+
/**
|
|
1142
|
+
* Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin *
|
|
1143
|
+
* materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported
|
|
1144
|
+
* fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom
|
|
1145
|
+
* attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the
|
|
1146
|
+
* following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more
|
|
1147
|
+
* fields in SearchResponse can increase response payload size and serving latency.
|
|
1148
|
+
*/
|
|
1149
|
+
retrievableFields?: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US"
|
|
1152
|
+
* represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32
|
|
1153
|
+
* inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a
|
|
1154
|
+
* length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property
|
|
1155
|
+
* [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and
|
|
1156
|
+
* [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size).
|
|
1157
|
+
*/
|
|
1158
|
+
sizes?: string[];
|
|
1159
|
+
/**
|
|
1160
|
+
* Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an
|
|
1161
|
+
* INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties:
|
|
1162
|
+
* Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473).
|
|
1163
|
+
*/
|
|
1164
|
+
tags?: string[];
|
|
1165
|
+
/**
|
|
1166
|
+
* Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding
|
|
1167
|
+
* properties: Google Merchant Center property [title](https://support.google.com/merchants/answer/6324415). Schema.org property [Product.name](https://schema.org/name).
|
|
1168
|
+
*/
|
|
1169
|
+
title?: string;
|
|
1170
|
+
/**
|
|
1171
|
+
* Input only. The TTL (time to live) of the product. If it is set, it must be a non-negative value, and expire_time is set as current timestamp plus ttl. The derived expire_time is
|
|
1172
|
+
* returned in the output and ttl is left blank when retrieving the Product. If it is set, the product is not available for SearchService.Search after current timestamp plus ttl.
|
|
1173
|
+
* However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts.
|
|
1174
|
+
*/
|
|
1175
|
+
ttl?: string;
|
|
1176
|
+
/** Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset. */
|
|
1177
|
+
type?: string;
|
|
1178
|
+
/**
|
|
1179
|
+
* Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be
|
|
1180
|
+
* significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding
|
|
1181
|
+
* properties: Google Merchant Center property [link](https://support.google.com/merchants/answer/6324416). Schema.org property [Offer.url](https://schema.org/url).
|
|
1182
|
+
*/
|
|
1183
|
+
uri?: string;
|
|
1184
|
+
/**
|
|
1185
|
+
* Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by primary_product_id for all the product
|
|
1186
|
+
* variants. Only populated for Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.
|
|
1187
|
+
*/
|
|
1188
|
+
variants?: GoogleCloudRetailV2Product[];
|
|
1189
|
+
}
|
|
1190
|
+
interface GoogleCloudRetailV2ProductDetail {
|
|
1191
|
+
/**
|
|
1192
|
+
* Required. Product information. Required field(s): * Product.id Optional override field(s): * Product.price_info If any supported optional fields are provided, we will treat them as
|
|
1193
|
+
* a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete. All other product fields
|
|
1194
|
+
* are ignored and instead populated via catalog lookup after event ingestion.
|
|
1195
|
+
*/
|
|
1196
|
+
product?: GoogleCloudRetailV2Product;
|
|
1197
|
+
/**
|
|
1198
|
+
* Quantity of the product associated with the user event. For example, this field will be 2 if two products are added to the shopping cart for `purchase-complete` event. Required for
|
|
1199
|
+
* `add-to-cart` and `purchase-complete` event types.
|
|
1200
|
+
*/
|
|
1201
|
+
quantity?: number;
|
|
1202
|
+
}
|
|
1203
|
+
interface GoogleCloudRetailV2ProductInlineSource {
|
|
1204
|
+
/** Required. A list of products to update/create. Each product must have a valid Product.id. Recommended max of 100 items. */
|
|
1205
|
+
products?: GoogleCloudRetailV2Product[];
|
|
1206
|
+
}
|
|
1207
|
+
interface GoogleCloudRetailV2ProductInputConfig {
|
|
1208
|
+
/** BigQuery input source. */
|
|
1209
|
+
bigQuerySource?: GoogleCloudRetailV2BigQuerySource;
|
|
1210
|
+
/** Google Cloud Storage location for the input content. */
|
|
1211
|
+
gcsSource?: GoogleCloudRetailV2GcsSource;
|
|
1212
|
+
/** The Inline source for the input content for products. */
|
|
1213
|
+
productInlineSource?: GoogleCloudRetailV2ProductInlineSource;
|
|
1214
|
+
}
|
|
1215
|
+
interface GoogleCloudRetailV2ProductLevelConfig {
|
|
1216
|
+
/**
|
|
1217
|
+
* The type of Products allowed to be ingested into the catalog. Acceptable values are: * `primary` (default): You can ingest Products of all types. When ingesting a Product, its type
|
|
1218
|
+
* will default to Product.Type.PRIMARY if unset. * `variant` (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means
|
|
1219
|
+
* Product.primary_product_id cannot be empty. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `variant` and
|
|
1220
|
+
* merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more
|
|
1221
|
+
* details.
|
|
1222
|
+
*/
|
|
1223
|
+
ingestionProductType?: string;
|
|
1224
|
+
/**
|
|
1225
|
+
* Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as Product.id. Acceptable values are: * `offerId` (default):
|
|
1226
|
+
* Import `offerId` as the product ID. * `itemGroupId`: Import `itemGroupId` as the product ID. Notice that Retail API will choose one item from the ones with the same `itemGroupId`,
|
|
1227
|
+
* and use it to represent the item group. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `itemGroupId` and
|
|
1228
|
+
* ingestion_product_type is `variant`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more details.
|
|
1229
|
+
*/
|
|
1230
|
+
merchantCenterProductIdField?: string;
|
|
1231
|
+
}
|
|
1232
|
+
interface GoogleCloudRetailV2Promotion {
|
|
1233
|
+
/**
|
|
1234
|
+
* Promotion identifier, which is the final component of name. For example, this field is "free_gift", if name is
|
|
1235
|
+
* `projects/*/locations/global/catalogs/default_catalog/promotions/free_gift`. The value must be a UTF-8 encoded string with a length limit of 128 characters, and match the pattern:
|
|
1236
|
+
* `a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to Google Merchant Center property
|
|
1237
|
+
* [promotion_id](https://support.google.com/merchants/answer/7050148).
|
|
1238
|
+
*/
|
|
1239
|
+
promotionId?: string;
|
|
1240
|
+
}
|
|
1241
|
+
interface GoogleCloudRetailV2PurchaseTransaction {
|
|
1242
|
+
/**
|
|
1243
|
+
* All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = revenue - tax -
|
|
1244
|
+
* cost
|
|
1245
|
+
*/
|
|
1246
|
+
cost?: number;
|
|
1247
|
+
/** Required. Currency code. Use three-character ISO-4217 code. */
|
|
1248
|
+
currencyCode?: string;
|
|
1249
|
+
/** The transaction ID with a length limit of 128 characters. */
|
|
1250
|
+
id?: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* Required. Total non-zero revenue or grand total associated with the transaction. This value include shipping, tax, or other adjustments to total revenue that you want to include as
|
|
1253
|
+
* part of your revenue calculations.
|
|
1254
|
+
*/
|
|
1255
|
+
revenue?: number;
|
|
1256
|
+
/** All the taxes associated with the transaction. */
|
|
1257
|
+
tax?: number;
|
|
1258
|
+
}
|
|
1259
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1260
|
+
interface GoogleCloudRetailV2PurgeMetadata {
|
|
1261
|
+
}
|
|
1262
|
+
interface GoogleCloudRetailV2PurgeUserEventsRequest {
|
|
1263
|
+
/**
|
|
1264
|
+
* Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. The eligible fields for filtering are: *
|
|
1265
|
+
* `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu" format. * `visitorId`: Double quoted string. Specifying this will delete all events
|
|
1266
|
+
* associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range:
|
|
1267
|
+
* `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType in time range: `eventTime > "2012-04-23T18:25:43.511Z" eventType =
|
|
1268
|
+
* "detail-page-view"` * Deleting all events for a specific visitor: `visitorId = "visitor1024"` The filtering fields are assumed to have an implicit AND.
|
|
1269
|
+
*/
|
|
1270
|
+
filter?: string;
|
|
1271
|
+
/** Actually perform the purge. If `force` is set to false, the method will return the expected purge count without deleting any user events. */
|
|
1272
|
+
force?: boolean;
|
|
1273
|
+
}
|
|
1274
|
+
interface GoogleCloudRetailV2PurgeUserEventsResponse {
|
|
1275
|
+
/** The total count of events purged as a result of the operation. */
|
|
1276
|
+
purgedEventsCount?: string;
|
|
1277
|
+
}
|
|
1278
|
+
interface GoogleCloudRetailV2Rating {
|
|
1279
|
+
/** The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
1280
|
+
averageRating?: number;
|
|
1281
|
+
/** The total number of ratings. This value is independent of the value of rating_histogram. This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
1282
|
+
ratingCount?: number;
|
|
1283
|
+
/**
|
|
1284
|
+
* List of rating counts per rating value (index = rating - 1). The list is empty if there is no rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT
|
|
1285
|
+
* error is returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1 star, 14 ratings with 2 star, and so on.
|
|
1286
|
+
*/
|
|
1287
|
+
ratingHistogram?: number[];
|
|
1288
|
+
}
|
|
1289
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1290
|
+
interface GoogleCloudRetailV2RejoinUserEventsMetadata {
|
|
1291
|
+
}
|
|
1292
|
+
interface GoogleCloudRetailV2RejoinUserEventsRequest {
|
|
1293
|
+
/**
|
|
1294
|
+
* The type of the user event rejoin to define the scope and range of the user events to be rejoined with the latest product catalog. Defaults to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if
|
|
1295
|
+
* this field is not set, or set to an invalid integer value.
|
|
1296
|
+
*/
|
|
1297
|
+
userEventRejoinScope?: string;
|
|
1298
|
+
}
|
|
1299
|
+
interface GoogleCloudRetailV2RejoinUserEventsResponse {
|
|
1300
|
+
/** Number of user events that were joined with latest product catalog. */
|
|
1301
|
+
rejoinedUserEventsCount?: string;
|
|
1302
|
+
}
|
|
1303
|
+
interface GoogleCloudRetailV2RemoveCatalogAttributeRequest {
|
|
1304
|
+
/** Required. The attribute name key of the CatalogAttribute to remove. */
|
|
1305
|
+
key?: string;
|
|
1306
|
+
}
|
|
1307
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1308
|
+
interface GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata {
|
|
1309
|
+
}
|
|
1310
|
+
interface GoogleCloudRetailV2RemoveFulfillmentPlacesRequest {
|
|
1311
|
+
/**
|
|
1312
|
+
* If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to
|
|
1313
|
+
* false, a NOT_FOUND error is returned if the Product is not found.
|
|
1314
|
+
*/
|
|
1315
|
+
allowMissing?: boolean;
|
|
1316
|
+
/**
|
|
1317
|
+
* Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery", to be removed for this type. At least 1 value is required,
|
|
1318
|
+
* and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2".
|
|
1319
|
+
* Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1320
|
+
*/
|
|
1321
|
+
placeIds?: string[];
|
|
1322
|
+
/** The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used. */
|
|
1323
|
+
removeTime?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Supported values: * "pickup-in-store" *
|
|
1326
|
+
* "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an
|
|
1327
|
+
* invalid value other than these, an INVALID_ARGUMENT error is returned. This field directly corresponds to Product.fulfillment_info.type.
|
|
1328
|
+
*/
|
|
1329
|
+
type?: string;
|
|
1330
|
+
}
|
|
1331
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1332
|
+
interface GoogleCloudRetailV2RemoveFulfillmentPlacesResponse {
|
|
1333
|
+
}
|
|
1334
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1335
|
+
interface GoogleCloudRetailV2RemoveLocalInventoriesMetadata {
|
|
1336
|
+
}
|
|
1337
|
+
interface GoogleCloudRetailV2RemoveLocalInventoriesRequest {
|
|
1338
|
+
/**
|
|
1339
|
+
* If set to true, and the Product is not found, the local inventory removal request will still be processed and retained for at most 1 day and processed once the Product is created.
|
|
1340
|
+
* If set to false, a NOT_FOUND error is returned if the Product is not found.
|
|
1341
|
+
*/
|
|
1342
|
+
allowMissing?: boolean;
|
|
1343
|
+
/** Required. A list of place IDs to have their inventory deleted. At most 3000 place IDs are allowed per request. */
|
|
1344
|
+
placeIds?: string[];
|
|
1345
|
+
/**
|
|
1346
|
+
* The time when the inventory deletions are issued. Used to prevent out-of-order updates and deletions on local inventory fields. If not provided, the internal system time will be
|
|
1347
|
+
* used.
|
|
1348
|
+
*/
|
|
1349
|
+
removeTime?: string;
|
|
1350
|
+
}
|
|
1351
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1352
|
+
interface GoogleCloudRetailV2RemoveLocalInventoriesResponse {
|
|
1353
|
+
}
|
|
1354
|
+
interface GoogleCloudRetailV2SearchRequest {
|
|
1355
|
+
/**
|
|
1356
|
+
* Boost specification to boost certain products. See more details at this [user guide](https://cloud.google.com/retail/docs/boosting). Notice that if both
|
|
1357
|
+
* ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the
|
|
1358
|
+
* final boost score is equal to the sum of the boost scores from all matched boost conditions.
|
|
1359
|
+
*/
|
|
1360
|
+
boostSpec?: GoogleCloudRetailV2SearchRequestBoostSpec;
|
|
1361
|
+
/**
|
|
1362
|
+
* The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or leave this field empty, to search
|
|
1363
|
+
* products under the default branch.
|
|
1364
|
+
*/
|
|
1365
|
+
branch?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement
|
|
1368
|
+
* such as query expansion is needed. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of
|
|
1369
|
+
* the original query. This field is strongly recommended to achieve high search quality. See SearchRequest.filter for more details about filter syntax.
|
|
1370
|
+
*/
|
|
1371
|
+
canonicalFilter?: string;
|
|
1372
|
+
/**
|
|
1373
|
+
* Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice
|
|
1374
|
+
* that only textual facets can be dynamically generated.
|
|
1375
|
+
*/
|
|
1376
|
+
dynamicFacetSpec?: GoogleCloudRetailV2SearchRequestDynamicFacetSpec;
|
|
1377
|
+
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
1378
|
+
facetSpecs?: GoogleCloudRetailV2SearchRequestFacetSpec[];
|
|
1379
|
+
/**
|
|
1380
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. See
|
|
1381
|
+
* more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#filter). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
1382
|
+
*/
|
|
1383
|
+
filter?: string;
|
|
1384
|
+
/**
|
|
1385
|
+
* The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys
|
|
1386
|
+
* have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can
|
|
1387
|
+
* contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a
|
|
1388
|
+
* label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud
|
|
1389
|
+
* Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
|
|
1390
|
+
*/
|
|
1391
|
+
labels?: { [P in string]: string };
|
|
1392
|
+
/**
|
|
1393
|
+
* A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results. This field is only
|
|
1394
|
+
* considered if page_token is unset. If this field is negative, an INVALID_ARGUMENT is returned.
|
|
1395
|
+
*/
|
|
1396
|
+
offset?: number;
|
|
1397
|
+
/**
|
|
1398
|
+
* The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. See
|
|
1399
|
+
* more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#order). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
1400
|
+
*/
|
|
1401
|
+
orderBy?: string;
|
|
1402
|
+
/**
|
|
1403
|
+
* The categories associated with a category page. Required for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
|
|
1404
|
+
* To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). Category pages
|
|
1405
|
+
* include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
|
|
1406
|
+
*/
|
|
1407
|
+
pageCategories?: string[];
|
|
1408
|
+
/**
|
|
1409
|
+
* Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 120. Values above 120 will be coerced to 120. If this field is
|
|
1410
|
+
* negative, an INVALID_ARGUMENT is returned.
|
|
1411
|
+
*/
|
|
1412
|
+
pageSize?: number;
|
|
1413
|
+
/**
|
|
1414
|
+
* A page token SearchResponse.next_page_token, received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters
|
|
1415
|
+
* provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1416
|
+
*/
|
|
1417
|
+
pageToken?: string;
|
|
1418
|
+
/** The specification for personalization. */
|
|
1419
|
+
personalizationSpec?: GoogleCloudRetailV2SearchRequestPersonalizationSpec;
|
|
1420
|
+
/** Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories. */
|
|
1421
|
+
query?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this [user
|
|
1424
|
+
* guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
|
|
1425
|
+
*/
|
|
1426
|
+
queryExpansionSpec?: GoogleCloudRetailV2SearchRequestQueryExpansionSpec;
|
|
1427
|
+
/** The search mode of the search request. If not specified, a single search request triggers both product search and faceted search. */
|
|
1428
|
+
searchMode?: string;
|
|
1429
|
+
/** The spell correction specification that specifies the mode under which spell correction will take effect. */
|
|
1430
|
+
spellCorrectionSpec?: GoogleCloudRetailV2SearchRequestSpellCorrectionSpec;
|
|
1431
|
+
/** User information. */
|
|
1432
|
+
userInfo?: GoogleCloudRetailV2UserInfo;
|
|
1433
|
+
/**
|
|
1434
|
+
* The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or
|
|
1435
|
+
* LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For FulfillmentInfo, a fulfillment type
|
|
1436
|
+
* and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the
|
|
1437
|
+
* store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * variantId * inventory(place_id,price) * inventory(place_id,original_price) *
|
|
1438
|
+
* inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map. * attributes.key, where key is any key in the Product.attributes map. *
|
|
1439
|
+
* pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". * shipToStore.id, where id is any FulfillmentInfo.place_ids for
|
|
1440
|
+
* FulfillmentInfo.type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id, where id is
|
|
1441
|
+
* any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type
|
|
1442
|
+
* "custom-type-1". * customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". * customFulfillment3.id, where id is any
|
|
1443
|
+
* FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
|
|
1444
|
+
* customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5". If this field is set to an invalid value other than these, an
|
|
1445
|
+
* INVALID_ARGUMENT error is returned.
|
|
1446
|
+
*/
|
|
1447
|
+
variantRollupKeys?: string[];
|
|
1448
|
+
/**
|
|
1449
|
+
* Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single
|
|
1450
|
+
* device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8
|
|
1451
|
+
* encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1452
|
+
*/
|
|
1453
|
+
visitorId?: string;
|
|
1454
|
+
}
|
|
1455
|
+
interface GoogleCloudRetailV2SearchRequestBoostSpec {
|
|
1456
|
+
/**
|
|
1457
|
+
* Condition boost specifications. If a product matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear
|
|
1458
|
+
* way. Maximum number of specifications is 20.
|
|
1459
|
+
*/
|
|
1460
|
+
conditionBoostSpecs?: GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec[];
|
|
1461
|
+
/**
|
|
1462
|
+
* Whether to skip boostspec validation. If this field is set to true, invalid BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will still be
|
|
1463
|
+
* applied.
|
|
1464
|
+
*/
|
|
1465
|
+
skipBoostSpecValidation?: boolean;
|
|
1466
|
+
}
|
|
1467
|
+
interface GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec {
|
|
1468
|
+
/**
|
|
1469
|
+
* Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not
|
|
1470
|
+
* necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the
|
|
1471
|
+
* condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big
|
|
1472
|
+
* demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely.
|
|
1473
|
+
* Setting to 0.0 means no boost applied. The boosting condition is ignored.
|
|
1474
|
+
*/
|
|
1475
|
+
boost?: number;
|
|
1476
|
+
/**
|
|
1477
|
+
* An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.
|
|
1478
|
+
* Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": * (id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red","Blue"))
|
|
1479
|
+
*/
|
|
1480
|
+
condition?: string;
|
|
1481
|
+
}
|
|
1482
|
+
interface GoogleCloudRetailV2SearchRequestDynamicFacetSpec {
|
|
1483
|
+
/** Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset. */
|
|
1484
|
+
mode?: string;
|
|
1485
|
+
}
|
|
1486
|
+
interface GoogleCloudRetailV2SearchRequestFacetSpec {
|
|
1487
|
+
/**
|
|
1488
|
+
* Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered
|
|
1489
|
+
* together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked
|
|
1490
|
+
* before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to
|
|
1491
|
+
* always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google
|
|
1492
|
+
* Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false *
|
|
1493
|
+
* "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be
|
|
1494
|
+
* ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that
|
|
1495
|
+
* "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.
|
|
1496
|
+
*/
|
|
1497
|
+
enableDynamicPosition?: boolean;
|
|
1498
|
+
/**
|
|
1499
|
+
* List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its
|
|
1500
|
+
* values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there
|
|
1501
|
+
* are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
|
|
1502
|
+
* FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products
|
|
1503
|
+
* available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100
|
|
1504
|
+
* and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly
|
|
1505
|
+
* filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1506
|
+
*/
|
|
1507
|
+
excludedFilterKeys?: string[];
|
|
1508
|
+
/** Required. The facet key specification. */
|
|
1509
|
+
facetKey?: GoogleCloudRetailV2SearchRequestFacetSpecFacetKey;
|
|
1510
|
+
/**
|
|
1511
|
+
* Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this
|
|
1512
|
+
* field is negative, an INVALID_ARGUMENT is returned.
|
|
1513
|
+
*/
|
|
1514
|
+
limit?: number;
|
|
1515
|
+
}
|
|
1516
|
+
interface GoogleCloudRetailV2SearchRequestFacetSpecFacetKey {
|
|
1517
|
+
/** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
|
|
1518
|
+
caseInsensitive?: boolean;
|
|
1519
|
+
/**
|
|
1520
|
+
* Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to
|
|
1521
|
+
* "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
|
|
1522
|
+
*/
|
|
1523
|
+
contains?: string[];
|
|
1524
|
+
/** Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */
|
|
1525
|
+
intervals?: GoogleCloudRetailV2Interval[];
|
|
1526
|
+
/**
|
|
1527
|
+
* Required. Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query
|
|
1528
|
+
* is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" *
|
|
1529
|
+
* "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" *
|
|
1530
|
+
* "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" *
|
|
1531
|
+
* "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
|
|
1532
|
+
*/
|
|
1533
|
+
key?: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc",
|
|
1536
|
+
* which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural
|
|
1537
|
+
* order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in
|
|
1538
|
+
* the order given by FacetSpec.FacetKey.restricted_values.
|
|
1539
|
+
*/
|
|
1540
|
+
orderBy?: string;
|
|
1541
|
+
/**
|
|
1542
|
+
* Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes"
|
|
1543
|
+
* to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
|
|
1544
|
+
*/
|
|
1545
|
+
prefixes?: string[];
|
|
1546
|
+
/**
|
|
1547
|
+
* The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter
|
|
1548
|
+
* expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response,
|
|
1549
|
+
* SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query. For example, you can set a customized
|
|
1550
|
+
* facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet will
|
|
1551
|
+
* count the products that are both in stock and ship to store "123".
|
|
1552
|
+
*/
|
|
1553
|
+
query?: string;
|
|
1554
|
+
/**
|
|
1555
|
+
* Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and
|
|
1556
|
+
* "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: *
|
|
1557
|
+
* pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
|
|
1558
|
+
*/
|
|
1559
|
+
restrictedValues?: string[];
|
|
1560
|
+
/** Returns the min and max value for each numerical facet intervals. Ignored for textual facets. */
|
|
1561
|
+
returnMinMax?: boolean;
|
|
1562
|
+
}
|
|
1563
|
+
interface GoogleCloudRetailV2SearchRequestPersonalizationSpec {
|
|
1564
|
+
/** Defaults to Mode.AUTO. */
|
|
1565
|
+
mode?: string;
|
|
1566
|
+
}
|
|
1567
|
+
interface GoogleCloudRetailV2SearchRequestQueryExpansionSpec {
|
|
1568
|
+
/** The condition under which query expansion should occur. Default to Condition.DISABLED. */
|
|
1569
|
+
condition?: string;
|
|
1570
|
+
/** Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */
|
|
1571
|
+
pinUnexpandedResults?: boolean;
|
|
1572
|
+
}
|
|
1573
|
+
interface GoogleCloudRetailV2SearchRequestSpellCorrectionSpec {
|
|
1574
|
+
/** The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. */
|
|
1575
|
+
mode?: string;
|
|
1576
|
+
}
|
|
1577
|
+
interface GoogleCloudRetailV2SearchResponse {
|
|
1578
|
+
/** The fully qualified resource name of applied [controls](https://cloud.google.com/retail/docs/serving-control-rules). */
|
|
1579
|
+
appliedControls?: string[];
|
|
1580
|
+
/** A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. */
|
|
1581
|
+
attributionToken?: string;
|
|
1582
|
+
/**
|
|
1583
|
+
* Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used
|
|
1584
|
+
* for search.
|
|
1585
|
+
*/
|
|
1586
|
+
correctedQuery?: string;
|
|
1587
|
+
/** Results of facets requested by user. */
|
|
1588
|
+
facets?: GoogleCloudRetailV2SearchResponseFacet[];
|
|
1589
|
+
/** The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving. */
|
|
1590
|
+
invalidConditionBoostSpecs?: GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec[];
|
|
1591
|
+
/** A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
1592
|
+
nextPageToken?: string;
|
|
1593
|
+
/** Query expansion information for the returned results. */
|
|
1594
|
+
queryExpansionInfo?: GoogleCloudRetailV2SearchResponseQueryExpansionInfo;
|
|
1595
|
+
/** The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. */
|
|
1596
|
+
redirectUri?: string;
|
|
1597
|
+
/** A list of matched items. The order represents the ranking. */
|
|
1598
|
+
results?: GoogleCloudRetailV2SearchResponseSearchResult[];
|
|
1599
|
+
/** The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */
|
|
1600
|
+
totalSize?: number;
|
|
1601
|
+
}
|
|
1602
|
+
interface GoogleCloudRetailV2SearchResponseFacet {
|
|
1603
|
+
/** Whether the facet is dynamically generated. */
|
|
1604
|
+
dynamicFacet?: boolean;
|
|
1605
|
+
/** The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1". */
|
|
1606
|
+
key?: string;
|
|
1607
|
+
/** The facet values for this field. */
|
|
1608
|
+
values?: GoogleCloudRetailV2SearchResponseFacetFacetValue[];
|
|
1609
|
+
}
|
|
1610
|
+
interface GoogleCloudRetailV2SearchResponseFacetFacetValue {
|
|
1611
|
+
/** Number of items that have this facet value. */
|
|
1612
|
+
count?: string;
|
|
1613
|
+
/** Interval value for a facet, such as [10, 20) for facet "price". */
|
|
1614
|
+
interval?: GoogleCloudRetailV2Interval;
|
|
1615
|
+
/** The maximum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true. */
|
|
1616
|
+
maxValue?: number;
|
|
1617
|
+
/** The minimum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true. */
|
|
1618
|
+
minValue?: number;
|
|
1619
|
+
/** Text value of a facet, such as "Black" for facet "colorFamilies". */
|
|
1620
|
+
value?: string;
|
|
1621
|
+
}
|
|
1622
|
+
interface GoogleCloudRetailV2SearchResponseQueryExpansionInfo {
|
|
1623
|
+
/** Bool describing whether query expansion has occurred. */
|
|
1624
|
+
expandedQuery?: boolean;
|
|
1625
|
+
/** Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true. */
|
|
1626
|
+
pinnedResultCount?: string;
|
|
1627
|
+
}
|
|
1628
|
+
interface GoogleCloudRetailV2SearchResponseSearchResult {
|
|
1629
|
+
/** Product.id of the searched Product. */
|
|
1630
|
+
id?: string;
|
|
1631
|
+
/** The count of matched variant Products. */
|
|
1632
|
+
matchingVariantCount?: number;
|
|
1633
|
+
/**
|
|
1634
|
+
* If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product
|
|
1635
|
+
* fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1"
|
|
1636
|
+
* ColorInfo and the query.
|
|
1637
|
+
*/
|
|
1638
|
+
matchingVariantFields?: { [P in string]: string };
|
|
1639
|
+
/**
|
|
1640
|
+
* Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set only when
|
|
1641
|
+
* SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that this product has been purchased before.
|
|
1642
|
+
*/
|
|
1643
|
+
personalLabels?: string[];
|
|
1644
|
+
/**
|
|
1645
|
+
* The product data snippet in the search response. Only Product.name is guaranteed to be populated. Product.variants contains the product variants that match the search query. If
|
|
1646
|
+
* there are multiple product variants matching the query, top 5 most relevant product variants are returned and ordered by relevancy. If relevancy can be deternmined, use
|
|
1647
|
+
* matching_variant_fields to look up matched product variants fields. If relevancy cannot be determined, e.g. when searching "shoe" all products in a shoe product can be a match, 5
|
|
1648
|
+
* product variants are returned but order is meaningless.
|
|
1649
|
+
*/
|
|
1650
|
+
product?: GoogleCloudRetailV2Product;
|
|
1651
|
+
/**
|
|
1652
|
+
* The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated Product attributes. Notice that
|
|
1653
|
+
* the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is returned. For textual and numerical
|
|
1654
|
+
* attributes, the rollup values is a list of string or double values with type google.protobuf.ListValue. For example, if there are two variants with colors "red" and "blue", the
|
|
1655
|
+
* rollup values are { key: "colorFamilies" value { list_value { values { string_value: "red" } values { string_value: "blue" } } } } For FulfillmentInfo, the rollup values is a double
|
|
1656
|
+
* value with type google.protobuf.Value. For example, `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there are 10 variants in this product are available in the
|
|
1657
|
+
* store "store1".
|
|
1658
|
+
*/
|
|
1659
|
+
variantRollupValues?: { [P in string]: any };
|
|
1660
|
+
}
|
|
1661
|
+
interface GoogleCloudRetailV2SetDefaultBranchRequest {
|
|
1662
|
+
/**
|
|
1663
|
+
* The final component of the resource name of a branch. This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned. If there are no sufficient active
|
|
1664
|
+
* products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
|
|
1665
|
+
*/
|
|
1666
|
+
branchId?: string;
|
|
1667
|
+
/** If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products. */
|
|
1668
|
+
force?: boolean;
|
|
1669
|
+
/**
|
|
1670
|
+
* Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs. This field must be a UTF-8 encoded string with a
|
|
1671
|
+
* length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1672
|
+
*/
|
|
1673
|
+
note?: string;
|
|
1674
|
+
}
|
|
1675
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1676
|
+
interface GoogleCloudRetailV2SetInventoryMetadata {
|
|
1677
|
+
}
|
|
1678
|
+
interface GoogleCloudRetailV2SetInventoryRequest {
|
|
1679
|
+
/**
|
|
1680
|
+
* If set to true, and the Product with name Product.name is not found, the inventory update will still be processed and retained for at most 1 day until the Product is created. If set
|
|
1681
|
+
* to false, a NOT_FOUND error is returned if the Product is not found.
|
|
1682
|
+
*/
|
|
1683
|
+
allowMissing?: boolean;
|
|
1684
|
+
/**
|
|
1685
|
+
* Required. The inventory information to update. The allowable fields to update are: * Product.price_info * Product.availability * Product.available_quantity *
|
|
1686
|
+
* Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask. If SetInventoryRequest.inventory.name is empty or invalid, an
|
|
1687
|
+
* INVALID_ARGUMENT error is returned. If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED
|
|
1688
|
+
* error is returned. If the Product to update does not have existing inventory information, the provided inventory information will be inserted. If the Product to update has existing
|
|
1689
|
+
* inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for
|
|
1690
|
+
* SetInventoryRequest.set_time. The caller can replace place IDs for a subset of fulfillment types in the following ways: * Adds "fulfillment_info" in SetInventoryRequest.set_mask *
|
|
1691
|
+
* Specifies only the desired fulfillment types and corresponding place IDs to update in SetInventoryRequest.inventory.fulfillment_info The caller can clear all place IDs from a subset
|
|
1692
|
+
* of fulfillment types in the following ways: * Adds "fulfillment_info" in SetInventoryRequest.set_mask * Specifies only the desired fulfillment types to clear in
|
|
1693
|
+
* SetInventoryRequest.inventory.fulfillment_info * Checks that only the desired fulfillment info types have empty SetInventoryRequest.inventory.fulfillment_info.place_ids The last
|
|
1694
|
+
* update time is recorded for the following inventory fields: * Product.price_info * Product.availability * Product.available_quantity * Product.fulfillment_info If a full overwrite
|
|
1695
|
+
* of inventory information while ignoring timestamps is needed, ProductService.UpdateProduct should be invoked instead.
|
|
1696
|
+
*/
|
|
1697
|
+
inventory?: GoogleCloudRetailV2Product;
|
|
1698
|
+
/**
|
|
1699
|
+
* Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is
|
|
1700
|
+
* returned and the entire update will be ignored.
|
|
1701
|
+
*/
|
|
1702
|
+
setMask?: string;
|
|
1703
|
+
/**
|
|
1704
|
+
* The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be
|
|
1705
|
+
* used.
|
|
1706
|
+
*/
|
|
1707
|
+
setTime?: string;
|
|
1708
|
+
}
|
|
1709
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1710
|
+
interface GoogleCloudRetailV2SetInventoryResponse {
|
|
1711
|
+
}
|
|
1712
|
+
interface GoogleCloudRetailV2UserEvent {
|
|
1713
|
+
/**
|
|
1714
|
+
* Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate
|
|
1715
|
+
* with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those
|
|
1716
|
+
* custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an
|
|
1717
|
+
* INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty
|
|
1718
|
+
* values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product
|
|
1719
|
+
* recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly,
|
|
1720
|
+
* coming through Google search, or in other ways.
|
|
1721
|
+
*/
|
|
1722
|
+
attributes?: { [P in string]: GoogleCloudRetailV2CustomAttribute };
|
|
1723
|
+
/**
|
|
1724
|
+
* Highly recommended for user events that are the result of PredictionService.Predict. This field enables accurate attribution of recommendation model performance. The value must be a
|
|
1725
|
+
* valid PredictResponse.attribution_token for user events that are the result of PredictionService.Predict. The value must be a valid SearchResponse.attribution_token for user events
|
|
1726
|
+
* that are the result of SearchService.Search. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing
|
|
1727
|
+
* this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When
|
|
1728
|
+
* recording events on product K's page, log the PredictResponse.attribution_token to this field.
|
|
1729
|
+
*/
|
|
1730
|
+
attributionToken?: string;
|
|
1731
|
+
/**
|
|
1732
|
+
* The ID or name of the associated shopping cart. This ID is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`,
|
|
1733
|
+
* `purchase-complete`, or `shopping-cart-page-view` events.
|
|
1734
|
+
*/
|
|
1735
|
+
cartId?: string;
|
|
1736
|
+
/** The main auto-completion details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
|
|
1737
|
+
completionDetail?: GoogleCloudRetailV2CompletionDetail;
|
|
1738
|
+
/** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
|
|
1739
|
+
eventTime?: string;
|
|
1740
|
+
/**
|
|
1741
|
+
* Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. *
|
|
1742
|
+
* `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-not-offered`: Promotion is
|
|
1743
|
+
* not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.
|
|
1744
|
+
*/
|
|
1745
|
+
eventType?: string;
|
|
1746
|
+
/**
|
|
1747
|
+
* A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups
|
|
1748
|
+
* (e.g. using Retail API, using different recommendation models).
|
|
1749
|
+
*/
|
|
1750
|
+
experimentIds?: string[];
|
|
1751
|
+
/**
|
|
1752
|
+
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and
|
|
1753
|
+
* syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1754
|
+
*/
|
|
1755
|
+
filter?: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for
|
|
1758
|
+
* definition. If this field is negative, an INVALID_ARGUMENT is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an
|
|
1759
|
+
* INVALID_ARGUMENT error is returned.
|
|
1760
|
+
*/
|
|
1761
|
+
offset?: number;
|
|
1762
|
+
/**
|
|
1763
|
+
* The order in which products are returned. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters.
|
|
1764
|
+
* Otherwise, an INVALID_ARGUMENT error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is
|
|
1765
|
+
* returned.
|
|
1766
|
+
*/
|
|
1767
|
+
orderBy?: string;
|
|
1768
|
+
/**
|
|
1769
|
+
* The categories associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please
|
|
1770
|
+
* replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy:
|
|
1771
|
+
* "pageCategories" : ["Sales > 2017 Black Friday Deals"]. Required for `category-page-view` events. At least one of search_query or page_categories is required for `search` events.
|
|
1772
|
+
* Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1773
|
+
*/
|
|
1774
|
+
pageCategories?: string[];
|
|
1775
|
+
/**
|
|
1776
|
+
* A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple
|
|
1777
|
+
* events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. When using the client
|
|
1778
|
+
* side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
|
|
1779
|
+
*/
|
|
1780
|
+
pageViewId?: string;
|
|
1781
|
+
/**
|
|
1782
|
+
* The main product details related to the event. This field is optional except for the following event types: * `add-to-cart` * `detail-page-view` * `purchase-complete` In a `search`
|
|
1783
|
+
* event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned
|
|
1784
|
+
* to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different product_details is desired. The end user may have not finished
|
|
1785
|
+
* browsing the whole page yet.
|
|
1786
|
+
*/
|
|
1787
|
+
productDetails?: GoogleCloudRetailV2ProductDetail[];
|
|
1788
|
+
/**
|
|
1789
|
+
* A transaction represents the entire purchase transaction. Required for `purchase-complete` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error
|
|
1790
|
+
* is returned.
|
|
1791
|
+
*/
|
|
1792
|
+
purchaseTransaction?: GoogleCloudRetailV2PurchaseTransaction;
|
|
1793
|
+
/** The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. */
|
|
1794
|
+
referrerUri?: string;
|
|
1795
|
+
/**
|
|
1796
|
+
* The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT
|
|
1797
|
+
* error is returned. At least one of search_query or page_categories is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error
|
|
1798
|
+
* is returned.
|
|
1799
|
+
*/
|
|
1800
|
+
searchQuery?: string;
|
|
1801
|
+
/**
|
|
1802
|
+
* A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to
|
|
1803
|
+
* populate the sesion_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add
|
|
1804
|
+
* visitor_id as prefix.
|
|
1805
|
+
*/
|
|
1806
|
+
sessionId?: string;
|
|
1807
|
+
/**
|
|
1808
|
+
* Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in
|
|
1809
|
+
* automatically. Maximum length 5,000 characters.
|
|
1810
|
+
*/
|
|
1811
|
+
uri?: string;
|
|
1812
|
+
/** User information. */
|
|
1813
|
+
userInfo?: GoogleCloudRetailV2UserInfo;
|
|
1814
|
+
/**
|
|
1815
|
+
* Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single
|
|
1816
|
+
* device. This unique identifier should not change if the visitor log in/out of the website. Don't set the field to the same fixed ID for different users. This mixes the event history
|
|
1817
|
+
* of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
|
|
1818
|
+
* error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client
|
|
1819
|
+
* ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
|
|
1820
|
+
*/
|
|
1821
|
+
visitorId?: string;
|
|
1822
|
+
}
|
|
1823
|
+
interface GoogleCloudRetailV2UserEventImportSummary {
|
|
1824
|
+
/** Count of user events imported with complete existing catalog information. */
|
|
1825
|
+
joinedEventsCount?: string;
|
|
1826
|
+
/** Count of user events imported, but with catalog information not found in the imported catalog. */
|
|
1827
|
+
unjoinedEventsCount?: string;
|
|
1828
|
+
}
|
|
1829
|
+
interface GoogleCloudRetailV2UserEventInlineSource {
|
|
1830
|
+
/** Required. A list of user events to import. Recommended max of 10k items. */
|
|
1831
|
+
userEvents?: GoogleCloudRetailV2UserEvent[];
|
|
1832
|
+
}
|
|
1833
|
+
interface GoogleCloudRetailV2UserEventInputConfig {
|
|
1834
|
+
/** Required. BigQuery input source. */
|
|
1835
|
+
bigQuerySource?: GoogleCloudRetailV2BigQuerySource;
|
|
1836
|
+
/** Required. Google Cloud Storage location for the input content. */
|
|
1837
|
+
gcsSource?: GoogleCloudRetailV2GcsSource;
|
|
1838
|
+
/** Required. The Inline source for the input content for UserEvents. */
|
|
1839
|
+
userEventInlineSource?: GoogleCloudRetailV2UserEventInlineSource;
|
|
1840
|
+
}
|
|
1841
|
+
interface GoogleCloudRetailV2UserInfo {
|
|
1842
|
+
/**
|
|
1843
|
+
* True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API
|
|
1844
|
+
* request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the
|
|
1845
|
+
* JavaScript tag in UserEventService.CollectUserEvent.
|
|
1846
|
+
*/
|
|
1847
|
+
directUserRequest?: boolean;
|
|
1848
|
+
/**
|
|
1849
|
+
* The end user's IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address
|
|
1850
|
+
* (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when: * setting SearchRequest.user_info. * using the
|
|
1851
|
+
* JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
|
|
1852
|
+
*/
|
|
1853
|
+
ipAddress?: string;
|
|
1854
|
+
/**
|
|
1855
|
+
* User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters.
|
|
1856
|
+
* Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent
|
|
1857
|
+
* or if direct_user_request is set.
|
|
1858
|
+
*/
|
|
1859
|
+
userAgent?: string;
|
|
1860
|
+
/**
|
|
1861
|
+
* Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set
|
|
1862
|
+
* the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded
|
|
1863
|
+
* string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
1864
|
+
*/
|
|
1865
|
+
userId?: string;
|
|
1866
|
+
}
|
|
1867
|
+
interface GoogleLongrunningListOperationsResponse {
|
|
1868
|
+
/** The standard List next-page token. */
|
|
1869
|
+
nextPageToken?: string;
|
|
1870
|
+
/** A list of operations that matches the specified filter in the request. */
|
|
1871
|
+
operations?: GoogleLongrunningOperation[];
|
|
1872
|
+
}
|
|
1873
|
+
interface GoogleLongrunningOperation {
|
|
1874
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
1875
|
+
done?: boolean;
|
|
1876
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
1877
|
+
error?: GoogleRpcStatus;
|
|
1878
|
+
/**
|
|
1879
|
+
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
|
|
1880
|
+
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
1881
|
+
*/
|
|
1882
|
+
metadata?: { [P in string]: any };
|
|
1883
|
+
/**
|
|
1884
|
+
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
|
|
1885
|
+
* with `operations/{unique_id}`.
|
|
1886
|
+
*/
|
|
1887
|
+
name?: string;
|
|
1888
|
+
/**
|
|
1889
|
+
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
1890
|
+
* original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
|
|
1891
|
+
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
1892
|
+
*/
|
|
1893
|
+
response?: { [P in string]: any };
|
|
1894
|
+
}
|
|
1895
|
+
// tslint:disable-next-line:no-empty-interface
|
|
1896
|
+
interface GoogleProtobufEmpty {
|
|
1897
|
+
}
|
|
1898
|
+
interface GoogleRpcStatus {
|
|
1899
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
1900
|
+
code?: number;
|
|
1901
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
1902
|
+
details?: Array<{ [P in string]: any }>;
|
|
1903
|
+
/**
|
|
1904
|
+
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
|
|
1905
|
+
* client.
|
|
1906
|
+
*/
|
|
1907
|
+
message?: string;
|
|
1908
|
+
}
|
|
1909
|
+
interface GoogleTypeDate {
|
|
1910
|
+
/** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
|
|
1911
|
+
day?: number;
|
|
1912
|
+
/** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
|
|
1913
|
+
month?: number;
|
|
1914
|
+
/** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
|
|
1915
|
+
year?: number;
|
|
1916
|
+
}
|
|
1917
|
+
interface AttributesConfigResource {
|
|
1918
|
+
/** Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned. */
|
|
1919
|
+
addCatalogAttribute(request: {
|
|
1920
|
+
/** V1 error format. */
|
|
1921
|
+
"$.xgafv"?: string;
|
|
1922
|
+
/** OAuth access token. */
|
|
1923
|
+
access_token?: string;
|
|
1924
|
+
/** Data format for response. */
|
|
1925
|
+
alt?: string;
|
|
1926
|
+
/** Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig` */
|
|
1927
|
+
attributesConfig: string;
|
|
1928
|
+
/** JSONP */
|
|
1929
|
+
callback?: string;
|
|
1930
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1931
|
+
fields?: string;
|
|
1932
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1933
|
+
key?: string;
|
|
1934
|
+
/** OAuth 2.0 token for the current user. */
|
|
1935
|
+
oauth_token?: string;
|
|
1936
|
+
/** Returns response with indentations and line breaks. */
|
|
1937
|
+
prettyPrint?: boolean;
|
|
1938
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1939
|
+
quotaUser?: string;
|
|
1940
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1941
|
+
upload_protocol?: string;
|
|
1942
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1943
|
+
uploadType?: string;
|
|
1944
|
+
/** Request body */
|
|
1945
|
+
resource: GoogleCloudRetailV2AddCatalogAttributeRequest;
|
|
1946
|
+
}): Request<GoogleCloudRetailV2AttributesConfig>;
|
|
1947
|
+
addCatalogAttribute(request: {
|
|
1948
|
+
/** V1 error format. */
|
|
1949
|
+
"$.xgafv"?: string;
|
|
1950
|
+
/** OAuth access token. */
|
|
1951
|
+
access_token?: string;
|
|
1952
|
+
/** Data format for response. */
|
|
1953
|
+
alt?: string;
|
|
1954
|
+
/** Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig` */
|
|
1955
|
+
attributesConfig: string;
|
|
1956
|
+
/** JSONP */
|
|
1957
|
+
callback?: string;
|
|
1958
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1959
|
+
fields?: string;
|
|
1960
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1961
|
+
key?: string;
|
|
1962
|
+
/** OAuth 2.0 token for the current user. */
|
|
1963
|
+
oauth_token?: string;
|
|
1964
|
+
/** Returns response with indentations and line breaks. */
|
|
1965
|
+
prettyPrint?: boolean;
|
|
1966
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1967
|
+
quotaUser?: string;
|
|
1968
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1969
|
+
upload_protocol?: string;
|
|
1970
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1971
|
+
uploadType?: string;
|
|
1972
|
+
},
|
|
1973
|
+
body: GoogleCloudRetailV2AddCatalogAttributeRequest): Request<GoogleCloudRetailV2AttributesConfig>;
|
|
1974
|
+
/** Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned. */
|
|
1975
|
+
removeCatalogAttribute(request: {
|
|
1976
|
+
/** V1 error format. */
|
|
1977
|
+
"$.xgafv"?: string;
|
|
1978
|
+
/** OAuth access token. */
|
|
1979
|
+
access_token?: string;
|
|
1980
|
+
/** Data format for response. */
|
|
1981
|
+
alt?: string;
|
|
1982
|
+
/** Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig` */
|
|
1983
|
+
attributesConfig: string;
|
|
1984
|
+
/** JSONP */
|
|
1985
|
+
callback?: string;
|
|
1986
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1987
|
+
fields?: string;
|
|
1988
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
1989
|
+
key?: string;
|
|
1990
|
+
/** OAuth 2.0 token for the current user. */
|
|
1991
|
+
oauth_token?: string;
|
|
1992
|
+
/** Returns response with indentations and line breaks. */
|
|
1993
|
+
prettyPrint?: boolean;
|
|
1994
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
1995
|
+
quotaUser?: string;
|
|
1996
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1997
|
+
upload_protocol?: string;
|
|
1998
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1999
|
+
uploadType?: string;
|
|
2000
|
+
/** Request body */
|
|
2001
|
+
resource: GoogleCloudRetailV2RemoveCatalogAttributeRequest;
|
|
2002
|
+
}): Request<GoogleCloudRetailV2AttributesConfig>;
|
|
2003
|
+
removeCatalogAttribute(request: {
|
|
2004
|
+
/** V1 error format. */
|
|
2005
|
+
"$.xgafv"?: string;
|
|
2006
|
+
/** OAuth access token. */
|
|
2007
|
+
access_token?: string;
|
|
2008
|
+
/** Data format for response. */
|
|
2009
|
+
alt?: string;
|
|
2010
|
+
/** Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig` */
|
|
2011
|
+
attributesConfig: string;
|
|
2012
|
+
/** JSONP */
|
|
2013
|
+
callback?: string;
|
|
2014
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2015
|
+
fields?: string;
|
|
2016
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2017
|
+
key?: string;
|
|
2018
|
+
/** OAuth 2.0 token for the current user. */
|
|
2019
|
+
oauth_token?: string;
|
|
2020
|
+
/** Returns response with indentations and line breaks. */
|
|
2021
|
+
prettyPrint?: boolean;
|
|
2022
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2023
|
+
quotaUser?: string;
|
|
2024
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2025
|
+
upload_protocol?: string;
|
|
2026
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2027
|
+
uploadType?: string;
|
|
2028
|
+
},
|
|
2029
|
+
body: GoogleCloudRetailV2RemoveCatalogAttributeRequest): Request<GoogleCloudRetailV2AttributesConfig>;
|
|
2030
|
+
}
|
|
2031
|
+
interface OperationsResource {
|
|
2032
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
2033
|
+
get(request?: {
|
|
2034
|
+
/** V1 error format. */
|
|
2035
|
+
"$.xgafv"?: string;
|
|
2036
|
+
/** OAuth access token. */
|
|
2037
|
+
access_token?: string;
|
|
2038
|
+
/** Data format for response. */
|
|
2039
|
+
alt?: string;
|
|
2040
|
+
/** JSONP */
|
|
2041
|
+
callback?: string;
|
|
2042
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2043
|
+
fields?: string;
|
|
2044
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2045
|
+
key?: string;
|
|
2046
|
+
/** The name of the operation resource. */
|
|
2047
|
+
name: string;
|
|
2048
|
+
/** OAuth 2.0 token for the current user. */
|
|
2049
|
+
oauth_token?: string;
|
|
2050
|
+
/** Returns response with indentations and line breaks. */
|
|
2051
|
+
prettyPrint?: boolean;
|
|
2052
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2053
|
+
quotaUser?: string;
|
|
2054
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2055
|
+
upload_protocol?: string;
|
|
2056
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2057
|
+
uploadType?: string;
|
|
2058
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2059
|
+
}
|
|
2060
|
+
interface ProductsResource {
|
|
2061
|
+
/**
|
|
2062
|
+
* Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information.
|
|
2063
|
+
* If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in
|
|
2064
|
+
* the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search
|
|
2065
|
+
* on Cloud Console before using this feature.
|
|
2066
|
+
*/
|
|
2067
|
+
addFulfillmentPlaces(request: {
|
|
2068
|
+
/** V1 error format. */
|
|
2069
|
+
"$.xgafv"?: string;
|
|
2070
|
+
/** OAuth access token. */
|
|
2071
|
+
access_token?: string;
|
|
2072
|
+
/** Data format for response. */
|
|
2073
|
+
alt?: string;
|
|
2074
|
+
/** JSONP */
|
|
2075
|
+
callback?: string;
|
|
2076
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2077
|
+
fields?: string;
|
|
2078
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2079
|
+
key?: string;
|
|
2080
|
+
/** OAuth 2.0 token for the current user. */
|
|
2081
|
+
oauth_token?: string;
|
|
2082
|
+
/** Returns response with indentations and line breaks. */
|
|
2083
|
+
prettyPrint?: boolean;
|
|
2084
|
+
/**
|
|
2085
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2086
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
2087
|
+
*/
|
|
2088
|
+
product: string;
|
|
2089
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2090
|
+
quotaUser?: string;
|
|
2091
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2092
|
+
upload_protocol?: string;
|
|
2093
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2094
|
+
uploadType?: string;
|
|
2095
|
+
/** Request body */
|
|
2096
|
+
resource: GoogleCloudRetailV2AddFulfillmentPlacesRequest;
|
|
2097
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2098
|
+
addFulfillmentPlaces(request: {
|
|
2099
|
+
/** V1 error format. */
|
|
2100
|
+
"$.xgafv"?: string;
|
|
2101
|
+
/** OAuth access token. */
|
|
2102
|
+
access_token?: string;
|
|
2103
|
+
/** Data format for response. */
|
|
2104
|
+
alt?: string;
|
|
2105
|
+
/** JSONP */
|
|
2106
|
+
callback?: string;
|
|
2107
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2108
|
+
fields?: string;
|
|
2109
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2110
|
+
key?: string;
|
|
2111
|
+
/** OAuth 2.0 token for the current user. */
|
|
2112
|
+
oauth_token?: string;
|
|
2113
|
+
/** Returns response with indentations and line breaks. */
|
|
2114
|
+
prettyPrint?: boolean;
|
|
2115
|
+
/**
|
|
2116
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2117
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
2118
|
+
*/
|
|
2119
|
+
product: string;
|
|
2120
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2121
|
+
quotaUser?: string;
|
|
2122
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2123
|
+
upload_protocol?: string;
|
|
2124
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2125
|
+
uploadType?: string;
|
|
2126
|
+
},
|
|
2127
|
+
body: GoogleCloudRetailV2AddFulfillmentPlacesRequest): Request<GoogleLongrunningOperation>;
|
|
2128
|
+
/**
|
|
2129
|
+
* Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not
|
|
2130
|
+
* require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response
|
|
2131
|
+
* is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be
|
|
2132
|
+
* modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. This feature is only available for users who have
|
|
2133
|
+
* Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.
|
|
2134
|
+
*/
|
|
2135
|
+
addLocalInventories(request: {
|
|
2136
|
+
/** V1 error format. */
|
|
2137
|
+
"$.xgafv"?: string;
|
|
2138
|
+
/** OAuth access token. */
|
|
2139
|
+
access_token?: string;
|
|
2140
|
+
/** Data format for response. */
|
|
2141
|
+
alt?: string;
|
|
2142
|
+
/** JSONP */
|
|
2143
|
+
callback?: string;
|
|
2144
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2145
|
+
fields?: string;
|
|
2146
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2147
|
+
key?: string;
|
|
2148
|
+
/** OAuth 2.0 token for the current user. */
|
|
2149
|
+
oauth_token?: string;
|
|
2150
|
+
/** Returns response with indentations and line breaks. */
|
|
2151
|
+
prettyPrint?: boolean;
|
|
2152
|
+
/**
|
|
2153
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2154
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
2155
|
+
*/
|
|
2156
|
+
product: string;
|
|
2157
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2158
|
+
quotaUser?: string;
|
|
2159
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2160
|
+
upload_protocol?: string;
|
|
2161
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2162
|
+
uploadType?: string;
|
|
2163
|
+
/** Request body */
|
|
2164
|
+
resource: GoogleCloudRetailV2AddLocalInventoriesRequest;
|
|
2165
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2166
|
+
addLocalInventories(request: {
|
|
2167
|
+
/** V1 error format. */
|
|
2168
|
+
"$.xgafv"?: string;
|
|
2169
|
+
/** OAuth access token. */
|
|
2170
|
+
access_token?: string;
|
|
2171
|
+
/** Data format for response. */
|
|
2172
|
+
alt?: string;
|
|
2173
|
+
/** JSONP */
|
|
2174
|
+
callback?: string;
|
|
2175
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2176
|
+
fields?: string;
|
|
2177
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2178
|
+
key?: string;
|
|
2179
|
+
/** OAuth 2.0 token for the current user. */
|
|
2180
|
+
oauth_token?: string;
|
|
2181
|
+
/** Returns response with indentations and line breaks. */
|
|
2182
|
+
prettyPrint?: boolean;
|
|
2183
|
+
/**
|
|
2184
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2185
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
2186
|
+
*/
|
|
2187
|
+
product: string;
|
|
2188
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2189
|
+
quotaUser?: string;
|
|
2190
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2191
|
+
upload_protocol?: string;
|
|
2192
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2193
|
+
uploadType?: string;
|
|
2194
|
+
},
|
|
2195
|
+
body: GoogleCloudRetailV2AddLocalInventoriesRequest): Request<GoogleLongrunningOperation>;
|
|
2196
|
+
/** Creates a Product. */
|
|
2197
|
+
create(request: {
|
|
2198
|
+
/** V1 error format. */
|
|
2199
|
+
"$.xgafv"?: string;
|
|
2200
|
+
/** OAuth access token. */
|
|
2201
|
+
access_token?: string;
|
|
2202
|
+
/** Data format for response. */
|
|
2203
|
+
alt?: string;
|
|
2204
|
+
/** JSONP */
|
|
2205
|
+
callback?: string;
|
|
2206
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2207
|
+
fields?: string;
|
|
2208
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2209
|
+
key?: string;
|
|
2210
|
+
/** OAuth 2.0 token for the current user. */
|
|
2211
|
+
oauth_token?: string;
|
|
2212
|
+
/** Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`. */
|
|
2213
|
+
parent: string;
|
|
2214
|
+
/** Returns response with indentations and line breaks. */
|
|
2215
|
+
prettyPrint?: boolean;
|
|
2216
|
+
/**
|
|
2217
|
+
* Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of
|
|
2218
|
+
* whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is
|
|
2219
|
+
* returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
2220
|
+
*/
|
|
2221
|
+
productId?: string;
|
|
2222
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2223
|
+
quotaUser?: string;
|
|
2224
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2225
|
+
upload_protocol?: string;
|
|
2226
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2227
|
+
uploadType?: string;
|
|
2228
|
+
/** Request body */
|
|
2229
|
+
resource: GoogleCloudRetailV2Product;
|
|
2230
|
+
}): Request<GoogleCloudRetailV2Product>;
|
|
2231
|
+
create(request: {
|
|
2232
|
+
/** V1 error format. */
|
|
2233
|
+
"$.xgafv"?: string;
|
|
2234
|
+
/** OAuth access token. */
|
|
2235
|
+
access_token?: string;
|
|
2236
|
+
/** Data format for response. */
|
|
2237
|
+
alt?: string;
|
|
2238
|
+
/** JSONP */
|
|
2239
|
+
callback?: string;
|
|
2240
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2241
|
+
fields?: string;
|
|
2242
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2243
|
+
key?: string;
|
|
2244
|
+
/** OAuth 2.0 token for the current user. */
|
|
2245
|
+
oauth_token?: string;
|
|
2246
|
+
/** Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`. */
|
|
2247
|
+
parent: string;
|
|
2248
|
+
/** Returns response with indentations and line breaks. */
|
|
2249
|
+
prettyPrint?: boolean;
|
|
2250
|
+
/**
|
|
2251
|
+
* Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of
|
|
2252
|
+
* whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is
|
|
2253
|
+
* returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
2254
|
+
*/
|
|
2255
|
+
productId?: string;
|
|
2256
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2257
|
+
quotaUser?: string;
|
|
2258
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2259
|
+
upload_protocol?: string;
|
|
2260
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2261
|
+
uploadType?: string;
|
|
2262
|
+
},
|
|
2263
|
+
body: GoogleCloudRetailV2Product): Request<GoogleCloudRetailV2Product>;
|
|
2264
|
+
/** Deletes a Product. */
|
|
2265
|
+
delete(request?: {
|
|
2266
|
+
/** V1 error format. */
|
|
2267
|
+
"$.xgafv"?: string;
|
|
2268
|
+
/** OAuth access token. */
|
|
2269
|
+
access_token?: string;
|
|
2270
|
+
/** Data format for response. */
|
|
2271
|
+
alt?: string;
|
|
2272
|
+
/** JSONP */
|
|
2273
|
+
callback?: string;
|
|
2274
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2275
|
+
fields?: string;
|
|
2276
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2277
|
+
key?: string;
|
|
2278
|
+
/**
|
|
2279
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2280
|
+
* have permission to delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error
|
|
2281
|
+
* is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an
|
|
2282
|
+
* INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.
|
|
2283
|
+
*/
|
|
2284
|
+
name: string;
|
|
2285
|
+
/** OAuth 2.0 token for the current user. */
|
|
2286
|
+
oauth_token?: string;
|
|
2287
|
+
/** Returns response with indentations and line breaks. */
|
|
2288
|
+
prettyPrint?: boolean;
|
|
2289
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2290
|
+
quotaUser?: string;
|
|
2291
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2292
|
+
upload_protocol?: string;
|
|
2293
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2294
|
+
uploadType?: string;
|
|
2295
|
+
}): Request<{}>;
|
|
2296
|
+
/** Gets a Product. */
|
|
2297
|
+
get(request?: {
|
|
2298
|
+
/** V1 error format. */
|
|
2299
|
+
"$.xgafv"?: string;
|
|
2300
|
+
/** OAuth access token. */
|
|
2301
|
+
access_token?: string;
|
|
2302
|
+
/** Data format for response. */
|
|
2303
|
+
alt?: string;
|
|
2304
|
+
/** JSONP */
|
|
2305
|
+
callback?: string;
|
|
2306
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2307
|
+
fields?: string;
|
|
2308
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2309
|
+
key?: string;
|
|
2310
|
+
/**
|
|
2311
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2312
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Product does not exist, a NOT_FOUND error
|
|
2313
|
+
* is returned.
|
|
2314
|
+
*/
|
|
2315
|
+
name: string;
|
|
2316
|
+
/** OAuth 2.0 token for the current user. */
|
|
2317
|
+
oauth_token?: string;
|
|
2318
|
+
/** Returns response with indentations and line breaks. */
|
|
2319
|
+
prettyPrint?: boolean;
|
|
2320
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2321
|
+
quotaUser?: string;
|
|
2322
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2323
|
+
upload_protocol?: string;
|
|
2324
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2325
|
+
uploadType?: string;
|
|
2326
|
+
}): Request<GoogleCloudRetailV2Product>;
|
|
2327
|
+
/**
|
|
2328
|
+
* Bulk import of multiple Products. Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully
|
|
2329
|
+
* updated.
|
|
2330
|
+
*/
|
|
2331
|
+
import(request: {
|
|
2332
|
+
/** V1 error format. */
|
|
2333
|
+
"$.xgafv"?: string;
|
|
2334
|
+
/** OAuth access token. */
|
|
2335
|
+
access_token?: string;
|
|
2336
|
+
/** Data format for response. */
|
|
2337
|
+
alt?: string;
|
|
2338
|
+
/** JSONP */
|
|
2339
|
+
callback?: string;
|
|
2340
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2341
|
+
fields?: string;
|
|
2342
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2343
|
+
key?: string;
|
|
2344
|
+
/** OAuth 2.0 token for the current user. */
|
|
2345
|
+
oauth_token?: string;
|
|
2346
|
+
/**
|
|
2347
|
+
* Required. `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` If no updateMask is specified, requires products.create permission. If updateMask is
|
|
2348
|
+
* specified, requires products.update permission.
|
|
2349
|
+
*/
|
|
2350
|
+
parent: string;
|
|
2351
|
+
/** Returns response with indentations and line breaks. */
|
|
2352
|
+
prettyPrint?: boolean;
|
|
2353
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2354
|
+
quotaUser?: string;
|
|
2355
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2356
|
+
upload_protocol?: string;
|
|
2357
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2358
|
+
uploadType?: string;
|
|
2359
|
+
/** Request body */
|
|
2360
|
+
resource: GoogleCloudRetailV2ImportProductsRequest;
|
|
2361
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2362
|
+
import(request: {
|
|
2363
|
+
/** V1 error format. */
|
|
2364
|
+
"$.xgafv"?: string;
|
|
2365
|
+
/** OAuth access token. */
|
|
2366
|
+
access_token?: string;
|
|
2367
|
+
/** Data format for response. */
|
|
2368
|
+
alt?: string;
|
|
2369
|
+
/** JSONP */
|
|
2370
|
+
callback?: string;
|
|
2371
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2372
|
+
fields?: string;
|
|
2373
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2374
|
+
key?: string;
|
|
2375
|
+
/** OAuth 2.0 token for the current user. */
|
|
2376
|
+
oauth_token?: string;
|
|
2377
|
+
/**
|
|
2378
|
+
* Required. `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` If no updateMask is specified, requires products.create permission. If updateMask is
|
|
2379
|
+
* specified, requires products.update permission.
|
|
2380
|
+
*/
|
|
2381
|
+
parent: string;
|
|
2382
|
+
/** Returns response with indentations and line breaks. */
|
|
2383
|
+
prettyPrint?: boolean;
|
|
2384
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2385
|
+
quotaUser?: string;
|
|
2386
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2387
|
+
upload_protocol?: string;
|
|
2388
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2389
|
+
uploadType?: string;
|
|
2390
|
+
},
|
|
2391
|
+
body: GoogleCloudRetailV2ImportProductsRequest): Request<GoogleLongrunningOperation>;
|
|
2392
|
+
/** Gets a list of Products. */
|
|
2393
|
+
list(request?: {
|
|
2394
|
+
/** V1 error format. */
|
|
2395
|
+
"$.xgafv"?: string;
|
|
2396
|
+
/** OAuth access token. */
|
|
2397
|
+
access_token?: string;
|
|
2398
|
+
/** Data format for response. */
|
|
2399
|
+
alt?: string;
|
|
2400
|
+
/** JSONP */
|
|
2401
|
+
callback?: string;
|
|
2402
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2403
|
+
fields?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List Product.Type.VARIANT Products sharing the
|
|
2406
|
+
* same Product.Type.PRIMARY Product. For example: `primary_product_id = "some_product_id"` * List Products bundled in a Product.Type.COLLECTION Product. For example:
|
|
2407
|
+
* `collection_product_id = "some_product_id"` * List Products with a partibular type. For example: `type = "PRIMARY"` `type = "VARIANT"` `type = "COLLECTION"` If the field is
|
|
2408
|
+
* unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is
|
|
2409
|
+
* returned.
|
|
2410
|
+
*/
|
|
2411
|
+
filter?: string;
|
|
2412
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2413
|
+
key?: string;
|
|
2414
|
+
/** OAuth 2.0 token for the current user. */
|
|
2415
|
+
oauth_token?: string;
|
|
2416
|
+
/**
|
|
2417
|
+
* Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative,
|
|
2418
|
+
* an INVALID_ARGUMENT error is returned.
|
|
2419
|
+
*/
|
|
2420
|
+
pageSize?: number;
|
|
2421
|
+
/**
|
|
2422
|
+
* A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page. When paginating, all
|
|
2423
|
+
* other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
2424
|
+
*/
|
|
2425
|
+
pageToken?: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* Required. The parent branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products
|
|
2428
|
+
* under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error
|
|
2429
|
+
* is returned.
|
|
2430
|
+
*/
|
|
2431
|
+
parent: string;
|
|
2432
|
+
/** Returns response with indentations and line breaks. */
|
|
2433
|
+
prettyPrint?: boolean;
|
|
2434
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2435
|
+
quotaUser?: string;
|
|
2436
|
+
/**
|
|
2437
|
+
* The fields of Product to return in the responses. If not set or empty, the following fields are returned: * Product.name * Product.id * Product.title * Product.uri *
|
|
2438
|
+
* Product.images * Product.price_info * Product.brands If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set. If an unsupported
|
|
2439
|
+
* or unknown field is provided, an INVALID_ARGUMENT error is returned.
|
|
2440
|
+
*/
|
|
2441
|
+
readMask?: string;
|
|
2442
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2443
|
+
upload_protocol?: string;
|
|
2444
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2445
|
+
uploadType?: string;
|
|
2446
|
+
}): Request<GoogleCloudRetailV2ListProductsResponse>;
|
|
2447
|
+
/** Updates a Product. */
|
|
2448
|
+
patch(request: {
|
|
2449
|
+
/** V1 error format. */
|
|
2450
|
+
"$.xgafv"?: string;
|
|
2451
|
+
/** OAuth access token. */
|
|
2452
|
+
access_token?: string;
|
|
2453
|
+
/** If set to true, and the Product is not found, a new Product will be created. In this situation, `update_mask` is ignored. */
|
|
2454
|
+
allowMissing?: boolean;
|
|
2455
|
+
/** Data format for response. */
|
|
2456
|
+
alt?: string;
|
|
2457
|
+
/** JSONP */
|
|
2458
|
+
callback?: string;
|
|
2459
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2460
|
+
fields?: string;
|
|
2461
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2462
|
+
key?: string;
|
|
2463
|
+
/** Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. */
|
|
2464
|
+
name: string;
|
|
2465
|
+
/** OAuth 2.0 token for the current user. */
|
|
2466
|
+
oauth_token?: string;
|
|
2467
|
+
/** Returns response with indentations and line breaks. */
|
|
2468
|
+
prettyPrint?: boolean;
|
|
2469
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2470
|
+
quotaUser?: string;
|
|
2471
|
+
/**
|
|
2472
|
+
* Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither
|
|
2473
|
+
* immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the
|
|
2474
|
+
* mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.
|
|
2475
|
+
*/
|
|
2476
|
+
updateMask?: string;
|
|
2477
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2478
|
+
upload_protocol?: string;
|
|
2479
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2480
|
+
uploadType?: string;
|
|
2481
|
+
/** Request body */
|
|
2482
|
+
resource: GoogleCloudRetailV2Product;
|
|
2483
|
+
}): Request<GoogleCloudRetailV2Product>;
|
|
2484
|
+
patch(request: {
|
|
2485
|
+
/** V1 error format. */
|
|
2486
|
+
"$.xgafv"?: string;
|
|
2487
|
+
/** OAuth access token. */
|
|
2488
|
+
access_token?: string;
|
|
2489
|
+
/** If set to true, and the Product is not found, a new Product will be created. In this situation, `update_mask` is ignored. */
|
|
2490
|
+
allowMissing?: boolean;
|
|
2491
|
+
/** Data format for response. */
|
|
2492
|
+
alt?: string;
|
|
2493
|
+
/** JSONP */
|
|
2494
|
+
callback?: string;
|
|
2495
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2496
|
+
fields?: string;
|
|
2497
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2498
|
+
key?: string;
|
|
2499
|
+
/** Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. */
|
|
2500
|
+
name: string;
|
|
2501
|
+
/** OAuth 2.0 token for the current user. */
|
|
2502
|
+
oauth_token?: string;
|
|
2503
|
+
/** Returns response with indentations and line breaks. */
|
|
2504
|
+
prettyPrint?: boolean;
|
|
2505
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2506
|
+
quotaUser?: string;
|
|
2507
|
+
/**
|
|
2508
|
+
* Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither
|
|
2509
|
+
* immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the
|
|
2510
|
+
* mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.
|
|
2511
|
+
*/
|
|
2512
|
+
updateMask?: string;
|
|
2513
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2514
|
+
upload_protocol?: string;
|
|
2515
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2516
|
+
uploadType?: string;
|
|
2517
|
+
},
|
|
2518
|
+
body: GoogleCloudRetailV2Product): Request<GoogleCloudRetailV2Product>;
|
|
2519
|
+
/**
|
|
2520
|
+
* Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment
|
|
2521
|
+
* information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately
|
|
2522
|
+
* manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. This feature is only available for users who have Retail Search enabled. Please enable
|
|
2523
|
+
* Retail Search on Cloud Console before using this feature.
|
|
2524
|
+
*/
|
|
2525
|
+
removeFulfillmentPlaces(request: {
|
|
2526
|
+
/** V1 error format. */
|
|
2527
|
+
"$.xgafv"?: string;
|
|
2528
|
+
/** OAuth access token. */
|
|
2529
|
+
access_token?: string;
|
|
2530
|
+
/** Data format for response. */
|
|
2531
|
+
alt?: string;
|
|
2532
|
+
/** JSONP */
|
|
2533
|
+
callback?: string;
|
|
2534
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2535
|
+
fields?: string;
|
|
2536
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2537
|
+
key?: string;
|
|
2538
|
+
/** OAuth 2.0 token for the current user. */
|
|
2539
|
+
oauth_token?: string;
|
|
2540
|
+
/** Returns response with indentations and line breaks. */
|
|
2541
|
+
prettyPrint?: boolean;
|
|
2542
|
+
/**
|
|
2543
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2544
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
2545
|
+
*/
|
|
2546
|
+
product: string;
|
|
2547
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2548
|
+
quotaUser?: string;
|
|
2549
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2550
|
+
upload_protocol?: string;
|
|
2551
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2552
|
+
uploadType?: string;
|
|
2553
|
+
/** Request body */
|
|
2554
|
+
resource: GoogleCloudRetailV2RemoveFulfillmentPlacesRequest;
|
|
2555
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2556
|
+
removeFulfillmentPlaces(request: {
|
|
2557
|
+
/** V1 error format. */
|
|
2558
|
+
"$.xgafv"?: string;
|
|
2559
|
+
/** OAuth access token. */
|
|
2560
|
+
access_token?: string;
|
|
2561
|
+
/** Data format for response. */
|
|
2562
|
+
alt?: string;
|
|
2563
|
+
/** JSONP */
|
|
2564
|
+
callback?: string;
|
|
2565
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2566
|
+
fields?: string;
|
|
2567
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2568
|
+
key?: string;
|
|
2569
|
+
/** OAuth 2.0 token for the current user. */
|
|
2570
|
+
oauth_token?: string;
|
|
2571
|
+
/** Returns response with indentations and line breaks. */
|
|
2572
|
+
prettyPrint?: boolean;
|
|
2573
|
+
/**
|
|
2574
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2575
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
2576
|
+
*/
|
|
2577
|
+
product: string;
|
|
2578
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2579
|
+
quotaUser?: string;
|
|
2580
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2581
|
+
upload_protocol?: string;
|
|
2582
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2583
|
+
uploadType?: string;
|
|
2584
|
+
},
|
|
2585
|
+
body: GoogleCloudRetailV2RemoveFulfillmentPlacesRequest): Request<GoogleLongrunningOperation>;
|
|
2586
|
+
/**
|
|
2587
|
+
* Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and
|
|
2588
|
+
* processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or
|
|
2589
|
+
* ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local
|
|
2590
|
+
* inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.
|
|
2591
|
+
*/
|
|
2592
|
+
removeLocalInventories(request: {
|
|
2593
|
+
/** V1 error format. */
|
|
2594
|
+
"$.xgafv"?: string;
|
|
2595
|
+
/** OAuth access token. */
|
|
2596
|
+
access_token?: string;
|
|
2597
|
+
/** Data format for response. */
|
|
2598
|
+
alt?: string;
|
|
2599
|
+
/** JSONP */
|
|
2600
|
+
callback?: string;
|
|
2601
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2602
|
+
fields?: string;
|
|
2603
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2604
|
+
key?: string;
|
|
2605
|
+
/** OAuth 2.0 token for the current user. */
|
|
2606
|
+
oauth_token?: string;
|
|
2607
|
+
/** Returns response with indentations and line breaks. */
|
|
2608
|
+
prettyPrint?: boolean;
|
|
2609
|
+
/**
|
|
2610
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2611
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
2612
|
+
*/
|
|
2613
|
+
product: string;
|
|
2614
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2615
|
+
quotaUser?: string;
|
|
2616
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2617
|
+
upload_protocol?: string;
|
|
2618
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2619
|
+
uploadType?: string;
|
|
2620
|
+
/** Request body */
|
|
2621
|
+
resource: GoogleCloudRetailV2RemoveLocalInventoriesRequest;
|
|
2622
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2623
|
+
removeLocalInventories(request: {
|
|
2624
|
+
/** V1 error format. */
|
|
2625
|
+
"$.xgafv"?: string;
|
|
2626
|
+
/** OAuth access token. */
|
|
2627
|
+
access_token?: string;
|
|
2628
|
+
/** Data format for response. */
|
|
2629
|
+
alt?: string;
|
|
2630
|
+
/** JSONP */
|
|
2631
|
+
callback?: string;
|
|
2632
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2633
|
+
fields?: string;
|
|
2634
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2635
|
+
key?: string;
|
|
2636
|
+
/** OAuth 2.0 token for the current user. */
|
|
2637
|
+
oauth_token?: string;
|
|
2638
|
+
/** Returns response with indentations and line breaks. */
|
|
2639
|
+
prettyPrint?: boolean;
|
|
2640
|
+
/**
|
|
2641
|
+
* Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not
|
|
2642
|
+
* have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
|
2643
|
+
*/
|
|
2644
|
+
product: string;
|
|
2645
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2646
|
+
quotaUser?: string;
|
|
2647
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2648
|
+
upload_protocol?: string;
|
|
2649
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2650
|
+
uploadType?: string;
|
|
2651
|
+
},
|
|
2652
|
+
body: GoogleCloudRetailV2RemoveLocalInventoriesRequest): Request<GoogleLongrunningOperation>;
|
|
2653
|
+
/**
|
|
2654
|
+
* Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to
|
|
2655
|
+
* exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates
|
|
2656
|
+
* are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and
|
|
2657
|
+
* ProductService.UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last
|
|
2658
|
+
* update time for the specified inventory fields will be overwritten to the time of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields
|
|
2659
|
+
* are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask,
|
|
2660
|
+
* then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory,
|
|
2661
|
+
* ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. This feature is only available for users who have Retail Search enabled. Please enable Retail Search
|
|
2662
|
+
* on Cloud Console before using this feature.
|
|
2663
|
+
*/
|
|
2664
|
+
setInventory(request: {
|
|
2665
|
+
/** V1 error format. */
|
|
2666
|
+
"$.xgafv"?: string;
|
|
2667
|
+
/** OAuth access token. */
|
|
2668
|
+
access_token?: string;
|
|
2669
|
+
/** Data format for response. */
|
|
2670
|
+
alt?: string;
|
|
2671
|
+
/** JSONP */
|
|
2672
|
+
callback?: string;
|
|
2673
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2674
|
+
fields?: string;
|
|
2675
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2676
|
+
key?: string;
|
|
2677
|
+
/** Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. */
|
|
2678
|
+
name: string;
|
|
2679
|
+
/** OAuth 2.0 token for the current user. */
|
|
2680
|
+
oauth_token?: string;
|
|
2681
|
+
/** Returns response with indentations and line breaks. */
|
|
2682
|
+
prettyPrint?: boolean;
|
|
2683
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2684
|
+
quotaUser?: string;
|
|
2685
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2686
|
+
upload_protocol?: string;
|
|
2687
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2688
|
+
uploadType?: string;
|
|
2689
|
+
/** Request body */
|
|
2690
|
+
resource: GoogleCloudRetailV2SetInventoryRequest;
|
|
2691
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2692
|
+
setInventory(request: {
|
|
2693
|
+
/** V1 error format. */
|
|
2694
|
+
"$.xgafv"?: string;
|
|
2695
|
+
/** OAuth access token. */
|
|
2696
|
+
access_token?: string;
|
|
2697
|
+
/** Data format for response. */
|
|
2698
|
+
alt?: string;
|
|
2699
|
+
/** JSONP */
|
|
2700
|
+
callback?: string;
|
|
2701
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2702
|
+
fields?: string;
|
|
2703
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2704
|
+
key?: string;
|
|
2705
|
+
/** Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. */
|
|
2706
|
+
name: string;
|
|
2707
|
+
/** OAuth 2.0 token for the current user. */
|
|
2708
|
+
oauth_token?: string;
|
|
2709
|
+
/** Returns response with indentations and line breaks. */
|
|
2710
|
+
prettyPrint?: boolean;
|
|
2711
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2712
|
+
quotaUser?: string;
|
|
2713
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2714
|
+
upload_protocol?: string;
|
|
2715
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2716
|
+
uploadType?: string;
|
|
2717
|
+
},
|
|
2718
|
+
body: GoogleCloudRetailV2SetInventoryRequest): Request<GoogleLongrunningOperation>;
|
|
2719
|
+
}
|
|
2720
|
+
interface BranchesResource {
|
|
2721
|
+
operations: OperationsResource;
|
|
2722
|
+
products: ProductsResource;
|
|
2723
|
+
}
|
|
2724
|
+
interface CompletionDataResource {
|
|
2725
|
+
/**
|
|
2726
|
+
* Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported
|
|
2727
|
+
* suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Please enable Retail
|
|
2728
|
+
* Search on Cloud Console before using this feature.
|
|
2729
|
+
*/
|
|
2730
|
+
import(request: {
|
|
2731
|
+
/** V1 error format. */
|
|
2732
|
+
"$.xgafv"?: string;
|
|
2733
|
+
/** OAuth access token. */
|
|
2734
|
+
access_token?: string;
|
|
2735
|
+
/** Data format for response. */
|
|
2736
|
+
alt?: string;
|
|
2737
|
+
/** JSONP */
|
|
2738
|
+
callback?: string;
|
|
2739
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2740
|
+
fields?: string;
|
|
2741
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2742
|
+
key?: string;
|
|
2743
|
+
/** OAuth 2.0 token for the current user. */
|
|
2744
|
+
oauth_token?: string;
|
|
2745
|
+
/** Required. The catalog which the suggestions dataset belongs to. Format: `projects/1234/locations/global/catalogs/default_catalog`. */
|
|
2746
|
+
parent: string;
|
|
2747
|
+
/** Returns response with indentations and line breaks. */
|
|
2748
|
+
prettyPrint?: boolean;
|
|
2749
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2750
|
+
quotaUser?: string;
|
|
2751
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2752
|
+
upload_protocol?: string;
|
|
2753
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2754
|
+
uploadType?: string;
|
|
2755
|
+
/** Request body */
|
|
2756
|
+
resource: GoogleCloudRetailV2ImportCompletionDataRequest;
|
|
2757
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2758
|
+
import(request: {
|
|
2759
|
+
/** V1 error format. */
|
|
2760
|
+
"$.xgafv"?: string;
|
|
2761
|
+
/** OAuth access token. */
|
|
2762
|
+
access_token?: string;
|
|
2763
|
+
/** Data format for response. */
|
|
2764
|
+
alt?: string;
|
|
2765
|
+
/** JSONP */
|
|
2766
|
+
callback?: string;
|
|
2767
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2768
|
+
fields?: string;
|
|
2769
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2770
|
+
key?: string;
|
|
2771
|
+
/** OAuth 2.0 token for the current user. */
|
|
2772
|
+
oauth_token?: string;
|
|
2773
|
+
/** Required. The catalog which the suggestions dataset belongs to. Format: `projects/1234/locations/global/catalogs/default_catalog`. */
|
|
2774
|
+
parent: string;
|
|
2775
|
+
/** Returns response with indentations and line breaks. */
|
|
2776
|
+
prettyPrint?: boolean;
|
|
2777
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2778
|
+
quotaUser?: string;
|
|
2779
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2780
|
+
upload_protocol?: string;
|
|
2781
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2782
|
+
uploadType?: string;
|
|
2783
|
+
},
|
|
2784
|
+
body: GoogleCloudRetailV2ImportCompletionDataRequest): Request<GoogleLongrunningOperation>;
|
|
2785
|
+
}
|
|
2786
|
+
interface OperationsResource {
|
|
2787
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
2788
|
+
get(request?: {
|
|
2789
|
+
/** V1 error format. */
|
|
2790
|
+
"$.xgafv"?: string;
|
|
2791
|
+
/** OAuth access token. */
|
|
2792
|
+
access_token?: string;
|
|
2793
|
+
/** Data format for response. */
|
|
2794
|
+
alt?: string;
|
|
2795
|
+
/** JSONP */
|
|
2796
|
+
callback?: string;
|
|
2797
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2798
|
+
fields?: string;
|
|
2799
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2800
|
+
key?: string;
|
|
2801
|
+
/** The name of the operation resource. */
|
|
2802
|
+
name: string;
|
|
2803
|
+
/** OAuth 2.0 token for the current user. */
|
|
2804
|
+
oauth_token?: string;
|
|
2805
|
+
/** Returns response with indentations and line breaks. */
|
|
2806
|
+
prettyPrint?: boolean;
|
|
2807
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2808
|
+
quotaUser?: string;
|
|
2809
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2810
|
+
upload_protocol?: string;
|
|
2811
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2812
|
+
uploadType?: string;
|
|
2813
|
+
}): Request<GoogleLongrunningOperation>;
|
|
2814
|
+
/**
|
|
2815
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
2816
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
2817
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
2818
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
2819
|
+
*/
|
|
2820
|
+
list(request?: {
|
|
2821
|
+
/** V1 error format. */
|
|
2822
|
+
"$.xgafv"?: string;
|
|
2823
|
+
/** OAuth access token. */
|
|
2824
|
+
access_token?: string;
|
|
2825
|
+
/** Data format for response. */
|
|
2826
|
+
alt?: string;
|
|
2827
|
+
/** JSONP */
|
|
2828
|
+
callback?: string;
|
|
2829
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2830
|
+
fields?: string;
|
|
2831
|
+
/** The standard list filter. */
|
|
2832
|
+
filter?: string;
|
|
2833
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2834
|
+
key?: string;
|
|
2835
|
+
/** The name of the operation's parent resource. */
|
|
2836
|
+
name: string;
|
|
2837
|
+
/** OAuth 2.0 token for the current user. */
|
|
2838
|
+
oauth_token?: string;
|
|
2839
|
+
/** The standard list page size. */
|
|
2840
|
+
pageSize?: number;
|
|
2841
|
+
/** The standard list page token. */
|
|
2842
|
+
pageToken?: string;
|
|
2843
|
+
/** Returns response with indentations and line breaks. */
|
|
2844
|
+
prettyPrint?: boolean;
|
|
2845
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2846
|
+
quotaUser?: string;
|
|
2847
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2848
|
+
upload_protocol?: string;
|
|
2849
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2850
|
+
uploadType?: string;
|
|
2851
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
2852
|
+
}
|
|
2853
|
+
interface PlacementsResource {
|
|
2854
|
+
/** Makes a recommendation prediction. */
|
|
2855
|
+
predict(request: {
|
|
2856
|
+
/** V1 error format. */
|
|
2857
|
+
"$.xgafv"?: string;
|
|
2858
|
+
/** OAuth access token. */
|
|
2859
|
+
access_token?: string;
|
|
2860
|
+
/** Data format for response. */
|
|
2861
|
+
alt?: string;
|
|
2862
|
+
/** JSONP */
|
|
2863
|
+
callback?: string;
|
|
2864
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2865
|
+
fields?: string;
|
|
2866
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2867
|
+
key?: string;
|
|
2868
|
+
/** OAuth 2.0 token for the current user. */
|
|
2869
|
+
oauth_token?: string;
|
|
2870
|
+
/**
|
|
2871
|
+
* Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or
|
|
2872
|
+
* `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
|
2873
|
+
* the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more
|
|
2874
|
+
* information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at
|
|
2875
|
+
* https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
|
|
2876
|
+
*/
|
|
2877
|
+
placement: string;
|
|
2878
|
+
/** Returns response with indentations and line breaks. */
|
|
2879
|
+
prettyPrint?: boolean;
|
|
2880
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2881
|
+
quotaUser?: string;
|
|
2882
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2883
|
+
upload_protocol?: string;
|
|
2884
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2885
|
+
uploadType?: string;
|
|
2886
|
+
/** Request body */
|
|
2887
|
+
resource: GoogleCloudRetailV2PredictRequest;
|
|
2888
|
+
}): Request<GoogleCloudRetailV2PredictResponse>;
|
|
2889
|
+
predict(request: {
|
|
2890
|
+
/** V1 error format. */
|
|
2891
|
+
"$.xgafv"?: string;
|
|
2892
|
+
/** OAuth access token. */
|
|
2893
|
+
access_token?: string;
|
|
2894
|
+
/** Data format for response. */
|
|
2895
|
+
alt?: string;
|
|
2896
|
+
/** JSONP */
|
|
2897
|
+
callback?: string;
|
|
2898
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2899
|
+
fields?: string;
|
|
2900
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2901
|
+
key?: string;
|
|
2902
|
+
/** OAuth 2.0 token for the current user. */
|
|
2903
|
+
oauth_token?: string;
|
|
2904
|
+
/**
|
|
2905
|
+
* Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or
|
|
2906
|
+
* `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
|
2907
|
+
* the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more
|
|
2908
|
+
* information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at
|
|
2909
|
+
* https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
|
|
2910
|
+
*/
|
|
2911
|
+
placement: string;
|
|
2912
|
+
/** Returns response with indentations and line breaks. */
|
|
2913
|
+
prettyPrint?: boolean;
|
|
2914
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2915
|
+
quotaUser?: string;
|
|
2916
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2917
|
+
upload_protocol?: string;
|
|
2918
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2919
|
+
uploadType?: string;
|
|
2920
|
+
},
|
|
2921
|
+
body: GoogleCloudRetailV2PredictRequest): Request<GoogleCloudRetailV2PredictResponse>;
|
|
2922
|
+
/** Performs a search. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature. */
|
|
2923
|
+
search(request: {
|
|
2924
|
+
/** V1 error format. */
|
|
2925
|
+
"$.xgafv"?: string;
|
|
2926
|
+
/** OAuth access token. */
|
|
2927
|
+
access_token?: string;
|
|
2928
|
+
/** Data format for response. */
|
|
2929
|
+
alt?: string;
|
|
2930
|
+
/** JSONP */
|
|
2931
|
+
callback?: string;
|
|
2932
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2933
|
+
fields?: string;
|
|
2934
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2935
|
+
key?: string;
|
|
2936
|
+
/** OAuth 2.0 token for the current user. */
|
|
2937
|
+
oauth_token?: string;
|
|
2938
|
+
/**
|
|
2939
|
+
* Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the
|
|
2940
|
+
* name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving
|
|
2941
|
+
* configuration name and the set of models that will be used to make the search.
|
|
2942
|
+
*/
|
|
2943
|
+
placement: string;
|
|
2944
|
+
/** Returns response with indentations and line breaks. */
|
|
2945
|
+
prettyPrint?: boolean;
|
|
2946
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2947
|
+
quotaUser?: string;
|
|
2948
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2949
|
+
upload_protocol?: string;
|
|
2950
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2951
|
+
uploadType?: string;
|
|
2952
|
+
/** Request body */
|
|
2953
|
+
resource: GoogleCloudRetailV2SearchRequest;
|
|
2954
|
+
}): Request<GoogleCloudRetailV2SearchResponse>;
|
|
2955
|
+
search(request: {
|
|
2956
|
+
/** V1 error format. */
|
|
2957
|
+
"$.xgafv"?: string;
|
|
2958
|
+
/** OAuth access token. */
|
|
2959
|
+
access_token?: string;
|
|
2960
|
+
/** Data format for response. */
|
|
2961
|
+
alt?: string;
|
|
2962
|
+
/** JSONP */
|
|
2963
|
+
callback?: string;
|
|
2964
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2965
|
+
fields?: string;
|
|
2966
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2967
|
+
key?: string;
|
|
2968
|
+
/** OAuth 2.0 token for the current user. */
|
|
2969
|
+
oauth_token?: string;
|
|
2970
|
+
/**
|
|
2971
|
+
* Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the
|
|
2972
|
+
* name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving
|
|
2973
|
+
* configuration name and the set of models that will be used to make the search.
|
|
2974
|
+
*/
|
|
2975
|
+
placement: string;
|
|
2976
|
+
/** Returns response with indentations and line breaks. */
|
|
2977
|
+
prettyPrint?: boolean;
|
|
2978
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2979
|
+
quotaUser?: string;
|
|
2980
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2981
|
+
upload_protocol?: string;
|
|
2982
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2983
|
+
uploadType?: string;
|
|
2984
|
+
},
|
|
2985
|
+
body: GoogleCloudRetailV2SearchRequest): Request<GoogleCloudRetailV2SearchResponse>;
|
|
2986
|
+
}
|
|
2987
|
+
interface ServingConfigsResource {
|
|
2988
|
+
/** Makes a recommendation prediction. */
|
|
2989
|
+
predict(request: {
|
|
2990
|
+
/** V1 error format. */
|
|
2991
|
+
"$.xgafv"?: string;
|
|
2992
|
+
/** OAuth access token. */
|
|
2993
|
+
access_token?: string;
|
|
2994
|
+
/** Data format for response. */
|
|
2995
|
+
alt?: string;
|
|
2996
|
+
/** JSONP */
|
|
2997
|
+
callback?: string;
|
|
2998
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2999
|
+
fields?: string;
|
|
3000
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3001
|
+
key?: string;
|
|
3002
|
+
/** OAuth 2.0 token for the current user. */
|
|
3003
|
+
oauth_token?: string;
|
|
3004
|
+
/**
|
|
3005
|
+
* Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or
|
|
3006
|
+
* `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
|
3007
|
+
* the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more
|
|
3008
|
+
* information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at
|
|
3009
|
+
* https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
|
|
3010
|
+
*/
|
|
3011
|
+
placement: string;
|
|
3012
|
+
/** Returns response with indentations and line breaks. */
|
|
3013
|
+
prettyPrint?: boolean;
|
|
3014
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3015
|
+
quotaUser?: string;
|
|
3016
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3017
|
+
upload_protocol?: string;
|
|
3018
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3019
|
+
uploadType?: string;
|
|
3020
|
+
/** Request body */
|
|
3021
|
+
resource: GoogleCloudRetailV2PredictRequest;
|
|
3022
|
+
}): Request<GoogleCloudRetailV2PredictResponse>;
|
|
3023
|
+
predict(request: {
|
|
3024
|
+
/** V1 error format. */
|
|
3025
|
+
"$.xgafv"?: string;
|
|
3026
|
+
/** OAuth access token. */
|
|
3027
|
+
access_token?: string;
|
|
3028
|
+
/** Data format for response. */
|
|
3029
|
+
alt?: string;
|
|
3030
|
+
/** JSONP */
|
|
3031
|
+
callback?: string;
|
|
3032
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3033
|
+
fields?: string;
|
|
3034
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3035
|
+
key?: string;
|
|
3036
|
+
/** OAuth 2.0 token for the current user. */
|
|
3037
|
+
oauth_token?: string;
|
|
3038
|
+
/**
|
|
3039
|
+
* Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or
|
|
3040
|
+
* `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
|
3041
|
+
* the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more
|
|
3042
|
+
* information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at
|
|
3043
|
+
* https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
|
|
3044
|
+
*/
|
|
3045
|
+
placement: string;
|
|
3046
|
+
/** Returns response with indentations and line breaks. */
|
|
3047
|
+
prettyPrint?: boolean;
|
|
3048
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3049
|
+
quotaUser?: string;
|
|
3050
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3051
|
+
upload_protocol?: string;
|
|
3052
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3053
|
+
uploadType?: string;
|
|
3054
|
+
},
|
|
3055
|
+
body: GoogleCloudRetailV2PredictRequest): Request<GoogleCloudRetailV2PredictResponse>;
|
|
3056
|
+
/** Performs a search. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature. */
|
|
3057
|
+
search(request: {
|
|
3058
|
+
/** V1 error format. */
|
|
3059
|
+
"$.xgafv"?: string;
|
|
3060
|
+
/** OAuth access token. */
|
|
3061
|
+
access_token?: string;
|
|
3062
|
+
/** Data format for response. */
|
|
3063
|
+
alt?: string;
|
|
3064
|
+
/** JSONP */
|
|
3065
|
+
callback?: string;
|
|
3066
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3067
|
+
fields?: string;
|
|
3068
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3069
|
+
key?: string;
|
|
3070
|
+
/** OAuth 2.0 token for the current user. */
|
|
3071
|
+
oauth_token?: string;
|
|
3072
|
+
/**
|
|
3073
|
+
* Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the
|
|
3074
|
+
* name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving
|
|
3075
|
+
* configuration name and the set of models that will be used to make the search.
|
|
3076
|
+
*/
|
|
3077
|
+
placement: string;
|
|
3078
|
+
/** Returns response with indentations and line breaks. */
|
|
3079
|
+
prettyPrint?: boolean;
|
|
3080
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3081
|
+
quotaUser?: string;
|
|
3082
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3083
|
+
upload_protocol?: string;
|
|
3084
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3085
|
+
uploadType?: string;
|
|
3086
|
+
/** Request body */
|
|
3087
|
+
resource: GoogleCloudRetailV2SearchRequest;
|
|
3088
|
+
}): Request<GoogleCloudRetailV2SearchResponse>;
|
|
3089
|
+
search(request: {
|
|
3090
|
+
/** V1 error format. */
|
|
3091
|
+
"$.xgafv"?: string;
|
|
3092
|
+
/** OAuth access token. */
|
|
3093
|
+
access_token?: string;
|
|
3094
|
+
/** Data format for response. */
|
|
3095
|
+
alt?: string;
|
|
3096
|
+
/** JSONP */
|
|
3097
|
+
callback?: string;
|
|
3098
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3099
|
+
fields?: string;
|
|
3100
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3101
|
+
key?: string;
|
|
3102
|
+
/** OAuth 2.0 token for the current user. */
|
|
3103
|
+
oauth_token?: string;
|
|
3104
|
+
/**
|
|
3105
|
+
* Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the
|
|
3106
|
+
* name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving
|
|
3107
|
+
* configuration name and the set of models that will be used to make the search.
|
|
3108
|
+
*/
|
|
3109
|
+
placement: string;
|
|
3110
|
+
/** Returns response with indentations and line breaks. */
|
|
3111
|
+
prettyPrint?: boolean;
|
|
3112
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3113
|
+
quotaUser?: string;
|
|
3114
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3115
|
+
upload_protocol?: string;
|
|
3116
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3117
|
+
uploadType?: string;
|
|
3118
|
+
},
|
|
3119
|
+
body: GoogleCloudRetailV2SearchRequest): Request<GoogleCloudRetailV2SearchResponse>;
|
|
3120
|
+
}
|
|
3121
|
+
interface UserEventsResource {
|
|
3122
|
+
/**
|
|
3123
|
+
* Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API
|
|
3124
|
+
* JavaScript pixel and Google Tag Manager. Users should not call this method directly.
|
|
3125
|
+
*/
|
|
3126
|
+
collect(request?: {
|
|
3127
|
+
/** V1 error format. */
|
|
3128
|
+
"$.xgafv"?: string;
|
|
3129
|
+
/** OAuth access token. */
|
|
3130
|
+
access_token?: string;
|
|
3131
|
+
/** Data format for response. */
|
|
3132
|
+
alt?: string;
|
|
3133
|
+
/** JSONP */
|
|
3134
|
+
callback?: string;
|
|
3135
|
+
/** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
|
|
3136
|
+
ets?: string;
|
|
3137
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3138
|
+
fields?: string;
|
|
3139
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3140
|
+
key?: string;
|
|
3141
|
+
/** OAuth 2.0 token for the current user. */
|
|
3142
|
+
oauth_token?: string;
|
|
3143
|
+
/** Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. */
|
|
3144
|
+
parent: string;
|
|
3145
|
+
/** Returns response with indentations and line breaks. */
|
|
3146
|
+
prettyPrint?: boolean;
|
|
3147
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3148
|
+
quotaUser?: string;
|
|
3149
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3150
|
+
upload_protocol?: string;
|
|
3151
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3152
|
+
uploadType?: string;
|
|
3153
|
+
/**
|
|
3154
|
+
* The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers
|
|
3155
|
+
* only send the domain for 3rd party requests.
|
|
3156
|
+
*/
|
|
3157
|
+
uri?: string;
|
|
3158
|
+
/** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
|
|
3159
|
+
userEvent?: string;
|
|
3160
|
+
}): Request<GoogleApiHttpBody>;
|
|
3161
|
+
/**
|
|
3162
|
+
* Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
|
|
3163
|
+
* Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
|
|
3164
|
+
*/
|
|
3165
|
+
import(request: {
|
|
3166
|
+
/** V1 error format. */
|
|
3167
|
+
"$.xgafv"?: string;
|
|
3168
|
+
/** OAuth access token. */
|
|
3169
|
+
access_token?: string;
|
|
3170
|
+
/** Data format for response. */
|
|
3171
|
+
alt?: string;
|
|
3172
|
+
/** JSONP */
|
|
3173
|
+
callback?: string;
|
|
3174
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3175
|
+
fields?: string;
|
|
3176
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3177
|
+
key?: string;
|
|
3178
|
+
/** OAuth 2.0 token for the current user. */
|
|
3179
|
+
oauth_token?: string;
|
|
3180
|
+
/** Required. `projects/1234/locations/global/catalogs/default_catalog` */
|
|
3181
|
+
parent: string;
|
|
3182
|
+
/** Returns response with indentations and line breaks. */
|
|
3183
|
+
prettyPrint?: boolean;
|
|
3184
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3185
|
+
quotaUser?: string;
|
|
3186
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3187
|
+
upload_protocol?: string;
|
|
3188
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3189
|
+
uploadType?: string;
|
|
3190
|
+
/** Request body */
|
|
3191
|
+
resource: GoogleCloudRetailV2ImportUserEventsRequest;
|
|
3192
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3193
|
+
import(request: {
|
|
3194
|
+
/** V1 error format. */
|
|
3195
|
+
"$.xgafv"?: string;
|
|
3196
|
+
/** OAuth access token. */
|
|
3197
|
+
access_token?: string;
|
|
3198
|
+
/** Data format for response. */
|
|
3199
|
+
alt?: string;
|
|
3200
|
+
/** JSONP */
|
|
3201
|
+
callback?: string;
|
|
3202
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3203
|
+
fields?: string;
|
|
3204
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3205
|
+
key?: string;
|
|
3206
|
+
/** OAuth 2.0 token for the current user. */
|
|
3207
|
+
oauth_token?: string;
|
|
3208
|
+
/** Required. `projects/1234/locations/global/catalogs/default_catalog` */
|
|
3209
|
+
parent: string;
|
|
3210
|
+
/** Returns response with indentations and line breaks. */
|
|
3211
|
+
prettyPrint?: boolean;
|
|
3212
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3213
|
+
quotaUser?: string;
|
|
3214
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3215
|
+
upload_protocol?: string;
|
|
3216
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3217
|
+
uploadType?: string;
|
|
3218
|
+
},
|
|
3219
|
+
body: GoogleCloudRetailV2ImportUserEventsRequest): Request<GoogleLongrunningOperation>;
|
|
3220
|
+
/**
|
|
3221
|
+
* Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete.
|
|
3222
|
+
* To test a filter, use the list command first.
|
|
3223
|
+
*/
|
|
3224
|
+
purge(request: {
|
|
3225
|
+
/** V1 error format. */
|
|
3226
|
+
"$.xgafv"?: string;
|
|
3227
|
+
/** OAuth access token. */
|
|
3228
|
+
access_token?: string;
|
|
3229
|
+
/** Data format for response. */
|
|
3230
|
+
alt?: string;
|
|
3231
|
+
/** JSONP */
|
|
3232
|
+
callback?: string;
|
|
3233
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3234
|
+
fields?: string;
|
|
3235
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3236
|
+
key?: string;
|
|
3237
|
+
/** OAuth 2.0 token for the current user. */
|
|
3238
|
+
oauth_token?: string;
|
|
3239
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}` */
|
|
3240
|
+
parent: string;
|
|
3241
|
+
/** Returns response with indentations and line breaks. */
|
|
3242
|
+
prettyPrint?: boolean;
|
|
3243
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3244
|
+
quotaUser?: string;
|
|
3245
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3246
|
+
upload_protocol?: string;
|
|
3247
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3248
|
+
uploadType?: string;
|
|
3249
|
+
/** Request body */
|
|
3250
|
+
resource: GoogleCloudRetailV2PurgeUserEventsRequest;
|
|
3251
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3252
|
+
purge(request: {
|
|
3253
|
+
/** V1 error format. */
|
|
3254
|
+
"$.xgafv"?: string;
|
|
3255
|
+
/** OAuth access token. */
|
|
3256
|
+
access_token?: string;
|
|
3257
|
+
/** Data format for response. */
|
|
3258
|
+
alt?: string;
|
|
3259
|
+
/** JSONP */
|
|
3260
|
+
callback?: string;
|
|
3261
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3262
|
+
fields?: string;
|
|
3263
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3264
|
+
key?: string;
|
|
3265
|
+
/** OAuth 2.0 token for the current user. */
|
|
3266
|
+
oauth_token?: string;
|
|
3267
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}` */
|
|
3268
|
+
parent: string;
|
|
3269
|
+
/** Returns response with indentations and line breaks. */
|
|
3270
|
+
prettyPrint?: boolean;
|
|
3271
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3272
|
+
quotaUser?: string;
|
|
3273
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3274
|
+
upload_protocol?: string;
|
|
3275
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3276
|
+
uploadType?: string;
|
|
3277
|
+
},
|
|
3278
|
+
body: GoogleCloudRetailV2PurgeUserEventsRequest): Request<GoogleLongrunningOperation>;
|
|
3279
|
+
/**
|
|
3280
|
+
* Starts a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time
|
|
3281
|
+
* the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This method can be used to start a join operation on
|
|
3282
|
+
* specified events with latest version of product catalog. It can also be used to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to
|
|
3283
|
+
* complete.
|
|
3284
|
+
*/
|
|
3285
|
+
rejoin(request: {
|
|
3286
|
+
/** V1 error format. */
|
|
3287
|
+
"$.xgafv"?: string;
|
|
3288
|
+
/** OAuth access token. */
|
|
3289
|
+
access_token?: string;
|
|
3290
|
+
/** Data format for response. */
|
|
3291
|
+
alt?: string;
|
|
3292
|
+
/** JSONP */
|
|
3293
|
+
callback?: string;
|
|
3294
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3295
|
+
fields?: string;
|
|
3296
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3297
|
+
key?: string;
|
|
3298
|
+
/** OAuth 2.0 token for the current user. */
|
|
3299
|
+
oauth_token?: string;
|
|
3300
|
+
/** Required. The parent catalog resource name, such as `projects/1234/locations/global/catalogs/default_catalog`. */
|
|
3301
|
+
parent: string;
|
|
3302
|
+
/** Returns response with indentations and line breaks. */
|
|
3303
|
+
prettyPrint?: boolean;
|
|
3304
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3305
|
+
quotaUser?: string;
|
|
3306
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3307
|
+
upload_protocol?: string;
|
|
3308
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3309
|
+
uploadType?: string;
|
|
3310
|
+
/** Request body */
|
|
3311
|
+
resource: GoogleCloudRetailV2RejoinUserEventsRequest;
|
|
3312
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3313
|
+
rejoin(request: {
|
|
3314
|
+
/** V1 error format. */
|
|
3315
|
+
"$.xgafv"?: string;
|
|
3316
|
+
/** OAuth access token. */
|
|
3317
|
+
access_token?: string;
|
|
3318
|
+
/** Data format for response. */
|
|
3319
|
+
alt?: string;
|
|
3320
|
+
/** JSONP */
|
|
3321
|
+
callback?: string;
|
|
3322
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3323
|
+
fields?: string;
|
|
3324
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3325
|
+
key?: string;
|
|
3326
|
+
/** OAuth 2.0 token for the current user. */
|
|
3327
|
+
oauth_token?: string;
|
|
3328
|
+
/** Required. The parent catalog resource name, such as `projects/1234/locations/global/catalogs/default_catalog`. */
|
|
3329
|
+
parent: string;
|
|
3330
|
+
/** Returns response with indentations and line breaks. */
|
|
3331
|
+
prettyPrint?: boolean;
|
|
3332
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3333
|
+
quotaUser?: string;
|
|
3334
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3335
|
+
upload_protocol?: string;
|
|
3336
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3337
|
+
uploadType?: string;
|
|
3338
|
+
},
|
|
3339
|
+
body: GoogleCloudRetailV2RejoinUserEventsRequest): Request<GoogleLongrunningOperation>;
|
|
3340
|
+
/** Writes a single user event. */
|
|
3341
|
+
write(request: {
|
|
3342
|
+
/** V1 error format. */
|
|
3343
|
+
"$.xgafv"?: string;
|
|
3344
|
+
/** OAuth access token. */
|
|
3345
|
+
access_token?: string;
|
|
3346
|
+
/** Data format for response. */
|
|
3347
|
+
alt?: string;
|
|
3348
|
+
/** JSONP */
|
|
3349
|
+
callback?: string;
|
|
3350
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3351
|
+
fields?: string;
|
|
3352
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3353
|
+
key?: string;
|
|
3354
|
+
/** OAuth 2.0 token for the current user. */
|
|
3355
|
+
oauth_token?: string;
|
|
3356
|
+
/** Required. The parent catalog resource name, such as `projects/1234/locations/global/catalogs/default_catalog`. */
|
|
3357
|
+
parent: string;
|
|
3358
|
+
/** Returns response with indentations and line breaks. */
|
|
3359
|
+
prettyPrint?: boolean;
|
|
3360
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3361
|
+
quotaUser?: string;
|
|
3362
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3363
|
+
upload_protocol?: string;
|
|
3364
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3365
|
+
uploadType?: string;
|
|
3366
|
+
/** Request body */
|
|
3367
|
+
resource: GoogleCloudRetailV2UserEvent;
|
|
3368
|
+
}): Request<GoogleCloudRetailV2UserEvent>;
|
|
3369
|
+
write(request: {
|
|
3370
|
+
/** V1 error format. */
|
|
3371
|
+
"$.xgafv"?: string;
|
|
3372
|
+
/** OAuth access token. */
|
|
3373
|
+
access_token?: string;
|
|
3374
|
+
/** Data format for response. */
|
|
3375
|
+
alt?: string;
|
|
3376
|
+
/** JSONP */
|
|
3377
|
+
callback?: string;
|
|
3378
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3379
|
+
fields?: string;
|
|
3380
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3381
|
+
key?: string;
|
|
3382
|
+
/** OAuth 2.0 token for the current user. */
|
|
3383
|
+
oauth_token?: string;
|
|
3384
|
+
/** Required. The parent catalog resource name, such as `projects/1234/locations/global/catalogs/default_catalog`. */
|
|
3385
|
+
parent: string;
|
|
3386
|
+
/** Returns response with indentations and line breaks. */
|
|
3387
|
+
prettyPrint?: boolean;
|
|
3388
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3389
|
+
quotaUser?: string;
|
|
3390
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3391
|
+
upload_protocol?: string;
|
|
3392
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3393
|
+
uploadType?: string;
|
|
3394
|
+
},
|
|
3395
|
+
body: GoogleCloudRetailV2UserEvent): Request<GoogleCloudRetailV2UserEvent>;
|
|
3396
|
+
}
|
|
3397
|
+
interface CatalogsResource {
|
|
3398
|
+
/**
|
|
3399
|
+
* Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before
|
|
3400
|
+
* using this feature.
|
|
3401
|
+
*/
|
|
3402
|
+
completeQuery(request?: {
|
|
3403
|
+
/** V1 error format. */
|
|
3404
|
+
"$.xgafv"?: string;
|
|
3405
|
+
/** OAuth access token. */
|
|
3406
|
+
access_token?: string;
|
|
3407
|
+
/** Data format for response. */
|
|
3408
|
+
alt?: string;
|
|
3409
|
+
/** JSONP */
|
|
3410
|
+
callback?: string;
|
|
3411
|
+
/** Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`. */
|
|
3412
|
+
catalog: string;
|
|
3413
|
+
/**
|
|
3414
|
+
* Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the
|
|
3415
|
+
* dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: * user-data * cloud-retail: This option requires
|
|
3416
|
+
* enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
|
|
3417
|
+
*/
|
|
3418
|
+
dataset?: string;
|
|
3419
|
+
/**
|
|
3420
|
+
* The device type context for completion suggestions. It is useful to apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the
|
|
3421
|
+
* suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
|
|
3422
|
+
*/
|
|
3423
|
+
deviceType?: string;
|
|
3424
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3425
|
+
fields?: string;
|
|
3426
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3427
|
+
key?: string;
|
|
3428
|
+
/**
|
|
3429
|
+
* Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output
|
|
3430
|
+
* suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language
|
|
3431
|
+
* code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3.
|
|
3432
|
+
*/
|
|
3433
|
+
languageCodes?: string | string[];
|
|
3434
|
+
/**
|
|
3435
|
+
* Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If
|
|
3436
|
+
* it is set higher, it will be capped by 20.
|
|
3437
|
+
*/
|
|
3438
|
+
maxSuggestions?: number;
|
|
3439
|
+
/** OAuth 2.0 token for the current user. */
|
|
3440
|
+
oauth_token?: string;
|
|
3441
|
+
/** Returns response with indentations and line breaks. */
|
|
3442
|
+
prettyPrint?: boolean;
|
|
3443
|
+
/** Required. The query used to generate suggestions. The maximum number of allowed characters is 255. */
|
|
3444
|
+
query?: string;
|
|
3445
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3446
|
+
quotaUser?: string;
|
|
3447
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3448
|
+
upload_protocol?: string;
|
|
3449
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3450
|
+
uploadType?: string;
|
|
3451
|
+
/**
|
|
3452
|
+
* Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a
|
|
3453
|
+
* single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128
|
|
3454
|
+
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3455
|
+
*/
|
|
3456
|
+
visitorId?: string;
|
|
3457
|
+
}): Request<GoogleCloudRetailV2CompleteQueryResponse>;
|
|
3458
|
+
/** Gets an AttributesConfig. */
|
|
3459
|
+
getAttributesConfig(request?: {
|
|
3460
|
+
/** V1 error format. */
|
|
3461
|
+
"$.xgafv"?: string;
|
|
3462
|
+
/** OAuth access token. */
|
|
3463
|
+
access_token?: string;
|
|
3464
|
+
/** Data format for response. */
|
|
3465
|
+
alt?: string;
|
|
3466
|
+
/** JSONP */
|
|
3467
|
+
callback?: string;
|
|
3468
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3469
|
+
fields?: string;
|
|
3470
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3471
|
+
key?: string;
|
|
3472
|
+
/** Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig` */
|
|
3473
|
+
name: string;
|
|
3474
|
+
/** OAuth 2.0 token for the current user. */
|
|
3475
|
+
oauth_token?: string;
|
|
3476
|
+
/** Returns response with indentations and line breaks. */
|
|
3477
|
+
prettyPrint?: boolean;
|
|
3478
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3479
|
+
quotaUser?: string;
|
|
3480
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3481
|
+
upload_protocol?: string;
|
|
3482
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3483
|
+
uploadType?: string;
|
|
3484
|
+
}): Request<GoogleCloudRetailV2AttributesConfig>;
|
|
3485
|
+
/** Gets a CompletionConfig. */
|
|
3486
|
+
getCompletionConfig(request?: {
|
|
3487
|
+
/** V1 error format. */
|
|
3488
|
+
"$.xgafv"?: string;
|
|
3489
|
+
/** OAuth access token. */
|
|
3490
|
+
access_token?: string;
|
|
3491
|
+
/** Data format for response. */
|
|
3492
|
+
alt?: string;
|
|
3493
|
+
/** JSONP */
|
|
3494
|
+
callback?: string;
|
|
3495
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3496
|
+
fields?: string;
|
|
3497
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3498
|
+
key?: string;
|
|
3499
|
+
/** Required. Full CompletionConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig */
|
|
3500
|
+
name: string;
|
|
3501
|
+
/** OAuth 2.0 token for the current user. */
|
|
3502
|
+
oauth_token?: string;
|
|
3503
|
+
/** Returns response with indentations and line breaks. */
|
|
3504
|
+
prettyPrint?: boolean;
|
|
3505
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3506
|
+
quotaUser?: string;
|
|
3507
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3508
|
+
upload_protocol?: string;
|
|
3509
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3510
|
+
uploadType?: string;
|
|
3511
|
+
}): Request<GoogleCloudRetailV2CompletionConfig>;
|
|
3512
|
+
/** Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog. */
|
|
3513
|
+
getDefaultBranch(request?: {
|
|
3514
|
+
/** V1 error format. */
|
|
3515
|
+
"$.xgafv"?: string;
|
|
3516
|
+
/** OAuth access token. */
|
|
3517
|
+
access_token?: string;
|
|
3518
|
+
/** Data format for response. */
|
|
3519
|
+
alt?: string;
|
|
3520
|
+
/** JSONP */
|
|
3521
|
+
callback?: string;
|
|
3522
|
+
/** The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`. */
|
|
3523
|
+
catalog: string;
|
|
3524
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3525
|
+
fields?: string;
|
|
3526
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3527
|
+
key?: string;
|
|
3528
|
+
/** OAuth 2.0 token for the current user. */
|
|
3529
|
+
oauth_token?: string;
|
|
3530
|
+
/** Returns response with indentations and line breaks. */
|
|
3531
|
+
prettyPrint?: boolean;
|
|
3532
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3533
|
+
quotaUser?: string;
|
|
3534
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3535
|
+
upload_protocol?: string;
|
|
3536
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3537
|
+
uploadType?: string;
|
|
3538
|
+
}): Request<GoogleCloudRetailV2GetDefaultBranchResponse>;
|
|
3539
|
+
/** Lists all the Catalogs associated with the project. */
|
|
3540
|
+
list(request?: {
|
|
3541
|
+
/** V1 error format. */
|
|
3542
|
+
"$.xgafv"?: string;
|
|
3543
|
+
/** OAuth access token. */
|
|
3544
|
+
access_token?: string;
|
|
3545
|
+
/** Data format for response. */
|
|
3546
|
+
alt?: string;
|
|
3547
|
+
/** JSONP */
|
|
3548
|
+
callback?: string;
|
|
3549
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3550
|
+
fields?: string;
|
|
3551
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3552
|
+
key?: string;
|
|
3553
|
+
/** OAuth 2.0 token for the current user. */
|
|
3554
|
+
oauth_token?: string;
|
|
3555
|
+
/**
|
|
3556
|
+
* Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an
|
|
3557
|
+
* INVALID_ARGUMENT is returned.
|
|
3558
|
+
*/
|
|
3559
|
+
pageSize?: number;
|
|
3560
|
+
/**
|
|
3561
|
+
* A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page. When paginating, all
|
|
3562
|
+
* other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3563
|
+
*/
|
|
3564
|
+
pageToken?: string;
|
|
3565
|
+
/**
|
|
3566
|
+
* Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this
|
|
3567
|
+
* location exists, a PERMISSION_DENIED error is returned.
|
|
3568
|
+
*/
|
|
3569
|
+
parent: string;
|
|
3570
|
+
/** Returns response with indentations and line breaks. */
|
|
3571
|
+
prettyPrint?: boolean;
|
|
3572
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3573
|
+
quotaUser?: string;
|
|
3574
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3575
|
+
upload_protocol?: string;
|
|
3576
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3577
|
+
uploadType?: string;
|
|
3578
|
+
}): Request<GoogleCloudRetailV2ListCatalogsResponse>;
|
|
3579
|
+
/** Updates the Catalogs. */
|
|
3580
|
+
patch(request: {
|
|
3581
|
+
/** V1 error format. */
|
|
3582
|
+
"$.xgafv"?: string;
|
|
3583
|
+
/** OAuth access token. */
|
|
3584
|
+
access_token?: string;
|
|
3585
|
+
/** Data format for response. */
|
|
3586
|
+
alt?: string;
|
|
3587
|
+
/** JSONP */
|
|
3588
|
+
callback?: string;
|
|
3589
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3590
|
+
fields?: string;
|
|
3591
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3592
|
+
key?: string;
|
|
3593
|
+
/** Required. Immutable. The fully qualified resource name of the catalog. */
|
|
3594
|
+
name: string;
|
|
3595
|
+
/** OAuth 2.0 token for the current user. */
|
|
3596
|
+
oauth_token?: string;
|
|
3597
|
+
/** Returns response with indentations and line breaks. */
|
|
3598
|
+
prettyPrint?: boolean;
|
|
3599
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3600
|
+
quotaUser?: string;
|
|
3601
|
+
/** Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
|
|
3602
|
+
updateMask?: string;
|
|
3603
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3604
|
+
upload_protocol?: string;
|
|
3605
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3606
|
+
uploadType?: string;
|
|
3607
|
+
/** Request body */
|
|
3608
|
+
resource: GoogleCloudRetailV2Catalog;
|
|
3609
|
+
}): Request<GoogleCloudRetailV2Catalog>;
|
|
3610
|
+
patch(request: {
|
|
3611
|
+
/** V1 error format. */
|
|
3612
|
+
"$.xgafv"?: string;
|
|
3613
|
+
/** OAuth access token. */
|
|
3614
|
+
access_token?: string;
|
|
3615
|
+
/** Data format for response. */
|
|
3616
|
+
alt?: string;
|
|
3617
|
+
/** JSONP */
|
|
3618
|
+
callback?: string;
|
|
3619
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3620
|
+
fields?: string;
|
|
3621
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3622
|
+
key?: string;
|
|
3623
|
+
/** Required. Immutable. The fully qualified resource name of the catalog. */
|
|
3624
|
+
name: string;
|
|
3625
|
+
/** OAuth 2.0 token for the current user. */
|
|
3626
|
+
oauth_token?: string;
|
|
3627
|
+
/** Returns response with indentations and line breaks. */
|
|
3628
|
+
prettyPrint?: boolean;
|
|
3629
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3630
|
+
quotaUser?: string;
|
|
3631
|
+
/** Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
|
|
3632
|
+
updateMask?: string;
|
|
3633
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3634
|
+
upload_protocol?: string;
|
|
3635
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3636
|
+
uploadType?: string;
|
|
3637
|
+
},
|
|
3638
|
+
body: GoogleCloudRetailV2Catalog): Request<GoogleCloudRetailV2Catalog>;
|
|
3639
|
+
/**
|
|
3640
|
+
* Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using
|
|
3641
|
+
* "default_branch" to the actual branch id set as default. For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as default, setting SearchRequest.branch to
|
|
3642
|
+
* `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent to setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/1`. Using multiple
|
|
3643
|
+
* branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using
|
|
3644
|
+
* this API while keeping using `projects/*/locations/*/catalogs/*/branches/default_branch` as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have
|
|
3645
|
+
* live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: *
|
|
3646
|
+
* PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). *
|
|
3647
|
+
* UserEventService will only join events with products from branch {newBranch}.
|
|
3648
|
+
*/
|
|
3649
|
+
setDefaultBranch(request: {
|
|
3650
|
+
/** V1 error format. */
|
|
3651
|
+
"$.xgafv"?: string;
|
|
3652
|
+
/** OAuth access token. */
|
|
3653
|
+
access_token?: string;
|
|
3654
|
+
/** Data format for response. */
|
|
3655
|
+
alt?: string;
|
|
3656
|
+
/** JSONP */
|
|
3657
|
+
callback?: string;
|
|
3658
|
+
/** Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`. */
|
|
3659
|
+
catalog: string;
|
|
3660
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3661
|
+
fields?: string;
|
|
3662
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3663
|
+
key?: string;
|
|
3664
|
+
/** OAuth 2.0 token for the current user. */
|
|
3665
|
+
oauth_token?: string;
|
|
3666
|
+
/** Returns response with indentations and line breaks. */
|
|
3667
|
+
prettyPrint?: boolean;
|
|
3668
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3669
|
+
quotaUser?: string;
|
|
3670
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3671
|
+
upload_protocol?: string;
|
|
3672
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3673
|
+
uploadType?: string;
|
|
3674
|
+
/** Request body */
|
|
3675
|
+
resource: GoogleCloudRetailV2SetDefaultBranchRequest;
|
|
3676
|
+
}): Request<{}>;
|
|
3677
|
+
setDefaultBranch(request: {
|
|
3678
|
+
/** V1 error format. */
|
|
3679
|
+
"$.xgafv"?: string;
|
|
3680
|
+
/** OAuth access token. */
|
|
3681
|
+
access_token?: string;
|
|
3682
|
+
/** Data format for response. */
|
|
3683
|
+
alt?: string;
|
|
3684
|
+
/** JSONP */
|
|
3685
|
+
callback?: string;
|
|
3686
|
+
/** Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`. */
|
|
3687
|
+
catalog: string;
|
|
3688
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3689
|
+
fields?: string;
|
|
3690
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3691
|
+
key?: string;
|
|
3692
|
+
/** OAuth 2.0 token for the current user. */
|
|
3693
|
+
oauth_token?: string;
|
|
3694
|
+
/** Returns response with indentations and line breaks. */
|
|
3695
|
+
prettyPrint?: boolean;
|
|
3696
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3697
|
+
quotaUser?: string;
|
|
3698
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3699
|
+
upload_protocol?: string;
|
|
3700
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3701
|
+
uploadType?: string;
|
|
3702
|
+
},
|
|
3703
|
+
body: GoogleCloudRetailV2SetDefaultBranchRequest): Request<{}>;
|
|
3704
|
+
/**
|
|
3705
|
+
* Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the
|
|
3706
|
+
* request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is
|
|
3707
|
+
* assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.
|
|
3708
|
+
*/
|
|
3709
|
+
updateAttributesConfig(request: {
|
|
3710
|
+
/** V1 error format. */
|
|
3711
|
+
"$.xgafv"?: string;
|
|
3712
|
+
/** OAuth access token. */
|
|
3713
|
+
access_token?: string;
|
|
3714
|
+
/** Data format for response. */
|
|
3715
|
+
alt?: string;
|
|
3716
|
+
/** JSONP */
|
|
3717
|
+
callback?: string;
|
|
3718
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3719
|
+
fields?: string;
|
|
3720
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3721
|
+
key?: string;
|
|
3722
|
+
/** Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig` */
|
|
3723
|
+
name: string;
|
|
3724
|
+
/** OAuth 2.0 token for the current user. */
|
|
3725
|
+
oauth_token?: string;
|
|
3726
|
+
/** Returns response with indentations and line breaks. */
|
|
3727
|
+
prettyPrint?: boolean;
|
|
3728
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3729
|
+
quotaUser?: string;
|
|
3730
|
+
/**
|
|
3731
|
+
* Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported
|
|
3732
|
+
* fields are updated.
|
|
3733
|
+
*/
|
|
3734
|
+
updateMask?: string;
|
|
3735
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3736
|
+
upload_protocol?: string;
|
|
3737
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3738
|
+
uploadType?: string;
|
|
3739
|
+
/** Request body */
|
|
3740
|
+
resource: GoogleCloudRetailV2AttributesConfig;
|
|
3741
|
+
}): Request<GoogleCloudRetailV2AttributesConfig>;
|
|
3742
|
+
updateAttributesConfig(request: {
|
|
3743
|
+
/** V1 error format. */
|
|
3744
|
+
"$.xgafv"?: string;
|
|
3745
|
+
/** OAuth access token. */
|
|
3746
|
+
access_token?: string;
|
|
3747
|
+
/** Data format for response. */
|
|
3748
|
+
alt?: string;
|
|
3749
|
+
/** JSONP */
|
|
3750
|
+
callback?: string;
|
|
3751
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3752
|
+
fields?: string;
|
|
3753
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3754
|
+
key?: string;
|
|
3755
|
+
/** Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig` */
|
|
3756
|
+
name: string;
|
|
3757
|
+
/** OAuth 2.0 token for the current user. */
|
|
3758
|
+
oauth_token?: string;
|
|
3759
|
+
/** Returns response with indentations and line breaks. */
|
|
3760
|
+
prettyPrint?: boolean;
|
|
3761
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3762
|
+
quotaUser?: string;
|
|
3763
|
+
/**
|
|
3764
|
+
* Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported
|
|
3765
|
+
* fields are updated.
|
|
3766
|
+
*/
|
|
3767
|
+
updateMask?: string;
|
|
3768
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3769
|
+
upload_protocol?: string;
|
|
3770
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3771
|
+
uploadType?: string;
|
|
3772
|
+
},
|
|
3773
|
+
body: GoogleCloudRetailV2AttributesConfig): Request<GoogleCloudRetailV2AttributesConfig>;
|
|
3774
|
+
/** Updates the CompletionConfigs. */
|
|
3775
|
+
updateCompletionConfig(request: {
|
|
3776
|
+
/** V1 error format. */
|
|
3777
|
+
"$.xgafv"?: string;
|
|
3778
|
+
/** OAuth access token. */
|
|
3779
|
+
access_token?: string;
|
|
3780
|
+
/** Data format for response. */
|
|
3781
|
+
alt?: string;
|
|
3782
|
+
/** JSONP */
|
|
3783
|
+
callback?: string;
|
|
3784
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3785
|
+
fields?: string;
|
|
3786
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3787
|
+
key?: string;
|
|
3788
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig` */
|
|
3789
|
+
name: string;
|
|
3790
|
+
/** OAuth 2.0 token for the current user. */
|
|
3791
|
+
oauth_token?: string;
|
|
3792
|
+
/** Returns response with indentations and line breaks. */
|
|
3793
|
+
prettyPrint?: boolean;
|
|
3794
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3795
|
+
quotaUser?: string;
|
|
3796
|
+
/**
|
|
3797
|
+
* Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order *
|
|
3798
|
+
* CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.
|
|
3799
|
+
*/
|
|
3800
|
+
updateMask?: string;
|
|
3801
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3802
|
+
upload_protocol?: string;
|
|
3803
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3804
|
+
uploadType?: string;
|
|
3805
|
+
/** Request body */
|
|
3806
|
+
resource: GoogleCloudRetailV2CompletionConfig;
|
|
3807
|
+
}): Request<GoogleCloudRetailV2CompletionConfig>;
|
|
3808
|
+
updateCompletionConfig(request: {
|
|
3809
|
+
/** V1 error format. */
|
|
3810
|
+
"$.xgafv"?: string;
|
|
3811
|
+
/** OAuth access token. */
|
|
3812
|
+
access_token?: string;
|
|
3813
|
+
/** Data format for response. */
|
|
3814
|
+
alt?: string;
|
|
3815
|
+
/** JSONP */
|
|
3816
|
+
callback?: string;
|
|
3817
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3818
|
+
fields?: string;
|
|
3819
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3820
|
+
key?: string;
|
|
3821
|
+
/** Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig` */
|
|
3822
|
+
name: string;
|
|
3823
|
+
/** OAuth 2.0 token for the current user. */
|
|
3824
|
+
oauth_token?: string;
|
|
3825
|
+
/** Returns response with indentations and line breaks. */
|
|
3826
|
+
prettyPrint?: boolean;
|
|
3827
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3828
|
+
quotaUser?: string;
|
|
3829
|
+
/**
|
|
3830
|
+
* Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order *
|
|
3831
|
+
* CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.
|
|
3832
|
+
*/
|
|
3833
|
+
updateMask?: string;
|
|
3834
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3835
|
+
upload_protocol?: string;
|
|
3836
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3837
|
+
uploadType?: string;
|
|
3838
|
+
},
|
|
3839
|
+
body: GoogleCloudRetailV2CompletionConfig): Request<GoogleCloudRetailV2CompletionConfig>;
|
|
3840
|
+
attributesConfig: AttributesConfigResource;
|
|
3841
|
+
branches: BranchesResource;
|
|
3842
|
+
completionData: CompletionDataResource;
|
|
3843
|
+
operations: OperationsResource;
|
|
3844
|
+
placements: PlacementsResource;
|
|
3845
|
+
servingConfigs: ServingConfigsResource;
|
|
3846
|
+
userEvents: UserEventsResource;
|
|
3847
|
+
}
|
|
3848
|
+
interface OperationsResource {
|
|
3849
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
3850
|
+
get(request?: {
|
|
3851
|
+
/** V1 error format. */
|
|
3852
|
+
"$.xgafv"?: string;
|
|
3853
|
+
/** OAuth access token. */
|
|
3854
|
+
access_token?: string;
|
|
3855
|
+
/** Data format for response. */
|
|
3856
|
+
alt?: string;
|
|
3857
|
+
/** JSONP */
|
|
3858
|
+
callback?: string;
|
|
3859
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3860
|
+
fields?: string;
|
|
3861
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3862
|
+
key?: string;
|
|
3863
|
+
/** The name of the operation resource. */
|
|
3864
|
+
name: string;
|
|
3865
|
+
/** OAuth 2.0 token for the current user. */
|
|
3866
|
+
oauth_token?: string;
|
|
3867
|
+
/** Returns response with indentations and line breaks. */
|
|
3868
|
+
prettyPrint?: boolean;
|
|
3869
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3870
|
+
quotaUser?: string;
|
|
3871
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3872
|
+
upload_protocol?: string;
|
|
3873
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3874
|
+
uploadType?: string;
|
|
3875
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3876
|
+
/**
|
|
3877
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
3878
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
3879
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
3880
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
3881
|
+
*/
|
|
3882
|
+
list(request?: {
|
|
3883
|
+
/** V1 error format. */
|
|
3884
|
+
"$.xgafv"?: string;
|
|
3885
|
+
/** OAuth access token. */
|
|
3886
|
+
access_token?: string;
|
|
3887
|
+
/** Data format for response. */
|
|
3888
|
+
alt?: string;
|
|
3889
|
+
/** JSONP */
|
|
3890
|
+
callback?: string;
|
|
3891
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3892
|
+
fields?: string;
|
|
3893
|
+
/** The standard list filter. */
|
|
3894
|
+
filter?: string;
|
|
3895
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3896
|
+
key?: string;
|
|
3897
|
+
/** The name of the operation's parent resource. */
|
|
3898
|
+
name: string;
|
|
3899
|
+
/** OAuth 2.0 token for the current user. */
|
|
3900
|
+
oauth_token?: string;
|
|
3901
|
+
/** The standard list page size. */
|
|
3902
|
+
pageSize?: number;
|
|
3903
|
+
/** The standard list page token. */
|
|
3904
|
+
pageToken?: string;
|
|
3905
|
+
/** Returns response with indentations and line breaks. */
|
|
3906
|
+
prettyPrint?: boolean;
|
|
3907
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3908
|
+
quotaUser?: string;
|
|
3909
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3910
|
+
upload_protocol?: string;
|
|
3911
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3912
|
+
uploadType?: string;
|
|
3913
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
3914
|
+
}
|
|
3915
|
+
interface LocationsResource {
|
|
3916
|
+
catalogs: CatalogsResource;
|
|
3917
|
+
operations: OperationsResource;
|
|
3918
|
+
}
|
|
3919
|
+
interface OperationsResource {
|
|
3920
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
3921
|
+
get(request?: {
|
|
3922
|
+
/** V1 error format. */
|
|
3923
|
+
"$.xgafv"?: string;
|
|
3924
|
+
/** OAuth access token. */
|
|
3925
|
+
access_token?: string;
|
|
3926
|
+
/** Data format for response. */
|
|
3927
|
+
alt?: string;
|
|
3928
|
+
/** JSONP */
|
|
3929
|
+
callback?: string;
|
|
3930
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3931
|
+
fields?: string;
|
|
3932
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3933
|
+
key?: string;
|
|
3934
|
+
/** The name of the operation resource. */
|
|
3935
|
+
name: string;
|
|
3936
|
+
/** OAuth 2.0 token for the current user. */
|
|
3937
|
+
oauth_token?: string;
|
|
3938
|
+
/** Returns response with indentations and line breaks. */
|
|
3939
|
+
prettyPrint?: boolean;
|
|
3940
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3941
|
+
quotaUser?: string;
|
|
3942
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3943
|
+
upload_protocol?: string;
|
|
3944
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3945
|
+
uploadType?: string;
|
|
3946
|
+
}): Request<GoogleLongrunningOperation>;
|
|
3947
|
+
/**
|
|
3948
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
3949
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
3950
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
3951
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
3952
|
+
*/
|
|
3953
|
+
list(request?: {
|
|
3954
|
+
/** V1 error format. */
|
|
3955
|
+
"$.xgafv"?: string;
|
|
3956
|
+
/** OAuth access token. */
|
|
3957
|
+
access_token?: string;
|
|
3958
|
+
/** Data format for response. */
|
|
3959
|
+
alt?: string;
|
|
3960
|
+
/** JSONP */
|
|
3961
|
+
callback?: string;
|
|
3962
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3963
|
+
fields?: string;
|
|
3964
|
+
/** The standard list filter. */
|
|
3965
|
+
filter?: string;
|
|
3966
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
3967
|
+
key?: string;
|
|
3968
|
+
/** The name of the operation's parent resource. */
|
|
3969
|
+
name: string;
|
|
3970
|
+
/** OAuth 2.0 token for the current user. */
|
|
3971
|
+
oauth_token?: string;
|
|
3972
|
+
/** The standard list page size. */
|
|
3973
|
+
pageSize?: number;
|
|
3974
|
+
/** The standard list page token. */
|
|
3975
|
+
pageToken?: string;
|
|
3976
|
+
/** Returns response with indentations and line breaks. */
|
|
3977
|
+
prettyPrint?: boolean;
|
|
3978
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3979
|
+
quotaUser?: string;
|
|
3980
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3981
|
+
upload_protocol?: string;
|
|
3982
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3983
|
+
uploadType?: string;
|
|
3984
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
3985
|
+
}
|
|
3986
|
+
interface ProjectsResource {
|
|
3987
|
+
locations: LocationsResource;
|
|
3988
|
+
operations: OperationsResource;
|
|
3989
|
+
}
|
|
3990
|
+
|
|
3991
|
+
const projects: ProjectsResource;
|
|
3992
|
+
}
|
|
3993
|
+
}
|