Method: accounts.searchChangeHistoryEvents

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

HTTP 请求

POST https://analyticsadmin.googleapis.com/v1alpha/{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

可选。子属性的资源名称。如果设置,则仅返回对此属性或其子资源所做的更改。格式:property/{propertyId}

示例:properties/100

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

可选。从之前的 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 资源
EXPANDED_DATA_SET ExpandDataSet 资源
CHANNEL_GROUP ChannelGroup 资源
ENHANCED_MEASUREMENT_SETTINGS EnhancedMeasurementSettings 资源
DATA_REDACTION_SETTINGS DataRedactionSettings 资源
SKADNETWORK_CONVERSION_VALUE_SCHEMA SKAdNetworkConversionValueSchema 资源
AUDIENCE 受众群体资源
EVENT_CREATE_RULE EventCreateRule 资源
CALCULATED_METRIC CalculatedMetric 资源

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)

进行更改的时间。

时间戳采用 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 中指定的过滤条件。

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)
  },
  "googleSignalsSettings": {
    object (GoogleSignalsSettings)
  },
  "displayVideo360AdvertiserLink": {
    object (DisplayVideo360AdvertiserLink)
  },
  "displayVideo360AdvertiserLinkProposal": {
    object (DisplayVideo360AdvertiserLinkProposal)
  },
  "conversionEvent": {
    object (ConversionEvent)
  },
  "measurementProtocolSecret": {
    object (MeasurementProtocolSecret)
  },
  "customDimension": {
    object (CustomDimension)
  },
  "customMetric": {
    object (CustomMetric)
  },
  "dataRetentionSettings": {
    object (DataRetentionSettings)
  },
  "searchAds360Link": {
    object (SearchAds360Link)
  },
  "dataStream": {
    object (DataStream)
  },
  "attributionSettings": {
    object (AttributionSettings)
  },
  "expandedDataSet": {
    object (ExpandedDataSet)
  },
  "channelGroup": {
    object (ChannelGroup)
  },
  "bigqueryLink": {
    object (BigQueryLink)
  },
  "enhancedMeasurementSettings": {
    object (EnhancedMeasurementSettings)
  },
  "dataRedactionSettings": {
    object (DataRedactionSettings)
  },
  "skadnetworkConversionValueSchema": {
    object (SKAdNetworkConversionValueSchema)
  },
  "adsenseLink": {
    object (AdSenseLink)
  },
  "audience": {
    object (Audience)
  },
  "eventCreateRule": {
    object (EventCreateRule)
  },
  "calculatedMetric": {
    object (CalculatedMetric)
  }
  // End of list of possible types for union field resource.
}
字段

联合字段 resource

resource 只能是下列其中一项:

account

object (Account)

“更改历史记录”中某个账号资源的概况。

property

object (Property)

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

googleSignalsSettings

object (GoogleSignalsSettings)

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

conversionEvent

object (ConversionEvent)

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

measurementProtocolSecret

object (MeasurementProtocolSecret)

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

customDimension

object (CustomDimension)

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

customMetric

object (CustomMetric)

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

dataRetentionSettings

object (DataRetentionSettings)

“更改历史记录”中数据保留设置资源的快照。

dataStream

object (DataStream)

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

attributionSettings

object (AttributionSettings)

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

expandedDataSet

object (ExpandedDataSet)

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

channelGroup

object (ChannelGroup)

更改历史记录中某个 ChannelGroup 资源的快照。

enhancedMeasurementSettings

object (EnhancedMeasurementSettings)

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

dataRedactionSettings

object (DataRedactionSettings)

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

skadnetworkConversionValueSchema

object (SKAdNetworkConversionValueSchema)

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

audience

object (Audience)

更改历史记录中受众群体资源的快照。

eventCreateRule

object (EventCreateRule)

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

calculatedMetric

object (CalculatedMetric)

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