Method: userUsageReport.get

擷取報表，該報表是帳戶中一組使用者的屬性和統計資料集合。詳情請參閱使用者用量報表指南。如要進一步瞭解使用者報表的參數，請參閱使用者使用情形參數參考指南。

HTTP 要求

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

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

路徑參數

參數
userKey

string

代表應篩選資料的個人資料 ID 或使用者電子郵件。可以是 all (所有資訊)，或是 userKey (使用者專屬的 Google Workspace 個人資料 ID 或主要電子郵件地址)。不得為已刪除的使用者。針對已刪除的使用者，請使用 showDeleted=true 在 Directory API 中呼叫 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 查詢字串的 CSV 格式為 app_name1:param_name1, app_name2:param_name2。
groupIdFilter

string

以半形逗號分隔的群組 ID (經過模糊處理)，系統會根據這些群組 ID 篩選使用者活動，也就是說，回應只會包含至少屬於這裡所提及的群組 ID 之一的使用者活動。格式：「id:abc123,id:xyz456」

要求主體

要求主體必須為空白。

回應主體

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。