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 の ID に関する一般的な注意事項をご覧ください。
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 メディアタイプ）。

権限

メモに対する単一の権限。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。ロールが付与された 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

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

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

この項目にチェックが付いているかどうか。

メソッド

create

 新しメモを作成します。

delete

 メモを削除します。

get

 メモを取得します。

list

 メモを一覧表示します。