REST Resource: tasks

資源：Task

JSON 表示法 
{
  "kind": string,
  "id": string,
  "etag": string,
  "title": string,
  "updated": string,
  "selfLink": string,
  "parent": string,
  "position": string,
  "notes": string,
  "status": string,
  "due": string,
  "completed": string,
  "deleted": boolean,
  "hidden": boolean,
  "links": [
    {
      "type": string,
      "description": string,
      "link": string
    }
  ],
  "webViewLink": string,
  "assignmentInfo": {
    object (AssignmentInfo)
  }
}
欄位
kind

string

僅供輸出。資源類型。這一律為「tasks#task」。
id

string

工作 ID。
etag

string

資源的 ETag。
title

string

工作的標題。長度上限為 1024 個半形字元。
updated

string

僅供輸出。工作上次修改時間 (以 RFC 3339 時間戳記表示)。
parent

string

僅供輸出。父項工作 ID。如果是頂層工作，則省略這個欄位。使用「移動」功能方法，將工作移至其他父項或頂層。父項工作一律不得做為指派工作 (來自 Chat 聊天室和文件)。這是唯讀欄位。
position

string

僅供輸出。字串，表示任務在相同父項工作下或頂層中的同層級工作位置。如果此字串大於其他工作 (依字典編列順序) 的對應位置字串，則工作會置於相同父項工作中 (或頂層) 的其他工作之後。使用「移動」功能方法，即可將工作移至其他位置。
notes

string

說明工作的附註。透過 Google 文件指派的工作不能有記事。選用設定。長度上限為 8,192 個字元。
status

string

工作狀態。可能是「needsAction」或「已完成」
due

string

工作截止日期 (以 RFC 3339 時間戳記表示)。選用設定。截止日只會記錄日期資訊；設定到期日時，系統會捨棄時間戳記的時間部分。您無法透過 API 讀取或寫入工作到期的時間。
completed

string

工作的完成日期 (以 RFC 3339 時間戳記表示)。如果工作尚未完成，則省略這個欄位。
deleted

boolean

此標記用於註明工作是否已刪除。如果是指派的工作，這個欄位為唯讀性質。如要刪除這類工作，請呼叫 task.delete。在這種情況下，已指派的工作和原始工作 (位於 Google 文件或 Chat 聊天室) 會一併刪除。如果只要刪除已指派的工作，請前往作業介面並從該介面取消指派工作。預設值為 False。
hidden

boolean

此標記用於註明是否要隱藏工作。在工作清單上次清除時，工作就已經標示為完成。預設值為 False。這是唯讀欄位。
links[].type

string

連結類型，例如：「email」。
links[].description

string

說明。使用 HTML 編寫：<a>和 </a>。
links[].link

string

網址。
assignmentInfo

object (AssignmentInfo)

僅供輸出。指派工作的背景資訊。工作目前可以指派給使用者，目前可透過文件和 Chat 聊天室等途徑指派給使用者。這個欄位會填入指派給目前使用者的工作，並識別指派工作的來源。這是唯讀欄位。

AssignmentInfo

工作指派來源 (文件、Chat 聊天室) 的相關資訊。

JSON 表示法 
{
  "linkToTask": string,
  "surfaceType": enum (ContextType),

  // Union field surface_info can be only one of the following:
  "driveResourceInfo": {
    object (DriveResourceInfo)
  },
  "spaceInfo": {
    object (SpaceInfo)
  }
  // End of list of possible types for union field surface_info.
}
欄位
surfaceType

enum (ContextType)

僅供輸出。這個指派工作的介面類型。目前僅限於 DOCUMENT 或 SPACE。
聯集欄位 surface_info。指派這項工作的介面 (文件、Chat 聊天室) 相關資訊。surface_info 只能是下列其中一項：
driveResourceInfo

object (DriveResourceInfo)

僅供輸出。產生這項工作的雲端硬碟檔案相關資訊。目前，雲端硬碟檔案只能設為文件。這是唯讀欄位。
spaceInfo

object (SpaceInfo)

僅供輸出。產生這項工作的 Chat 聊天室相關資訊。這是唯讀欄位。

ContextType

與工作相關聯的產品。

列舉
CONTEXT_TYPE_UNSPECIFIED 這項工作的背景資訊不明。
GMAIL 這項工作是透過 Gmail 建立。
DOCUMENT 透過文件指派工作。
SPACE 從 Chat 聊天室指派工作。

DriveResourceInfo

指派工作的雲端硬碟資源 (文件、工作表等) 相關資訊。

JSON 表示法 
{
  "driveFileId": string,
  "resourceKey": string
}
欄位
driveFileId

string

僅供輸出。Drive API 中檔案的 ID。
resourceKey

string

僅供輸出。必須使用資源金鑰才能存取透過共用連結共用的檔案。並非所有檔案均需如此。另請參閱 developers.google.com/drive/api/guides/resource-keys。

SpaceInfo

指派工作的 Chat 聊天室相關資訊。

JSON 表示法 
{
  "space": string
}
欄位
space

string

僅供輸出。產生這項工作的 Chat 聊天室。格式為「spaces/{space}」。

方法

clear

 清除指定工作清單中所有已完成的工作。

delete

 從工作清單中刪除指定工作。

get

 傳回指定工作。

insert

 在指定的工作清單上建立新工作。

list

 傳回指定工作清單中的所有工作。

move

 將指定工作移至目的地工作清單中的其他位置。

patch

 更新指定工作。

update

 更新指定工作。