Events: list

Примечание. Авторизация необязательна.

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

Запрос

HTTP-запрос

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

Параметры

Имя параметра	Ценить	Описание
Параметры пути
calendarId	string	Идентификатор календаря. Чтобы получить идентификаторы календаря, вызовите метод calendarList.list . Если вы хотите получить доступ к основному календарю текущего пользователя, вошедшего в систему, используйте ключевое слово « primary ».
Необязательные параметры запроса
alwaysIncludeEmail	boolean	Устарело и игнорируется. Значение всегда будет возвращено в поле email для организатора, создателя и участников, даже если реальный адрес электронной почты недоступен (т. е. будет предоставлено сгенерированное, нерабочее значение).
eventTypes	string	Типы событий для возврата. Необязательный. Возможные значения: "default" "focusTime" "outOfOffice" Этот параметр можно повторять несколько раз, чтобы возвращать события разных типов. В настоящее время это единственное допустимое значение для этого поля: ["default", "focusTime", "outOfOffice"] Это значение будет значением по умолчанию. Если вы зарегистрированы в программе предварительного просмотра для разработчиков рабочего местоположения, в дополнение к указанному выше значению по умолчанию вы также можете установить тип события "workingLocation" : ["default", "focusTime", "outOfOffice", "workingLocation"] ["workingLocation"] Дополнительные комбинации этих 4 типов событий будут доступны в более поздних версиях. Предварительная версия для разработчиков: доступна в рамках программы предварительной версии Google Workspace для разработчиков , которая предоставляет ранний доступ к определенным функциям.
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 участника . Необязательный.
sharedExtendedProperty	string	Ограничение расширенных свойств указано как propertyName=value. Соответствует только общим свойствам. Этот параметр может повторяться несколько раз, чтобы возвращать события, соответствующие всем заданным ограничениям.
showDeleted	boolean	Включать ли удаленные события (со status « cancelled ») в результат. Отмененные экземпляры повторяющихся событий (но не базовое повторяющееся событие) будут по-прежнему включены, если для showDeleted и singleEvents установлено значение False. Если оба параметра showDeleted и singleEvents имеют значение True, возвращаются только отдельные экземпляры удаленных событий (но не базовые повторяющиеся события). Необязательный. Значение по умолчанию — Ложь.
showHiddenInvitations	boolean	Включать ли скрытые приглашения в результат. Необязательный. Значение по умолчанию — Ложь.
singleEvents	boolean	Следует ли расширять повторяющиеся события в экземпляры и возвращать только отдельные разовые события и экземпляры повторяющихся событий, но не сами базовые повторяющиеся события. Необязательный. Значение по умолчанию — Ложь.
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

Дополнительные сведения см. на странице аутентификации и авторизации .

Тело запроса

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

Ответ

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

{
  "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	Напоминания по умолчанию в календаре для аутентифицированного пользователя. Эти напоминания применяются ко всем событиям в этом календаре, которые не переопределяют их явным образом (т. е. для которых не установлено значение «True» для параметра reminders.useDefault »).
defaultReminders[]. method	string	Метод, используемый этим напоминанием. Возможные значения: « email » — напоминания отправляются по электронной почте. « popup » — напоминания отправляются через всплывающее окно пользовательского интерфейса. Требуется при добавлении напоминания.	доступный для записи
defaultReminders[]. minutes	integer	Количество минут до начала события, когда должно сработать напоминание. Допустимые значения находятся в диапазоне от 0 до 40320 (4 недели в минутах). Требуется при добавлении напоминания.	доступный для записи
nextPageToken	string	Токен, используемый для доступа к следующей странице этого результата. Опускается, если другие результаты недоступны, и в этом случае предоставляется nextSyncToken .
items[]	list	Список событий в календаре.
nextSyncToken	string	Токен, используемый в более поздний момент времени, для получения только тех записей, которые изменились с момента возврата этого результата. Опущен, если доступны дополнительные результаты, и в этом случае предоставляется nextPageToken .

Примеры

Примечание. Примеры кода, доступные для этого метода, не представляют все поддерживаемые языки программирования (список поддерживаемых языков см. на странице клиентских библиотек ).

Джава

Использует клиентскую библиотеку Java .

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Event;
import com.google.api.services.calendar.model.Events;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over the events in the specified calendar
String pageToken = null;
do {
  Events events = service.events().list('primary').setPageToken(pageToken).execute();
  List<Event> items = events.getItems();
  for (Event event : items) {
    System.out.println(event.getSummary());
  }
  pageToken = events.getNextPageToken();
} while (pageToken != null);

Питон

Использует клиентскую библиотеку Python .

page_token = None
while True:
  events = service.events().list(calendarId='primary', pageToken=page_token).execute()
  for event in events['items']:
    print event['summary']
  page_token = events.get('nextPageToken')
  if not page_token:
    break

PHP

Использует клиентскую библиотеку PHP .

$events = $service->events->listEvents('primary');

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->listEvents('primary', $optParams);
  } else {
    break;
  }
}

Рубин

Использует клиентскую библиотеку Ruby .

page_token = nil
begin
  result = client.list_events('primary', page_token: page_token)
  result.items.each do |e|
    print e.summary + "\n"
  end
  if result.next_page_token != page_token
    page_token = result.next_page_token
  else
    page_token = nil
  end
end while !page_token.nil?

Попробуй это!

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