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；对于用户的唯一 Google Workspace 个人资料 ID 或其主电子邮件地址，可以是 userKey。不得是已删除的用户。对于已删除的用户，请使用 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)。
  • < - 'less than'。它采用网址编码 (%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 查询字符串采用 app_name1:param_name1, app_name2:param_name2 的 CSV 格式。
groupIdFilter

string

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

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅授权指南。