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。如果是頂層工作，則會省略這個欄位。使用「move」方法，將工作移至其他上層或頂層。父項工作不得是已指派的工作 (來自 Chat 聊天室、Google 文件)。這是唯讀欄位。
position

string

僅供輸出。字串，指出工作在同一個父項工作或頂層的兄弟姊妹工作中的位置。如果這個字串根據字典順序大於其他工作對應的位置字串，則該工作會排在同一父項工作 (或頂層) 下方的其他工作之後。使用「move」方法將工作移至其他位置。
notes

string

說明工作的附註。透過 Google 文件指派的工作無法附註，選用設定。長度上限：8192 個半形字元。
status

string

工作狀態。這可能是「needsAction」或「completed」。
due

string

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

string

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

boolean

標記用於指出工作是否已刪除。對於已指派的工作，這個欄位為唯讀。您只能呼叫 tasks.delete 來刪除這些工作，在這種情況下，系統會刪除已指派的工作和原始工作 (在文件或 Chat 聊天室中)。如要只刪除已指派的工作，請前往指派介面，然後取消指派工作。預設值為 False。
hidden

boolean

此標記用於註明工作是否已隱藏。在清除工作清單時，如果工作已標示為完成，就會發生這種情況。預設值為 False。這是唯讀欄位。
links[].type

string

連結類型，例如「電子郵件」。
links[].description

string

說明。在 HTML 中，<a> 和 </a> 之間的所有內容。
links[].link

string

網址。
assignmentInfo

object (AssignmentInfo)

僅供輸出。指派工作內容的背景資訊。您可以指派工作給使用者，目前可透過 Google 文件和 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

指派工作時所用的 Google 雲端硬碟資源 (文件、試算表等) 相關資訊。

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

 更新指定的工作。