Method: accounts.searchChangeHistoryEvents

根据指定的一组过滤条件，搜索账号或其子账号的所有更改。

仅返回 API 支持的更改子集。界面可能会返回其他更改。

HTTP 请求

POST https://analyticsadmin.googleapis.com/v1beta/{account=accounts/*}:searchChangeHistoryEvents

网址采用 gRPC 转码语法。

路径参数

参数
account

string

必需。要为其返回更改历史记录资源的账号资源。格式：accounts/{account}

示例：accounts/100

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "property": string,
  "resourceType": [
    enum (ChangeHistoryResourceType)
  ],
  "action": [
    enum (ActionType)
  ],
  "actorEmail": [
    string
  ],
  "earliestChangeTime": string,
  "latestChangeTime": string,
  "pageSize": integer,
  "pageToken": string
}
字段
property

string

可选。子媒体资源的资源名称。如果设置，则仅返回对此媒体资源或其子资源所做的更改。格式：properties/{propertyId}

示例：properties/100
resourceType[]

enum (ChangeHistoryResourceType)

可选。如果设置，则仅返回与至少一种类型匹配的资源的更改。
action[]

enum (ActionType)

可选。如果设置了此参数，则仅返回与其中一个或多个操作类型匹配的更改。
actorEmail[]

string

可选。如果设置了此属性，则仅在更改由此列表中的用户进行时返回更改。
earliestChangeTime

string (Timestamp format)

可选。如果设置了此参数，则只会返回在此时间（包括此时间）之后所做的更改。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"
latestChangeTime

string (Timestamp format)

可选。如果设置了此属性，则只会返回在此时间（包括此时间）之前所做的更改。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"
pageSize

integer

可选。要返回的 ChangeHistoryEvent 项的数量上限。如果未指定，则最多返回 50 项。最大值为 200（更高的值将被强制转换为最大值）。

请注意，服务返回的页面中包含的项数可能少于此值（甚至可能为零），并且可能还有其他页面。如果您想要获取特定数量的项，则需要继续使用 pageToken 请求其他页面，直到获取所需数量的项。
pageToken

string

可选。从之前的 accounts.searchChangeHistoryEvents 调用接收的页面令牌。提供此令牌以检索后续页面。进行分页时，提供给 accounts.searchChangeHistoryEvents 的所有其他参数必须与提供页面令牌的调用匹配。

响应正文

SearchAccounts RPC 的响应消息。

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

JSON 表示法 
{
  "changeHistoryEvents": [
    {
      object (ChangeHistoryEvent)
    }
  ],
  "nextPageToken": string
}
字段
changeHistoryEvents[]

object (ChangeHistoryEvent)

可供调用方访问的结果。
nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/analytics.edit

ChangeHistoryResourceType

更改历史记录中可能会返回其更改的资源类型。

枚举
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED 资源类型未知或未指定。
ACCOUNT 账号资源
PROPERTY 媒体资源
GOOGLE_SIGNALS_SETTINGS GoogleSignalsSettings 资源
CONVERSION_EVENT ConversionEvent 资源
MEASUREMENT_PROTOCOL_SECRET MeasurementProtocolSecret 资源
CUSTOM_DIMENSION CustomDimension 资源
CUSTOM_METRIC CustomMetric 资源
DATA_RETENTION_SETTINGS DataRetentionSettings 资源
DATA_STREAM DataStream 资源
ATTRIBUTION_SETTINGS AttributionSettings 资源

ActionType

可能会更改资源的操作类型。

枚举
ACTION_TYPE_UNSPECIFIED 操作类型未知或未指定。
CREATED 在此更改中创建了资源。
UPDATED 此项更改更新了资源。
DELETED 在此更改中，资源已被删除。

ChangeHistoryEvent

Google Analytics 账号或其子媒体资源中因同一原因而发生的一组更改。常见原因包括在 Google Analytics 界面中进行的更新、客户支持团队所做的更改，或 Google Analytics 系统自动进行的更改。

JSON 表示法 
{
  "id": string,
  "changeTime": string,
  "actorType": enum (ActorType),
  "userActorEmail": string,
  "changesFiltered": boolean,
  "changes": [
    {
      object (ChangeHistoryChange)
    }
  ]
}
字段
id

string

此更改历史记录事件的 ID。此 ID 在 Google Analytics 中是唯一的。
changeTime

string (Timestamp format)

更改的时间。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
actorType

enum (ActorType)

进行此更改的操作者类型。
userActorEmail

string

做出更改的 Google 账号的电子邮件地址。如果“执行者”字段设置为“USER”，则此字段应为有效的电子邮件地址；否则，此字段应为空。已删除的 Google 账号会导致错误。
changesFiltered

boolean

如果为 true，则表示返回的更改列表已过滤，并不代表在此事件中发生的所有更改。
changes[]

object (ChangeHistoryChange)

在此更改历史记录事件中进行的符合 SearchChangeHistoryEventsRequest 中指定过滤条件的更改的列表。

ActorType

可以更改 Google Analytics 资源的不同类型的操作者。

枚举
ACTOR_TYPE_UNSPECIFIED 执行者类型未知或未指定。
USER actorEmail 中指定的用户所做的更改。
SYSTEM Google Analytics 系统所做的更改。
SUPPORT Google Analytics 支持团队人员所做的更改。

ChangeHistoryChange

对单个 Google Analytics 资源所做的更改的说明。

JSON 表示法 
{
  "resource": string,
  "action": enum (ActionType),
  "resourceBeforeChange": {
    object (ChangeHistoryResource)
  },
  "resourceAfterChange": {
    object (ChangeHistoryResource)
  }
}
字段
resource

string

此条目描述的资源的资源名称。
action

enum (ActionType)

更改此资源的操作类型。
resourceBeforeChange

object (ChangeHistoryResource)

更改生效前资源的内容。如果此资源是在此次更改中创建的，则此字段将缺失。
resourceAfterChange

object (ChangeHistoryResource)

更改生效后的资源内容。如果此资源在此更改中被删除，则此字段将缺失。

ChangeHistoryResource

更改历史记录中更改结果之前或之后的资源快照。

JSON 表示法 
{

  // Union field resource can be only one of the following:
  "account": {
    object (Account)
  },
  "property": {
    object (Property)
  },
  "firebaseLink": {
    object (FirebaseLink)
  },
  "googleAdsLink": {
    object (GoogleAdsLink)
  },
  "conversionEvent": {
    object (ConversionEvent)
  },
  "measurementProtocolSecret": {
    object (MeasurementProtocolSecret)
  },
  "dataRetentionSettings": {
    object (DataRetentionSettings)
  },
  "dataStream": {
    object (DataStream)
  }
  // End of list of possible types for union field resource.
}
字段

联合字段 resource。

resource 只能是下列其中一项：
account

object (Account)

更改历史记录中账号资源的快照。
property

object (Property)

更改历史记录中媒体资源的快照。
conversionEvent

object (ConversionEvent)

更改历史记录中 ConversionEvent 资源的快照。
measurementProtocolSecret

object (MeasurementProtocolSecret)

更改历史记录中 MeasurementProtocolSecret 资源的快照。
dataRetentionSettings

object (DataRetentionSettings)

更改记录中的数据保留设置资源的快照。
dataStream

object (DataStream)

更改历史记录中 DataStream 资源的快照。