• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<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.productSets.html">productSets</a> . <a href="vision_v1.projects.locations.productSets.products.html">products</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
79<p class="firstline">Lists the Products in a ProductSet, in an unspecified order. If the</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
86  <pre>Lists the Products in a ProductSet, in an unspecified order. If the
87ProductSet does not exist, the products field of the response will be
88empty.
89
90Possible errors:
91
92* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
93
94Args:
95  name: string, The ProductSet resource for which to retrieve Products.
96
97Format is:
98`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
99  pageToken: string, The next_page_token returned from a previous List request, if any.
100  x__xgafv: string, V1 error format.
101    Allowed values
102      1 - v1 error format
103      2 - v2 error format
104  pageSize: integer, The maximum number of items to return. Default 10, maximum 100.
105
106Returns:
107  An object of the form:
108
109    { # Response message for the `ListProductsInProductSet` method.
110    "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
111        # results in the list.
112    "products": [ # The list of Products.
113      { # A Product contains ReferenceImages.
114        "productLabels": [ # Key-value pairs that can be attached to a product. At query time,
115            # constraints can be specified based on the product_labels.
116            #
117            # Note that integer values can be provided as strings, e.g. "1199". Only
118            # strings with integer values can match a range-based restriction which is
119            # to be supported soon.
120            #
121            # Multiple values can be assigned to the same key. One product may have up to
122            # 100 product_labels.
123          { # A product label represented as a key-value pair.
124            "key": "A String", # The key of the label attached to the product. Cannot be empty and cannot
125                # exceed 128 bytes.
126            "value": "A String", # The value of the label attached to the product. Cannot be empty and
127                # cannot exceed 128 bytes.
128          },
129        ],
130        "displayName": "A String", # The user-provided name for this Product. Must not be empty. Must be at most
131            # 4096 characters long.
132        "name": "A String", # The resource name of the product.
133            #
134            # Format is:
135            # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
136            #
137            # This field is ignored when creating a product.
138        "productCategory": "A String", # The category for the product identified by the reference image. This should
139            # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories
140            # "homegoods", "apparel", and "toys" are still supported, but these should
141            # not be used for new products.
142            #
143            # This field is immutable.
144        "description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096
145            # characters long.
146      },
147    ],
148  }</pre>
149</div>
150
151<div class="method">
152    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
153  <pre>Retrieves the next page of results.
154
155Args:
156  previous_request: The request for the previous page. (required)
157  previous_response: The response from the request for the previous page. (required)
158
159Returns:
160  A request object that you can call 'execute()' on to request the next
161  page. Returns None if there are no more items in the collection.
162    </pre>
163</div>
164
165</body></html>