REST Resource: notes

资源：备注

单条记事。

JSON 表示法 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "trashTime": string,
  "trashed": boolean,
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "permissions": [
    {
      object (Permission)
    }
  ],
  "title": string,
  "body": {
    object (Section)
  }
}
字段
name

string

仅限输出。此备注的资源名称。请参阅 KeepService 中有关标识符的一般说明。
createTime

string (Timestamp format)

仅限输出。此备注的创建时间。
updateTime

string (Timestamp format)

仅限输出。此备注的上次修改时间。
trashTime

string (Timestamp format)

仅限输出。此记事被移至回收站的时间。如果为 trashed，则系统最终会删除该备注。如果记事未被移至回收站，则不会设置此字段（并且“已移至回收站”字段为 false）。
trashed

boolean

仅限输出。true，如果此记事已被移至回收站。如果移至回收站，备注最终会被删除。
attachments[]

object (Attachment)

仅限输出。此记事的附件。
permissions[]

object (Permission)

仅限输出。在备注上设置的权限列表。包含至少一个记事所有者的条目。
title

string

备注的标题。长度不得超过 1,000 个字符。
body

object (Section)

备注正文。

附件

记事的附件。

JSON 表示法 
{
  "name": string,
  "mimeType": [
    string
  ]
}
字段
name

string

资源名称；
mimeType[]

string

附件可用的 MIME 类型（IANA 媒体类型）。

权限

对备注使用单个权限。将 member 与 role 关联。

JSON 表示法 
{
  "name": string,
  "role": enum (Role),
  "email": string,
  "deleted": boolean,

  // Union field member can be only one of the following:
  "user": {
    object (User)
  },
  "group": {
    object (Group)
  },
  "family": {
    object (Family)
  }
  // End of list of possible types for union field member.
}
字段
name

string

仅限输出。资源名称。
role

enum (Role)

此权限所授予的角色。该角色决定了实体是否能够读取、写入和分享记事。
email

string

与会员关联的电子邮件地址。如果在创建时设置，User 或 Group 消息中的 email 字段必须为空或与此字段匹配。读取时，如果成员没有关联的电子邮件地址，则可能会取消设置。
deleted

boolean

仅限输出。此成员是否已被删除。如果成员已恢复，则此值会设为 false，并且恢复的成员会保留记事中的角色。
联合字段 member。指定授予角色的身份。如果成员已被删除，则成员会被取消设置。member 只能是下列其中一项：
user

object (User)

仅限输出。此角色适用的用户。
group

object (Group)

仅限输出。此角色适用的群组。
family

object (Family)

仅限输出。此角色适用的 Google 家人群组。

角色

定义实体可以具有的各种角色。

枚举
ROLE_UNSPECIFIED 未指定的角色。
OWNER 一种可授予完整访问权限的角色。无法添加或移除此角色。由备注的创建者定义。
WRITER 此角色可授予贡献内容和修改记事权限的权限。

用户

描述单个用户。

JSON 表示法 
{
  "email": string
}
字段
email

string

用户的电子邮件地址。

群组

描述单个组。

JSON 表示法 
{
  "email": string
}
字段
email

string

群组电子邮件地址。

家庭

此类型没有字段。

描述单个 Google 家人群组。

环节

备注的内容。

JSON 表示法 
{

  // Union field Content can be only one of the following:
  "text": {
    object (TextContent)
  },
  "list": {
    object (ListContent)
  }
  // End of list of possible types for union field Content.
}
字段
联合字段 Content。该部分的内容必须是以下值类型之一。Content 只能是下列其中一项：
text

object (TextContent)

如果此部分的内容是一段文本，则使用此属性。文本内容的长度不得超过 2 万个字符。
list

object (ListContent)

如果此部分的内容是列表，则使用此属性。

TextContent

单个文本部分或列表项的文本块。

JSON 表示法 
{
  "text": string
}
字段
text

string

备注的文本。此字段的限制因使用此类型的具体字段而异。

ListContent

单个列表记事的项列表。

JSON 表示法 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
字段
listItems[]

object (ListItem)

列表中的项。项数必须少于 1,000 个。

ListItem

记事列表中的单个列表项。

JSON 表示法 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
字段
childListItems[]

object (ListItem)

如果设置，则为此列表项下嵌套的列表项的列表。只允许嵌套一级。
text

object (TextContent)

此项的文本。长度不得超过 1,000 个字符。
checked

boolean

此项是否已勾选。

方法

create

 创建新记事。

delete

 删除记事。

get

 获取记事。

list

 列出备注。