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)

如果此部分的内容为文本块，则使用此属性。文字内容的长度必须少于 20000 个字符。
list

object (ListContent)

如果此部分的内容为列表，请使用此类型。

文本内容

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

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

 列出备注。