REST Resource: notes

リソース: Note

1 つのメモ。

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 メディアタイプ)。

権限

メモに対する単一の権限。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

メンバーに関連付けられているメールアドレス。create で設定する場合、User または Group メッセージの email フィールドは空にするか、このフィールドと一致する必要があります。メンバーにメールが関連付けられていない場合は、読み取り時に未設定になることがあります。

deleted

boolean

出力のみ。このメンバーが削除されたかどうか。メンバーが復元された場合、この値は false に設定され、復元されたメンバーはメモのロールを保持します。

共用体フィールド member。ロールを付与された ID を指定します。メンバーが削除されている場合、そのメンバーは設定されません。member は次のいずれかになります。
user

object (User)

出力のみ。このロールが適用されるユーザー。

group

object (Group)

出力のみ。このロールが適用されるグループ。

family

object (Family)

出力のみ。このロールが適用される Google ファミリー。

ロール

エンティティが持つさまざまなロールを定義します。

列挙型
ROLE_UNSPECIFIED 未定義のロール。
OWNER 完全アクセス権を付与するロール。このロールを追加、削除することはできません。メモの作成者によって定義されます。
WRITER コンテンツを投稿したり、メモの権限を変更したりするロール。

ユーザー

1 人のユーザーについて記述します。

JSON 表現
{
  "email": string
}
フィールド
email

string

ユーザーのメールアドレス。

グループ

1 つのグループを表します。

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)

このセクションのコンテンツがリストである場合に使用します。

テキスト コンテンツ

単一のテキスト セクションまたはリストアイテムのテキストのブロック。

JSON 表現
{
  "text": string
}
フィールド
text

string

メモのテキスト。この制限は、この型を使用する特定のフィールドによって異なります。

リストの内容

単一のリストメモのアイテムのリスト。

JSON 表現
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
フィールド
listItems[]

object (ListItem)

リスト内のアイテム。アイテム数は 1,000 未満にする必要があります。

ListItem

メモのリストに含まれる単一のリストアイテム。

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

object (ListItem)

設定されている場合、このリスト アイテムの下にネストされているリストアイテムのリスト。ネストできるレベルは 1 つのみです。

text

object (TextContent)

このアイテムのテキスト。1,000 文字未満で入力してください。

checked

boolean

この項目のチェックボックスをオンにするかどうか。

Methods

create

新しメモを作成します。

delete

メモを削除します。

get

メモを取得します。

list

メモのリストを取得します。