Events: list

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

返回指定日历中的活动。 立即试用或查看示例。

请求

HTTP 请求

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

参数

参数名称 值 说明
路径参数
calendarId string 日历标识符。要检索日历 ID，请调用 calendarList.list 方法。如果您想访问当前登录的用户的主日历，请使用“primary”关键字。
可选的查询参数
alwaysIncludeEmail boolean 已弃用并忽略。系统将始终在 email 字段中为组织者、创建者和参加者返回一个值，即使没有可用的实际电子邮件地址（即，将提供生成的非工作值）。
eventTypes string 要返回的事件类型。（可选）默认值为 ["default", "outOfOffice", "focusTime"]。除非您已在工作地点开发者预览版中注册，否则只能使用默认值。
iCalUID string 指定要在响应中提供的 iCalendar 格式的活动 ID。（可选）如果您想按活动 ID 来搜索活动，则可使用此属性。
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，则仅返回已删除事件的单个实例（而不是底层周期性事件）。（可选）默认值为 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

如需了解详情，请参阅身份验证和授权页面。

请求正文

使用此方法时请勿提供请求正文。

响应

如果成功，此方法将返回采用以下结构的响应正文：

{
  "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。

示例

注意：此方法的代码示例并未列出所有受支持的编程语言（请参阅客户端库页面，查看受支持的语言列表）。

Java

使用 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

使用 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

使用 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 Explorer 针对实际数据调用此方法，然后查看响应。