CalendarList

使用者日曆清單中的日曆集合。另請參閱 日曆與 CalendarList 的比較.

如需本資源的方法清單，請見本頁結尾。

資源表示法

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
資源名稱 值 說明 附註
accessRole string 已驗證使用者在日曆上具備的有效存取角色。唯讀。可能的值包括：
  • 「freeBusyReader」- 提供有空/忙碌資訊的讀取權限。
  • 「reader」：提供日曆的讀取權限。私人活動可供讀取者存取，但會隱藏活動詳細資料。
  • 「writer」- 提供日曆的讀取和寫入權限。私人活動可供寫入者存取，並能查看活動詳細資料。
  • 「owner」：提供日曆的擁有權。這個角色具有「寫入者」角色的所有權限，並提供查看和操控 ACL 的功能。
backgroundColor string 以十六進位格式 "#0088aa" 的日曆主要顏色。這個屬性會取代以索引為基礎的 colorId 屬性。如要設定或變更這個屬性，您必須在 insert、update 和 patch 方法的參數中指定 colorRgbFormat=true。選用。 可寫入
colorId string 日曆的顏色。這個 ID 是指顏色定義中 calendar 部分的項目 (請參閱「顏色端點」)。這個屬性會由 backgroundColor 和 foregroundColor 屬性取代，且可在使用這些屬性時忽略。選用。 可寫入
conferenceProperties nested object 此日曆的會議屬性，例如可以舉行的會議類型。
conferenceProperties.allowedConferenceSolutionTypes[] list 支援這個日曆的會議解決方案類型。

可能的值如下：

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
選填。
defaultReminders[] list 已驗證使用者為此日曆設定的預設提醒。 可寫入
defaultReminders[].method string 這則提醒使用的方法。可能的值包括：
  • 「email」：系統會透過電子郵件傳送提醒。
  • 「popup」：會透過使用者介面彈出式視窗傳送提醒。

新增提醒時必須提供。

 可寫入
defaultReminders[].minutes integer 活動開始前的分鐘數，應在活動開始之前觸發。有效值介於 0 到 40320 (4 週以分鐘為單位) 之間。

新增提醒時必須提供。

 可寫入
deleted boolean 這個日曆清單項目是否已從日曆清單中刪除。唯讀。選用設定。預設值為「False」。
description string 日曆的說明。選用設定。唯讀。
etag etag 資源的 ETag。
foregroundColor string 日曆的前景顏色採用十六進位格式「#ffffff」。這個屬性取代以索引為基礎的 colorId 屬性。如要設定或變更這個屬性，您必須在 insert、update 和 patch 方法的參數中指定 colorRgbFormat=true。選用。 可寫入
hidden boolean 日曆是否在清單中隱藏。選用設定。只有在日曆處於隱藏狀態時，系統才會傳回這個屬性，而其值為 true。 可寫入
id string 日曆的 ID。
kind string 資源類型 (「calendar#calendarListEntry」)。
location string 任意形式文字的日曆地理位置。選用設定。唯讀。
notificationSettings object 已驗證使用者收到的這個日曆通知。 可寫入
notificationSettings.notifications[] list 為此日曆設定的通知清單。
notificationSettings.notifications[].method string 用於傳送通知的方法。可能的值為：
  • 「email」：系統透過電子郵件傳送通知。

新增通知時必須提供。

 可寫入
notificationSettings.notifications[].type string 通知類型，可能的值包括：
  • 「eventCreation」：在日曆出現新活動時傳送通知。
  • 「eventChange」：在活動變更時傳送通知。
  • 「eventCancellation」：活動取消時傳送通知。
  • 「eventResponse」：參與者回覆活動邀請時會傳送通知。
  • 「agenda」：包含當天活動的待辦事項 (早上傳送)。

新增通知時必須提供。

 可寫入
primary boolean 該日曆是否為已驗證使用者的主要日曆。唯讀。選用設定。預設值為「False」。
selected boolean 日曆 UI 是否顯示日曆內容。選用設定。預設值為「False」。 可寫入
summary string 日曆的名稱。唯讀。
summaryOverride string 已驗證使用者為此日曆設定的摘要。選用。 可寫入
timeZone string 日曆的時區。選用設定。唯讀。

方法

刪除
從使用者的日曆清單中移除日曆。
取得
傳回使用者日曆清單中的日曆。
插入
將現有日曆插入使用者的日曆清單。
list
傳回使用者日曆清單中的日曆。
修補
更新使用者日曆清單中現有的日曆。這個方法支援修補語意。請注意，每個修補要求都會佔用三個配額單位，建議使用 get 和 update。您指定的欄位值會取代現有的值。您在要求中未指定的欄位則維持不變。陣列欄位 (如有指定) 會覆寫現有的陣列；這會忽略所有先前的陣列元素。
更新
更新使用者日曆清單中現有的日曆。
手錶
留意 CalendarList 資源的變更。