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 或主要電子郵件地址。不得為已刪除的使用者。如果是已刪除的使用者，請使用 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:abc123,id:xyz456」

要求主體

要求主體必須為空白。

回應主體

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。