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 Электронный тег коллекции.
summary string Заголовок календаря. Только для чтения.
description string Описание календаря. Только для чтения.
updated datetime Время последнего изменения календаря (в виде метки времени RFC3339 ). Только для чтения.
timeZone string Часовой пояс календаря. Только для чтения.
accessRole string Роль доступа пользователя к этому календарю. Только для чтения. Возможные значения:
  • " none " - У пользователя нет доступа.
  • " freeBusyReader " - Пользователь имеет доступ на чтение информации о занятости/доступности.
  • « reader » — пользователь имеет доступ на чтение к календарю. Приватные события будут отображаться пользователям с доступом на чтение, но подробности событий будут скрыты.
  • " writerWithoutPrivateAccess " — у пользователя есть доступ на чтение и запись к календарю. Приватные события будут отображаться пользователям с доступом writerWithoutPrivateAccess, но подробности событий будут скрыты.
  • « writer » — пользователь имеет доступ на чтение и запись к календарю. Приватные события будут отображаться пользователям с правами автора, а также будут видны подробности событий.
  • « owner » — пользователь имеет права администратора календаря. Эта роль обладает всеми правами доступа, что и роль писателя, а также возможностью просматривать и изменять уровни доступа других пользователей.

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, чтобы вызвать этот метод на реальных данных и увидеть ответ.