Method: activities.list

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
userKey

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 到当前时间的所有活动，如果 startTime 是过去 180 天之前的时间，则会返回最近 180 天内的所有活动。
eventName

string

API 要查询的事件的名称。每个 eventName 都与特定的 Google Workspace 服务或功能相关，该 API 会将这些服务或功能划分为事件类型。例如，管理控制台应用报告中的 Google 日历活动。日历设置 type 结构包含 API 报告的所有 Google 日历 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，并且报告包含两个活动，则报告将包含两个页面。响应的 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 的用户的活动。格式：“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

有关详情，请参阅授权指南。

ApplicationName

枚举
access_transparency

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

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

Google 日历应用的活动报告会返回有关各种 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

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

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

活动

activity 资源的 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 报告的活动的具体名称。每个 eventName 都与特定的 Google Workspace 服务或功能相关，API 按事件类型整理了相应服务或功能。
对于 eventName 请求参数，通常：

  • 如果未指定 eventName，报告会返回 eventName 的所有可能实例。
  • 当您请求 eventName 时，API 的响应会返回包含该 eventName 的所有 activity。

如需详细了解 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 对象的 activities.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；对于机器人账号，可以是标识符。