Method: projects.locations.collections.engines.assistants.cannedQueries.list

Assistant のすべての CannedQuery を一覧表示します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}/cannedQueries

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

パスパラメータ

パラメータ
parent

string

必須。親リソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

クエリ パラメータ

パラメータ
filter

string

省略可。フィルタ式。

サポートされているフィールド:

  • enabled
  • googleDefined

例:

  • enabled=true
  • googleDefined=true
  • enabled=true AND googleDefined=true
pageSize

integer

返される保存済みクエリの最大数。指定しない場合、デフォルトは 100 です。最大許容値は 1,000 です。これを超える値は 1,000 に強制変換されます。
pageToken

string

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

ページ分割を行う場合、CannedQueryService.ListCannedQueries に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

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

レスポンスの本文

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

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (CannedQuery)

リクエストに一致する CannedQuery のリスト。
nextPageToken

string

次のページを取得するために ListCannedQueriesRequest.page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

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

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

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