Method: accounts.searchChangeHistoryEvents

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

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

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

可选。子级媒体资源的资源名称。如果设置，则仅返回对此属性或其子资源所做的更改。格式：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 资源
EXPANDED_DATA_SET ExpandedDataSet 资源
CHANNEL_GROUP ChannelGroup 资源
ENHANCED_MEASUREMENT_SETTINGS EnhancedMeasurementSettings 资源
DATA_REDACTION_SETTINGS DataRedactionSettings 资源
SKADNETWORK_CONVERSION_VALUE_SCHEMA SKAdNetworkConversionValueSchema 资源
AUDIENCE 受众群体资源
EVENT_CREATE_RULE EventCreateRule 资源
KEY_EVENT KeyEvent 资源
CALCULATED_METRIC CalculatedMetric 资源
REPORTING_DATA_ANNOTATION ReportingDataAnnotation 资源
SUBPROPERTY_SYNC_CONFIG SubpropertySyncConfig 资源
REPORTING_IDENTITY_SETTINGS ReportingIdentitySettings 资源

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 账号的电子邮件地址。如果 actor 字段设置为 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)
  },
  "keyEvent": {
    object (KeyEvent)
  },
  "calculatedMetric": {
    object (CalculatedMetric)
  },
  "reportingDataAnnotation": {
    object (ReportingDataAnnotation)
  },
  "subpropertySyncConfig": {
    object (SubpropertySyncConfig)
  },
  "reportingIdentitySettings": {
    object (ReportingIdentitySettings)
  }
  // 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)

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

object (ChannelGroup)

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

object (EnhancedMeasurementSettings)

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

object (DataRedactionSettings)

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

object (SKAdNetworkConversionValueSchema)

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

object (Audience)

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

object (EventCreateRule)

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

object (KeyEvent)

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

object (CalculatedMetric)

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

object (ReportingDataAnnotation)

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

object (SubpropertySyncConfig)

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

object (ReportingIdentitySettings)

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