更新活动。此方法支持 patch 语义。请注意,每个 patch 请求会消耗 3 个配额单位;建议使用
get,然后使用 update。您指定的字段值会替换现有值。您未在请求中指定的字段将保持不变。如果指定了数组字段,则会覆盖现有数组;这会舍弃任何之前的数组元素。
立即试用。
请求
HTTP 请求
PATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId
参数
| 参数名称 | 值 | 说明 |
|---|---|---|
| 路径参数 | ||
calendarId |
string |
日历标识符。如需检索日历 ID,请调用 calendarList.list 方法。如果您想访问当前登录用户的主日历,请使用“primary”关键字。
|
eventId |
string |
活动标识符。 |
| 可选的查询参数 | ||
alwaysIncludeEmail |
boolean |
已弃用且已忽略。系统始终会在组织者、创建者和受邀者的 email 字段中返回一个值,即使没有真实的电子邮件地址也是如此(即,系统会提供一个生成的无效值)。
|
conferenceDataVersion |
integer |
API 客户端支持的会议数据的版本号。版本 0 假定不支持会议数据,并忽略活动正文中的会议数据。版本 1 支持复制 ConferenceData,以及使用 conferenceData 的 createRequest 字段创建新会议。默认值为 0。
可接受的值为 0 到 1(含端点值)。
|
eventLabelVersion |
integer |
API 客户端支持的活动标签功能的版本号。版本 0 假定不支持活动标签,并处理 colorId 字段以进行颜色管理。版本 1 支持活动标签,并处理活动正文中的 eventLabelId。在这种情况下,系统会忽略 colorId 字段。默认值为 0。
可接受的值为 0 到 1(含端点值)。
|
maxAttendees |
integer |
响应中包含的受邀者人数上限。如果受邀者人数超过指定人数,则仅返回参与者。可选。 |
sendNotifications |
boolean |
已弃用。请改用 sendUpdates。 是否发送有关活动更新的通知(例如,说明更改等)。请注意,即使您将该值设置为 false,系统可能仍会发送一些电子邮件。默认值为 false。
|
sendUpdates |
string |
应接收有关活动更新(例如,标题更改等)通知的受邀者。
可接受的值包括:
|
supportsAttachments |
boolean |
执行操作的 API 客户端是否支持活动附件。可选。默认值为 False。 |
授权
此请求需要获得以下至少一个范围的授权:
| 范围 |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.events |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.events.owned |
如需了解详情,请参阅身份验证和授权页面。
请求正文
在请求正文中,根据补丁语义规则提供 Events 资源 的相关部分。
响应
如果成功,此方法将在响应正文中返回 Events 资源。
试试看!
使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。