请求
HTTP 请求
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events
参数
参数名称 | 值 | 说明 |
---|---|---|
路径参数 | ||
calendarId |
string |
日历标识符。如要检索日历 ID,请调用 calendarList.list 方法。如果您要访问当前登录的用户的主日历,请使用关键字“primary ”。
|
可选的查询参数 | ||
alwaysIncludeEmail |
boolean |
已弃用并忽略。 |
eventTypes |
string |
要返回的事件类型。可选。此参数可以重复多次,以返回不同类型的事件。如果未设置,则返回所有事件类型。
可接受的值:
|
iCalUID |
string |
指定要在响应中提供的 iCalendar 格式的活动 ID。可选。如果您想按 iCalendar ID 搜索活动,请使用此方式。 |
maxAttendees |
integer |
回复中可包含的参加者数量上限。如果参加者人数超过指定的人数,则仅返回参与者。可选。 |
maxResults |
integer |
一个结果页上返回的事件数量上限。结果页面中的事件数量可能少于此值,也可能根本没有,即使有更多事件与查询匹配也是如此。不完整的页面可以通过响应中的非空 nextPageToken 字段检测出来。默认情况下,该值为 250 个事件。页面大小不得超过 2500 个事件。可选。
|
orderBy |
string |
结果中返回的事件的顺序。可选。默认值是一个未指定的稳定顺序。
可接受的值:
|
pageToken |
string |
用于指定要返回的结果页面的令牌。可选。 |
privateExtendedProperty |
string |
扩展属性限制条件已指定为 propertyName=value。仅匹配私有属性。此参数可以重复多次,以返回与所有给定约束条件匹配的事件。 |
q |
string |
使用自由文本搜索字词,在以下字段中查找与这些字词匹配的事件:
这些搜索字词还会将预定义的关键字与工作地点、不在办公室和专注时间活动的所有显示名称翻译进行匹配。例如,搜索“Office”或“Bureau”将返回 |
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 一起指定。这些国家/地区包括:
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 |
用户对此日历的访问角色。只读。可能的值有:
|
|
defaultReminders[] |
list |
日历上针对经过身份验证的用户的默认提醒。这些提醒适用于此日历上不会明确替换它们的所有活动(即未将 reminders.useDefault 设置为 True)。 |
|
defaultReminders[].method |
string |
此提醒使用的方法。可能的值有:
添加提醒时必填。 |
可写入 |
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 对实际数据调用此方法,并查看响应。