Method: notes.list

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

Каждый вызов списка возвращает страницу результатов с pageSize в качестве верхней границы возвращаемых элементов. Значение pageSize , равное нулю, позволяет серверу выбрать верхнюю границу.

ListNotesResponse содержит не более записей pageSize . Если в списке осталось еще что-то, он предоставляет значение nextPageToken . (Токены страницы являются непрозрачными значениями.)

Чтобы получить следующую страницу результатов, скопируйте nextPageToken результата в pageToken следующего запроса. Повторяйте до тех пор, пока nextPageToken , возвращаемый со страницей результатов, не станет пустым.

notes.list возвращает согласованные результаты перед лицом одновременных изменений или сигнализирует об ошибке ABORTED.

HTTP-запрос

GET https://keep.googleapis.com/v1/notes

URL-адрес использует синтаксис транскодирования gRPC .

Параметры запроса

Параметры
pageSize

integer

Максимальное количество возвращаемых результатов.

pageToken

string

Поле nextPageToken предыдущей страницы.

filter

string

Фильтр для списка результатов. Если фильтр не указан, по умолчанию применяется trashed фильтр. Допустимые поля для фильтрации: createTime , updateTime , trashTime и trashed .

Синтаксис фильтра соответствует спецификации фильтрации Google AIP .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ при перечислении страницы заметок.

В случае успеха тело ответа содержит данные со следующей структурой:

Представление JSON
{
  "notes": [
    {
      object (Note)
    }
  ],
  "nextPageToken": string
}
Поля
notes[]

object ( Note )

Страница заметок.

nextPageToken

string

Поле pageToken следующей страницы.

Области авторизации

Требуется одна из следующих областей действия OAuth:

  • https://www.googleapis.com/auth/keep
  • https://www.googleapis.com/auth/keep.readonly

Дополнительные сведения см. в руководстве по авторизации .