Method: entityUsageReports.get

enum (EntityType)

代表報表的實體類型。

string

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

string

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

string

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

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/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=)。

integer (uint32 format)

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

string

用於指定下一頁的符記。含有多個頁面的報表在回應中會有 nextPageToken 屬性。在取得報表下一頁的後續要求中，請在 pageToken 查詢字串中輸入 nextPageToken 值。

string

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