CalendarList: list

Возвращает календари из списка календарей пользователя. Попробуйте прямо сейчас .

Запрос

HTTP-запрос 

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

Параметры

Имя параметра Ценить Описание
Дополнительные параметры запроса
maxResults integer Максимальное количество записей, отображаемых на одной странице результатов. По умолчанию значение равно 100 записям. Размер страницы никогда не может превышать 250 записей. Необязательно.
minAccessRole string Минимальный уровень доступа для пользователя в возвращаемых записях. Необязательный параметр. По умолчанию — отсутствие ограничений.

Допустимые значения:
  • " freeBusyReader ": Пользователь может читать информацию о занятости/доступности.
  • " owner ": Пользователь может читать и изменять события и списки контроля доступа.
  • " reader ": Пользователь может читать события, которые не являются приватными.
  • " writer ": Пользователь может читать и изменять события.
  • " writerWithoutPrivateAccess ": Пользователь может читать и изменять события, но не может получить доступ к приватным событиям.
pageToken string Токен, указывающий, какую страницу результатов следует отобразить. Необязательный.
showDeleted boolean Включать ли в результат удаленные записи из списка календаря. Необязательный параметр. По умолчанию — False.
showHidden boolean Показывать ли скрытые записи. Необязательный параметр. По умолчанию — False.
syncToken string Токен, полученный из поля nextSyncToken возвращается на последней странице результатов предыдущего запроса списка. Это гарантирует, что результат этого запроса списка будет содержать только записи, изменившиеся с тех пор. Если изменились только поля, доступные только для чтения, такие как свойства календаря или списки контроля доступа (ACL), запись не будет возвращена. Все записи, удаленные и скрытые с момента предыдущего запроса списка, всегда будут присутствовать в результирующем наборе, и нельзя устанавливать showDeleted или showHidden в False.
Для обеспечения согласованности состояния клиента параметр запроса minAccessRole нельзя указывать одновременно с nextSyncToken .
Если срок syncToken истечет, сервер ответит кодом 410 GONE, и клиенту следует очистить свое хранилище и выполнить полную синхронизацию без использования syncToken .
Узнайте больше об инкрементальной синхронизации.
Необязательный параметр. По умолчанию возвращаются все записи.

Авторизация

Для выполнения этого запроса требуется авторизация как минимум в одной из следующих областей действия:

Объем
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

Для получения более подробной информации см. страницу аутентификации и авторизации .

Текст запроса

При использовании этого метода не следует передавать тело запроса.

Ответ

В случае успеха этот метод возвращает тело ответа со следующей структурой: 

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Название объекта недвижимости Ценить Описание Примечания
kind string Тип коллекции (" calendar#calendarList ).
etag etag Электронный тег коллекции.
nextPageToken string Токен, используемый для доступа к следующей странице результатов. Опускается, если других результатов нет, в этом случае предоставляется nextSyncToken .
items[] list Календари, присутствующие в списке календарей пользователя.
nextSyncToken string Токен, используемый позднее для получения только тех записей, которые изменились с момента получения данного результата. Опускается, если доступны дополнительные результаты, в этом случае предоставляется nextPageToken .

Попробуйте!

Воспользуйтесь приведенным ниже инструментом API Explorer, чтобы вызвать этот метод на реальных данных и увидеть ответ.