Method: tasks.list

指定されたフィルタに一致するタスクを一覧表示します。

HTTP リクエスト

GET https://ces.googleapis.com/tasks

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

クエリ パラメータ

パラメータ
tenant

string

省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した AgentInterface の tenant 値と一致する必要があります。
contextId

string

コンテキスト ID でタスクをフィルタして、特定の会話またはセッションからタスクを取得します。
status

enum (TaskState)

タスクを現在のステータスでフィルタします。
pageToken

string

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

string (Timestamp format)

ISO 8601 形式（例: 「2023-10-27T10:00:00Z」）で指定されたタイムスタンプ以降にステータスが更新されたタスクをフィルタします。ステータスのタイムスタンプがこの値以上のタスクのみが返されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
pageSize

integer

返されるタスクの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のタスクが返されます。最小値は 1 です。最大値は 100 です。
historyLength

integer

各タスクの履歴に含めるメッセージの最大数。
includeArtifacts

boolean

返されたタスクにアーティファクトを含めるかどうか。ペイロード サイズを小さくするため、デフォルトは false です。

リクエストの本文

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

レスポンスの本文

tasks.list メソッドの結果オブジェクト。タスクの配列とページネーション情報が含まれます。

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

JSON 表現 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "pageSize": integer,
  "totalSize": integer
}
フィールド
tasks[]

object (Task)

必須。指定された条件に一致するタスクの配列。
nextPageToken

string

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

integer

必須。このレスポンスに使用されたページサイズ。
totalSize

integer

必須。使用可能なタスクの合計数（ページネーション前）。

認可スコープ

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

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

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