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 の識別子に関する一般的な注意事項をご覧ください。

createTime

string (Timestamp format)

出力専用。このメモが作成された日時。

updateTime

string (Timestamp format)

出力専用。このメモの最終更新日。

trashTime

string (Timestamp format)

出力専用。このメモをゴミ箱に移動した日時。trashed の場合、メモは最終的に削除されます。メモがゴミ箱に移動されていない場合、このフィールドは設定されません(ゴミ箱に移動したメモは false になります)。

trashed

boolean

出力専用。このメモがゴミ箱に移動されている場合は true。ゴミ箱に移動したメモは最終的に削除されます。

attachments[]

object (Attachment)

出力専用。このメモに添付された添付ファイル。

permissions[]

object (Permission)

出力専用。メモに設定されている権限のリスト。メモのオーナーのエントリが 1 つ以上含まれます。

title

string

メモのタイトル。長さは 1,000 文字未満にしてください。

body

object (Section)

メモの本文。

添付ファイル

メモの添付ファイル。

JSON 表現
{
  "name": string,
  "mimeType": [
    string
  ]
}
フィールド
name

string

リソース名。

mimeType[]

string

添付ファイルを使用できる MIME タイプ(IANA メディアタイプ)。

権限

メモに対する 1 つの権限。memberrole に関連付けます。

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。ロールが付与されている ID を指定します。メンバーが削除された場合、メンバーは設定されません。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

メモのリスト内の 1 つのリストアイテム。

JSON 表現
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
フィールド
childListItems[]

object (ListItem)

設定されている場合、このリスト項目の下にネストされたリスト項目のリスト。ネストできるのは 1 レベルのみです。

text

object (TextContent)

このアイテムのテキスト。長さは 1,000 文字未満にしてください。

checked

boolean

このアイテムにチェックが入っているかどうか。

メソッド

create

新しメモを作成します。

delete

メモを削除します。

get

メモを取得します。

list

メモを一覧表示します。