此页面由 Cloud Translation API 翻译。

Method: activities.watch

HTTP 请求
路径参数
查询参数
请求正文
响应正文
- JSON 表示法
授权范围
ApplicationName

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数

参数
`userKey or all`	`string` 表示应过滤数据的个人资料 ID 或用户电子邮件地址。可以是 `all`（表示所有信息），也可以是 `userKey`（表示用户的唯一 Google Workspace 个人资料 ID 或其主电子邮件地址）。不得是已删除的用户。对于已删除的用户，请在 Directory API 中使用 `showDeleted=true` 调用 `users.list`，然后使用返回的 `ID` 作为 `userKey`。
`applicationName`	`enum (ApplicationName)` 要检索事件的应用的名称。

userKey or all

string

表示应过滤数据的个人资料 ID 或用户电子邮件地址。可以是 all（表示所有信息），也可以是 userKey（表示用户的唯一 Google Workspace 个人资料 ID 或其主电子邮件地址）。不得是已删除的用户。对于已删除的用户，请在 Directory API 中使用 showDeleted=true 调用 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 会在 Calendar Settings `type` 和 `eventName` 参数中报告此活动。如需详细了解 `eventName` 查询字符串和参数，请参阅上文 `applicationName` 中各种应用的事件名称列表。
`filters`	`string` `filters` 查询字符串是以英文逗号分隔的列表，由受关系运算符操控的事件参数组成。事件参数采用 `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` 格式这些事件参数与特定 `eventName` 相关联。如果请求的参数不属于 `eventName`，则返回空报告。如需详细了解每个应用的可用 `eventName` 字段及其关联的参数，请前往 ApplicationName 表，然后在附录中点击进入所需应用的“Activity Events”（活动事件）页面。在以下云端硬盘活动示例中，返回的列表包含所有 `edit` 事件，其中 `doc_id` 参数值符合关系运算符定义的条件。在第一个示例中，请求会返回所有 `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。系统只会显示属于指定组织部门的用户的活动记录。过滤结果中不会显示 2018 年 12 月 17 日之前的数据。
`pageToken`	`string` 用于指定下一页的令牌。如果报告包含多个页面，则响应中会包含 `nextPageToken` 属性。在后续请求中获取报告的下一页时，请在 `pageToken` 查询字符串中输入 `nextPageToken` 值。
`startTime`	`string` 设置报告中显示的时间范围的开始时间。日期采用 RFC 3339 格式，例如 2010-10-28T10:26:35.000Z。该报告会返回从 `startTime` 到 `endTime` 的所有活动。`startTime` 必须早于 `endTime`（如果指定）和发出请求时的当前时间，否则 API 会返回错误。
`groupIdFilter (deprecated)`	`string` `Deprecated`。此字段已弃用，不再受支持。以英文逗号分隔的群组 ID（经过混淆处理），用于过滤用户活动，即响应将仅包含属于此处提及的至少一个群组 ID 的用户的活动。格式：“id:abc123,id:xyz456” 重要提示：如需按群组进行过滤，您必须将群组明确添加到过滤群组许可名单中。如需详细了解如何将群组添加到过滤群组许可名单，请参阅按 Google 群组过滤结果

请求正文

请求正文包含一个 SubscriptionChannel 实例。

响应正文

用于监控资源变化的通知渠道。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string }

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