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
}
欄位
kind

string

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

id

string

工作 ID。

etag

string

資源的 ETag。

title

string

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

updated

string

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

parent

string

僅供輸出。父項工作 ID。如果是頂層工作,則省略這個欄位。這是唯讀欄位。使用「移動」方法,即可將工作移至其他父項或頂層。

position

string

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

notes

string

說明工作的附註。選用設定。長度上限為 8,192 個字元。

status

string

工作狀態。系統可為「needsAction」或「completed」

due

string

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

completed

string

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

deleted

boolean

此標記用於註明工作是否已刪除。預設值為 False。

hidden

boolean

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

links[].type

string

連結的類型,例如「電子郵件」。

links[].description

string

說明。使用 HTML 時:<a> 和 </a> 之間的所有內容。

links[].link

string

網址。

方法

clear

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

delete

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

get

傳回指定工作。

insert

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

list

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

move

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

patch

更新指定工作。

update

更新指定工作。