Method: projects.locations.productSets.products.list

ProductSet 内の Products を不特定の順序で一覧表示します。ProductSet が存在しない場合、レスポンスの products フィールドは空になります。

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

  • pageSize が 100 より大きいか 1 未満の場合は、INVALID_ARGUMENT を返します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

Products を取得する ProductSet リソース。

形式: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

クエリ パラメータ

パラメータ
pageSize

number

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

string

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

リクエストの本文

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

レスポンスの本文

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

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

JSON 表現 
{
  "products": [
    {
      object(Product)
    }
  ],
  "nextPageToken": string
}
フィールド
products[]

object(Product)

Products のリスト。
nextPageToken

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

認証スコープ

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

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

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