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)

変更履歴内のアカウント リソースのスナップショット。

property

object (Property)

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

conversionEvent

object (ConversionEvent)

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

measurementProtocolSecret

object (MeasurementProtocolSecret)

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

dataRetentionSettings

object (DataRetentionSettings)

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

dataStream

object (DataStream)

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