REST Resource: notes

資源：Note

單一記事。

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 中的 ID 一般說明。
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)

如果此部分的內容是文字區塊，就會使用此屬性。文字內容的長度不得超過 20,000 個半形字元。
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

 列出附註。