Method: entityUsageReports.get

擷取報表,內含帳戶中使用者所用實體的資源和統計資料。詳情請參閱實體用量報表指南。如要進一步瞭解實體報表的參數,請參閱實體使用參數參考指南。

HTTP 要求

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

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

路徑參數

參數
entityType

enum (EntityType)

代表報表的實體類型。

entityKey or all

string

代表要篩選資料的物件鍵。這個字串可接收 all 值,取得所有使用者的活動事件,或是應用程式專屬實體的任何其他值。如要進一步瞭解如何取得特定 entityTypeentityKey,請參閱實體使用參數參考指南。

date

string

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

查詢參數

參數
customerId

string

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

filters

string

filters 查詢字串是以逗號分隔的應用程式事件參數清單,其中的參數值可由關係運算子操控。filters 查詢字串包含報表中傳回用量的應用程式名稱。實體使用情形報表中的應用程式值包括 accountsdocsgmail

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

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

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0 

關係運算子包括:

  • == - 等於。
  • <> -「不等於」。經過網址編碼 (%3C%3E)。
  • < -「小於」。此為網址編碼 (%3C)。
  • <= -「小於或等於」。此為網址編碼 (%3C=)。
  • > -「大於」。此為網址編碼 (%3E)。
  • >= -「大於或等於」。經過網址編碼 (%3E=)。
篩選器只能套用至數字參數。

maxResults

integer (uint32 format)

決定每個回應頁面顯示的活動記錄數量。舉例來說,如果要求設定 <span>maxResults=1</span>,且報表有兩個活動,報表就會有兩個網頁。回應的 <span>nextPageToken</span> 屬性含有前往第二頁的符記。

pageToken

string

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

parameters

string

parameters 查詢字串是以半形逗號分隔的事件參數清單,可用來調整報表結果。參數與特定應用程式相關聯。實體用量報表中的應用程式值只有 gplus
parameter 查詢字串採用 [app_name1:param_name1], [app_name2:param_name2]... 的 CSV 格式。

要求主體

要求主體必須為空白。

回應主體

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

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱授權指南

EntityType

列舉
gplus_communities 傳回 Google+ 社群報告。