Method: accounts.searchChangeHistoryEvents

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

API でサポートされている変更のサブセットのみを返します。UI には、追加の変更が返される場合があります。

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)

省略可。設定されている場合、この時間以降に行われた変更のみを返します（その時刻を含む）。

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 アナリティクス アカウントまたはその子プロパティ内で、同じ原因によって行われた一連の変更。一般的な原因としては、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)

変更が行われた日時。

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 アカウントのメールアドレス。アクター フィールドが USER に設定されている場合は有効なメールアドレスになります。それ以外の場合は空になります。削除された Google アカウントはエラーになります。
changesFiltered

boolean

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

object (ChangeHistoryChange)

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

ActorType

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

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

ChangeHistoryChange

単一の 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 リソースのスナップショット。