Method: tasks.list

列出符合指定篩選條件的工作。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
tenant

string

選用。不透明的路由 ID。如果設定該欄位，則必須與所選代理資訊卡中的 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。