Method: accounts.searchChangeHistoryEvents

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
account

string

必需。要为其返回更改历史记录资源的帐号资源。

请求正文

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

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

string

(可选)子媒体资源的资源名称。如果设置了此属性,则仅返回对此属性或其子资源所做的更改。

resourceType[]

enum (ChangeHistoryResourceType)

(可选)如果设置了此属性,则仅当更改至少与其中一种类型的资源匹配时,才返回更改。

action[]

enum (ActionType)

(可选)如果设置了该字段,则仅返回与其中一种或多种操作匹配的更改。

actorEmail[]

string

(可选)如果设置了此标记,则只有在此列表中的用户进行更改时才会返回这些更改。

earliestChangeTime

string (Timestamp format)

(可选)如果已设置,则仅返回在此时间(含)之后所做的更改。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

latestChangeTime

string (Timestamp format)

(可选)如果已设置,则仅返回此日期之前(含当日)所做的更改。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

pageSize

integer

(可选)要返回的 ChangeHistoryEvent 项数上限。即使返回更多网页,服务返回的值也可能少于此值。如果未指定,则最多返回 50 件商品。最大值为 200(较大的值会被强制转换为最大值)。

pageToken

string

(可选)从之前的 SearchChangeHistoryEvents 调用接收的页面令牌。提供此字段以检索后续页面。进行分页时,提供给 SearchChangeHistoryEvents 的所有其他参数必须与提供页面令牌的调用匹配。

响应正文

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

SearchAccounts RPC 的响应消息。

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

object (ChangeHistoryEvent)

调用方可访问的结果。

nextPageToken

string

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

授权范围

需要以下 OAuth 作用域:

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

更改历史记录资源类型

可通过更改历史记录返回其更改的资源的类型。

枚举
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED 资源类型未知或未指定。
ACCOUNT 帐号资源
PROPERTY 媒体资源资源
GOOGLE_SIGNALS_SETTINGS GoogleSignalsSettings 资源
CONVERSION_EVENT ConversionEvent 资源
MEASUREMENT_PROTOCOL_SECRET MeasurementProtocolSecret 资源
DATA_RETENTION_SETTINGS Data 留存率 Settings 资源
DATA_STREAM DataStream 资源
ATTRIBUTION_SETTINGS AttributionSettings 资源

操作类型

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

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

更改历史记录事件

同一原因导致 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)

进行更改的时间。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

actorType

enum (ActorType)

执行此变更的操作者类型。

userActorEmail

string

进行更改的 Google 帐号的电子邮件地址。如果“操作者”字段设置为 USER,那么这是一个有效的电子邮件地址;否则,留空。已被删除的 Google 帐号会导致错误。

changesFiltered

boolean

如果为 true,则系统会过滤返回的更改列表,不代表此事件中发生的所有更改。

changes[]

object (ChangeHistoryChange)

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

执行者类型

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

枚举
ACTOR_TYPE_UNSPECIFIED 未知或未指定的演员类型。
USER 由 actorEmail 中指定的用户所做的更改。
SYSTEM Google Analytics(分析)系统所做的更改。
SUPPORT 由 Google Analytics(分析)支持团队员工做出的更改。

更改历史记录更改

对单个 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)

进行更改后的资源内容。如果此资源在这项更改中被删除,此字段将缺失。

更改历史记录资源

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

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 资源的快照。