REST Resource: tasks

资源：任务

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

任务标识符。
etag

string

资源的 ETag。
title

string

任务的标题。允许的长度上限：1,024 个字符。
updated

string

仅限输出。任务的最后修改时间（采用 RFC 3339 时间戳）。
parent

string

仅限输出。父级任务标识符。如果是顶级任务，则省略此字段。使用“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 来删除这些任务，在这种情况下，分配的任务和原始任务（在 Google 文档或 Chat 聊天室中）都会被删除。如需仅删除已分配的任务，请前往作业界面，然后在该界面中取消分配任务。默认值为 False。
hidden

boolean

指示任务是否处于隐藏状态的标志。如果任务在上次清除任务列表时已被标记为已完成，则会出现这种情况。默认值为 False。此字段为只读字段。
links[].type

string

链接的类型，例如“电子邮件”。
links[].description

string

说明。用 HTML 术语来说：<a> 和 </a> 之间的所有内容。
links[].link

string

网址。
assignmentInfo

object (AssignmentInfo)

仅限输出。分配的任务的上下文信息。您可以向用户分配任务，目前可以在 Google 文档和 Chat 聊天室等界面中执行此操作。系统会针对分配给当前用户的任务填充此字段，并标识任务的分配来源。此字段为只读字段。

AssignmentInfo

有关任务分配来源（文档、聊天室）的信息。

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)

仅限输出。此分配任务的来源界面类型。目前仅限于“文档”或“聊天室”。
联合字段 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 中文件的标识符。
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

 更新指定的任务。