List

Lists ProductSets in an unspecified order

3 variables
10 variables

Lists ProductSets in an unspecified order.

Possible errors:

  • Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • Apply machine learning models to understand and label images

Input

This building block consumes 3 input parameters

  = Parameter name
  = Format

parent STRING Required

The project from which ProductSets should be listed.

Format is projects/PROJECT_ID/locations/LOC_ID

pageToken STRING

The next_page_token returned from a previous List request, if any

pageSize INTEGER

The maximum number of items to return. Default 10, maximum 100

Output

This building block provides 10 output parameters

  = Parameter name
  = Format

productSets[] OBJECT

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail

productSets[].indexTime ANY

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z".

This field is ignored when creating a ProductSet

productSets[].indexError OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide

productSets[].indexError.code INTEGER

The status code, which should be an enum value of google.rpc.Code

productSets[].indexError.message STRING

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 client

productSets[].indexError.details[] OBJECT

productSets[].indexError.details[].customKey.value ANY

productSets[].name STRING

The resource name of the ProductSet.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

This field is ignored when creating a ProductSet

productSets[].displayName STRING

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long

nextPageToken STRING

Token to retrieve the next page of results, or empty if there are no more results in the list