Reports API:客户使用情况报告

客户使用情况报告 汇总整个网域中所有用户的 Google Workspace 服务使用情况信息。 用户使用情况报告会返回您账号中的 Google Workspace 服务使用情况信息。 这些使用情况信息按应用程序类型进行整理,应用程序类型由应用程序特有的参数组成。 每份报告的默认时间段和最长时间段都是过去 450 天。

这些使用情况报告只能按照《客户协议》用于合法目的。此外,这些 报告适用于 Google Workspace 和 Google Workspace 教育版。

检索客户使用情况报告

要检索账号活动报告,请使用以下 GET HTTP 请求并在其中包含授权令牌 授权文档中所述。为了方便阅读 以下示例采用回车行格式:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

dates 值是使用情况的发生日期,时间戳采用 ISO 8601 格式,即 yyyy-mm-dd。在选择时区时,我们建议您使用自己账号的时区。有关请求查询字符串和响应属性的详情,请参阅 API 参考客户使用情况报告参数参考

以下示例将获取一个报告,其中包含过去 30 天内所有成功登录您的账号的总次数和一个列表。 授权应用数量,以及每个应用的用户授权数量,从 2013 年 3 月 3 日开始。maxResults 查询字符串,显示此报告在每个报告页面上返回两个事件:

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

客户使用情况报告的 JSON 响应

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
  {
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}