实体使用情况报告会返回与您帐号的用户所用实体相关的 Google Workspace 服务活动。您可以根据具体的使用情况信息自定义和过滤这些报告。您可以查看过去 30 天的数据。
根据您的客户协议，实体使用情况报告只能用于合法目的。这些报告同样适用于 Google Workspace 和 Google Workspace 教育版。
检索所有实体使用情况
目前，此 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 是特定于实体所属应用的实体标识符。请参阅 API 参考文档，详细了解如何获取您感兴趣的特定实体的 entityKey。其他参数记录在上面的检索所有实体使用活动下。
如需详细了解查询字符串参数和响应属性，请参阅 API 参考文档。如需了解实体使用情况报告参数，请参阅实体使用情况参数参考。
示例
以下示例展示了如何获取 entityKey 为“1234”的 gplus_community 实体的实体报告。
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：可提供详细警告信息的键值对列表