Events: instances

傳回指定週期性活動的執行個體。 立即試用。

要求

HTTP 要求

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances

參數

參數名稱 值 說明
路徑參數
calendarId string 日曆 ID。如要擷取日曆 ID，請呼叫 calendarList.list 方法。如要存取目前登入使用者的主要日曆，請使用「primary」關鍵字。
eventId string 週期性活動 ID。
選用查詢參數
alwaysIncludeEmail boolean 已淘汰並忽略。即使沒有可用的實際電子郵件地址 (也就是提供產生的無效值)，系統仍會在主辦人、建立者和出席者的 email 欄位中傳回值。
maxAttendees integer 回覆中可納入的出席者人數上限。如果出席者人數超過指定數量，系統只會傳回參與者。選用。
maxResults integer 單一結果頁面中傳回的事件數量上限。預設值為 250 個事件。網頁大小不得超過 2500 個事件。選用。
originalStart string 結果中執行個體的原始開始時間。選用。
pageToken string 指定要傳回哪個結果頁面的符記。選用。
showDeleted boolean 是否要在結果中納入已刪除的事件 (status 等於「cancelled」)。如果 singleEvents 為 False，系統仍會納入已取消的週期性活動執行個體。(選用步驟) 預設值為 False。
timeMax datetime 活動開始時間的上限 (不含上限)，用於篩選。(選用步驟) 系統預設不會依開始時間篩選。必須是 RFC3339 時間戳記，且必須包含時區偏移量。
timeMin datetime 事件結束時間的下限 (含)，用於篩選。(選用步驟) 系統預設不會依結束時間篩選。必須是 RFC3339 時間戳記，且必須包含時區偏移量。
timeZone string 回覆中使用的時區。(選用步驟) 預設為日曆的時區。

授權

這項要求允許使用下列至少一個範圍授權：

範圍
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

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

要求主體

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

回應

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

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
屬性名稱 值 說明 附註
kind string 集合類型 (「calendar#events」)。
etag etag 集合的 ETag。
summary string 日曆標題。唯讀。
description string 日曆說明。唯讀。
updated datetime 日曆的上次修改時間 (採用 RFC3339 時間戳記)。唯讀。
timeZone string 日曆的時區。唯讀。
accessRole string 使用者對這個日曆的存取角色。這個唯讀設定檔可能的值包括：
  • 「none」- 使用者沒有存取權。
  • 「freeBusyReader」- 使用者擁有空閒/忙碌資訊的讀取權。
  • 「reader」：使用者擁有日曆的讀取權限。具有讀取權限的使用者會看到私人活動，但活動詳細資料會隱藏。
  • 「writer」：使用者擁有日曆的讀取和寫入權限。私人活動會向具有寫入權限的使用者顯示，且使用者可查看活動詳細資料。
  • 「owner」：使用者擁有日曆的管理員存取權。這個角色具備撰寫者角色的所有權限，還能查看及修改其他使用者的存取層級。
defaultReminders[] list 已驗證使用者的日曆預設提醒。這些提醒適用於這個日曆上的所有活動，但如果活動明確覆寫提醒 (也就是 reminders.useDefault 設為 True)，則不適用。
defaultReminders[].method string 這個提醒事項所用的方法。可能的值包括：
  • 「email」- 系統會透過電子郵件傳送提醒。
  • 「popup」- 提醒會透過 UI 彈出式視窗傳送。

新增提醒時必須填寫。

 可寫入
defaultReminders[].minutes integer 提醒通知應在活動開始前幾分鐘觸發。有效值介於 0 和 40320 (4 週，以分鐘為單位)。

新增提醒時必須填寫。

 可寫入
nextPageToken string 用於存取下一頁結果的權杖。如果沒有其他結果，則會省略這個欄位，並提供 nextSyncToken。
items[] list 日曆上的活動清單。
nextSyncToken string 稍後可用於只擷取自傳回這項結果後變更的項目。如果還有其他結果，則會省略這個屬性，並提供 nextPageToken。

試試看！

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