Method: activities.list

检索特定客户的帐号和应用的活动列表，如管理控制台应用或 Google 云端硬盘应用。有关详情，请参阅管理员和 Google 云端硬盘活动报告的相关指南。如需详细了解活动报告的参数，请参阅活动参数参考指南。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
userKey or all

string

表示应过滤其数据的配置文件 ID 或用户电子邮件地址。可以是 all（代表所有信息），也可以是 userKey（代表用户的唯一 Google Workspace 个人资料 ID 或其主电子邮件地址）。不得是已删除的用户。对于已删除的用户，请使用 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 到当前时间的所有活动，或者返回最近 180 天（如果 startTime 已超过 180 天）。
eventName

string

API 查询的事件的名称。每个 eventName 都与 API 整理到特定事件类型的 Google Workspace 服务或功能相关。例如，管理控制台应用的 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 表，然后点击进入附录的相应活动对应的“活动事件”页面。

在以下云端硬盘活动示例中，返回的列表由所有 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，且报告包含两个 activity，则报告包含两个页面。响应的 nextPageToken 属性包含指向第二页的令牌。maxResults 查询字符串在请求中是可选的。默认值为 1000。
orgUnitId

string

要生成报告的单位部门的 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 的用户对应的活动）。格式：&idot;id:abc123,id:xyz456"

请求正文

请求正文必须为空。

响应正文

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

一系列 activity 的 JSON 模板。

JSON 表示法 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
字段
kind

string

API 资源类型。对于活动报告，此值为 reports#activities。
etag

string

资源的 ETag。
items[]

object (Activity)

响应中的每个活动记录。
nextPageToken

string

用于检索报告的下一页的令牌。nextPageToken 值用于请求的 pageToken 查询字符串。

授权范围

需要以下 OAuth 作用域：

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

如需了解详情，请参阅 OAuth 2.0 概览。

应用名称

枚举
access_transparency

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

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

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

Google 云端硬盘应用的活动报告会返回有关各种 Google 云端硬盘活动事件的信息。“云端硬盘活动”报告仅适用于 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

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

“用户帐号”应用的活动报告会返回有关不同类型的用户帐号活动事件的帐号信息。
context_aware_access

情境感知访问权限活动报告会根据情境感知访问权限规则返回有关用户拒绝访问事件的信息。
chrome

Chrome 活动报告会返回有关 Chrome 浏览器和 Chrome 操作系统事件的信息。
data_studio 数据洞察活动报告可返回有关各种数据洞察活动事件的信息。
keep Keep 应用的活动报告会返回有关各种 Google Keep 活动事件的信息。只有 Google Workspace 商务版和企业版客户可以使用 Keep 活动报告。

活动

活动资源的 JSON 模板。

JSON 表示法 
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}
字段
kind

string

API 资源类型。对于活动报告，此值为 audit#activity。
etag

string

条目的 ETag。
ownerDomain

string

这是受报告事件影响的网域。例如管理控制台的域名或云端硬盘应用的文档所有者域名。
ipAddress

string

执行操作的用户的 IP 地址。这是用户在登录 Google Workspace 时获得的互联网协议 (IP) 地址，不一定能反映用户的实际位置。例如，IP 地址可以是用户的代理服务器地址或虚拟专用网 (VPN) 地址。该 API 支持 IPv4 和 IPv6。
events[]

object

报告中的活动事件。
events[].type

string

事件类型。管理员更改的 Google Workspace 服务或功能会在 type 属性（标识使用 eventName 属性）中标识。如需查看该 API 的 type 类别的完整列表，请参阅上文 applicationName 中各种应用的事件名称列表。
events[].name

string

事件的名称。这是 API 所报告 Activity 的具体名称。每个 eventName 都与 API 整理到特定事件类型的 Google Workspace 服务或功能相关。
通常适用于 eventName 请求参数：

  • 如果未指定 eventName，则报告会返回 eventName 的所有可能实例。
  • 当您请求 eventName 时，API 的响应会返回包含该 eventName 的所有 Activity。除了所请求的属性外，返回的 activity 可能还具有其他 eventName 属性。

如需详细了解 eventName 属性，请参阅上文 applicationName 中各种应用的事件名称列表。
events[].parameters[]

object

各种应用的参数值对。如需详细了解 eventName 参数，请参阅上文 applicationName 中各种应用的事件名称列表。
events[].parameters[].messageValue

object

与此参数关联的嵌套参数值对。参数的复杂值类型以参数值列表的形式返回。例如，地址参数的值可能为 [{parameter: [{name: city, value: abc}]}]
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

参数值
events[].parameters[].name

string

参数的名称。
events[].parameters[].value

string

参数的字符串值。
events[].parameters[].multiValue[]

string

参数的字符串值。
events[].parameters[].intValue

string (int64 format)

参数的整数值。
events[].parameters[].multiIntValue[]

string (int64 format)

参数的整数值。
events[].parameters[].boolValue

boolean

参数的布尔值。
events[].parameters[].multiMessageValue[]

object

messageValue 对象的 activity.list。
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

参数值
id

object

每条活动记录的唯一标识符。
id.time

string

活动的发生时间。这是 UNIX 纪元时间，以秒为单位。
id.uniqueQualifier

string (int64 format)

在多个事件相同的情况下使用的唯一限定符。
id.applicationName

string

事件所属的应用名称。如需了解可能的值，请参阅上文 applicationName 中的应用列表。
id.customerId

string

Google Workspace 帐号的唯一标识符。
actor

object

执行操作的用户。
actor.profileId

string

操作者的唯一 Google Workspace 个人资料 ID。如果操作者不是 Google Workspace 用户，或者编号 105250506097979753968 充当占位符 ID，则此值可能不存在。
actor.email

string

操作者的主电子邮件地址。如果没有与执行者关联的电子邮件地址，则可能不存在。
actor.callerType

string

演员的类型。
actor.key

string

仅当 callerType 为 KEY 时才存在。可以是 OAuth 2LO API 请求的请求者的 consumer_key，也可以是机器人帐号的标识符。