Method: adEvents.ingest

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

Эта функция доступна только для учетных записей, включенных в список разрешенных.

HTTP-запрос

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

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

Текст запроса

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

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

object ( AdEvent )

Обязательно. Обязательно (минимум 1). Список рекламных событий.

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 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "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 Analytics.

medium

string

Обязательно. Тип рекламного объявления, аналогичный типу данных в Google Analytics.

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 )

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

platformString

string

Строковое значение для платформы.

Конец взаимоисключающих областей.
measurementAllowed

boolean

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

Тип события

Тип мероприятия.

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

Подтип события

Дополнительная классификация по типу рекламного события.

Перечисления
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 Реклама в потоке.
AD_FORMAT_IN_STREAM_SKIPPABLE Встроенная реклама, которую можно пропустить.
AD_FORMAT_IN_STREAM_NON_SKIPPABLE Неотключаемая реклама в потоке видео.
AD_FORMAT_NATIVE Нативная реклама.
AD_FORMAT_SHORTS Реклама шорт.
AD_FORMAT_STORY Рекламное объявление.
AD_FORMAT_SPONSORED Рекламное объявление.
AD_FORMAT_VIDEO Видеореклама.

Размещение рекламы

Место размещения показанной рекламы.

Перечисления
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 Платформа 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" .

Тип представления

Тип мероприятия.

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