Method: accounts.searchChangeHistoryEvents

Выполняет поиск по всем изменениям в учетной записи или ее дочерних элементах с учетом указанного набора фильтров.

Возвращает только подмножество изменений, поддерживаемое API. Пользовательский интерфейс может возвращать дополнительные изменения.

HTTP-запрос

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

URL использует синтаксис перекодировки 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
EXPANDED_DATA_SET Ресурс ExpandedDataSet
CHANNEL_GROUP Ресурс ChannelGroup
ENHANCED_MEASUREMENT_SETTINGS Ресурс EnhancedMeasurementSettings
DATA_REDACTION_SETTINGS Ресурс DataRedactionSettings
SKADNETWORK_CONVERSION_VALUE_SCHEMA Ресурс SKAdNetworkConversionValueSchema
AUDIENCE Ресурс аудитории
EVENT_CREATE_RULE Ресурс EventCreateRule
KEY_EVENT Ресурс KeyEvent
CALCULATED_METRIC Ресурс CalculatedMetric
REPORTING_DATA_ANNOTATION Ресурс ReportingDataAnnotation
SUBPROPERTY_SYNC_CONFIG Ресурс SubpropertySyncConfig
REPORTING_IDENTITY_SETTINGS Ресурс ReportingIdentitySettings

Тип действия

Типы действий, которые могут изменить ресурс.

Перечисления
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

Идентификатор этого события истории изменений. Этот идентификатор уникален в 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.

История измененийИзменение

Описание изменения одного ресурса 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)
  },
  "googleSignalsSettings": {
    object (GoogleSignalsSettings)
  },
  "displayVideo360AdvertiserLink": {
    object (DisplayVideo360AdvertiserLink)
  },
  "displayVideo360AdvertiserLinkProposal": {
    object (DisplayVideo360AdvertiserLinkProposal)
  },
  "conversionEvent": {
    object (ConversionEvent)
  },
  "measurementProtocolSecret": {
    object (MeasurementProtocolSecret)
  },
  "customDimension": {
    object (CustomDimension)
  },
  "customMetric": {
    object (CustomMetric)
  },
  "dataRetentionSettings": {
    object (DataRetentionSettings)
  },
  "searchAds360Link": {
    object (SearchAds360Link)
  },
  "dataStream": {
    object (DataStream)
  },
  "attributionSettings": {
    object (AttributionSettings)
  },
  "expandedDataSet": {
    object (ExpandedDataSet)
  },
  "channelGroup": {
    object (ChannelGroup)
  },
  "bigqueryLink": {
    object (BigQueryLink)
  },
  "enhancedMeasurementSettings": {
    object (EnhancedMeasurementSettings)
  },
  "dataRedactionSettings": {
    object (DataRedactionSettings)
  },
  "skadnetworkConversionValueSchema": {
    object (SKAdNetworkConversionValueSchema)
  },
  "adsenseLink": {
    object (AdSenseLink)
  },
  "audience": {
    object (Audience)
  },
  "eventCreateRule": {
    object (EventCreateRule)
  },
  "keyEvent": {
    object (KeyEvent)
  },
  "calculatedMetric": {
    object (CalculatedMetric)
  },
  "reportingDataAnnotation": {
    object (ReportingDataAnnotation)
  },
  "subpropertySyncConfig": {
    object (SubpropertySyncConfig)
  },
  "reportingIdentitySettings": {
    object (ReportingIdentitySettings)
  }
  // End of list of possible types for union field resource.
}
Поля

resource Союза на местах.

resource может быть только одним из следующих:

account

object ( Account )

Снимок ресурса учетной записи в истории изменений.

property

object ( Property )

Снимок ресурса свойства в истории изменений.

googleSignalsSettings

object ( GoogleSignalsSettings )

Снимок ресурса GoogleSignalsSettings в истории изменений.

conversionEvent

object ( ConversionEvent )

Снимок ресурса ConversionEvent в истории изменений.

measurementProtocolSecret

object ( MeasurementProtocolSecret )

Снимок ресурса MeasurementProtocolSecret в истории изменений.

customDimension

object ( CustomDimension )

Снимок ресурса CustomDimension в истории изменений.

customMetric

object ( CustomMetric )

Снимок ресурса CustomMetric в истории изменений.

dataRetentionSettings

object ( DataRetentionSettings )

Снимок ресурса настроек хранения данных в истории изменений.

dataStream

object ( DataStream )

Снимок ресурса DataStream в истории изменений.

attributionSettings

object ( AttributionSettings )

Снимок ресурса AttributionSettings в истории изменений.

expandedDataSet

object ( ExpandedDataSet )

Снимок ресурса ExpandedDataSet в истории изменений.

channelGroup

object ( ChannelGroup )

Снимок ресурса ChannelGroup в истории изменений.

enhancedMeasurementSettings

object ( EnhancedMeasurementSettings )

Снимок ресурса EnhancedMeasurementSettings в истории изменений.

dataRedactionSettings

object ( DataRedactionSettings )

Снимок ресурса DataRedactionSettings в истории изменений.

skadnetworkConversionValueSchema

object ( SKAdNetworkConversionValueSchema )

Снимок ресурса SKAdNetworkConversionValueSchema в истории изменений.

audience

object ( Audience )

Снимок ресурса аудитории в истории изменений.

eventCreateRule

object ( EventCreateRule )

Снимок ресурса EventCreateRule в истории изменений.

keyEvent

object ( KeyEvent )

Снимок ресурса KeyEvent в истории изменений.

calculatedMetric

object ( CalculatedMetric )

Снимок ресурса CalculatedMetric в истории изменений.

reportingDataAnnotation

object ( ReportingDataAnnotation )

Снимок ресурса ReportingDataAnnotation в истории изменений.

subpropertySyncConfig

object ( SubpropertySyncConfig )

Снимок ресурса SubpropertySyncConfig в истории изменений.

reportingIdentitySettings

object ( ReportingIdentitySettings )

Снимок ресурса ReportingIdentitySettings в истории изменений.