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

 清單記事。