Method: accounts.searchChangeHistoryEvents

根據指定的篩選器組合,搜尋帳戶或子帳戶的所有變更。

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)

選用設定。如已設定,系統只會傳回此時間之後所做的變更 (含此時間)。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

latestChangeTime

string (Timestamp format)

選用設定。如已設定,系統只會傳回這個時間之前的變更項目 (含)。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"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 資源
DATA_RETENTION_SETTINGS DataReReserveSettings 資源
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)

變更時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"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)
  },
  "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 資源的快照。