Method: userUsageReport.get

检索报告，其中包含该账号的一组用户的属性和统计信息。如需了解详情，请参阅用户使用情况报告指南。如需详细了解用户报告的参数，请参阅用户使用情况参数参考指南。

HTTP 请求

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

网址采用 gRPC 转码语法。

路径参数

参数
userKey or all

string

表示要过滤数据的个人资料 ID 或用户电子邮件地址。可以是 all（表示所有信息）；userKey（表示用户的唯一 Google Workspace 个人资料 ID 或其主电子邮件地址）。不得是已删除的用户。对于已删除的用户，请使用 showDeleted=true 在 Directory API 中调用 users.list，然后将返回的 ID 用作 userKey。
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/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

关系运算符包括：

  • == -“等于”。
  • <> -“不等于”。它经过网址编码 (%3C%3E)。
  • < -“小于”。它经过网址编码 (%3C)。
  • <= -“小于或等于”。它经过了网址编码 (%3C=)。
  • > -“大于”。它经过网址编码 (%3E)。
  • >= -“大于或等于”。它经过了网址编码 (%3E=)。
maxResults

integer (uint32 format)

确定每个响应页面上显示的活动记录数量。例如，如果请求设置 maxResults=1 且报表包含两个活动，则该报表包含两个页面。响应的 nextPageToken 属性具有第二页的令牌。
maxResults 查询字符串是可选的。
orgUnitID

string

要为其生成报告的组织部门的 ID。系统仅会为属于指定组织部门的用户显示用户活动。
pageToken

string

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

string

parameters 查询字符串是一个以英文逗号分隔的事件参数列表，该参数可优化报告结果。该参数与特定的应用相关联。“客户使用情况”报告的应用值包括 accounts、app_maker、apps_scripts、calendar、classroom、cros、docs、gmail、gplus、device_management、meet 和 sites。
parameters 查询字符串采用 CSV 格式，即 app_name1:param_name1, app_name2:param_name2。
groupIdFilter

string

以逗号分隔的群组 ID（经过混淆处理），用于过滤用户活动，即响应将仅包含属于此处提及的至少一个群组 ID 的用户的活动。格式：“id:abc123,id:xyz456”

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 范围：

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

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