开始接收有关账号活动的通知。如需了解详情,请参阅接收推送通知。
HTTP 请求
POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
userKey or all |
表示应过滤数据的个人资料 ID 或用户电子邮件地址。可以是 |
applicationName |
要检索事件的应用的名称。 |
查询参数
参数 | |
---|---|
actorIpAddress |
执行相应事件的主机的互联网协议 (IP) 地址。这是另一种过滤报告摘要的方式,可根据报告中涉及的用户活动的 IP 地址进行过滤。此 IP 地址可能会反映用户的实际位置,但也可能不会。例如,IP 地址可以是用户的代理服务器地址或虚拟专用网 (VPN) 地址。此参数同时支持 IPv4 和 IPv6 地址版本。 |
customerId |
要检索数据的客户的唯一 ID。 |
endTime |
设置报告中显示的时间范围的结束时间。日期采用 RFC 3339 格式,例如 2010-10-28T10:26:35.000Z。默认值为 API 请求的大致时间。API 报告有三个基本时间概念:
endTime ,则报告会返回从 startTime 到当前时间的所有活动;如果 startTime 是 180 天以前的时间,则报告会返回最近 180 天内的所有活动。
|
eventName |
API 查询的事件的名称。每个 |
filters |
这些事件参数与特定 在以下云端硬盘活动示例中,返回的列表包含所有
注意:该 API 不接受同一参数的多个值。如果 API 请求中多次提供某个参数,API 只接受该参数的最后一个值。此外,如果 API 请求中提供了无效的参数,API 会忽略该参数,并返回与其余有效参数对应的响应。如果未请求任何参数,则返回所有参数。 |
maxResults |
确定每个响应页面上显示多少条活动记录。例如,如果请求设置了 |
orgUnitID |
要生成报告的组织部门的 ID。系统只会显示属于指定组织部门的用户的活动记录。 |
pageToken |
用于指定下一页的令牌。如果报告包含多个页面,则响应中会包含 |
startTime |
设置报告中显示的时间范围的开始时间。日期采用 RFC 3339 格式,例如 2010-10-28T10:26:35.000Z。该报告会返回从 |
groupIdFilter |
以英文逗号分隔的群组 ID(经过混淆处理),用于过滤用户活动,即响应将仅包含属于此处提及的至少一个群组 ID 的用户的活动。格式:“id:abc123,id:xyz456” |
请求正文
请求正文包含一个 SubscriptionChannel
实例。
响应正文
用于监控资源变化的通知渠道。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string } |
字段 | |
---|---|
id |
用于标识相应频道的 UUID 或类似唯一字符串。 |
token |
通过此渠道传送的每条通知中都会包含一个任意字符串,该字符串会传送给目标地址。可选。 |
expiration |
通知渠道的过期日期和时间,以 Unix 时间戳(以毫秒为单位)表示。可选。 |
type |
相应渠道所用的交付机制类型。值应设置为 |
address |
相应渠道的通知的传送地址。 |
payload |
一个布尔值,用于指示是否需要载荷。载荷是在 HTTP POST、PUT 或 PATCH 消息的正文中发送的数据,其中包含有关请求的重要信息。可选。 |
params |
用于控制交付渠道行为的其他参数。可选。 包含一系列 |
resourceId |
用于标识相应渠道上所监控资源的不透明 ID。在不同 API 版本中保持稳定。 |
resourceUri |
所监控资源的特定于版本的标识符。 |
kind |
将此标识为用于监控资源(即“ |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/admin.reports.audit.readonly
如需了解详情,请参阅授权指南。
ApplicationName
要检索事件的应用的名称。
枚举 | |
---|---|
access_transparency |
Google Workspace Access Transparency 活动报告会返回有关不同类型的 Access Transparency 活动事件的信息。 |
admin |
管理控制台应用的活动报告会返回有关不同类型管理员活动事件的账号信息。 |
calendar |
Google 日历应用的活动报告会返回有关各种日历活动事件的信息。 |
chat |
聊天活动报告会返回各种聊天活动事件的相关信息。 |
drive |
Google 云端硬盘应用的活动报告会返回有关各种 Google 云端硬盘活动事件的信息。云端硬盘活动报告仅适用于 Google Workspace 商务版和 Google Workspace 企业版客户。 |
gcp |
Google Cloud Platform 应用的活动报告会返回有关各种 GCP 活动事件的信息。 |
gplus |
Google+ 应用的活动报告会返回有关各种 Google+ 活动事件的信息。 |
groups |
Google 群组应用的活动报告会返回有关各种群组活动事件的信息。 |
groups_enterprise |
企业群组活动报告会返回有关各种企业群组活动事件的信息。 |
jamboard |
Jamboard 活动报告会返回各种 Jamboard 活动事件的相关信息。 |
login |
登录应用的活动报告会返回有关不同类型登录活动事件的账号信息。 |
meet |
Meet 审核活动报告会返回有关不同类型的 Meet 审核活动事件的信息。 |
mobile |
设备审核活动报告会返回有关不同类型的设备审核活动事件的信息。 |
rules |
“规则活动”报告会返回有关不同类型的规则活动事件的信息。 |
saml |
SAML 活动报告会返回有关不同类型的 SAML 活动事件的信息。 |
token |
Token 应用的活动报告会返回有关不同类型 Token 活动事件的账号信息。 |
user_accounts |
“用户账号”应用的活动报告会返回有关不同类型用户账号活动事件的账号信息。 |
context_aware_access |
情境感知访问权限活动报告会返回有关用户因 情境感知访问权限规则而遭拒的访问事件的信息。 |
chrome |
Chrome 活动报告会返回有关 Chrome 浏览器和 Chrome OS 事件的信息。 |
data_studio |
数据洞察活动报告会返回有关各种类型的数据洞察活动事件的信息。 |
keep |
Keep 应用的活动报告会返回有关各种 Google Keep 活动事件的信息。Keep 活动报告仅适用于 Google Workspace 商务版和企业版客户。 |
classroom |
Google 课堂活动报告会返回有关不同类型的 Google 课堂活动事件的信息。 |