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

任务标识符。

etag

string

资源的 ETag。

title

string

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

updated

string

仅限输出。任务的上次修改时间(采用 RFC 3339 时间戳格式)。

parent

string

仅限输出。父任务标识符。如果相应任务是顶级任务,则省略此字段。使用“移动”方法将任务移至其他父级或顶级。父任务永远不能是分配的任务(来自 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 文档或聊天室中)都会被删除。如需仅删除已分配的任务,请前往作业界面,然后从该界面中取消分配任务。默认值为 False。

hidden

boolean

一个标志,用于指示任务是否处于隐藏状态。如果任务列表上次清空时,相应任务已被标记为完成,则会发生这种情况。默认值为 False。此字段为只读字段。

links[].type

string

链接的类型,例如“email”“generic”“chat_message”“keep_note”。

links[].description

string

说明(可能为空)。

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)

仅限输出。分配的任务的来源界面类型。目前仅限 DOCUMENT 或 SPACE。

联合字段 surface_info。有关分配此任务的界面(Google 文档、Chat 聊天室)的信息。surface_info 只能是下列其中一项:
driveResourceInfo

object (DriveResourceInfo)

仅限输出。相应任务所源自的云端硬盘文件的相关信息。目前,云端硬盘文件只能是文档。此字段为只读字段。

spaceInfo

object (SpaceInfo)

仅限输出。有关相应任务的来源聊天室的信息。此字段为只读字段。

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

更新指定的任务。