CalendarList

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

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

資源表示法

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": 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」：提供日曆的管理員存取權。這個角色具備撰寫者角色的所有權限，並可查看及修改其他使用者的存取層級。
backgroundColor string 日曆的主要顏色，格式為十六進位「#0088aa」。這個屬性會取代以索引為準的 colorId 屬性。如要設定或變更這項屬性，請在 insert、update 和 patch 方法的參數中指定 colorRgbFormat=true。選用項目。 可寫入
colorId string 日曆顏色。這是指顏色定義的 calendar 區段中的項目 ID (請參閱顏色端點)。這項屬性已由 backgroundColor 和 foregroundColor 屬性取代，使用這些屬性時可以忽略這項屬性。選用項目。 可寫入
conferenceProperties nested object 這個日曆的會議屬性，例如允許的會議類型。
conferenceProperties.allowedConferenceSolutionTypes[] list 這個日曆支援的會議解決方案類型。

可能的值包括：

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
選用。
dataOwner string 日曆擁有者的電子郵件地址。僅適用於次要日曆。唯讀。
defaultReminders[] list 已驗證使用者為這個日曆設定的預設提醒。 可寫入
defaultReminders[].method string 這個提醒事項所用的方法。可能的值包括：
  • 「email」- 系統會透過電子郵件傳送提醒。
  • 「popup」- 提醒會透過 UI 彈出式視窗傳送。

新增提醒時必須填寫。

 可寫入
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 日曆的時區。(選用步驟) 唯讀。

方法

刪除
從使用者的日曆清單中移除日曆。
get
從使用者的日曆清單傳回日曆。
插入
將現有日曆插入使用者的日曆清單。
list
傳回使用者日曆清單中的日曆。
修補程式
更新使用者日曆清單中的現有日曆。這個方法支援 patch 語意。請注意，每個修補程式要求會耗用三個配額單位，建議使用 get，然後再使用 update。您指定的欄位值會取代現有值。要求中未指定的欄位會維持不變。如果指定陣列欄位，系統會覆寫現有陣列，並捨棄先前的陣列元素。
更新
更新使用者日曆清單中的現有日曆。
智慧手錶
監控 CalendarList 資源的變更。