Method: accounts.searchChangeHistoryEvents

指定した一連のフィルタに基づいて、アカウントまたはその子に対するすべての変更を検索します。

HTTP リクエスト

POST https://analyticsadmin.googleapis.com/v1beta/{account=accounts/*}:searchChangeHistoryEvents

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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)

省略可。設定すると、これらのタイプの少なくとも 1 つに一致するリソースに対する変更のみが返されます。

action[]

enum (ActionType)

省略可。設定すると、これらのタイプのアクションの 1 つ以上に一致する変更のみが返されます。

actorEmail[]

string

省略可。設定すると、このリスト内のユーザーによって行われた変更のみが返されます。

earliestChangeTime

string (Timestamp format)

省略可。設定すると、この時間より後に行われた変更のみが返されます(指定した時間を含む)。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

latestChangeTime

string (Timestamp format)

省略可。設定すると、この時間より前に行われた変更のみが返されます(指定した時間を含む)。

RFC3339 UTC「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 DataRetentionSettings リソース
DATA_STREAM DataStream リソース
ATTRIBUTION_SETTINGS AttributionSettings リソース

ActionType

リソースを変更する可能性のあるアクションの種類。

列挙型
ACTION_TYPE_UNSPECIFIED アクション タイプが不明であるか、指定されていません。
CREATED リソースはこの変更で作成されました。
UPDATED この変更でリソースが更新されました。
DELETED この変更でリソースが削除されました。

ChangeHistoryEvent

同じ原因によって行われた、Google アナリティクス アカウントまたはその子プロパティ内の一連の変更。原因としては、Google アナリティクスの管理画面で行われた更新、カスタマー サポートによる変更、Google アナリティクス システムの自動変更などが考えられます。

JSON 表現
{
  "id": string,
  "changeTime": string,
  "actorType": enum (ActorType),
  "userActorEmail": string,
  "changesFiltered": boolean,
  "changes": [
    {
      object (ChangeHistoryChange)
    }
  ]
}
フィールド
id

string

この変更履歴イベントの ID。この ID は Google アナリティクス全体で一意です。

changeTime

string (Timestamp format)

変更が行われた時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

actorType

enum (ActorType)

この変更を行ったアクターのタイプ。

userActorEmail

string

変更を行った Google アカウントのメールアドレス。actor フィールドが USER に設定されている場合は有効なメールアドレスになり、それ以外の場合は空になります。削除された Google アカウントはエラーになります。

changesFiltered

boolean

true の場合、返された変更のリストはフィルタされたものであり、このイベントで発生したすべての変更を表すものではありません。

changes[]

object (ChangeHistoryChange)

この変更履歴イベントで行われた、SearchChangeHistoryEventsRequest で指定されたフィルタに一致する変更のリスト。

ActorType

Google アナリティクスのリソースを変更できるさまざまなタイプのアクター。

列挙型
ACTOR_TYPE_UNSPECIFIED アクタータイプが不明または未指定。
USER actorEmail で指定されたユーザーが行った変更。
SYSTEM Google アナリティクス システムによって行われた変更。
SUPPORT Google アナリティクス サポートチームのスタッフが行った変更。

ChangeHistoryChange

1 つの Google アナリティクス リソースに対する変更の説明。

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)

変更履歴にある Account リソースのスナップショット。

property

object (Property)

変更履歴のプロパティ リソースのスナップショット。

conversionEvent

object (ConversionEvent)

変更履歴にある ConversionEvent リソースのスナップショット。

measurementProtocolSecret

object (MeasurementProtocolSecret)

変更履歴にある MeasurementProtocolSecret リソースのスナップショット。

dataRetentionSettings

object (DataRetentionSettings)

変更履歴にあるデータ保持設定のリソースのスナップショット。

dataStream

object (DataStream)

変更履歴にある DataStream リソースのスナップショット。