- HTTP-запрос
- Текст запроса
- Ответный текст
- Области полномочий
- AdEvent
- Тип события
- Подтип события
- AdType
- AdFormat
- Размещение рекламы
- TargetingType
- PlatformType
- Платформа
- AttributionHint
- ViewabilityInfo
- Тип представления
- MediaQuartile
- Попробуйте!
Загружает список ресурсов AdEvent в Google Analytics.
Эта функция доступна только для учетных записей, включенных в список разрешенных.
HTTP-запрос
POST https://datamanager.googleapis.com/v1/adEvents:ingest
В URL-адресе используется синтаксис транскодирования gRPC .
Текст запроса
Тело запроса содержит данные следующей структуры:
| JSON-представление |
|---|
{ "adEvents": [ { object ( |
| Поля | |
|---|---|
adEvents[] | Обязательно. Обязательно (минимум 1). Список рекламных событий. |
encryptionInfo | Необязательно. Информация о ключах шифрования, используемых для шифрования данных. |
validateOnly | Необязательный параметр. Если значение равно true, запрос проверяется, но не выполняется. |
Ответный текст
В случае успеха тело ответа будет пустым.
Области полномочий
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/datamanager
AdEvent
Рекламное мероприятие.
| JSON-представление |
|---|
{ "advertiserId": string, "eventType": enum ( |
| Поля | |
|---|---|
advertiserId | Обязательно. Идентификатор рекламодателя для рекламного мероприятия. Этот идентификатор должен совпадать с идентификатором, отправленным в процессе связывания. |
eventType | Обязательно. Тип мероприятия. |
timestamp | Обязательно. Время, когда произошло событие. Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: |
eventId | Необязательный параметр. Идентификатор, созданный и управляемый вызывающей стороной, который однозначно идентифицирует это событие. Этот параметр обязателен, если вы хотите удалить дубликаты рекламных событий, включенных в несколько запросов. В противном случае, это поле необязательно. |
userData | Необязательно. Несколько предоставленных пользователем данных, представляющих пользователя, с которым связано событие. Можно указать несколько экземпляров данных одного типа (например, адрес электронной почты). Чем больше данных, тем выше вероятность обнаружения совпадения. |
deviceInfo | Необязательно. Информация, собранная об устройстве, использовавшемся во время показа рекламы. |
mobileDeviceId | Необязательно. Идентификатор устройства, на которое была показана реклама. |
campaignId | Обязательно. Идентификатор соответствующей кампании. |
campaignName | Обязательно. Название соответствующей кампании. |
adGroupId | Необязательно. Идентификатор соответствующей группы объявлений. |
adId | Необязательно. Идентификатор соответствующего объявления в группе. |
adHeight | Необязательно. Высота объявления в пикселях. |
adWidth | Необязательно. Ширина объявления в пикселях. |
regionCode | Обязательно. Страна, соответствующая стандарту ISO 3166-2, плюс подразделение. |
source | Обязательно. Источник платформы для показа рекламы, аналогичный источнику данных Google Analytics. |
medium | Обязательно. Тип рекламного объявления, аналогичный типу данных в Google Analytics. |
attributionHint | Необязательно. Предполагаемый статус атрибуции партнера для данного рекламного события. Это служит лишь сигналом того, как проявилось предполагаемое авторство партнера, и не обязывает к определенному результату в итоговых отчетах. |
viewabilityInfo | Обязательно. Подробная информация о видимости показываемой рекламы. |
Поле объединения Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. | |
eventSubtype | Перечисляемое значение для подтипа события. |
eventSubtypeString | Строковое значение для подтипа события. |
Поле объединения Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. | |
adType | Перечисляемое значение для типа объявления. |
adTypeString | Строковое значение для типа объявления. |
Поле объединения Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. | |
adFormat | Перечисляемое значение для формата объявления. |
adFormatString | Строковое значение для формата объявления. |
Поле объединения Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. | |
adPlacement | Перечисляемое значение для размещения рекламы. |
adPlacementString | Строковое значение для размещения рекламы. |
Поле объединения Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. | |
targetingType | Перечисляемое значение для типа таргетинга. |
targetingTypeString | Строковое значение для типа целевого объекта. |
Поле объединения Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. | |
platformType | Перечисляемое значение для типа платформы. |
platformTypeString | Строковое значение для типа платформы. |
Поле объединения Для обработки значений, отличных от чистых перечислений, принимается необработанная строка. По возможности предпочтительнее использовать перечисление. | |
platform | Перечисляемое значение для платформы. |
platformString | Строковое значение для платформы. |
measurementAllowed | Необязательный параметр. Указывает, разрешено ли использование данной строки в целях измерения в соответствии с применимыми законами о защите персональных данных в пределах региональной юрисдикции. |
Тип события
Тип мероприятия.
| Перечисления | |
|---|---|
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_CAROUSEL | Реклама-карусель. |
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_FOOTER | Размещение нижнего колонтитула. |
AD_PLACEMENT_HEADER | Размещение заголовка. |
AD_PLACEMENT_HOME | Размещение на дому. |
AD_PLACEMENT_IN_CONTENT | Размещение внутри контента. |
AD_PLACEMENT_PROMOTED | Продвижение по службе. |
AD_PLACEMENT_SEARCH | Размещение в результатах поиска. |
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 | Необязательно. Числовой процент (0-100) видимых пикселей. |
viewableDuration | Необязательно. Время, в течение которого реклама была доступна для просмотра. Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « |
mediaSkippable | Необязательно. Можно ли было пропустить рекламный ролик или нет. |
mediaQuartile | Необязательно. Количество воспроизведенного медиаконтента, представленное в виде отдельных квартилей. |
mediaDuration | Необязательно. Продолжительность показа рекламного ролика. Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « |
mediaVolumePercent | Необязательно. Числовое значение (0-100) громкости воспроизводимого медиафайла в процентах. |
playbackDuration | Необязательно. Продолжительность воспроизведения рекламного ролика, независимо от того, был ли он виден или нет. Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « |
Тип представления
Тип мероприятия.
| Перечисления | |
|---|---|
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 | Полный. |