REST Resource: notes

Ресурс: Примечание

Единственная заметка.

Представление 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 )

Только вывод. Список разрешений, установленных на заметку. Содержит как минимум одну запись для владельца заметки.

title

string

Название заметки. Длина должна быть менее 1000 символов.

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

Адрес электронной почты, связанный с участником. Если установлено при создании, поле email в сообщении User или Group должно быть либо пустым, либо соответствовать этому полю. При прочтении может быть отключен, если у участника нет связанного адреса электронной почты.

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 )

Используется, если содержимое этого раздела представляет собой список.

ТекстКонтент

Блок текста для отдельного текстового раздела или элемента списка.

Представление JSON
{
  "text": string
}
Поля
text

string

Текст записки. Ограничения на это зависят от конкретного поля, использующего этот тип.

ListContent

Список элементов для одной примечания к списку.

Представление JSON
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Поля
listItems[]

object ( ListItem )

Элементы в списке. Количество элементов должно быть менее 1000.

Пункт списка

Отдельный элемент списка в списке заметки.

Представление JSON
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
Поля
childListItems[]

object ( ListItem )

Если установлено, список элементов списка, вложенных в этот элемент списка. Допускается только один уровень вложенности.

text

object ( TextContent )

Текст этого пункта. Длина должна быть менее 1000 символов.

checked

boolean

Был ли этот элемент отмечен или нет.

Методы

create

Создает новую заметку.

delete

Удаляет заметку.

get

Получает записку.

list

Перечисляет заметки.