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

Эти поисковые термины также сопоставляют предопределенные ключевые слова со всеми переводами отображаемых заголовков рабочего местоположения, событий вне офиса и времени фокусировки. Например, поиск "Office" или "Bureau" возвращает события рабочего местоположения типа officeLocation , тогда как поиск "Out of office" или "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 " - пользователь владеет календарем. Эта роль имеет все разрешения роли писателя с дополнительной возможностью видеть и манипулировать 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 ниже, чтобы вызвать этот метод для реальных данных и увидеть ответ.

,

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

Запрос

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

Эти поисковые термины также сопоставляют предопределенные ключевые слова со всеми переводами отображаемых заголовков рабочего местоположения, событий вне офиса и времени фокусировки. Например, поиск "Office" или "Bureau" возвращает события рабочего местоположения типа officeLocation , тогда как поиск "Out of office" или "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 " - пользователь владеет календарем. Эта роль имеет все разрешения роли писателя с дополнительной возможностью видеть и манипулировать 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 ниже, чтобы вызвать этот метод для реальных данных и увидеть ответ.