Events: patch
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
更新事件。此方法支持修补语义。请注意,每个补丁请求都会消耗三个配额单元;建议使用 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 (含)。
|
maxAttendees |
integer |
响应中包含的参加者数量上限。如果参加者人数超过指定数量,则只返回参与者。可选。
|
sendNotifications |
boolean |
已弃用。请改用 sendUpdates。
是否发送有关活动更新(例如说明变更等)的通知。请注意,即使您将该值设为 false ,系统可能仍会发送某些电子邮件。默认值为 false 。
|
sendUpdates |
string |
应接收活动更新通知(例如标题更改等)的邀请对象。
可接受的值包括:
- “
all ”:系统会向所有访客发送通知。
- “
externalOnly ”:仅向非 Google 日历访客发送通知。
- “
none ”:不发送任何通知。对于日历迁移任务,不妨改用 Events.import 方法。
|
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 资源的相关部分。
试试看!
使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],[],null,["# Events: patch\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates an event. This method supports patch semantics. Note that each patch request consumes three quota units; prefer using a `get` followed by an `update`. The field values you specify replace the existing values. Fields that you don't specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nPATCH https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|-------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `calendarId` | `string` | Calendar identifier. To retrieve calendar IDs call the [calendarList.list](/workspace/calendar/api/v3/reference/calendarList/list) method. If you want to access the primary calendar of the currently logged in user, use the \"`primary`\" keyword. |\n| `eventId` | `string` | Event identifier. |\n| **Optional query parameters** |||\n| `alwaysIncludeEmail` | `boolean` | Deprecated and ignored. A value will always be returned in the `email` field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). |\n| `conferenceDataVersion` | `integer` | Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. Acceptable values are `0` to `1`, inclusive. |\n| `maxAttendees` | `integer` | The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. |\n| `sendNotifications` | `boolean` | Deprecated. Please use [sendUpdates](/workspace/calendar/api/v3/reference/events/update#sendUpdates) instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to `false`. The default is `false`. |\n| `sendUpdates` | `string` | Guests who should receive notifications about the event update (for example, title changes, etc.). \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`all`\": Notifications are sent to all guests. - \"`externalOnly`\": Notifications are sent to non-Google Calendar guests only. - \"`none`\": No notifications are sent. For calendar migration tasks, consider using the [Events.import](/workspace/calendar/api/v3/reference/events/import) method instead. |\n| `supportsAttachments` | `boolean` | Whether API client performing operation supports event attachments. Optional. The default is False. |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|---------------------------------------------------------|\n| `https://www.googleapis.com/auth/calendar` |\n| `https://www.googleapis.com/auth/calendar.events` |\n| `https://www.googleapis.com/auth/calendar.app.created` |\n| `https://www.googleapis.com/auth/calendar.events.owned` |\n\nFor more information, see the [authentication and authorization](/workspace/guides/configure-oauth-consent) page.\n\n### Request body\n\nIn the request body, supply the relevant portions of an [Events resource](/workspace/calendar/api/v3/reference/events#resource), according to the rules of patch semantics.\n\nResponse\n--------\n\nIf successful, this method returns an [Events resource](/workspace/calendar/api/v3/reference/events#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]