Method: projects.locations.collections.engines.controls.list

すべてのコントロールを親 DataStore で一覧表示します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/engines/*}/controls

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

パスパラメータ

パラメータ
parent

string

必須。データストアのリソース名。形式: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId} または projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}。

クエリ パラメータ

パラメータ
pageSize

integer

省略可。ページあたりの結果数の上限です。指定されていない場合、デフォルトは 50 件です。最大許容値は 1,000 です。
pageToken

string

省略可。前回の controls.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。
filter

string

省略可。リストの結果に適用するフィルタ。サポートされている機能:

  • filter が設定されていない場合は、親ブランチのすべての商品を一覧表示します。現在、このフィールドはサポートされていません。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文には ListControlsResponse のインスタンスが含まれます。

認可スコープ

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

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.controls.list

詳細については、IAM のドキュメントをご覧ください。