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 或其主电子邮件地址）。不得是已删除的用户。对于已删除的用户，请在 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 天内的所有活动。

对于 Gmail 请求，必须提供 startTime 和 endTime，并且两者之间的差值不得超过 30 天。
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

string

要生成报告的组织部门的 ID。系统只会显示属于指定组织部门的用户的活动记录。
pageToken

string

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

string

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

对于 Gmail 请求，必须提供 startTime 和 endTime，并且两者之间的差值不得超过 30 天。
groupIdFilter

string

以英文逗号分隔的群组 ID（经过混淆处理），用于过滤用户活动，即响应将仅包含属于此处提及的至少一个群组 ID 的用户的活动。格式：“id:abc123,id:xyz456”

请求正文

请求正文必须为空。

响应正文

活动集合的 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 日历应用的活动报告会返回有关各种日历活动事件的信息。
chat 聊天活动报告会返回各种聊天活动事件的相关信息。
drive

Google 云端硬盘应用的活动报告会返回有关各种 Google 云端硬盘活动事件的信息。云端硬盘活动报告仅适用于 Google Workspace 商务版和企业版客户。
gcp Google Cloud Platform 应用的活动报告会返回有关各种 GCP 活动事件的信息。
gmail Gmail 应用的活动报告会返回有关各种 Gmail 活动事件的信息。
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 商务版和企业版客户。
vault 保险柜活动报告会返回有关各种类型的保险柜活动事件的信息。
gemini_in_workspace_apps Gemini for Workspace 活动报告会返回有关 Workspace 应用中用户执行的各种类型的 Gemini 活动事件的信息。
classroom Google 课堂活动报告会返回有关不同类型的 Google 课堂活动事件的信息。

活动

活动资源的 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)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
字段
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 都与 API 归类为事件类型的特定 Google Workspace 服务或功能相关。
对于一般的 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

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

object (NestedParameter)

参数值
events[].resourceIds[]

string

与活动关联的资源 ID。
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，也可以是机器人账号的标识符。
actor.applicationInfo

object

作为相应活动的执行者的应用的详细信息。
actor.applicationInfo.oauthClientId

string

用于执行相应操作的第三方应用的 OAuth 客户端 ID。
actor.applicationInfo.applicationName

string

用于执行相应操作的应用的名称。
actor.applicationInfo.impersonation

boolean

应用是否曾冒充用户。
networkInfo

object (NetworkInfo)

执行操作的用户的网络信息。
resourceDetails[]

object (ResourceDetails)

执行操作的资源的详细信息。

NetworkInfo

执行操作的用户的网络信息。

JSON 表示法 
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
字段
ipAsn[]

integer

执行操作的用户的 IP 地址。
regionCode

string

执行操作的用户的 ISO 3166-1 alpha-2 地区代码。
subdivisionCode

string

执行操作的用户的国家/地区的 ISO 3166-2 地区代码（州和省）。

ResourceDetails

执行操作的资源的详细信息。

JSON 表示法 
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
字段
id

string

资源的标识符。
title

string

资源的标题。例如，对于 Google 云端硬盘文档，此属性将是文档的标题。如果是电子邮件，则为主题。
type

string

资源类型 - 文档、电子邮件、聊天消息
appliedLabels[]

object (AppliedLabel)

应用于资源的标签的 activities.list
relation

string

定义资源与事件的关系

AppliedLabel

应用于资源的标签的详细信息。

JSON 表示法 
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
字段
id

string

标签的标识符 - 仅为标签 ID，而非完整的 OnePlatform 资源名称。
title

string

标签的标题
fieldValues[]

object (FieldValue)

属于标签且已由用户设置的字段的 activities.list。如果标签具有用户未设置的字段，则该字段不会显示在此列表中。
reason

object (Reason)

标签应用于资源的原因。

FieldValue

用户为特定标签设置的字段值详情。

JSON 表示法 
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
字段
id

string

字段的标识符
displayName

string

字段的显示名称
type

string

字段的类型
reason

object (Reason)

将字段应用于标签的原因。
联合字段 value。存储在字段 value 中的值只能是以下值之一：
unsetValue

boolean

如果未设置该字段，则此值为 true。
longTextValue

string

设置长文本值。
textValue

string

设置文本值。
textListValue

object (TextListValue)

设置文本列表值。
selectionValue

object (SelectionValue)

通过从下拉菜单中选择单个值来设置选择值。
selectionListValue

object (SelectionListValue)

通过从下拉菜单中选择多个值来设置选择列表值。
integerValue

string (int64 format)

设置整数值。
userValue

object (UserValue)

通过选择单个用户来设置用户值。
userListValue

object (UserListValue)

通过选择多个用户来设置用户列表值。
dateValue

object (Date)

设置日期值。

TextListValue

设置文本列表值。

JSON 表示法 
{
  "values": [
    string
  ]
}
字段
values[]

string

activities.list 的文本值。

SelectionValue

通过从下拉菜单中选择单个值来设置选择值。

JSON 表示法 
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
字段
id

string

所选内容的标识符。
displayName

string

所选内容的显示名称。
badged

boolean

选择是否带有标记。

SelectionListValue

通过从下拉菜单中选择多个值来设置选择列表值。

JSON 表示法 
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
字段
values[]

object (SelectionValue)

activities.list 的选择列表。

UserValue

通过选择单个用户来设置用户值。

JSON 表示法 
{
  "email": string
}
字段
email

string

用户的电子邮件地址。

UserListValue

通过选择多个用户来设置用户列表值。

JSON 表示法 
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
字段
values[]

object (UserValue)

用户的活动列表。

日期

表示整个或部分日历日期（例如生日）。一天中的时间和时区要么在别处指定，要么不重要。日期相对于公历。可以表示以下任一情况：

  • 包含非零年份、月份和天值的完整日期。
  • 月份和天，年份值为零（例如周年纪念日）。
  • 单独的年份，月份和天值为零。
  • 年份和月份，天值为零（例如，信用卡到期日期）。

相关类型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
字段
year

integer

日期中的年份。必须介于 1 到 9999 之间，或为 0（即指定不含年份的日期）。
month

integer

一年中的第几个月。必须介于 1 到 12 之间，或为 0（即只指定年份，不指定月份和天值）。
day

integer

一个月中的第几天。必须介于 1 到 31 之间并且对年份和月份有效，或为 0（即天不重要，指定单独的年份或者年份和月份）。

原因

应用标签/字段的原因。

JSON 表示法 
{
  "reasonType": string
}
字段
reasonType

string

原因的类型。