更新日曆的中繼資料。 立即試用。
要求
HTTP 要求
PUT https://www.googleapis.com/calendar/v3/calendars/calendarId參數
| 參數名稱 | 值 | 說明 |
|---|---|---|
| 路徑參數 | ||
calendarId |
string |
日曆 ID。如要擷取日曆 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 |
詳情請參閱「驗證和授權」頁面。
要求主體
在要求主體中,請提供具有下列屬性的 Calendars 資源:
| 屬性名稱 | 值 | 說明 | 附註 |
|---|---|---|---|
| 選用屬性 | |||
description |
string |
日曆說明。選填。 | 可寫入 |
labelProperties |
nested object |
這個日曆上定義的標籤屬性。如果指定,則會覆寫現有標籤屬性。如未指定,標籤屬性會維持不變。 | 可寫入 |
labelProperties.eventLabels[] |
list |
這個日曆上定義的活動標籤。如果更新日曆時提供這項資訊,系統會取代現有的活動標籤。 展開清單即可新增活動標籤,從清單中移除實體則可從日曆中刪除標籤。 每個日曆最多可有 200 個標籤。 |
可寫入 |
labelProperties.eventLabels[].backgroundColor |
string |
標籤的背景顏色,以十六進位格式表示,例如 "#039be5"。系統會以這個顏色顯示具有此標籤的活動。必填。 |
可寫入 |
labelProperties.eventLabels[].id |
string |
標籤的 ID。插入新標籤時為選用步驟。如未提供,系統會產生專屬 ID。更新標籤時必須提供, 如果提供 ID,該 ID 在日曆中不得重複,且必須採用 UUID 格式。 |
可寫入 |
labelProperties.eventLabels[].name |
string |
標籤名稱。選用。 如有提供,不得超過 50 個半形字元。 |
可寫入 |
location |
string |
日曆的地理位置,以自由格式文字表示。選填。 | 可寫入 |
summary |
string |
日曆的名稱。 | 可寫入 |
timeZone |
string |
日曆的時區。(格式為 IANA 時區資料庫名稱,例如「Europe/Zurich」)。選填。 | 可寫入 |
回應
如果成功,這個方法會在回應內文中傳回 Calendars 資源。
試試看!
您可以使用下方的 API Explorer,針對即時資料呼叫這個方法,然後查看回應。