管理员活动报告

管理员活动报告会返回您账号所有管理员的管理控制台活动信息。每个报告都使用带有报告专用参数(例如管理员名称或特定管理控制台事件)的基本报告端点请求。每份报告的最长时间段是过去 180 天。

根据《客户协议》,管理员活动报告只能用于合法目的。这些报告适用于 Google Workspace、教育版和 ISP 账号。

检索所有管理活动

要检索为账号执行的所有管理活动的报告,请使用以下 GET HTTP 请求并加入授权文档中所述的授权令牌。如需详细了解请求的查询字符串和响应属性,请参阅 API 参考。为确保可读性,以下示例采用回车行格式:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/admin?endTime=a date&startTime=a date
&maxResults=number of events listed on each page of the report

以下示例可获取关于过去 180 天内所有账号管理活动的报告,这是报告可以涵盖的最长期限。maxResults 查询字符串确定此报告的每个报告页面包含两个事件。如需查看 API 响应的示例,请参阅 JSON 响应示例

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/admin?maxResults=2

以下示例获取了有关客户过去 180 天内所有管理活动的报表。customerId 指定要为哪个客户检索报告。

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/admin?customerId=C03az79cb

按管理员检索所有活动

要检索特定管理员执行的所有管理控制台活动的报告,请使用以下 GET HTTP 请求,并在其中添加授权文档中所述的授权令牌。userKey 是报告中管理员的主电子邮件地址。如需详细了解请求的查询字符串和响应属性,请参阅 API 参考。为确保可读性,以下示例采用回车行格式:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/userKey
/applications/admin?endTime=a date&startTime=a date
&maxResults=number of events listed on each page of the report
&filters=event name parameter relational operator parameter value

以下示例会获取关于 john@example.com 对管理控制台应用所做的所有更改的报告,并会对响应进行过滤,以返回 OLD_VALUE 等于 ALLOW_CAMERA 的所有活动。如需查看 API 响应的示例,请参阅 JSON 响应示例。有关这些活动的信息,请参阅管理员活动名称

GET https://admin.googleapis.com/admin/reports/v1/activity/users/john@example.com
/applications/admin?maxResults=2&filters=OLD_VALUE==ALLOW_CAMERA

按事件名称检索所有活动

要检索关于特定事件名称的所有活动的报告,请使用以下 GET HTTP 请求并包含授权文档中所述的授权令牌。如需了解 eventName,请参阅管理员事件名称参考信息。如需详细了解请求的查询字符串和响应属性,请参阅 API 参考。为确保可读性,以下示例采用回车行格式:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/admin?endTime=a date&startTime=a date
&maxResults=maximum number of events returned on a response page
&eventName=name of the administrative event

以下示例检索了有关更改用户姓氏的所有管理控制台实例的报告。如需查看 API 响应的示例,请参阅 JSON 响应示例

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/admin?maxResults=1&eventName=CHANGE_LAST_NAME

按活动和管理员检索所有活动

如要检索管理控制台中由特定管理员对特定活动名称执行的所有更改的报告,请使用以下 GET HTTP 请求,并附上授权文档中所述的授权令牌。userKey 是报告中管理员的主电子邮件地址。如需了解 eventName,请参阅管理员事件名称参考信息。如需详细了解请求的查询字符串和响应属性,请参阅 API 参考。为确保可读性,以下示例采用回车行格式:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/userKey
/applications/admin?endTime=a date&startTime=a date
&maxResults=maximum number of events returned on a response page
&eventName=name of the administrative event

以下示例检索报告,其中包含由 john@example.com 对特定用户姓氏所做的所有管理控制台更改。如需查看 API 响应的示例,请参阅 JSON 响应示例

GET https://admin.googleapis.com/admin/reports/v1/activity/users/john@example.com
/applications/admin?maxResults=1&eventName=CHANGE_LAST_NAME

管理员活动报告示例 JSON 响应

成功的响应会返回 HTTP 200 状态代码。响应将返回状态代码以及状态代码。如需了解 eventName,请参阅管理员事件名称参考信息。如需详细了解请求的网址查询字符串和响应属性,请参阅 API 参考

{
 
"kind": "reports#auditActivities",
 
"nextPageToken": "the next page's token",
 
"items": [
 
{
   
"kind": "audit#activity",
   
"id": {
   
"time": "2011-06-17T15:39:18.460Z",
   
"uniqueQualifier": "report's unique ID",
   
"applicationName": "admin",
   
"customerId": "C03az79cb"
   
},
   
"actor": {
   
"callerType": "USER",
   
"email": "liz@example.com",
   
"profileId": "user's unique Google Workspace profile ID",
   
"key": "consumer key of requestor in OAuth 2LO requests"
   
},
   
"ownerDomain": "example.com",
   
"ipAddress": "user's IP address",
   
"events": [
   
{
     
"type": "GROUP_SETTINGS",
     
"name": "CHANGE_GROUP_SETTING",
     
"parameters": [
     
{
       
"name": "SETTING_NAME",
       
"value": "WHO_CAN_JOIN",
       
"intValue": "integer value of parameter",
       
"boolValue": "boolean value of parameter"
     
}
     
]
   
}
   
]
 
},
 
{
   
"kind": "audit#activity",
   
"id": {
   
"time": "2011-06-17T15:39:18.460Z",
   
"uniqueQualifier": "reports unique ID",
   
"applicationName": "admin",
   
"customerId": "C03az79cb"
   
},
   
"actor": {
   
"callerType": "USER",
   
"email": "liz@example.com",
   
"profileId": "user's unique Google Workspace profile ID",
   
"key": "consumer key of requestor in an OAuth 2LO request"
   
},
   
"ownerDomain": "example.com",
   
"ipAddress": "user's IP address",
   
"events": [
   
{
     
"type": "GROUP_SETTINGS",
     
"name": "CREATE_GROUP",
     
"parameters": [
     
{
       
"name": "GROUP_EMAIL",
       
"value": "helpdesk@example.com",
       
"intValue": "",
       
"boolValue": ""
       
}
     
]
     
}
   
]
   
}
 
]
 
}