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 索取使用者的特定資訊。

  • 客戶使用情況報表會列出帳戶中的詳細應用程式和服務活動。這項使用資訊是依應用程式類型整理,且包含該應用程式專屬的資訊。
  • 使用者使用情形報表:顯示帳戶使用者的活動。您可以依據特定使用資訊自訂和篩選這些報表。這份使用資訊是依應用程式類型整理,且包含該應用程式專屬的資訊。
  • 實體用量報表:列出目前使用者對於目前在 Apps 應用程式中使用的實體 進行的活動。
通知
Reports API 提供通知,讓您監控事件,例如資源變更。當您在查看資源,且該資源發生變更時,Reports API 會傳送通知給您。如要進一步瞭解如何透過 Reports API 設定及接收通知,請參閱接收推播通知指南。

後續步驟

  • 要瞭解 Reports API 並查看其運作方式,請使用快速入門導覽課程,並參閱左側導覽列中的程式設計語言。您也可以繼續閱讀本節,瞭解有關帳戶設定的一般資訊。

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

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

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

  • 詳情請參閱 Admin SDK API 問題追蹤工具Google Workspace 開發人員網誌Google Workspace 管理員說明中心