Method: adEvents.ingest

Загружает список ресурсов AdEvent в Google Аналитику.

Эта функция доступна только для аккаунтов, добавленных в белый список.

Заголовки авторизации:

Этот метод также требует наличия следующего заголовка, чтобы определить, как API авторизует доступ для запроса:

  • login-account (обязательно): название ресурса аккаунта партнера по данным, в котором аккаунт Google с учетными данными является пользователем. Формат: accountTypes/DATA_PARTNER/accounts/{loginAccountId}

HTTP-запрос

POST https://datamanager.googleapis.com/v1/adEvents:ingest

URL имеет синтаксис gRPC Transcoding.

Тело запроса

Ниже приведена структура данных в теле запроса.

JSON-представление 
{
  "adEvents": [
    {
      object (AdEvent)
    }
  ],
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "validateOnly": boolean
}
Поля
adEvents[]

object (AdEvent)

Обязательно. Обязательный параметр (не менее одного). Список событий, связанных с объявлениями.
encryptionInfo

object (EncryptionInfo)

Необязательное поле. Информация о ключах шифрования, которые используются для шифрования данных. Это поле обязательно нужно заполнить, если в событиях объявлений есть UserData.
validateOnly
(deprecated)

boolean

Необязательное поле. Если значение равно true, запрос проверяется, но не выполняется.

Тело ответа

Если запрос выполнен успешно, тело ответа будет пустым.

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

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

  • https://www.googleapis.com/auth/datamanager

AdEvent

Событие объявления.

JSON-представление 
{
  "advertiserId": string,
  "eventType": enum (EventType),
  "timestamp": string,
  "eventId": string,
  "userData": {
    object (UserData)
  },
  "deviceInfo": {
    object (DeviceInfo)
  },
  "ipAddress": string,
  "mobileDeviceId": string,
  "campaignId": string,
  "campaignName": string,
  "adGroupId": string,
  "adId": string,
  "adHeight": integer,
  "adWidth": integer,
  "regionCode": string,
  "source": string,
  "medium": string,
  "attributionHint": enum (AttributionHint),
  "viewabilityInfo": {
    object (ViewabilityInfo)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "eventSubtype": enum (EventSubtype),
  "eventSubtypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adType": enum (AdType),
  "adTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adFormat": enum (AdFormat),
  "adFormatString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "adPlacement": enum (AdPlacement),
  "adPlacementString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "targetingType": enum (TargetingType),
  "targetingTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platformType": enum (PlatformType),
  "platformTypeString": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "platform": enum (Platform),
  "platformString": string
  // End of mutually exclusive fields.
  "measurementAllowed": boolean
}
Поля
advertiserId

string

Обязательно. Идентификатор рекламодателя для события объявления.

Он должен совпадать с идентификатором, отправленным в процессе связывания.
eventType

enum (EventType)

Обязательно. Тип события.
timestamp

string (Timestamp format)

Обязательно. Время, когда произошло событие.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
eventId

string

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

Обязательный параметр, если вы хотите дедуплицировать события объявлений, включенные в несколько запросов. В остальных случаях это поле можно не заполнять.
userData

object (UserData)

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

Можно указать несколько экземпляров одного типа данных (например, адресов электронной почты). Чем больше данных вы предоставите, тем выше вероятность того, что мы найдем совпадение.
deviceInfo

object (DeviceInfo)

Обязательно. Информация об устройстве, которое использовалось при событии, связанном с объявлением.
ipAddress

string

Необязательное поле. IP-адрес, используемый для сбора данных. Значение должно совпадать со значением DeviceInfo.ip_address. Если вы не хотите передавать IP-адреса для отслеживания, оставьте это поле пустым.
mobileDeviceId

string

Необязательное поле. Идентификатор устройства, на котором было показано объявление.
campaignId

string

Обязательно. Идентификатор связанной кампании.
campaignName

string

Обязательно. Название связанной кампании.
adGroupId

string

Необязательное поле. Идентификатор связанной группы объявлений.
adId

string

Необязательное поле. Идентификатор связанного объявления в группе.
adHeight

integer

Необязательное поле. Высота объявления в пикселях.
adWidth

integer

Необязательное поле. Ширина объявления в пикселях.
regionCode

string

Необязательное поле. Страна и административная единица в формате ISO 3166-2.
source

string

Обязательно. Платформа, на которой размещено объявление. Аналогично источнику в Google Аналитике.
medium

string

Обязательно. Канал объявления, аналогичный каналу в Google Аналитике.
attributionHint

enum (AttributionHint)

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

Это только сигнал о том, как партнер выполнил атрибуцию, и он не влияет на конечные результаты в отчетах.
viewabilityInfo

object (ViewabilityInfo)

Обязательно. Подробные сведения о видимости показанного объявления.

Необязательное поле. Дополнительная классификация типа события объявления.

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

enum (EventSubtype)

Значение перечисления для подтипа события.
eventSubtypeString

string

Значение подтипа события в виде строки.
Конец взаимоисключающих полей.

Необязательное поле. Тип показанного объявления.

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

enum (AdType)

Значение перечисления для типа объявления.
adTypeString

string

Строковое значение типа объявления.
Конец взаимоисключающих полей.

Необязательное поле. Тип показанного объявления.

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

enum (AdFormat)

Значение перечисления для формата объявления.
adFormatString

string

Строковое значение для формата объявления.
Конец взаимоисключающих полей.

Необязательное поле. Место размещения показанного объявления.

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

enum (AdPlacement)

Перечисляемое значение для места размещения объявления.
adPlacementString

string

Строковое значение для места размещения объявления.
Конец взаимоисключающих полей.

Необязательное поле. Тип таргетинга, использованный для показа объявления.

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

enum (TargetingType)

Значение перечисления для типа таргетинга.
targetingTypeString

string

Строковое значение типа таргетинга.
Конец взаимоисключающих полей.

Необязательное поле. Тип платформы, на которой было показано объявление.

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

enum (PlatformType)

Значение перечисления для типа платформы.
platformTypeString

string

Строковое значение для типа платформы.
Конец взаимоисключающих полей.

Необязательное поле. Дополнительная информация о платформе, на которой было показано объявление.

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

enum (Platform)

Значение enum для платформы.
platformString

string

Строковое значение для платформы.
Конец взаимоисключающих полей.
measurementAllowed

boolean

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

EventType

Тип события.

Перечисления
EVENT_TYPE_UNSPECIFIED Неуказанный тип события.
EVENT_TYPE_VIEW Посмотреть описание.
EVENT_TYPE_CLICK Событие клика.

EventSubtype

Дополнительная классификация типа события объявления.

Перечисления
EVENT_SUBTYPE_UNSPECIFIED Неуказанный подтип события.
EVENT_SUBTYPE_IMPRESSION Событие показа.
EVENT_SUBTYPE_ENGAGED_VIEW Событие заинтересованного просмотра.
EVENT_SUBTYPE_ONSITE_CLICK Событие клика на сайте.
EVENT_SUBTYPE_OUTBOUND_CLICK Событие исходящего клика.

AdType

Тип показанного объявления.

Перечисления
AD_TYPE_UNSPECIFIED Тип объявления не указан.
AD_TYPE_DISPLAY Медийное объявление.
AD_TYPE_TEXT Текстовое объявление.
AD_TYPE_IMAGE Графические объявления
AD_TYPE_RICH_MEDIA Мультимедийная реклама.
AD_TYPE_HTML HTML-объявление.
AD_TYPE_AUDIO Аудиообъявление.
AD_TYPE_VIDEO Видеореклама

AdFormat

Формат показанного объявления.

Перечисления
AD_FORMAT_UNSPECIFIED Формат объявления не указан.
AD_FORMAT_AR Реклама AR.
AD_FORMAT_AUDIO Аудиообъявление.
AD_FORMAT_BANNER Баннер.
AD_FORMAT_BUMPER Объявление-заставка.
AD_FORMAT_COLLECTION Объявление с подборкой.
AD_FORMAT_IMAGE Графические объявления
AD_FORMAT_INTERACTIVE Интерактивное объявление.
AD_FORMAT_INTERSTITIAL Межстраничное объявление.
AD_FORMAT_IN_FEED Объявление в фиде.
AD_FORMAT_IN_STREAM Объявление In-Stream.
AD_FORMAT_IN_STREAM_SKIPPABLE Объявление In-Stream с возможностью пропуска.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Объявление In-Stream без возможности пропуска.
AD_FORMAT_NATIVE Нативное объявление.
AD_FORMAT_SHORTS Реклама в Shorts.
AD_FORMAT_STORY Объявление-рассказ.
AD_FORMAT_SPONSORED Реклама.
AD_FORMAT_VIDEO Видеореклама

AdPlacement

Место размещения показанного объявления.

Перечисления
AD_PLACEMENT_UNSPECIFIED Не указано место размещения объявления.
AD_PLACEMENT_DISCOVER Найти место размещения.
AD_PLACEMENT_FEED Место размещения в фиде.
AD_PLACEMENT_HEADER Место размещения в заголовке.
AD_PLACEMENT_HOME Главная страница.
AD_PLACEMENT_IN_CONTENT Места размещения в контенте.
AD_PLACEMENT_PROMOTED Продвигаемое место размещения.
AD_PLACEMENT_STORY Место размещения истории.

TargetingType

Тип таргетинга, использованный для показа объявления.

Перечисления
TARGETING_TYPE_UNSPECIFIED Неуказанный тип таргетинга.
TARGETING_TYPE_AUDIENCE Таргетинг на аудитории.
TARGETING_TYPE_CONTEXTUAL Контекстный таргетинг.
TARGETING_TYPE_DEMOGRAPHIC Демографический таргетинг.
TARGETING_TYPE_DEVICE Таргетинг на устройства.
TARGETING_TYPE_GEO Геотаргетинг.
TARGETING_TYPE_INTEREST Таргетинг на интересы.
TARGETING_TYPE_PURCHASE_INTENT Таргетинг на основе покупательского намерения.
TARGETING_TYPE_REMARKETING Таргетинг на списки ремаркетинга.

PlatformType

Тип платформы, на которой было показано объявление.

Перечисления
PLATFORM_TYPE_UNSPECIFIED Тип платформы не указан.
PLATFORM_TYPE_MOBILE Мобильная платформа.
PLATFORM_TYPE_DESKTOP Платформа компьютера.
PLATFORM_TYPE_CTV платформы подключенных телевизоров;
PLATFORM_TYPE_PHONE Платформа телефона.
PLATFORM_TYPE_TABLET Платформа планшета.

Платформа

Дополнительная информация о платформе, на которой было показано объявление.

Перечисления
PLATFORM_UNSPECIFIED Платформа не указана.
PLATFORM_IOS платформы iOS.
PLATFORM_ANDROID платформы Android.
PLATFORM_WEB Веб-платформа.

AttributionHint

Статус атрибуции, присвоенный партнером для этого события объявления.

Перечисления
ATTRIBUTION_HINT_UNSPECIFIED Статус атрибуции неизвестен.
ATTRIBUTION_HINT_CONVERTED Статус "Преобразовано".
ATTRIBUTION_HINT_NOT_CONVERTED Статус "Не конвертировано".

ViewabilityInfo

Подробные сведения о видимости показанного объявления.

JSON-представление 
{
  "viewType": enum (ViewType),
  "viewablePercent": integer,
  "viewableDuration": string,
  "mediaSkippable": boolean,
  "mediaQuartile": enum (MediaQuartile),
  "mediaDuration": string,
  "mediaVolumePercent": integer,
  "playbackDuration": string
}
Поля
viewType

enum (ViewType)

Обязательно. Тип события.
viewablePercent

integer

Необязательное поле. Процент видимых пикселей (от 0 до 100).
viewableDuration

string (Duration format)

Необязательное поле. Время, в течение которого объявление было видно.

Продолжительность в секундах, может содержать до девяти дробных цифр и заканчиваться на символ "s". Пример: "3.5s".
mediaSkippable

boolean

Необязательное поле. Возможность пропуска объявления.
mediaQuartile

enum (MediaQuartile)

Необязательное поле. Доля воспроизведенного медиаконтента в виде отдельных квартилей.
mediaDuration

string (Duration format)

Необязательное поле. Продолжительность медийного объявления.

Продолжительность в секундах, может содержать до девяти дробных цифр и заканчиваться на символ "s". Пример: "3.5s".
mediaVolumePercent

integer

Необязательное поле. Громкость воспроизведения медиаконтента в процентах (от 0 до 100).
playbackDuration

string (Duration format)

Необязательное поле. Продолжительность воспроизведения медиаконтента объявления независимо от того, было ли оно показано в видимой области экрана.

Продолжительность в секундах, может содержать до девяти дробных цифр и заканчиваться на символ "s". Пример: "3.5s".

ViewType

Тип события.

Перечисления
VIEW_TYPE_UNSPECIFIED Тип просмотра не указан.
VIEW_TYPE_MRC_VIEWED Просмотрено по стандарту MRC.
VIEW_TYPE_MRC_RENDERED Показ в видимой области экрана по стандартам MRC.

MediaQuartile

Доля воспроизведенного медиаконтента в виде отдельных квартилей.

Перечисления
MEDIA_QUARTILE_UNSPECIFIED Не указан квартиль медиаконтента.
MEDIA_QUARTILE_START Кнопка "Начать".
MEDIA_QUARTILE_FIRST_QUARTILE Первый квартиль.
MEDIA_QUARTILE_MIDPOINT Средняя точка.
MEDIA_QUARTILE_THIRD_QUARTILE Третий квартиль.
MEDIA_QUARTILE_COMPLETE Завершено.