| <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.productSets.html">productSets</a> . <a href="vision_v1.projects.locations.productSets.products.html">products</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the Products in a ProductSet, in an unspecified order. If the</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> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="list">list(name, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the Products in a ProductSet, in an unspecified order. If the |
| ProductSet does not exist, the products field of the response will be |
| empty. |
| |
| Possible errors: |
| |
| * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. |
| |
| Args: |
| name: string, Required. The ProductSet resource for which to retrieve Products. |
| |
| Format is: |
| `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_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 `ListProductsInProductSet` method. |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more |
| # results in the list. |
| "products": [ # The list of Products. |
| { # A Product contains ReferenceImages. |
| "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. |
| "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 |
| # 500 product_labels. |
| # |
| # Notice that the total number of distinct product_labels over all products |
| # in one ProductSet cannot exceed 1M, otherwise the product search pipeline |
| # will refuse to work for that ProductSet. |
| { # 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. |
| }, |
| ], |
| "description": "A String", # User-provided metadata to be stored with this product. Must be at most 4096 |
| # characters long. |
| "productCategory": "A String", # Immutable. 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. |
| }, |
| ], |
| }</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> |
| |
| </body></html> |