Method: activities.watch

开始接收账号活动通知。如需了解详情，请参阅接收推送通知。

HTTP 请求

POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch

网址采用 gRPC 转码语法。

路径参数

参数
userKey

string

表示应过滤其数据的个人资料 ID 或用户电子邮件地址。对于所有信息，可以是 all；对于用户的唯一 Google Workspace 个人资料 ID 或其主电子邮件地址，可以是 userKey。不得是已删除的用户。对于已删除的用户，请使用 showDeleted=true 在 Directory API 中调用 users.list，然后将返回的 ID 用作 userKey。
applicationName

enum (ApplicationName)

要检索事件的应用名称。

查询参数

参数
actorIpAddress

string

执行事件的主机的互联网协议 (IP) 地址。这是使用被报告活动的用户的 IP 地址过滤报告摘要的另一种方法。此 IP 地址可能或不一定反映用户的实际位置。例如，IP 地址可以是用户的代理服务器地址或虚拟专用网 (VPN) 地址。此参数支持 IPv4 和 IPv6 地址版本。
customerId

string

要为其提取数据的客户的唯一 ID。
endTime

string

设置报告中显示的时间范围的结束时间。日期采用 RFC 3339 格式，例如 2010-10-28T10:26:35.000Z。默认值为 API 请求的大致时间。API 报告包含三个基本时间概念：

  • API 请求报告的日期：API 创建和检索报告的时间。
  • 报表开始时间：报表中显示的时间范围的开始时间。startTime 必须早于 endTime（如果已指定）和发出请求时的当前时间，否则 API 会返回错误。
  • 报告的结束时间：报告中显示的时间段的结束时间。例如，报告中汇总的事件的时间范围可以从 4 月开始，到 5 月结束。您可以在 8 月请求该报告。
如果未指定 endTime，则报告会返回 startTime 到当前时间的所有活动，如果 startTime 是过去 180 天之前的时间，则会返回最近 180 天内的所有活动。
eventName

string

API 要查询的事件的名称。每个 eventName 都与特定的 Google Workspace 服务或功能相关，该 API 会将这些服务或功能划分为事件类型。例如，管理控制台应用报告中的 Google 日历活动。“日历设置”type 结构包含 API 报告的所有日历 eventName 活动。当管理员更改日历设置时，API 会在“日历设置”type 和 eventName 参数中报告此活动。如需详细了解 eventName 查询字符串和参数，请参阅上述 applicationName 中各种应用的事件名称列表。
filters

string

filters 查询字符串是一个由关系运算符操控的事件参数组成的逗号分隔列表。事件参数的格式为 {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

这些事件参数与特定的 eventName 相关联。如果请求的参数不属于 eventName，则系统会返回空报告。如需详细了解每个应用的可用 eventName 字段及其关联的参数，请前往 ApplicationName 表格，然后点击“附录”中的“活动事件”页面，找到您要查看的应用。

在以下云端硬盘活动示例中，返回的列表包含 doc_id 参数值与关系运算符定义的条件匹配的所有 edit 事件。在第一个示例中，请求会返回 doc_id 值等于 12345 的所有已修改文档。在第二个示例中，报告会返回 doc_id 值不等于 98765 的所有已修改文档。<> 运算符在请求的查询字符串 (%3C%3E) 中采用网址编码：

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

filters 查询支持以下关系运算符：

  • == -“等于”。
  • <> -“不等于”。必须经过网址编码 (%3C%3E)。
  • < -“小于”。必须采用网址编码 (%3C)。
  • <= -“小于或等于”。必须采用网址编码 (%3C=)。
  • > -“大于”。必须采用网址编码 (%3E)。
  • >= -“大于或等于”。必须采用网址编码 (%3E=)。

注意：该 API 不接受同一参数的多个值。如果在 API 请求中多次提供某个参数，API 只会接受该参数的最后一个值。此外，如果 API 请求中提供了无效参数，API 会忽略该参数，并返回与其余有效参数对应的响应。如果未请求任何参数，则返回所有参数。
maxResults

integer

确定每个响应页面上显示的活动记录数量。例如，如果请求设置了 maxResults=1，并且报告包含两个活动，则报告将包含两个页面。响应的 nextPageToken 属性包含指向第二页的令牌。请求中的 maxResults 查询字符串是可选的。默认值为 1000。
orgUnitID
(deprecated)

string

Deprecated。此字段已废弃，不再受支持。

要生成报告的组织部门的 ID。只有属于指定组织部门的用户才能看到活动记录。
pageToken

string

用于指定下一页的令牌。包含多个页面的报告在响应中具有 nextPageToken 属性。在用于获取报告下一页的后续请求中，在 pageToken 查询字符串中输入 nextPageToken 值。
startTime

string

设置报告中显示的时间范围的开始时间。日期采用 RFC 3339 格式，例如 2010-10-28T10:26:35.000Z。该报告会返回 startTime 到 endTime 之间的所有活动。startTime 必须在 endTime（如果已指定）和发出请求的当前时间之前，否则 API 会返回错误。
groupIdFilter

string

用于过滤用户活动的分组 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

string

用于标识此渠道的 UUID 或类似的唯一字符串。
token

string

随每条通过此渠道传送的通知一起传送到目标地址的任意字符串。可选。
expiration

string (int64 format)

通知渠道到期日期和时间，以 Unix 时间戳表示（以毫秒为单位）。可选。
type

string

此渠道使用的传送机制类型。该值应设置为 "web_hook"。
address

string

为此频道发送通知的地址。
payload

boolean

一个布尔值，指示是否需要载荷。载荷是指在 HTTP POST、PUT 或 PATCH 消息正文中发送的数据，其中包含有关请求的重要信息。可选。
params

map (key: string, value: string)

用于控制投放渠道行为的其他参数。可选。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
resourceId

string

用于标识在此频道上被监控的资源的不透明 ID。在不同 API 版本中保持稳定。
resourceUri

string

所监控资源的版本专用标识符。
kind

string

将其标识为用于监控资源更改的通知渠道（即“api#channel”）。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

如需了解详情，请参阅授权指南。

ApplicationName

要检索事件的应用名称。

枚举
access_transparency

Google Workspace Access Transparency 活动报告会返回有关不同类型 Access Transparency 活动事件的信息。
admin

管理控制台应用的活动报告会返回与不同类型的管理员活动事件相关的账号信息。
calendar

Google 日历应用的活动报告会返回有关各种 Google 日历活动事件的信息。
chat Chat 活动报告会返回关于各种 Chat 活动事件的信息。
drive

Google 云端硬盘应用的活动报告会返回有关各种 Google 云端硬盘活动事件的信息。云端硬盘活动报告仅适用于 Google Workspace 商务版和 Google Workspace 企业版客户。
gcp Google Cloud Platform 应用的活动报告会返回各种 GCP 活动事件的相关信息。
gplus Google+ 应用的活动报告会返回有关各种 Google+ 活动事件的信息。
groups

Google 群组应用的活动报告会返回有关各种 Google 群组活动事件的信息。
groups_enterprise

企业版群组活动报告会返回各种企业版群组活动事件的相关信息。
jamboard Jamboard 活动报告会返回有关各种 Jamboard 活动事件的信息。
login

Login 应用的活动报告会返回各类 Login 活动事件的账号信息。
meet Meet 审核活动报告会返回有关不同类型 Meet 审核活动事件的信息。
mobile “设备审核活动”报告会返回有关不同类型的设备审核活动事件的信息。
rules

“规则活动”报告会返回有关不同类型规则活动事件的信息。
saml

SAML 活动报告会返回有关不同类型 SAML 活动事件的信息。
token

令牌应用的活动报告会返回不同类型的令牌活动事件的账号信息。
user_accounts

用户账号应用的活动报告会返回各类用户账号活动事件的账号信息。
context_aware_access

情境感知访问权限 activity 报告会返回与用户因 情境感知访问权限规则而被拒绝访问的事件相关的信息。
chrome

Chrome 活动报告会返回有关 Chrome 浏览器和 ChromeOS 事件的信息。
data_studio 数据洞察活动报告会返回有关各种类型的数据洞察活动事件的信息。
keep Keep 应用的活动报告会返回有关各种 Google Keep 活动事件的信息。“Keep 活动”报告仅适用于 Google Workspace 商务版和企业版客户。