实体使用情况报告会返回与实体相关的 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
以下示例会获取包含 community_name
参数的报告
针对所有 gplus_communities
实体。
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all /dates/2017-12-11?parameters=gplus:community_name
以下示例获取了 community_name
的报告,并且
每个gplus_communities
实体的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 参考。相关信息 实体使用情况报告参数,请参阅 实体用法参数 参考。
示例
以下示例使用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
数组中的每个条目都具有以下参数:
<ph type="x-smartling-placeholder">- </ph>
code
:机器可读的警告代码message
:直观易懂的警告消息data
:提供详细警告信息的键值对列表