客户使用情况报告汇总了整个网域中所有用户的 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 }, ... ] } ] } ] }