Events: instances

Возвращает экземпляры указанного повторяющегося события. Попробуйте сейчас .

Запрос

HTTP-запрос 

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances

Параметры

Имя параметра Ценить Описание
Параметры пути
calendarId string Идентификатор календаря. Для получения идентификаторов календаря вызовите метод calendarList.list . Если вы хотите получить доступ к основному календарю текущего вошедшего в систему пользователя, используйте ключевое слово " primary ".
eventId string Идентификатор повторяющегося события.
Необязательные параметры запроса
alwaysIncludeEmail boolean Устарело и игнорируется. Значение всегда будет возвращаться в поле email для организатора, создателя и участников, даже если реальный адрес электронной почты недоступен (т. е. будет предоставлено сгенерированное, нерабочее значение).
maxAttendees integer Максимальное количество участников для включения в ответ. Если участников больше указанного количества, возвращается только участник. Необязательно.
maxResults integer Максимальное количество событий, возвращаемых на одной странице результатов. По умолчанию значение составляет 250 событий. Размер страницы никогда не может быть больше 2500 событий. Необязательно.
originalStart string Первоначальное время начала экземпляра в результате. Необязательно.
pageToken string Токен, указывающий, какую страницу результатов следует вернуть. Необязательно.
showDeleted boolean Включать ли удаленные события (со status " cancelled ") в результат. Отмененные экземпляры повторяющихся событий все равно будут включены, если singleEvents имеет значение False. Необязательно. Значение по умолчанию — False.
timeMax datetime Верхняя граница (исключительная) для времени начала события для фильтрации. Необязательно. По умолчанию фильтрация по времени начала не выполняется. Должна быть временная метка RFC3339 с обязательным смещением часового пояса.
timeMin datetime Нижняя граница (включительно) для времени окончания события для фильтрации. Необязательно. По умолчанию фильтрация по времени окончания не выполняется. Должна быть временная метка RFC3339 с обязательным смещением часового пояса.
timeZone string Часовой пояс, используемый в ответе. Необязательно. По умолчанию используется часовой пояс календаря.

Авторизация

Этот запрос допускает авторизацию по крайней мере в одной из следующих областей:

Объем
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

Более подробную информацию смотрите на странице аутентификации и авторизации .

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

Не указывайте текст запроса при использовании этого метода.

Ответ

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

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
Имя свойства Ценить Описание Примечания
kind string Тип коллекции (« calendar#events »).
etag etag ETag коллекции.
summary string Название календаря. Только для чтения.
description string Описание календаря. Только для чтения.
updated datetime Время последнего изменения календаря (в виде временной метки RFC3339 ). Только для чтения.
timeZone string Часовой пояс календаря. Только для чтения.
accessRole string Роль доступа пользователя к этому календарю. Только для чтения. Возможные значения:
  • « none » — у пользователя нет доступа.
  • « freeBusyReader » — пользователь имеет доступ на чтение информации о занятости.
  • " reader " - пользователь имеет доступ для чтения календаря. Частные события будут видны пользователям с доступом для чтения, но подробности событий будут скрыты.
  • " writer " - пользователь имеет доступ на чтение и запись в календарь. Частные события будут видны пользователям с доступом на запись, а также будут видны подробности событий.
  • " owner " - пользователь владеет календарем. Эта роль имеет все разрешения роли писателя с дополнительной возможностью видеть и манипулировать ACL.
defaultReminders[] list Напоминания по умолчанию в календаре для аутентифицированного пользователя. Эти напоминания применяются ко всем событиям в этом календаре, которые явно не переопределяют их (т.е. не имеют reminders.useDefault , установленного на True).
defaultReminders[]. method string Метод, используемый этим напоминанием. Возможные значения:
  • « email » — напоминания отправляются по электронной почте.
  • « popup » — напоминания отправляются через всплывающее окно пользовательского интерфейса.

Обязательно при добавлении напоминания.

 записываемый
defaultReminders[]. minutes integer Количество минут до начала события, когда должно сработать напоминание. Допустимые значения — от 0 до 40320 (4 недели в минутах).

Обязательно при добавлении напоминания.

 записываемый
nextPageToken string Токен, используемый для доступа к следующей странице этого результата. Опускается, если нет дополнительных результатов, в этом случае предоставляется nextSyncToken .
items[] list Список событий в календаре.
nextSyncToken string Токен, используемый в более поздний момент времени для извлечения только тех записей, которые изменились с момента возврата этого результата. Опускается, если доступны дополнительные результаты, в этом случае предоставляется nextPageToken .

Попробуйте!

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