Method: projects.locations.products.referenceImages.list

Lists reference images.

Possible errors:

  • Returns NOT_FOUND if the parent product does not exist.
  • Returns INVALID_ARGUMENT if the pageSize is greater than 100, or less than 1.

HTTP request

GET https://vision.googleapis.com/v1/{parent=projects/*/locations/*/products/*}/referenceImages

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource name of the product containing the reference images.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Query parameters

Parameters
pageSize

number

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

pageToken

string

A token identifying a page of results to be returned. This is the value of nextPageToken returned in a previous reference image list request.

Defaults to the first page if not specified.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for the referenceImages.list method.

JSON representation 
{
  "referenceImages": [
    {
      object (ReferenceImage)
    }
  ],
  "pageSize": number,
  "nextPageToken": string
}
Fields
referenceImages[]

object (ReferenceImage)

The list of reference images.

pageSize

number

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

nextPageToken

string

The nextPageToken returned from a previous List request, if any.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

For more information, see the Authentication Overview.