1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="vision_v1.html">Cloud Vision API</a> . <a href="vision_v1.projects.html">projects</a> . <a href="vision_v1.projects.locations.html">locations</a> . <a href="vision_v1.projects.locations.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="vision_v1.projects.locations.products.referenceImages.html">referenceImages()</a></code>
</p>
<p class="firstline">Returns the referenceImages Resource.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body, x__xgafv=None, productId=None)</a></code></p>
<p class="firstline">Creates and returns a new product resource.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Permanently deletes a product and its reference images.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information associated with a Product.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists products in an unspecified order.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Makes changes to a Product resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body, x__xgafv=None, productId=None)</code>
<pre>Creates and returns a new product resource.
Possible errors:
* Returns INVALID_ARGUMENT if display_name is missing or longer than 4096
characters.
* Returns INVALID_ARGUMENT if description is longer than 4096 characters.
* Returns INVALID_ARGUMENT if product_category is missing or invalid.
Args:
parent: string, The project in which the Product should be created.
Format is
`projects/PROJECT_ID/locations/LOC_ID`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A Product contains ReferenceImages.
"productLabels": [ # Key-value pairs that can be attached to a product. At query time,
# constraints can be specified based on the product_labels.
#
# Note that integer values can be provided as strings, e.g. "1199". Only
# strings with integer values can match a range-based restriction which is
# to be supported soon.
#
# Multiple values can be assigned to the same key. One product may have up to
# 100 product_labels.
{ # A product label represented as a key-value pair.
"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot
# exceed 128 bytes.
"value": "A String", # The value of the label attached to the product. Cannot be empty and
# cannot exceed 128 bytes.
},
],
"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most
# 4096 characters long.
"name": "A String", # The resource name of the product.
#
# Format is:
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
#
# This field is ignored when creating a product.
"productCategory": "A String", # The category for the product identified by the reference image. This should
# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
# "homegoods", "apparel", and "toys" are still supported, but these should
# not be used for new products.
#
# This field is immutable.
"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096
# characters long.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
productId: string, A user-supplied resource id for this Product. If set, the server will
attempt to use this value as the resource id. If it is already in use, an
error is returned with code ALREADY_EXISTS. Must be at most 128 characters
long. It cannot contain the character `/`.
Returns:
An object of the form:
{ # A Product contains ReferenceImages.
"productLabels": [ # Key-value pairs that can be attached to a product. At query time,
# constraints can be specified based on the product_labels.
#
# Note that integer values can be provided as strings, e.g. "1199". Only
# strings with integer values can match a range-based restriction which is
# to be supported soon.
#
# Multiple values can be assigned to the same key. One product may have up to
# 100 product_labels.
{ # A product label represented as a key-value pair.
"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot
# exceed 128 bytes.
"value": "A String", # The value of the label attached to the product. Cannot be empty and
# cannot exceed 128 bytes.
},
],
"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most
# 4096 characters long.
"name": "A String", # The resource name of the product.
#
# Format is:
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
#
# This field is ignored when creating a product.
"productCategory": "A String", # The category for the product identified by the reference image. This should
# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
# "homegoods", "apparel", and "toys" are still supported, but these should
# not be used for new products.
#
# This field is immutable.
"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096
# characters long.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Permanently deletes a product and its reference images.
Metadata of the product and all its images will be deleted right away, but
search queries against ProductSets containing the product may still work
until all related caches are refreshed.
Args:
name: string, Resource name of product to delete.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets information associated with a Product.
Possible errors:
* Returns NOT_FOUND if the Product does not exist.
Args:
name: string, Resource name of the Product to get.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Product contains ReferenceImages.
"productLabels": [ # Key-value pairs that can be attached to a product. At query time,
# constraints can be specified based on the product_labels.
#
# Note that integer values can be provided as strings, e.g. "1199". Only
# strings with integer values can match a range-based restriction which is
# to be supported soon.
#
# Multiple values can be assigned to the same key. One product may have up to
# 100 product_labels.
{ # A product label represented as a key-value pair.
"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot
# exceed 128 bytes.
"value": "A String", # The value of the label attached to the product. Cannot be empty and
# cannot exceed 128 bytes.
},
],
"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most
# 4096 characters long.
"name": "A String", # The resource name of the product.
#
# Format is:
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
#
# This field is ignored when creating a product.
"productCategory": "A String", # The category for the product identified by the reference image. This should
# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
# "homegoods", "apparel", and "toys" are still supported, but these should
# not be used for new products.
#
# This field is immutable.
"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096
# characters long.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists products in an unspecified order.
Possible errors:
* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
Args:
parent: string, The project OR ProductSet from which Products should be listed.
Format:
`projects/PROJECT_ID/locations/LOC_ID` (required)
pageSize: integer, The maximum number of items to return. Default 10, maximum 100.
pageToken: string, The next_page_token returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the `ListProducts` method.
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
# results in the list.
"products": [ # List of products.
{ # A Product contains ReferenceImages.
"productLabels": [ # Key-value pairs that can be attached to a product. At query time,
# constraints can be specified based on the product_labels.
#
# Note that integer values can be provided as strings, e.g. "1199". Only
# strings with integer values can match a range-based restriction which is
# to be supported soon.
#
# Multiple values can be assigned to the same key. One product may have up to
# 100 product_labels.
{ # A product label represented as a key-value pair.
"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot
# exceed 128 bytes.
"value": "A String", # The value of the label attached to the product. Cannot be empty and
# cannot exceed 128 bytes.
},
],
"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most
# 4096 characters long.
"name": "A String", # The resource name of the product.
#
# Format is:
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
#
# This field is ignored when creating a product.
"productCategory": "A String", # The category for the product identified by the reference image. This should
# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
# "homegoods", "apparel", and "toys" are still supported, but these should
# not be used for new products.
#
# This field is immutable.
"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096
# characters long.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
<pre>Makes changes to a Product resource.
Only the `display_name`, `description`, and `labels` fields can be updated
right now.
If labels are updated, the change will not be reflected in queries until
the next index time.
Possible errors:
* Returns NOT_FOUND if the Product does not exist.
* Returns INVALID_ARGUMENT if display_name is present in update_mask but is
missing from the request or longer than 4096 characters.
* Returns INVALID_ARGUMENT if description is present in update_mask but is
longer than 4096 characters.
* Returns INVALID_ARGUMENT if product_category is present in update_mask.
Args:
name: string, The resource name of the product.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
This field is ignored when creating a product. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A Product contains ReferenceImages.
"productLabels": [ # Key-value pairs that can be attached to a product. At query time,
# constraints can be specified based on the product_labels.
#
# Note that integer values can be provided as strings, e.g. "1199". Only
# strings with integer values can match a range-based restriction which is
# to be supported soon.
#
# Multiple values can be assigned to the same key. One product may have up to
# 100 product_labels.
{ # A product label represented as a key-value pair.
"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot
# exceed 128 bytes.
"value": "A String", # The value of the label attached to the product. Cannot be empty and
# cannot exceed 128 bytes.
},
],
"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most
# 4096 characters long.
"name": "A String", # The resource name of the product.
#
# Format is:
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
#
# This field is ignored when creating a product.
"productCategory": "A String", # The category for the product identified by the reference image. This should
# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
# "homegoods", "apparel", and "toys" are still supported, but these should
# not be used for new products.
#
# This field is immutable.
"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096
# characters long.
}
updateMask: string, The FieldMask that specifies which fields
to update.
If update_mask isn't specified, all mutable fields are to be updated.
Valid mask paths include `product_labels`, `display_name`, and
`description`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Product contains ReferenceImages.
"productLabels": [ # Key-value pairs that can be attached to a product. At query time,
# constraints can be specified based on the product_labels.
#
# Note that integer values can be provided as strings, e.g. "1199". Only
# strings with integer values can match a range-based restriction which is
# to be supported soon.
#
# Multiple values can be assigned to the same key. One product may have up to
# 100 product_labels.
{ # A product label represented as a key-value pair.
"key": "A String", # The key of the label attached to the product. Cannot be empty and cannot
# exceed 128 bytes.
"value": "A String", # The value of the label attached to the product. Cannot be empty and
# cannot exceed 128 bytes.
},
],
"displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most
# 4096 characters long.
"name": "A String", # The resource name of the product.
#
# Format is:
# `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
#
# This field is ignored when creating a product.
"productCategory": "A String", # The category for the product identified by the reference image. This should
# be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
# "homegoods", "apparel", and "toys" are still supported, but these should
# not be used for new products.
#
# This field is immutable.
"description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096
# characters long.
}</pre>
</div>
</body></html>
|
