Method: userUsageReport.get

擷取報表，當中列有帳戶一組使用者的資源和統計資料。詳情請參閱使用者使用情況報告指南。如要進一步瞭解使用者報表的參數，請參閱使用者使用情形參數參考指南。

HTTP 要求

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
userKey or all

string

代表要篩選其資料的個人資料 ID 或使用者電子郵件。可以是 all 所有資訊，也可以是 userKey 使用者的專屬 Google Workspace 個人資料 ID 或主要電子郵件地址。不得為已刪除的使用者。針對已刪除的使用者，請在 Directory API 中透過 showDeleted=true 呼叫 users.list，然後使用傳回的 ID 做為 userKey。
date

string

代表使用日期，以太平洋標準時間 (UTC-8:00) 為準。時間戳記採用 ISO 8601 格式 (yyyy-mm-dd)。

查詢參數

參數
customerId

string

要擷取資料的客戶專屬 ID。
filters

string

filters 查詢字串是以逗號分隔的應用程式事件參數清單，其中的參數值可由關係運算子操控。filters 查詢字串包含報表中傳回用量的應用程式名稱。「使用者使用情形」報表中的應用程式值包括 accounts、docs 和 gmail。

篩選器的格式為 [application name]:[parameter name][relational operator][parameter value],...。

在此範例中，<> 「不等於」運算子在要求的查詢字串 (%3C%3E) 中經過網址編碼：

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

關係運算子包括：

  • == - 等於。
  • <> -「不等於」。經過網址編碼 (%3C%3E)。
  • < -「小於」。此為網址編碼 (%3C)。
  • <= -「小於或等於」。此為網址編碼 (%3C=)。
  • > -「大於」。此為網址編碼 (%3E)。
  • >= -「大於或等於」。經過網址編碼 (%3E=)。
maxResults

integer (uint32 format)

決定每個回應頁面顯示的活動記錄數量。舉例來說，如果要求設定 maxResults=1，且報表有兩個活動，報表就會有兩個網頁。回應的 nextPageToken 屬性含有前往第二頁的符記。
maxResults 查詢字串為選填項目。
orgUnitID

string

要製作報表的機構單位 ID。系統只會針對屬於指定機構單位的使用者顯示使用者活動。
pageToken

string

用於指定下一頁的權杖。如果報表包含多個網頁，在回應中會包含 nextPageToken 屬性。在後續要求中，請在 pageToken 查詢字串中輸入 nextPageToken 值。
parameters

string

parameters 查詢字串是以半形逗號分隔的事件參數清單，可用來調整報表結果。參數與特定應用程式相關聯。「客戶使用情形」報表的應用值包括 accounts、app_maker、apps_scripts、calendar、classroom、cros、docs、gmail、gplus、device_management、meet 和 sites。
parameters 查詢字串採用 app_name1:param_name1, app_name2:param_name2 的 CSV 格式。
groupIdFilter

string

用於篩選使用者活動的群組 ID (以半形逗號分隔)。舉例來說，回應會包含至少屬於其中一個群組 ID 的使用者活動。格式：「id:abc123,id:xyz456」

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 UsageReports 的執行例項。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

詳情請參閱授權指南。