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

表示发生使用量的日期。时间戳采用 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)。
  • >= - 大于等于 39。该网址采用网址编码 (%3E=)。
过滤条件只能应用于数字参数。
maxResults

integer (uint32 format)

确定每个响应页面中显示的活动记录数。例如，如果请求设置了 <span>maxResults=1</span>，且报告包含两个 activity，则报告包含两个页面。响应的 <span>nextPageToken</span> 属性包含指向第二页的令牌。
pageToken

string

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

string

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

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 作用域：

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

如需了解详情，请参阅 OAuth 2.0 概览。

EntityType

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