Events: list

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

Запрос

HTTP-запрос 

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

Параметры

Имя параметра Ценить Описание
Параметры пути
calendarId string Идентификатор календаря. Для получения идентификаторов календарей вызовите метод calendarList.list . Чтобы получить доступ к основному календарю текущего вошедшего в систему пользователя, используйте ключевое слово « primary ».
Необязательные параметры запроса
alwaysIncludeEmail boolean Устарело и игнорируется.
eventTypes string Типы возвращаемых событий. Необязательный параметр. Этот параметр можно повторить несколько раз для возврата событий разных типов. Если не задано, возвращаются все типы событий.

Допустимые значения:
  • « birthday »: специальные мероприятия, длящиеся целый день и повторяющиеся ежегодно.
  • « default »: Регулярные события.
  • " focusTime ": события времени фокусировки.
  • " fromGmail ": События из Gmail.
  • « outOfOffice »: события отсутствия на рабочем месте.
  • " workingLocation ": События рабочего места.
iCalUID string Указывает идентификатор события в формате iCalendar, который будет предоставлен в ответе. Необязательно. Используйте этот параметр, если хотите найти событие по его идентификатору iCalendar.
maxAttendees integer Максимальное количество участников, включаемое в ответ. Если количество участников превышает указанное, возвращается только участник. Необязательно.
maxResults integer Максимальное количество событий, возвращаемых на одной странице результатов. Количество событий на странице результатов может быть меньше этого значения или отсутствовать вовсе, даже если запросу соответствует больше событий. Неполные страницы можно определить по непустому полю nextPageToken в ответе. По умолчанию это значение равно 250 событиям. Размер страницы не может превышать 2500 событий. Необязательно.
orderBy string Порядок событий, возвращаемых в результате. Необязательный. По умолчанию используется неопределённый, стабильный порядок.

Допустимые значения:
  • " startTime ": сортировка по дате/времени начала (по возрастанию). Доступно только при запросе отдельных событий (т.е. параметр singleEvents имеет значение True).
  • « updated »: сортировать по времени последнего изменения (по возрастанию).
pageToken string Токен, указывающий, какую страницу результатов следует вернуть. Необязательно.
privateExtendedProperty string Ограничение расширенных свойств указано как propertyName=value. Соответствует только закрытым свойствам. Этот параметр может быть повторен несколько раз для возврата событий, соответствующих всем заданным ограничениям.
q string Свободный поиск по текстовым запросам для поиска событий, соответствующих этим терминам, в следующих полях:
  • summary
  • description
  • location
  • displayName участника
  • email участника
  • displayName организатора
  • email организатора
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label

Эти поисковые запросы также сопоставляют предопределённые ключевые слова со всеми переводами отображаемых заголовков для событий рабочего места, отсутствия на рабочем месте и событий, связанных с фокусом. Например, поиск по запросу «Офис» или «Бюро» возвращает события рабочего места типа officeLocation , тогда как поиск по запросу «Нет на рабочем месте» или «Abwesend» возвращает события, связанные с отсутствием на рабочем месте. Необязательно.

sharedExtendedProperty string Ограничение расширенных свойств указано как propertyName=value. Соответствует только общим свойствам. Этот параметр может быть повторен несколько раз для возврата событий, соответствующих всем заданным ограничениям.
showDeleted boolean Включать ли удалённые события (со status « cancelled ») в результат. Отменённые экземпляры повторяющихся событий (но не сами повторяющиеся события) всё равно будут включены, если и showDeleted , и singleEvents имеют значение False. Если и showDeleted , и singleEvents имеют значение True, возвращаются только отдельные экземпляры удалённых событий (но не сами повторяющиеся события). Необязательно. Значение по умолчанию — False.
showHiddenInvitations boolean Включать ли скрытые приглашения в результат. Необязательно. Значение по умолчанию — False.
singleEvents boolean Разворачивать ли повторяющиеся события в экземпляры и возвращать только отдельные разовые события и экземпляры повторяющихся событий, но не сами повторяющиеся события. Необязательно. Значение по умолчанию — False.
syncToken string Токен, полученный из поля nextSyncToken , возвращаемого на последней странице результатов предыдущего запроса списка. Это позволяет сохранить в результатах этого запроса только те записи, которые были изменены с момента последнего запроса. Все события, удалённые с момента предыдущего запроса списка, всегда будут присутствовать в наборе результатов, и showDeleted нельзя задать значение False.
Существует несколько параметров запроса, которые нельзя указать вместе с nextSyncToken чтобы обеспечить согласованность состояния клиента.

Это:
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
Все остальные параметры запроса должны быть такими же, как и при первоначальной синхронизации, чтобы избежать неопределённого поведения. Если срок действия syncToken истечёт, сервер вернёт код ответа 410 GONE, а клиент должен очистить хранилище и выполнить полную синхронизацию без syncToken .
Узнайте больше об инкрементной синхронизации.
Необязательно. По умолчанию возвращаются все записи.
timeMax datetime Верхняя граница (исключая) времени начала события для фильтрации. Необязательно. Фильтрация по времени начала не производится. Должна быть временная метка RFC3339 с обязательным смещением часового пояса, например, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Миллисекунды могут быть указаны, но игнорируются. Если задано значение timeMin , timeMax должно быть больше timeMin .
timeMin datetime Нижняя граница (исключая) времени окончания события для фильтрации. Необязательно. Фильтрация по времени окончания не производится. Должна быть временная метка RFC3339 с обязательным смещением часового пояса, например, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Миллисекунды могут быть указаны, но игнорируются. Если задано значение timeMax , timeMin должно быть меньше timeMax .
timeZone string Часовой пояс, используемый в ответе. Необязательно. По умолчанию используется часовой пояс календаря.
updatedMin datetime Нижняя граница времени последнего изменения события (в виде временной метки RFC3339 ) для фильтрации. Если указано, записи, удалённые с этого времени, всегда будут включены независимо от showDeleted . Необязательно. По умолчанию фильтрация по времени последнего изменения не выполняется.

Авторизация

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

Объем
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 » — пользователь имеет доступ к календарю с правами менеджера. Эта роль обладает всеми правами автора, а также возможностью просматривать и изменять уровни доступа других пользователей.

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