Method: projects.locations.products.referenceImages.list
Stay organized with collections
Save and categorize content based on your preferences.
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/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
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-platformhttps://www.googleapis.com/auth/cloud-vision
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-27 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: projects.locations.products.referenceImages.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListReferenceImagesResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nLists reference images.\n\nPossible errors:\n\n- Returns NOT_FOUND if the parent product does not exist.\n- Returns INVALID_ARGUMENT if the pageSize is greater than 100, or less than 1.\n\n### HTTP request\n\n`GET https://vision.googleapis.com/v1p3beta1/{parent=projects/*/locations/*/products/*}/referenceImages`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for the `referenceImages.list` method.\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `https://www.googleapis.com/auth/cloud-vision`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
