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 遠端程序呼叫的回應訊息。

如果成功，回應主體會含有以下結構的資料：

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 帳戶電子郵件地址。如果 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)
  },
  "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 資源快照。