Method: accounts.searchChangeHistoryEvents

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

只會傳回 API 支援的變更子集。UI 可能會傳回其他變更。

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 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 資源

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 帳戶電子郵件地址。如果「執行者」欄位設為「使用者」,則此欄位會是有效的電子郵件地址,否則會是空白。已刪除的 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 資源的快照。