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
傳回使用者日曆清單中的日曆。
修補程式
更新使用者日曆清單中的現有日曆。這個方法支援 patch 語意。請注意，每個修補要求都會耗用三個配額單位；偏好使用 get，後面加上 update。您指定的欄位值會取代現有的值。未指定要求中的欄位會維持不變。陣列欄位 (如有指定) 會覆寫現有陣列；就會捨棄先前的所有陣列元素。
更新
更新使用者日曆清單中的現有日曆。
手錶
留意 CalendarList 資源的異動。