本頁面由 Cloud Translation API 翻譯而成。

Events: list

傳回指定日曆中的活動。立即試用。

要求

HTTP 要求

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

參數

參數名稱	值	說明
路徑參數
`calendarId`	`string`	日曆 ID。如要擷取日曆 ID，請呼叫 calendarList.list 方法。如要存取目前登入使用者的主要日曆，請使用「`primary`」關鍵字。
選用查詢參數
`alwaysIncludeEmail`	`boolean`	已淘汰並忽略。
`eventTypes`	`string`	要傳回的事件類型。(選用步驟) 這個參數可以重複多次，傳回不同類型的活動。如未設定，則會傳回所有事件類型。可接受的值如下：「`birthday`」：每年舉辦的全天特別活動。「`default`」：定期活動。「`focusTime`」：專注時間活動。「`fromGmail`」：Gmail 中的活動。「`outOfOffice`」：不在辦公室的活動。「`workingLocation`」：工作地點活動。
`iCalUID`	`string`	指定要以 iCalendar 格式在回覆中提供的活動 ID。(選用步驟) 如要依 iCalendar ID 搜尋活動，請使用這個方法。
`maxAttendees`	`integer`	回覆中可納入的出席者人數上限。如果出席者人數超過指定數量，系統只會傳回參與者。選用。
`maxResults`	`integer`	單一結果頁面中傳回的事件數量上限。即使有更多事件符合查詢條件，結果頁面中的事件數量也可能少於這個值，甚至完全沒有。如果回應中含有非空白的 `nextPageToken` 欄位，就表示網頁不完整。預設值為 250 個事件。網頁大小不得超過 2500 個事件。選用。
`orderBy`	`string`	結果中傳回的事件順序。(選用步驟) 預設值為未指定的穩定順序。可接受的值如下：「`startTime`」：依開始日期/時間排序 (遞增)。只有在查詢單一事件時 (即參數 `singleEvents` 為 True) 才會顯示這項資訊「`updated`」：依上次修改時間排序 (遞增)。
`pageToken`	`string`	指定要傳回哪個結果頁面的符記。選用。
`privateExtendedProperty`	`string`	以 propertyName=value 形式指定的擴充屬性限制。僅比對私有屬性。這個參數可能會重複多次，以傳回符合所有指定限制的事件。
`q`	`string`	自由輸入搜尋字詞，在下列欄位中尋找符合這些字詞的事件： `summary` `description` `location` 與會者的`displayName` 與會者的`email` 主辦人的`displayName` 主辦人的`email` `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` 這些搜尋字詞也會比對預先定義的關鍵字，以及工作地點、不在辦公室和專注時間活動的所有顯示標題翻譯。舉例來說，搜尋「辦公室」或「Bureau」會傳回 `officeLocation` 類型的工作地點活動，而搜尋「Out of office」或「Abwesend」則會傳回不在辦公室活動。選用項目。
`sharedExtendedProperty`	`string`	以 propertyName=value 形式指定的擴充屬性限制。僅比對共用屬性。這個參數可能會重複多次，以傳回符合所有指定限制的事件。
`showDeleted`	`boolean`	是否要在結果中納入已刪除的事件 (`status` 等於「`cancelled`」)。如果 `showDeleted` 和 `singleEvents` 皆為 False，系統仍會納入已取消的週期性活動例項 (但不會納入基礎週期性活動)。如果 `showDeleted` 和 `singleEvents` 都為 True，則只會傳回已刪除活動的單一執行個體 (但不會傳回基礎週期性活動)。(選用步驟) 預設值為 False。
`showHiddenInvitations`	`boolean`	是否要在結果中納入隱藏的邀請。(選用步驟) 預設值為 False。
`singleEvents`	`boolean`	是否要將週期性活動展開為執行個體，並只傳回單一一次性活動和週期性活動的執行個體，但不傳回基礎週期性活動本身。(選用步驟) 預設值為 False。
`syncToken`	`string`	從先前清單要求的最後一頁結果傳回的 `nextSyncToken` 欄位取得的權杖。這樣一來，這項清單要求只會傳回自該時間起有變更的項目。自上次清單要求以來刪除的所有活動一律會出現在結果集中，且不允許將 `showDeleted` 設為 False。為確保用戶端狀態一致，您無法同時指定多個查詢參數和 `nextSyncToken`。這些是： `iCalUID` `orderBy` `privateExtendedProperty` `q` `sharedExtendedProperty` `timeMin` `timeMax` `updatedMin` 所有其他查詢參數應與初始同步作業相同，以免發生未定義的行為。如果 `syncToken` 過期，伺服器會傳回 410 GONE 回應代碼，用戶端應清除儲存空間，並在沒有 `syncToken` 的情況下執行完整同步。進一步瞭解增量同步。選用。預設值為傳回所有項目。
`timeMax`	`datetime`	活動開始時間的上限 (不含上限)，用於篩選。(選用步驟) 系統預設不會依開始時間篩選。必須是 RFC3339 時間戳記，且必須包含時區偏移量，例如 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z。系統會忽略毫秒。如果設定 `timeMin`，`timeMax` 必須大於 `timeMin`。
`timeMin`	`datetime`	事件結束時間的下限 (不含)，用於篩選。(選用步驟) 系統預設不會依結束時間篩選。必須是 RFC3339 時間戳記，且必須包含時區偏移量，例如 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z。系統會忽略毫秒。如果已設定 `timeMax`，則 `timeMin` 必須小於 `timeMax`。
`timeZone`	`string`	回覆中使用的時區。(選用步驟) 預設為日曆的時區。
`updatedMin`	`datetime`	事件上次修改時間的下限 (以 RFC3339 時間戳記表示)，用於篩選。如果指定這個時間，系統一律會納入自該時間起刪除的項目，無論 `showDeleted` 為何。(選用步驟) 預設值是不依上次修改時間篩選。

授權

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

範圍
`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`」：使用者擁有日曆的管理員存取權。這個角色具備撰寫者角色的所有權限，並可查看及修改其他使用者的存取層級。重要事項：`owner`角色與日曆的資料擁有者不同。日曆只有一位資料擁有者，但可以有多位具有`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，針對即時資料呼叫這個方法，然後查看回應。

Events: list 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

要求

HTTP 要求

參數

授權

要求主體

回應

試試看！

Events: list