list(name, pageToken=None, x__xgafv=None, pageSize=None)

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, The ProductSet resource for which to retrieve Products.

Format is:
`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` (required)
  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
  pageSize: integer, The maximum number of items to return. Default 10, maximum 100.

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.
        "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.
      },
    ],
  }

list_next(previous_request, previous_response)

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.

Cloud Vision API . projects . locations . productSets . products

Instance Methods

Method Details