Method: accounts.searchChangeHistoryEvents

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

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

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
account

string

Необходимый. Ресурс учетной записи, для которого возвращаются ресурсы истории изменений. Формат: аккаунты/{аккаунт}

Пример: accounts/100

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "property": string,
  "resourceType": [
    enum (ChangeHistoryResourceType)
  ],
  "action": [
    enum (ActionType)
  ],
  "actorEmail": [
    string
  ],
  "earliestChangeTime": string,
  "latestChangeTime": string,
  "pageSize": integer,
  "pageToken": string
}
Поля
property

string

Необязательный. Имя ресурса для дочернего свойства. Если установлено, возвращаются только изменения, внесенные в это свойство или его дочерние ресурсы. Формат: свойства/{propertyId}

Пример: properties/100

resource Type[]

enum ( ChangeHistoryResourceType )

Необязательный. Если установлено, возвращать изменения только в том случае, если они относятся к ресурсу, соответствующему хотя бы одному из этих типов.

action[]

enum ( ActionType )

Необязательный. Если установлено, возвращаются только те изменения, которые соответствуют одному или нескольким из этих типов действий.

actor Email[]

string

Необязательный. Если установлено, возвращать изменения только в том случае, если они внесены пользователем из этого списка.

earliest Change Time

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" .

latest Change Time

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" .

page Size

integer

Необязательный. Максимальное количество возвращаемых элементов ChangeHistoryEvent. Если не указано, будет возвращено не более 50 товаров. Максимальное значение — 200 (более высокие значения будут приведены к максимальному).

Обратите внимание, что служба может вернуть страницу с меньшим количеством элементов, чем указано в этом значении (возможно, даже с нулем), и что дополнительные страницы все равно могут быть. Если вам нужно определенное количество элементов, вам нужно будет продолжать запрашивать дополнительные страницы с помощью pageToken , пока не получите необходимое количество.

page Token

string

Необязательный. Токен страницы, полученный в результате предыдущего вызова accounts.searchChangeHistoryEvents . Предоставьте это, чтобы получить следующую страницу. При разбиении на страницы все остальные параметры, предоставленные для accounts.searchChangeHistoryEvents должны соответствовать вызову, который предоставил токен страницы.

Тело ответа

Ответное сообщение для RPC SearchAccounts.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "changeHistoryEvents": [
    {
      object (ChangeHistoryEvent)
    }
  ],
  "nextPageToken": string
}
Поля
change History Events[]

object ( ChangeHistoryEvent )

Результаты, которые были доступны вызывающему абоненту.

next Page Token

string

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/analytics.edit

Чейнджисториресурцетипе

Типы ресурсов, изменения которых могут быть возвращены из истории изменений.

Перечисления
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED Тип ресурса неизвестен или не указан.
ACCOUNT Ресурс аккаунта
PROPERTY Ресурс недвижимости
GOOGLE_SIGNALS_SETTINGS Ресурс GoogleSignalsSettings
CONVERSION_EVENT Ресурс ConversionEvent
MEASUREMENT_PROTOCOL_SECRET Протокол измеренийСекретный ресурс
CUSTOM_DIMENSION Ресурс CustomDimension
CUSTOM_METRIC Ресурс CustomMetric
DATA_RETENTION_SETTINGS Ресурс DataRetentionSettings
DATA_STREAM Ресурс потока данных
ATTRIBUTION_SETTINGS Ресурс AttributionSettings

Тип действия

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

Перечисления
ACTION_TYPE_UNSPECIFIED Тип действия неизвестен или не указан.
CREATED Ресурс был создан в результате этого изменения.
UPDATED Ресурс был обновлен с учетом данного изменения.
DELETED Ресурс был удален в результате этого изменения.

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

Набор изменений в аккаунте 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.

change Time

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" .

actor Type

enum ( ActorType )

Тип актера, который внес это изменение.

user Actor Email

string

Адрес электронной почты аккаунта Google, в котором были внесены изменения. Это будет действительный адрес электронной почты, если в поле актера установлено значение ПОЛЬЗОВАТЕЛЬ, и пустое в противном случае. Удаленные учетные записи Google вызовут ошибку.

changes Filtered

boolean

Если это правда, то возвращаемый список изменений был отфильтрован и не отражает все изменения, произошедшие в этом событии.

changes[]

object ( ChangeHistoryChange )

Список изменений, внесенных в это событие истории изменений, которые соответствуют фильтрам, указанным в SearchChangeHistoryEventsRequest.

Тип актера

Различные участники, которые могут вносить изменения в ресурсы 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 )

Тип действия, которое изменило этот ресурс.

resource Before Change

object ( ChangeHistoryResource )

Содержимое ресурса до внесения изменений. Если этот ресурс был создан в результате этого изменения, это поле будет отсутствовать.

resource After Change

object ( 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 )

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

conversion Event

object ( ConversionEvent )

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

measurement Protocol Secret

object ( MeasurementProtocolSecret )

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

data Retention Settings

object ( DataRetentionSettings )

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

data Stream

object ( DataStream )

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