更新日历的元数据。 立即试用。
请求
HTTP 请求
PUT https://www.googleapis.com/calendar/v3/calendars/calendarId参数
| 参数名称 | 值 | 说明 |
|---|---|---|
| 路径参数 | ||
calendarId |
string |
日历标识符。如需检索日历 ID，请调用 calendarList.list 方法。如果您想访问当前登录用户的主日历，请使用“primary”关键字。
|
授权
此请求需要获得以下至少一个范围的授权：
| 范围 |
|---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.app.created |
https://www.googleapis.com/auth/calendar.calendars |
如需了解详情，请参阅身份验证和授权页面。
请求正文
在请求正文中，提供具有以下属性的日历资源：
| 属性名称 | 值 | 说明 | 备注 |
|---|---|---|---|
| 可选属性 | |||
description |
string |
日历的说明。可选。 | 可写入 |
labelProperties |
nested object |
此日历上定义的标签属性。如果指定，则会覆盖现有标签属性。如果未指定，标签属性将保持不变。 | 可写入 |
labelProperties.eventLabels[] |
list |
此日历上定义的活动标签。如果在更新日历时存在此字段，它将替换现有的活动标签。 扩展列表可添加新的活动标签，从列表中移除实体可从日历中删除标签。 每个日历最多可以有 200 个标签。 |
可写入 |
labelProperties.eventLabels[].backgroundColor |
string |
标签的背景颜色（采用十六进制格式），例如 "#039be5"。带有此标签的活动会以这种颜色显示。必填。 |
可写入 |
labelProperties.eventLabels[].id |
string |
标签的 ID。插入新标签时，此字段为可选字段。如果未提供，系统将自动生成唯一 ID。更新标签时必须提供。 如果提供，该 ID 在日历中必须是唯一的，并且遵循 UUID 格式。 |
可写入 |
labelProperties.eventLabels[].name |
string |
标签的名称。可选。 如果提供，则不得超过 50 个字符。 |
可写入 |
location |
string |
日历的地理位置（自由格式文本）。可选。 | 可写入 |
summary |
string |
日历的标题。 | 可写入 |
timeZone |
string |
日历的时区。（格式采用 IANA 时区数据库名称，例如“Europe/Zurich”。）可选。 | 可写入 |
workingHours |
object |
表示用户工作时间的相关信息。仅适用于 Google Workspace 用户的主日历。如需更新工作时间，必须传递整个工作时间对象。如果未指定（或作为 null 或空对象传递），则现有工作时间保持不变。如需停用工作时间或清除时间表，请将 workingHoursEnabled 设置为 false（并省略 availableTimes 或传递空列表）。 |
可写入 |
workingHours.availableTimes[] |
list |
工作时间。每个空闲时间段都代表用户在一天中的工作时间段。 | 可写入 |
workingHours.availableTimes[].dayOfWeek |
string |
星期几。必需。可能的值包括：
|
可写入 |
workingHours.availableTimes[].periodEnd |
integer |
时段结束时间，以从当天开始算起的分钟数表示（不含）。必填。 | 可写入 |
workingHours.availableTimes[].periodStart |
integer |
时段开始时间，以从当天开始算起的分钟数表示（含）。必填。 | 可写入 |
workingHours.workingHoursEnabled |
boolean |
是否为此日历启用了工作时间。当 availableTimes 为空时，无法设置为 true。 |
可写入 |
响应
如果成功，此方法会在响应正文中返回一个日历资源。
试试看！
使用下面的 API Explorer 对实际数据调用此方法，然后查看响应。