Method: accounts.searchChangeHistoryEvents

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

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

HTTP-запрос

POST https://analyticsadmin.googleapis.com/v1beta/{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 должны соответствовать вызову, который предоставил токен страницы.

Ответный текст

Ответное сообщение для RPC-запроса SearchAccounts.

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

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 Протокол измерения. Секретный ресурс.
CUSTOM_DIMENSION Ресурс CustomDimension
CUSTOM_METRIC Ресурс CustomMetric
DATA_RETENTION_SETTINGS Ресурс DataRetentionSettings
DATA_STREAM Ресурс DataStream
ATTRIBUTION_SETTINGS Ресурс AttributionSettings

Тип действия

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

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

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

changes[]

object ( ChangeHistoryChange )

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

ActorType

Различные типы субъектов, которые могут вносить изменения в ресурсы Google Analytics.

Перечисления
ACTOR_TYPE_UNSPECIFIED Тип актора неизвестен или не указан.
USER Изменения, внесенные пользователем, указанным в actorEmail.
SYSTEM Изменения внесены системой Google Analytics.
SUPPORT Изменения внесены сотрудниками службы поддержки Google Analytics.

ChangeHistoryChange

Описание изменения, внесенного в один из ресурсов 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)
  },
  "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 в истории изменений.