Reports API 是一種 RESTful API,可讓您存取使用者的 Google Workspace 活動相關資訊。Reports API 是 Admin SDK API 的一部分。
Reports API 提供兩種報表:
- 活動報表:針對特定應用程式或服務 (例如 Google 雲端硬碟或管理控制台) 回報事件。
- 「使用情形」報表:列出使用者造成的工作區事件。
- 「客戶」使用情況報表會列出網域中所有使用者的事件。
- 「使用者」用量報表會列出依使用者分類的事件。
以下列出報表 API 中常用的術語:
- 活動報表
活動報告會列出特定 Google Workspace 應用程式或服務中的活動資訊。活動報表會顯示日期、時間、使用者和活動類型。API 參考資料包含活動報告的完整清單,以及這些報告包含的資訊。以下列舉幾份活動報表的範例,並按應用程式或服務分類:
- 管理員活動報表會顯示管理員使用管理控制台執行的活動。舉例來說,您可以使用管理控制台取得管理員變更使用者名稱的所有時間點清單。
- Google 雲端硬碟活動報表會列出網域使用者如何編輯及查看雲端硬碟文件。舉例來說,您可以取得特定使用者在雲端硬碟上的活動清單。
- 登入活動報告會提供帳戶使用者登入及登出帳戶的時間資訊。舉例來說,您可以取得特定時間範圍內,網域的所有登入事件報表。
- 行動裝置活動報告會顯示使用由 Google 行動管理服務管理的行動裝置所進行的活動。舉例來說,您可以收到使用者註冊新裝置的通知。
- OAuth 權杖活動報表會列出使用者授予或撤銷第三方網站和應用程式使用的授權權杖時的事件。您可以使用 Reports API,取得所有第三方對使用者 Google Workspace 資料的存取權清單。
- 用量報表
用量報表會提供網域中 Google Workspace 事件的相關資訊。您可以使用 API 要求使用者的特定資訊。
- 客戶使用情形報表會列出帳戶中的詳細應用程式和服務活動。這類使用情形資訊會依應用程式類型分類,並包含該應用程式專屬的資訊。
- 使用者使用情形報表會顯示帳戶使用者的活動。您可以自訂這些報表,並篩選特定的使用資訊。這項使用資訊會依應用程式類型分類,並包含該應用程式專屬的資訊。
- 實體使用情形報表會列出帳戶使用者在 Currents 應用程式中使用的實體相關活動。
- 通知
- Reports API 會提供通知,讓您監控資源變更等事件。當您正在監控資源,而該資源發生變更時,Reports API 就會傳送通知給您。如要進一步瞭解如何設定及接收 Reports API 通知,請參閱接收推播通知指南。
後續步驟
如要瞭解 Reports API 並查看其運作方式,請使用快速入門導覽課程,這些課程會依左側導覽列的程式設計語言列出。您也可以繼續閱讀本節的一般資訊,瞭解如何設定帳戶。
「授權」一節說明如何使用 OAuth 2.0 存取權杖,從 Google Workspace 應用程式和服務取得使用者資料。
如要查看特定資源類型或方法的詳細資料,請參閱 API 參考資料。
如需更多資訊,請參閱 Admin SDK API 問題追蹤器、Google Workspace Developers 網誌和 Google Workspace Admin 說明中心。