Возвращает календари в списке календарей пользователя. Попробуйте сейчас .
Запрос
HTTP-запрос
GET https://www.googleapis.com/calendar/v3/users/me/calendarList
Параметры
| Имя параметра | Ценить | Описание |
|---|---|---|
| Необязательные параметры запроса | ||
maxResults | integer | Максимальное количество записей, возвращаемых на одной странице результатов. По умолчанию значение равно 100 записей. Размер страницы не может превышать 250 записей. Необязательно. |
minAccessRole | string | Минимальная роль доступа для пользователя в возвращаемых записях. Необязательно. По умолчанию — без ограничений. Допустимые значения:
|
pageToken | string | Токен, указывающий, какую страницу результатов следует вернуть. Необязательно. |
showDeleted | boolean | Включать ли удаленные записи списка календарей в результат. Необязательно. Значение по умолчанию — False. |
showHidden | boolean | Показывать ли скрытые записи. Необязательно. Значение по умолчанию — False. |
syncToken | string | Токен, полученный из поля nextSyncToken , возвращенного на последней странице результатов предыдущего запроса списка. Он делает так, что результат этого запроса списка содержит только записи, которые изменились с тех пор. Если изменились только поля, доступные только для чтения, такие как свойства календаря или списки контроля доступа, запись не будет возвращена. Все записи, удаленные и скрытые с момента предыдущего запроса списка, всегда будут в наборе результатов, и не разрешается устанавливать 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 | ETag коллекции. | |
nextPageToken | string | Токен, используемый для доступа к следующей странице этого результата. Опускается, если нет дополнительных результатов, в этом случае предоставляется nextSyncToken . | |
items[] | list | Календари, присутствующие в списке календарей пользователя. | |
nextSyncToken | string | Токен, используемый в более поздний момент времени для извлечения только тех записей, которые изменились с момента возврата этого результата. Опускается, если доступны дополнительные результаты, в этом случае предоставляется nextPageToken . |
Попробуйте!
Используйте API Explorer ниже, чтобы вызвать этот метод для реальных данных и увидеть ответ.
Возвращает календари в списке календарей пользователя. Попробуйте сейчас .
Запрос
HTTP-запрос
GET https://www.googleapis.com/calendar/v3/users/me/calendarList
Параметры
| Имя параметра | Ценить | Описание |
|---|---|---|
| Необязательные параметры запроса | ||
maxResults | integer | Максимальное количество записей, возвращаемых на одной странице результатов. По умолчанию значение равно 100 записей. Размер страницы не может превышать 250 записей. Необязательно. |
minAccessRole | string | Минимальная роль доступа для пользователя в возвращаемых записях. Необязательно. По умолчанию — без ограничений. Допустимые значения:
|
pageToken | string | Токен, указывающий, какую страницу результатов следует вернуть. Необязательно. |
showDeleted | boolean | Включать ли удаленные записи списка календарей в результат. Необязательно. Значение по умолчанию — False. |
showHidden | boolean | Показывать ли скрытые записи. Необязательно. Значение по умолчанию — False. |
syncToken | string | Токен, полученный из поля nextSyncToken , возвращенного на последней странице результатов предыдущего запроса списка. Он делает так, что результат этого запроса списка содержит только записи, которые изменились с тех пор. Если изменились только поля, доступные только для чтения, такие как свойства календаря или списки контроля доступа, запись не будет возвращена. Все записи, удаленные и скрытые с момента предыдущего запроса списка, всегда будут в наборе результатов, и не разрешается устанавливать 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 | ETag коллекции. | |
nextPageToken | string | Токен, используемый для доступа к следующей странице этого результата. Опускается, если нет дополнительных результатов, в этом случае предоставляется nextSyncToken . | |
items[] | list | Календари, присутствующие в списке календарей пользователя. | |
nextSyncToken | string | Токен, используемый в более поздний момент времени для извлечения только тех записей, которые изменились с момента возврата этого результата. Опускается, если доступны дополнительные результаты, в этом случае предоставляется nextPageToken . |
Попробуйте!
Используйте API Explorer ниже, чтобы вызвать этот метод для реальных данных и увидеть ответ.