實體用量報表會傳回與帳戶使用者所用實體相關的 Google Workspace 服務活動。您可以自訂及篩選這些報表，取得特定使用資訊。系統提供過去 30 天的資料。
實體用量報表只能用於合法用途，且須遵守《客戶協議》。這些報表也適用於 Google Workspace 和 Education。
擷取所有實體的使用活動
這項 API 僅支援 Google+ 社群實體類型。如要擷取帳戶中與應用程式實體相關的所有活動報表，請使用下列 GET HTTP 要求，並附上授權文件中所述的授權權杖。為了方便閱讀，以下範例會以換行格式呈現：
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
date 值是使用時間的日期，時間戳記採用 ISO 8601 格式 (yyyy-mm-dd)。建議您使用帳戶時區。如要進一步瞭解查詢字串參數和回應屬性，請參閱 API 參考資料。如要瞭解實體用量報表參數，請參閱實體用量參數參考資料。
applicationParameters 是以逗號分隔的參數清單，列出您要擷取的參數。每個參數的格式為 application:parameter_name，例如 gplus:community_name。如要瞭解可用的參數，請參閱「實體用量參數參考資料」。如未指定參數，系統會傳回所有參數。
parameterFilters 是以逗號分隔的清單，可套用至結果的篩選器。每個篩選條件的格式為 application:parameter_name[relational_operator]parameter_value。舉例來說，篩選器 gplus:num_total_members>100 會篩選結果，只保留 gplus:num_total_members 參數值大於 100 的結果。
maxResults 是單次擷取作業傳回的結果數上限。如果結果總數超過這個值，回應就會遭到截斷，並包含 nextPageToken (請參閱下方的 JSON 回應範例)。
範例
以下範例會取得報表，其中包含所有 gplus_communities 實體的所有參數。
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11
以下範例會取得報表，其中包含所有 gplus_communities 實體的 community_name 參數。
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
以下範例會取得每個 gplus_communities 實體的 community_name 和 num_total_members 報表，並依成員超過 100 人的社群篩選。如需 API 回應範例，請參閱「JSON 回應範例」。
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11 ?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
擷取特定實體的報表
如要擷取特定實體的報表，請使用下列 GET HTTP 要求，並附上授權文件中所述的授權權杖。為了方便閱讀，以下範例會換行。
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date ?parameters=applicationParameters &filters=parameterFilters &maxResults=maxResults
entityKey 是實體 ID，專用於實體所在的應用程式。如要瞭解如何取得感興趣實體的 entityKey，請參閱 API 參考資料。其他參數已記錄在「 擷取所有實體使用活動」一節中。
如要進一步瞭解查詢字串參數和回應屬性，請參閱 API 參考資料。如要瞭解實體用量報表參數，請參閱實體用量參數參考資料。
範例
以下範例會取得 gplus_community 實體的實體報表，其中 entityKey 為「1234」。
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
用量報表的 JSON 回應範例
成功的回應會傳回 HTTP 200 狀態碼。除了狀態碼外，回應還會傳回報表。為方便閱讀，回應中省略了部分參數。
實體報表的 JSON 回應範例
{ "kind": "reports#usageReports", "nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA", "usageReports": [ { "kind": "admin#reports#usageReport", "date": "2017-12-11", "entity": { "type": "OBJECT", "customerId": "C03az79cb", "objectType": "GPLUS_COMMUNITY", "objectId": "1234", }, "parameters": [ { "name": "gplus:community_name", "stringValue": "My Community" }, { "name": "gplus:num_total_members", "intValue": 37 }, { "name": "gplus:num_7day_active_members", "intValue": 12 }, { "name": "gplus:num_30day_active_members", "intValue": 17 }, ] } ] }
含有警告的實體報表 JSON 回應範例
如果無法滿足要求，回應中可能會傳回一或多項警告。在這個範例中，要求提出時報表尚無法使用。{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}warnings 陣列中的每個項目都有下列參數：
code：機器可讀的警告代碼message：使用者可自然閱讀的警告訊息data：鍵/值組合清單，提供詳細的警告資訊