Method: projects.locations.products.referenceImages.list

参照画像を一覧表示します。

発生する可能性があるエラー:

  • 親商品が存在しない場合、NOT_FOUND を返します。
  • pageSize が 100 より大きいか 1 未満の場合は、INVALID_ARGUMENT を返します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

参照画像が含まれる商品のリソース名。

形式は projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID です。

クエリ パラメータ

パラメータ
pageSize

number

返される最大アイテム数。デフォルト 10、最大 100。
pageToken

string

返される結果のページを特定するトークンです。これは、前の参照画像の list リクエストで返された nextPageToken の値です。

指定しない場合、デフォルトで先頭ページになります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

referenceImages.list メソッドに対するレスポンス メッセージ。

JSON 表現 
{
  "referenceImages": [
    {
      object(ReferenceImage)
    }
  ],
  "pageSize": number,
  "nextPageToken": string
}
フィールド
referenceImages[]

object(ReferenceImage)

参照画像のリスト。
pageSize

number

返される最大アイテム数。デフォルト 10、最大 100。
nextPageToken

string

前の List リクエストから返された nextPageToken（存在する場合）。

認証スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。