Reports API 總覽

Reports API 是 RESTful API,可供存取使用者 Google Workspace 活動的相關資訊。Reports API 是 Admin SDK API 的一部分。

Reports API 提供兩種類型的報表:

  • 活動報告:回報特定應用程式或服務 (例如 Google 雲端硬碟或管理控制台) 的事件。
  • 使用情形報表:列出使用者造成的工作區事件。
    • 客戶使用情形報表會列出網域中所有使用者的事件。
    • 使用者使用情形報表會列出使用者分類的事件。

以下是 Reports API 使用的常見詞彙:

活動報告

活動報表會列出特定 Google Workspace 應用程式或服務中的活動資訊。活動報表包含日期、時間、使用者和活動類型。API 參考資料包含活動報告及其所含資訊的完整清單。以下是一些依應用程式或服務列出的活動報告範例:

  • 管理員活動報告會顯示管理員使用管理控制台執行的活動。舉例來說,您可以透過管理控制台查看管理員變更使用者名稱的所有時間清單。
  • Google 雲端硬碟活動報告會列出您網域的使用者編輯和查看雲端硬碟文件的方式。舉例來說,您可以取得特定使用者的雲端硬碟活動清單。
  • 登入活動報表會提供帳戶使用者登入和登出帳戶的時間資訊。舉例來說,您可以取得網域在特定時間範圍內的所有登入報表。
  • 行動裝置活動報表會顯示使用 Google 行動管理服務管理的行動裝置活動。舉例來說,您可以在使用者註冊新裝置時接收通知。
  • OAuth 權杖活動報表會列出使用者授予或撤銷第三方網站和應用程式使用的授權權杖時的事件。您可以使用 Reports API 取得一份清單,瞭解所有第三方對於使用者 Google Workspace 資料的存取權。
使用情況報表

用量報表提供網域中 Google Workspace 事件的相關資訊。 您可以使用 API 要求使用者的特定資訊。

  • 客戶使用情形報表會列出您帳戶中的詳細應用程式與服務活動。這些使用資訊依應用程式類型分類,其中包含該應用程式的專屬資訊。
  • 使用者使用情形報表會顯示帳戶使用者的活動。您可自訂這些報告,並根據特定使用資訊進行篩選。這些使用資訊依應用程式類型分類,其中包含該應用程式的專屬資訊。
  • 實體使用情形報表會列出帳戶使用者在 Currents 應用程式中使用的實體相關活動。
通知
您可以透過 Reports API 查看事件,例如資源變更。您在監控資源時,資源變更時, Reports API 會傳送通知給您。如要進一步瞭解如何透過 Reports API 設定及接收通知,請參閱接收推播通知指南。

後續步驟

  • 如要瞭解 Reports API 及其運作方式,請使用左側導覽列,按照程式語言列出的程式語言。您也可以繼續閱讀本節,瞭解設定帳戶的一般資訊。

  • 如要使用 Reports API,請按照事前準備步驟設定帳戶並成為管理員。您也將建立專案並透過 Google API 控制台註冊,然後啟用 Reports API 服務。

  • 授權一節說明如何使用 OAuth 2.0 存取權杖,從 Google Workspace 應用程式和服務取得使用者資料。

  • 如要尋找特定資源類型或方法的詳細資料,請參閱 API 參考資料

  • 詳情請參閱 Admin SDK API Issue TrackerGoogle Workspace 開發人員網誌Google Workspace 管理員說明中心