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

任务的标题。允许的长度上限:1024 个字符。

updated

string

仅限输出。任务的上次修改时间(以 RFC 3339 时间戳表示)。

parent

string

仅限输出。父级任务标识符。如果它是顶级任务,则省略此字段。使用“移动”方法将任务移至其他父级或顶级。绝不会是父级任务(来自 Chat 聊天室、Google 文档)。此字段为只读字段。

position

string

仅限输出。字符串,指示同一任务在同一父级任务下或位于顶级任务的同级任务中的位置。如果此字符串大于另一任务的相应位置字符串(按字典顺序排列),则该任务将在同一父任务下(或顶级)排在另一个任务之后。使用“移动”方法将任务移到其他位置。

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

链接类型,例如“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 中文件的标识符。

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

更新指定的任务。