CalendarList: list

傳回使用者日曆清單中的日曆。 立即試用。

要求

HTTP 要求

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

參數

參數名稱 值 說明
選用查詢參數
maxResults integer 單一結果頁面中傳回的項目數量上限。預設值為 100 個項目。頁面大小不得超過 250 個項目。選用。
minAccessRole string 傳回項目中，使用者的最低存取角色。(選用步驟) 預設值為無限制。

可接受的值如下：
  • 「freeBusyReader」：使用者可以讀取有空/忙碌資訊。
  • 「owner」：使用者可以讀取及修改事件，並存取存取控制清單。
  • 「reader」：使用者可以讀取非私人活動。
  • 「writer」：使用者可以讀取及修改事件。
  • 「writerWithoutPrivateAccess」：使用者可以讀取及修改活動，但無法存取私人活動。
pageToken string 指定要傳回哪個結果頁面的符記。選用。
showDeleted boolean 是否要在結果中納入已刪除的日曆清單項目。(選用步驟) 預設值為 False。
showHidden boolean 是否顯示隱藏的項目。(選用步驟) 預設值為 False。
syncToken string 從先前清單要求的最後一頁結果傳回的 nextSyncToken 欄位取得的權杖。這樣一來，這項清單要求只會傳回自該時間起有變更的項目。如果只有唯讀欄位 (例如日曆屬性或 ACL) 變更，系統就不會傳回項目。自上次要求清單以來刪除及隱藏的所有項目，一律會出現在結果集中，且不允許將 showDeleted 或 showHidden 設為 False。
為確保用戶端狀態一致性，minAccessRole 查詢參數不得與 nextSyncToken 一併指定。
如果 syncToken 過期，伺服器會傳回 410 GONE 回應代碼，用戶端應清除儲存空間，並在沒有任何 syncToken 的情況下執行完整同步。
進一步瞭解增量同步。
選用。預設值為傳回所有項目。

授權

這項要求需要至少下列其中一個範圍的授權：

範圍
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

詳情請參閱「驗證和授權」頁面。

要求主體

請勿透過此方法提供要求主體。

回應

如果成功的話，這個方法會傳回回應內文，其結構如下：

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
屬性名稱 值 說明 附註
kind string 集合類型 (「calendar#calendarList」)。
etag etag 集合的 ETag。
nextPageToken string 用於存取下一頁結果的權杖。如果沒有其他結果，則會省略這個欄位，並提供 nextSyncToken。
items[] list 使用者日曆清單中的日曆。
nextSyncToken string 這個權杖稍後可用於只擷取自傳回這項結果以來有所變更的項目。如果還有其他結果，系統會省略這個權杖，並提供 nextPageToken。

試試看！

您可以使用下方的 API Explorer，針對即時資料呼叫這個方法，然後查看回應。