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.

ListItem

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

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

object ( ListItem )

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

text

object ( TextContent )

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

checked

boolean

Был ли этот пункт отмечен галочкой или нет.

Методы

create

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

delete

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

get

 Получает заметку.

list

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