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。不得是已删除的用户。对于已删除的用户,请在 Directory API 中使用 showDeleted=true 调用 users.list,然后将返回的 ID 用作 userKey

date

string

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

查询参数

参数
customerId

string

要为其检索数据的客户的唯一 ID。

filters

string

filters 查询字符串是应用事件参数的逗号分隔列表,其中参数的值由关系运算符操纵。filters 查询字符串包含报告中返回其使用情况的应用的名称。用户使用情况报告的应用值包括 accountsdocsgmail

过滤条件的格式为 [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 查询字符串是一系列用于优化报告结果的事件参数(以英文逗号分隔)。该参数与特定应用相关联。客户使用情况报告的应用值包括 accountsapp_makerapps_scriptscalendarclassroomcrosdocsgmailgplusdevice_managementmeetsites
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

有关详情,请参阅授权指南