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