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 来获取所有用户的活动事件，或获取应用专属实体的任何其他值。如需详细了解如何获取特定 entityType 的 entityKey，请参阅实体使用参数参考指南。
date

string

表示使用量发生的日期，基于 UTC-8:00（太平洋标准时间）。时间戳采用 ISO 8601 格式 yyyy-mm-dd。

查询参数

参数
customerId

string

要为其提取数据的客户的唯一 ID。
filters

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=)。
过滤条件只能应用于数字参数。
maxResults

integer (uint32 format)

确定每个响应页面上显示的活动记录数量。例如，如果请求设置 <span>maxResults=1</span> 且报表包含两个活动，则该报表包含两个页面。响应的 <span>nextPageToken</span> 属性具有第二页的令牌。
pageToken

string

用于指定下一页的令牌。包含多个网页的报告会在响应中包含一个 nextPageToken 属性。在您获取报告的下一页的后续请求中，在 pageToken 查询字符串中输入 nextPageToken 值。
parameters

string

parameters 查询字符串是一个以英文逗号分隔的事件参数列表，该参数可优化报告结果。该参数与特定的应用相关联。实体使用情况报告的应用值只有 gplus。
parameter 查询字符串采用 CSV 格式，即 [app_name1:param_name1], [app_name2:param_name2]...。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 UsageReports 实例。

授权范围

需要以下 OAuth 范围：

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

有关详情，请参阅授权指南。

EntityType

枚举
gplus_communities 返回有关 Google+ 社群的报告。