Events: instances

返回指定周期性活动的实例。 立即试用。

请求

HTTP 请求

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

参数

参数名称 值 说明
路径参数
calendarId string 日历标识符。如需检索日历 ID，请调用 calendarList.list 方法。如果您想访问当前登录用户的主日历，请使用“primary”关键字。
eventId string 周期性活动标识符。
可选的查询参数
alwaysIncludeEmail boolean 已弃用且已忽略。即使没有真实的电子邮件地址，组织者、创建者和参与者的 email 字段中也始终会返回一个值（即会提供一个生成的无效值）。
maxAttendees integer 响应中可包含的最多出席者人数。如果出席者人数超过指定人数，则仅返回参与者。可选。
maxResults integer 一个结果页面中返回的事件数上限。默认情况下，值为 250 个事件。网页大小永远不能超过 2,500 个事件。可选。
originalStart string 结果中实例的原始开始时间。可选。
pageToken string 用于指定要返回哪个结果页面的令牌。可选。
showDeleted boolean 是否在结果中包含已删除的事件（status 等于“cancelled”）。如果 singleEvents 为 False，系统仍会包含已取消的周期性活动实例。可选。默认值为 False。
timeMax datetime 要过滤的事件开始时间的上限（不含）。可选。默认情况下，系统不会按开始时间进行过滤。必须是 RFC3339 时间戳，且必须包含时区偏移量。
timeMin datetime 要过滤的事件结束时间的下限（含）。可选。默认情况下，不按结束时间过滤。必须是 RFC3339 时间戳，且必须包含时区偏移量。
timeZone string 回答中使用的时区。可选。默认值为日历的时区。

授权

此请求需要获得以下至少一个范围的授权：

范围
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” - 用户对日历拥有经理访问权限。此角色拥有撰写者角色的所有权限，并且还能够查看和修改其他用户的访问权限级别。
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 对实际数据调用此方法，然后查看响应。