В этом руководстве описывается каждое поле в прототипе авторизованных покупателей в режиме реального времени, версия 275, а также дополнительные советы по внедрению и информация.
Также см. прото-файл Авторизованных покупателей RTB, на котором основано это руководство.
Объект BidRequest
Это сообщение, которое Google использует для запроса ставок. BidRequest включает рекламное место из одного показа.
В этом разделе перечислены сведения, которые нам известны о пользователе.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
id | необходимый | байты | Уникальный идентификатор запроса, сгенерированный Google. Это 16 байтов. |
ip | необязательный | байты | Первые 3 байта IP-адреса в сетевом порядке байтов для IPv4 или первые 6 байтов для IPv6. Обратите внимание, что количество и положение байтов, включенных из IPv6-адресов, могут позже измениться. |
user_data_treatment | повторный | перечисление | Если установлено значение user_data_treatment, данные cookie/идентификатора пользователя удаляются из запроса и не отправляются в выноске. Затронутые поля:
|
google _user_id | необязательный | нить | Идентификатор Google для пользователя, как описано в документации для службы сопоставления файлов cookie. Это поле представляет собой незаполненную веб-безопасную версию двоичного идентификатора файла cookie в кодировке base64. Подробную информацию о кодировании см. в разделе Кодировка Base 64 с URL-адресом и безопасным алфавитом имени файла в RFC 3548. Это поле совпадает с идентификатором Google, возвращаемым службой сопоставления файлов cookie. |
cookie _version | необязательный | int32 | Номер версии google_user_id . Иногда мы можем изменить сопоставление с cookie на google_user_id . В этом случае версия будет увеличена. |
cookie _age _seconds | необязательный | int32 | Время в секундах с момента создания google_user_id . Это число может быть квантовано. |
hosted _match _data | необязательный | байты | Сопоставьте данные, хранящиеся для этого google_user_id с помощью службы сопоставления файлов cookie. Если совпадение существует, то это поле содержит декодированные данные, которые были переданы в параметре google_hm . |
session_id | необязательный | нить | Представляет кратковременный сеанс пользователя на устройствах CTV/OTT с максимальной продолжительностью сеанса 6 часов. Использование session_id никогда не допускается для персонализации рекламы. session_id может использоваться только для ограничения частоты показов, конкурентного исключения или в подобных целях. |
user_agent | необязательный | нить | Строка, идентифицирующая браузер и тип устройства, отправившего запрос. Некоторые данные могут быть отредактированы или заменены. |
privacy_treatments | необязательный | КонфиденциальностьПроцедуры | Процедуры конфиденциальности. Некоторые поля в запросе ставки могут быть расширены или отредактированы для защиты конфиденциальности пользователя. В этом сообщении содержится информация о мерах по обеспечению конфиденциальности, применимых к рекламным возможностям, предлагаемым в этом запросе. |
user_agent_data | необязательный | Агент пользователя | Информация об агенте пользователя. |
publisher _country | необязательный | нить | Страна платежного адреса издателя. Это может отличаться от определенной страны пользователя в geo_criteria_id или страны размещения веб-сайта. Полный список кодов стран см. в документации по спискам кодов стран . |
host _publisher_id | необязательный | нить | Идентификатор хост-издателя. При заполнении указывает, что хост-издатель участвовал в распределении доходов, и этот идентификатор можно использовать для авторизации ads.txt. |
inventorypartnerdomain | необязательный | нить | Домен партнера (владельца сайта или приложения), которому принадлежит часть рекламных ресурсов на сайте или в приложении. Здесь будет размещен файл ads.txt или app-ads.txt партнера. Подробнее на http://iabtechlab.com/wp-content/uploads/2021/03/ctv-app-ads-explainer-guide.pdf . |
geo _criteria_id | необязательный | int32 | Местонахождение конечного пользователя. Использует подмножество кодов, используемых в Google Ads API. Список идентификаторов см. в таблице geo-table.csv в технической документации. Поле geo_criteria_id заменяет устаревшие поля страны, региона, города и города. |
geo | необязательный | гео | Приблизительное географическое местоположение пользователя. Вся информация о местоположении получена на основе IP-геолокации. Поля широты/долготы могут быть опорной позицией (например, центроид) для местоположения, полученного из IP-геолокации, которое также передается другими полями (например, город), а точность будет радиусом круга с приблизительным площадь этого места. Местоположение и его точность будут уточняться по мере необходимости для защиты конфиденциальности пользователей. |
postal _code | необязательный | нить | Обнаружен почтовый индекс соответствующего типа для страны конечного пользователя (например, почтовый индекс, если страна "США"). Поле postal_code_prefix устанавливается, когда точность слишком низкая, чтобы подразумевать полный код, в противном случае устанавливается поле postal_code . |
encrypted _hyperlocal _set | необязательный | байты | Зашифрованные сигналы гиперлокального таргетинга. |
hyperlocal _set | необязательный | Гиперлокалсет | Незашифрованная версия encrypted_hyperlocal_set . Это поле устанавливается только при использовании соединения SSL. |
timezone _offset | необязательный | int32 | Смещение времени пользователя от GMT в минутах. Например, GMT+10 — это timezone_offset = 600 . |
user _list | повторный | Список пользователей | |
publisher _id | необязательный | нить | Идентификатор издателя, определенный суффиксом кода издателя кода веб-ресурса. Например, "pub-123" – это код издателя кода веб-ресурса "ca-pub-123" (ca- – это префикс веб-ресурса, зависящий от продукта). |
seller _network _id | необязательный | int32 | Идентификатор сети продавца. Список идентификаторов см. в файлеeller-network-ids.txt в технической документации. Это устанавливается только в том случае, если сайт не является анонимным и издатель разрешает таргетинг на сайты. |
partner _id | необязательный | исправлено64 | Идентификатор партнера, который предоставляет этот инвентарь. Это значение устанавливается только в том случае, если также установлено значение seller_network_id и доступна дополнительная информация о партнере, помимо seller_network_id . Значение partner_id не имеет смысла, кроме предоставления стабильного идентификатора. |
url | необязательный | нить | URL страницы с удаленными параметрами. Это всегда начинается с протокола (либо http, либо https). |
is_semi_transparent _request | необязательный | логический | Указывает, что запрос использует полупрозрачную торговую марку, что означает, что будет предоставлена только усеченная версия URL-адреса запроса. Это решение принимает издатель, см. //support.google.com/admanager/answer/4584891 . |
detected _language | повторный | нить | Обнаруженные пользовательские языки на основе языка веб-страницы, настроек браузера и других сигналов. Порядок произвольный. Коды состоят из 2 или 5 символов и задокументированы в таблице языковых кодов . |
detected _vertical | повторный | Вертикальный | Примечание. Значения для этого поля теперь отредактированы. Неупорядоченный список обнаруженных вертикалей контента. Список идентификаторов см. в файле publisher-verticals.txt в технической документации. |
detected _content _label | повторный | int32 | Примечание. Значения для этого поля теперь отредактированы. Список обнаруженных меток контента. Список идентификаторов см. в файле content-labels.txt в технической документации. |
google _query_id | необязательный | нить | Это уникальный идентификатор для всего запроса. В случае наличия нескольких уточнений для запроса все запросы уточнений для этого запроса будут содержать один и тот же google_query_id. |
auction_type | необязательный | перечисление | Тип аукциона, который будет запущен для этого запроса. По умолчанию = SECOND_PRICE . |
device | необязательный | Устройство | |
key _value | повторный | ключ-значение | |
mobile | необязательный | Мобильный | |
video | необязательный | видео | |
publisher _settings _list_id | необязательный | исправлено64 | Идентификатор списка настроек издателя, который применяется к этой странице. Подробнее см. в руководстве по настройкам RTB Publisher . |
publisher _type | необязательный | перечисление | Тип издателя инвентаря, на котором будет показываться реклама. Для данного запроса ресурсы издателя могут принадлежать и управляться (O&O), представляться издателем или иметь неизвестный статус. По умолчанию = UNKNOWN_PUBLISHER_TYPE . |
page _visibility | необязательный | перечисление | Состояние видимости веб-страницы, содержащей рекламные места. См. www.w3.org/TR/page-visibility/ . |
adslot | повторный | рекламное место | |
bid _response _feedback | повторный | BidResponseОтзыв | |
response _deadline _ms | необязательный | int32 | Указывает, как долго Google будет ждать ответа в миллисекундах на конкретный запрос ставки. Если не установлено, участники торгов должны исходить из того, что используется крайний срок по умолчанию. |
is_test | необязательный | логический | Если правда, то это тестовый запрос. Результаты не будут отображаться для пользователей, и вам не будет выставлен счет за ответ, даже если он выиграет аукцион. Вы по-прежнему должны выполнять регулярную обработку, поскольку запрос может использоваться для оценки задержек или для другого тестирования. Во время вашего первоначального тестирования с трафиком Google любой ваш ответ будет исключен из аукциона независимо от того, имеет ли этот параметр значение true или false. |
is_ping | необязательный | логический | Если это правда, то этот запрос предназначен для измерения задержки в сети. Как можно быстрее вернуть пустой BidResponse только с установленным значением processing_time_ms без выполнения какой-либо логики торгов. |
is_predicted _to_be _ignored | необязательный | логический | Если это правда, то модель выноски предсказала, что вы не будете делать ставки по этому запросу. Мы отправляем выборочный процент таких запросов, чтобы мы могли автоматически обновлять модель при изменении шаблонов ставок. |
supply_chain | необязательный | Цепочка поставок |
Объект UserAgent
Информация об агенте пользователя. Это будет заполнено информацией о пользовательском агенте, извлеченной из заголовка User-Agent или из заголовков Sec-CH-UA .
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
browser | необязательный | Версия бренда | Идентифицирует браузер. |
platform | необязательный | Версия бренда | Идентифицирует платформу. |
mobile | необязательный | логический | Значение true, если агент предпочитает контент, оптимизированный для мобильных устройств. Обратитесь к полю BidRequest.device для получения конкретной информации об устройстве, которая может соответствовать или не соответствовать этому полю (например, браузер мобильного телефона может запрашивать «Настольный сайт»). |
architecture | необязательный | нить | Архитектура устройства, например, "x86" или "arm". |
bitness | необязательный | нить | Разрядность устройства, например "64" для 64-битной архитектуры. |
model | необязательный | нить | Модель устройства. |
Объект PrivacyTreatments
Процедуры конфиденциальности. Некоторые поля в запросе ставки могут быть расширены или отредактированы для защиты конфиденциальности пользователя. В этом сообщении содержится информация о мерах по обеспечению конфиденциальности, применимых к рекламным возможностям, предлагаемым в этом запросе.
Родитель| Атрибут | Обязательный/необязательный | Тип | Детали реализации |
|---|---|---|---|
non_personalized_ads_reason | необязательный | Перечисление NonPersonalizedAdsReason | Указывает причины, по которым объявления, возвращенные в ответ на этот запрос, не должны быть персонализированы. |
allow_user_data_collection | необязательный | логический | Значение true, если издатель разрешает участнику торгов использовать данные запроса ставки для создания профилей пользователей для таких целей, как реклама на основе интересов и ремаркетинг. Чтобы использовать эти данные для создания профилей пользователей, участник торгов также должен выиграть определенный показ. См . раздел Об элементах управления сбором данных . |
Объект BrandVersion
РодительКортеж (марка, версия) для браузера или платформы.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
brand | необязательный | нить | Идентификатор бренда, например, «Chrome» или «Windows». |
version | повторный | нить | Версия, при необходимости разделенная на компоненты, например, {"85", "1"} = v85.1. |
Геообъект
Приблизительное географическое местоположение пользователя. Вся информация о местоположении получена на основе IP-геолокации. Поля широты/долготы могут быть опорной позицией (например, центроид) для местоположения, полученного из IP-геолокации, которое также передается другими полями (например, город), а точность будет радиусом круга с приблизительным площадь этого места. Местоположение и его точность будут уточняться по мере необходимости для защиты конфиденциальности пользователей.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
lat | необязательный | двойной | |
lon | необязательный | двойной | Долгота от -180.0 до +180.0, где минус - запад. |
country | необязательный | нить | Страна, использующая ISO-3166-1 Alpha-3. |
region | необязательный | нить | Код региона с использованием ISO-3166-2; 2-буквенный код штата, если США. |
metro | необязательный | нить | Гугл код метро; похожие, но не совсем Nielsen DMA. |
city | необязательный | нить | Город, использующий Кодекс Организации Объединенных Наций для торговых и транспортных местоположений. Нажмите на страну из списка стран , чтобы увидеть коды городов. |
zip | необязательный | нить | Почтовый индекс. |
accuracy | необязательный | int32 | Расчетная точность определения местоположения в метрах. |
utcoffset | необязательный | int32 | Местное время как число +/- минут от UTC. |
Объект HyperlocalSet
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
hyperlocal | повторный | Гиперлокальный | В настоящее время это поле содержит не более одного гиперлокального полигона. |
center _point | необязательный | Гиперлокальный .Point | Примерный геометрический центр области геозоны. Он рассчитывается исключительно на основе геометрической формы зоны геозоны и никоим образом не указывает фактическое местоположение мобильного устройства в пределах зоны геозоны. Если выше указано несколько гиперлокальных полигонов, то center_point является геометрическим центром всех гиперлокальных полигонов. |
Гиперлокальный объект
РодительПриблизительная информация о геолокации, аппроксимированная на основе IP-адреса устройства, с которого был отправлен запрос рекламы.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
corners | повторный | Точка | Устройство может находиться в любой точке полигона геозоны, определяемой списком углов. В настоящее время многоугольник всегда является параллелограммом с 4 углами. |
Точечный объект
РодительМесто на поверхности Земли.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
latitude | необязательный | плавать | Широта местоположения. |
longitude | необязательный | плавать | Долгота местоположения. |
Объект UserList
Это поле не заполняется по умолчанию. Вместо этого мы рекомендуем участникам торгов хранить и искать идентификаторы списков, используя либо google_user_id , либо hosted_match_data в качестве ключей.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
id | необязательный | int64 | Идентификатор списка пользователей. |
age_seconds | необязательный | int32 | Время в секундах с момента добавления пользователя в список. |
Вертикальный объект
Одна или несколько обнаруженных вертикалей для страницы, определенных Google.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
id | необходимый | int32 | Вертикальный идентификатор. Список идентификаторов см. в файле publisher-verticals.txt в технической документации. |
weight | необходимый | плавать | Вес для этой вертикали в диапазоне (0,0, 1,0]. Более релевантные вертикали имеют больший вес. |
Объект устройства
Информация об устройстве.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
device_type | необязательный | перечисление | Тип устройства, на котором будет показываться реклама. По умолчанию = UNKNOWN_DEVICE . |
platform | необязательный | нить | Платформа устройства. Примеры: Android, iPhone, Palm. |
brand | необязательный | нить | Марка устройства, например Nokia, Samsung. |
model | необязательный | нить | Модель устройства, например, N70, Galaxy. |
os_version | необязательный | ОСВерсия | Версия ОС; например, 2 для Android 2.1 или 3.3 для iOS 3.3.1. |
carrier _id | необязательный | int64 | Уникальный идентификатор оператора мобильной связи, если устройство подключено к Интернету через оператора (а не через WiFi). Чтобы найти имя оператора и страну по идентификатору оператора, обратитесь к этой таблице операторов мобильной связи . |
screen _width | необязательный | int32 | Ширина экрана устройства в пикселях. |
screen _height | необязательный | int32 | Высота экрана устройства в пикселях. |
screen _pixel _ratio _millis | необязательный | int32 | Используется для устройств с высокой плотностью (например, Retina-дисплеи iOS). Значение, отличное от значения по умолчанию, указывает, что номинальный размер экрана (с пикселями в качестве единицы измерения) не описывает фактическое количество пикселей на экране. Например, номинальные ширина и высота могут быть 320x640 для экрана, который на самом деле имеет 640x1280 пикселей, и в этом случае screen_width=320 , screen_height=640 и screen_pixel_ratio_millis=2000 , поскольку каждая ось имеет в два раза больше пикселей, чем указывают ее размеры. По умолчанию = |
screen _orientation | необязательный | перечисление | Ориентация экрана устройства при отправке запроса рекламы. По умолчанию = UNKNOWN_ORIENTATION . |
hardware _version | необязательный | нить | Модель устройства Apple iOS; например, «айфон 5s», «айфон 6+», «айпад 4». |
limit_ad _tracking | необязательный | логический | «Ограничить отслеживание рекламы» — это одобренный коммерческий сигнал, основанный на настройках операционной системы или устройства, где false указывает, что отслеживание не ограничено, а true указывает, что отслеживание должно быть ограничено в соответствии с коммерческими правилами.Этот сигнал отражает решения пользователей на различных поверхностях, включая Прозрачность отслеживания приложений iOS. См. также руководство по прозрачности lmt и отслеживания приложений и рекламный идентификатор Android . |
app _tracking _authorization _status | необязательный | перечисление | Это поле заполняется только для устройств iOS. Указывает статус авторизации отслеживания приложения. Это значение извлекается из ATTrackingManager и предоставляется как есть. Дополнительные сведения о статусе авторизации отслеживания приложений iOS см. в этой статье . |
Объект ОсВерсион
РодительСодержит версию ОС платформы. Например, для Android 2 основной = 2, дополнительный = 0. Для iPhone 3.3.1 мажор=3 и минор=3.
| Атрибут | Обязательно/необязательно | Тип |
|---|---|---|
major | необязательный | int32 |
Объект KeyValue
Дополнительные атрибуты ключ-значение. В настоящее время не используется.
| Атрибут | Обязательно/необязательно | Тип |
|---|---|---|
key | необязательный | нить |
Мобильный объект
Информация по рекламным запросам, поступающим с мобильных устройств. Мобильное устройство — это либо смартфон, либо планшет. Это присутствует для рекламных запросов как с мобильных устройств, просматривающих Интернет, так и из мобильных приложений.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
is_app | необязательный | логический | Если правда, то этот запрос из мобильного приложения. Всегда будет true, если установлен app_id . |
app_id | необязательный | нить | Идентификатор мобильного приложения, когда этот рекламный запрос исходит из мобильного приложения. Если приложение было загружено из магазина приложений Apple iTunes, то это идентификатор магазина приложений; например, 343200656. Для устройств Android это полное имя пакета; например, com.rovio.angrybirds. Для устройств Windows это идентификатор приложения; например, f15abcde-f6gh-47i0-j3k8-37l93817mn3o. |
is _interstitial _request | необязательный | логический | Если да, то это запрос мобильной полноэкранной рекламы. |
app _category _ids | повторный | int32 | Примечание. Значения для этого поля теперь отредактированы. Это поле содержит идентификаторы категорий, к которым относится текущее мобильное приложение. Это поле будет пустым, если is_app имеет значение false. Сопоставление между мобильными приложениями и категориями определяется магазином Google Play для приложений Android или магазином Apple iTunes для приложений iOS. Чтобы найти название категории по идентификатору категории, обратитесь к таблице категорий мобильных приложений . |
is _mobile _web _optimized | необязательный | логический | Для мобильного веб-запроса это поле указывает, оптимизирована ли страница для мобильных браузеров на мобильных телефонах высокого класса. По умолчанию = ложь. |
is _app _open _ad | необязательный | логический | Указывает, относится ли запрос ставки для мобильного приложения к объявлению об открытии приложения. Дополнительную информацию см. в руководстве по открытию рекламы в приложении . |
encrypted _advertising _id | необязательный | байты | Это поле используется для рекламных идентификаторов для:
Когда |
encrypted _hashed _idfa | необязательный | байты | Также обратитесь к описанию encrypted_advertising_id . |
advertising _id | необязательный | байты | Незашифрованная версия encrypted_advertising_id . Это поле устанавливается только при использовании соединения SSL. Это поле представляет собой 16-байтовый UUID. |
hashed _idfa | необязательный | байты | Незашифрованная encrypted_hashed_idfa . Это поле устанавливается только при использовании соединения SSL. Это поле представляет собой 16-байтовый MD5. |
app _name | необязательный | нить | Названия приложений для Android взяты из магазина Google Play. Имена приложений для iOS предоставляются App Annie . |
app _rating | необязательный | плавать | Средний рейтинг пользователей для приложения. Диапазон пользовательского рейтинга составляет от 1,0 до 5,0. В настоящее время доступно только для приложений в магазине Google Play. |
installed_sdk | необязательный | Установленный SDK | Идентификация и информация о SDK, установленном в приложении издателя, к которому у участника торгов есть доступ, часто потому, что это SDK участника торгов. |
skadn | необязательный | SKAdNetworkRequest | Информация SKAdNetwork издателя для поддержки атрибуции установки приложения для iOS 14 и более поздних версий. SKAdNetwork API от Apple помогает рекламодателям измерять установку приложений, управляемых рекламой, отправляя обратную передачу в рекламную сеть после успешной установки. Издателям необходимо будет настроить поддерживаемые рекламные сети в списке свойств своего приложения (Info.plist), чтобы установку можно было связать с показом рекламы. Дополнительные сведения см. в этой статье . |
Объект InstalledSdk
РодительИдентификация и информация о SDK, установленном в приложении издателя, к которому у участника торгов есть доступ, часто потому, что это SDK участника торгов.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
id | необязательный | нить | Идентификатор установленного SDK. |
sdk_version | необязательный | Версия | Версия установленного SDK. |
adapter_version | необязательный | Версия | Версия адаптера, взаимодействующая с установленным пакетом SDK. |
Объект версии
РодительСемантическая версия установленного SDK и адаптера, который взаимодействует между установленным SDK и SDK Google.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
major | необязательный | int32 | По умолчанию = -1 |
minor | необязательный | int32 | По умолчанию = -1 |
micro | необязательный | int32 | По умолчанию = -1 |
Объект SKAdNetworkRequest
РодительИнформация SKAdNetwork издателя для поддержки атрибуции установки приложения для iOS 14 и более поздних версий. SKAdNetwork API от Apple помогает рекламодателям измерять установку приложений, управляемых рекламой, отправляя обратную передачу в рекламную сеть после успешной установки. Издателям необходимо будет настроить поддерживаемые рекламные сети в списке свойств своего приложения (Info.plist), чтобы установку можно было связать с показом рекламы. Дополнительные сведения см. в этой статье .
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
versions | повторный | нить | Список всех версий SKAdNetwork, поддерживаемых запросом, в зависимости от версии ОС и версии SDK. |
sourceapp | необязательный | нить | Идентификатор приложения издателя в Apple App Store. |
skadnetids | повторный | нить | Записи SKAdNetworkIdentifier в файле Info.plist приложения издателя. |
supported_fidelity_types | повторный | перечисление | Список поддерживаемых типов достоверности в зависимости от версии SKAdNetwork API, поддерживаемой операционной системой и SDK, а также от свойств рекламного места. |
skoverlay | необязательный | логический | Указывает, поддерживает ли этот запрос SKOverlay для видеообъявлений. |
Видео объект
Информация о видео, если это запрос рекламы в видео.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
placement | необязательный | перечисление | Описывает, где будет воспроизводиться видеореклама. По умолчанию = UNKNOWN_PLACEMENT . |
description _url | необязательный | нить | URL страницы, которую издатель предоставляет Google для описания видеоконтента, с удаленными параметрами. |
is _embedded _offsite | необязательный | логический | Если это правда, видео встраивается на страницу за пределами домена издателя. Когда это установлено, description_url указывает на описание видео (как всегда), а поле url в BidRequest — это страница, в которую встроено видео. Например, запрос на рекламу In-Stream в видео Vimeo, опубликованном на Facebook, имеет значение is_embedded_offsite . Поле url предназначено для страницы Facebook, а description_url указывает на видео на Vimeo. |
playback_method | необязательный | перечисление | Описывает, как будет воспроизводиться видеореклама. Метод воспроизведения определяется как автоматическое воспроизведение, воспроизведение по щелчку или наведение курсора мыши на основе наилучших доступных измерений. Это включает в себя такие вещи, как то, как недавно пользователь взаимодействовал с веб-страницей. При автоматическом воспроизведении объявления могут воспроизводиться с включенным или выключенным звуком. Некоторые объявления (например, реклама в ленте) отключены до тех пор, пока пользователь не взаимодействует с объявлением. В качестве альтернативы, если реклама обычно воспроизводится с включенным звуком, но устройство отключено, тогда значение будет отключено. Для устройств, где невозможно определить, отключен ли звук устройства (например, рабочий стол), мы предполагаем, что звук включен. По умолчанию = |
is _clickable | необязательный | логический | Позволяет ли инвентарь щелкнуть видеообъявление, чтобы перейти на сайт рекламодателя. Некоторые платформы, в частности подключенные телевизоры, не поддерживают нажатие на видеообъявления, и в этом случае для этого поля установлено значение false. |
videoad _start _delay | необязательный | int32 | Время в миллисекундах от начала видео, когда будет отображаться реклама. 0 означает начало ролика, -1 (или любое отрицательное 32-битное целое число) означает конец ролика, а 1 (или положительное 32-битное целое число) означает середину ролика. Значение допустимо, только если этот параметр установлен. Если не установлено, позиция дисплея неизвестна. |
max_ad _duration | необязательный | int32 | Максимальная продолжительность в миллисекундах объявления, которое вы должны вернуть. Если он не установлен или имеет значение <= 0, разрешена любая продолжительность. |
min_ad _duration | необязательный | int32 | Минимальная продолжительность в миллисекундах объявления, которое вы должны вернуть. Если он не установлен или имеет значение <= 0, минимальной продолжительности не существует. |
max_ads _in_pod | необязательный | int32 | Максимальное количество объявлений в пакете видео. Ненулевое значение указывает, что текущее рекламное место представляет собой модуль видео, который может показывать несколько видеообъявлений. Фактическое количество показанных видеообъявлений может быть меньше или равно этому значению, но не может превышать его. |
video_ad _skippable | необязательный | перечисление | Разрешает ли/требует/блокирует ли издатель видеообъявления с возможностью пропуска? По умолчанию = ALLOW_SKIPPABLE . |
skippable _max_ ad _duration | необязательный | int32 | Максимальная продолжительность в миллисекундах для объявления, которое вы должны вернуть, если это объявление можно пропустить (обычно это отличается от максимальной продолжительности, разрешенной для объявлений без возможности пропуска). Если он не установлен или имеет значение <= 0, разрешена любая продолжительность. |
protocols | повторный | перечисление | Массив поддерживаемых протоколов ответов на ставки для видео. Поддерживаемые видеопротоколы. |
allowed _video _formats | повторный | перечисление | Форматы видеофайлов, разрешенные для этого запроса. Ответ должен поддерживать хотя бы один из них.UNKNOWN_VIDEO_FORMAT = -1; // Flash video files are accepted (FLV). VIDEO_FLV = 0; VIDEO_MP4 = 1; // Valid VAST ads with at least one media file // hosted on youtube.com. YT_HOSTED = 2; // Flash VPAID (SWF). VPAID_FLASH = 3; // JavaScript VPAID. VPAID_JS = 4; AUDIO_MP3 = 5; AUDIO_OGG = 6; // Requires both MP3 & OGG as Google does not know // which codecs are installed on the player. AUDIO_MP3_OGG = 7; VIDEO_WEBM = 8; VIDEO_MOV = 9; VIDEO_3GPP = 10; VIDEO_HLS = 11; VIDEO_DASH = 12; // Audio version of MP4. AUDIO_MP4A = 13; |
companion_slot | повторный | CompanionSlot | Информация о рекламных местах для сопутствующих объявлений, которые можно показывать вместе с видео. Хотя это повторяющееся поле, в большинстве случаев будет только одно значение. Если нет доступных сопутствующих объявлений, это поле не будет установлено. |
end_cap _support | необязательный | перечисление | Поддержка торцевой крышки. Если эта функция включена, сопутствующее объявление может быть выбрано для отображения в качестве шапки (информационной карточки) в видеослоте после завершения воспроизведения видеообъявления. Если возвращается несколько сопутствующих объявлений, IMA SDK выбирает тот, который лучше всего соответствует размеру экрана устройства. Конечная заставка поддерживается только в межстраничном видеоинвентаре для мобильных устройств. По состоянию на август 2015 года END_CAP_FORBIDDEN и END_CAP_REQUIRED не поддерживаются. |
content _attributes | необязательный | ContentAttributes | Атрибуты видео, которое просматривает пользователь, а не видеообъявления. Эти поля основаны на доступности метаданных видео от издателя видео и не всегда могут быть заполнены. |
DEPRECATED _inventory _type | необязательный | перечисление | Тип инвентаря, из которого отправляется запрос. Устарело, но будет по-прежнему заполняться до января 2017 года. Используйте поле размещения, чтобы определить, является ли инвентарь межстраничным или встроенным. Используйте Device.device_type чтобы определить, исходит ли запрос от мобильного устройства, и Mobile.is_app , чтобы определить, исходит ли запрос из приложения. WEB_VIDEO — это места размещения INSTREAM из веб-браузеров. GAMES состоят из INTERSTITIAL мест размещения как в приложениях, так и в веб-браузерах. MOBILE_INTERSTITIAL — это места размещения INTERSTITIAL только из приложений. Этот инвентарь также позволяет отображать рекламу. Вы можете узнать, разрешает ли рекламное место медийную рекламу, если adslot.excluded_attributes не содержит 21 ( CreativeType: Html ) |
is_livestream | необязательный | логический | Определите, обрабатывается ли запрос объявления из видеопотока в прямом эфире (0 = не в прямом эфире, 1 = в прямом эфире). По умолчанию = ложь. |
Объект CompanionSlot
РодительИнформация о рекламных местах для сопутствующих объявлений, которые можно показывать вместе с видео. Хотя это повторяющееся поле, в большинстве случаев будет только одно значение. Если нет доступных сопутствующих объявлений, это поле не будет установлено. Он не отображается, если пользователь пропускает видео. Дополнительную информацию см. в руководстве по видеообъявлениям .
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
height | повторный | int32 | Эти поля представляют доступные высоты и ширины в этом слоте. Поля с одинаковой высотой и шириной всегда будут одинаковыми. |
width | повторный | int32 | Эти поля представляют доступные высоты и ширины в этом слоте. Поля с одинаковой высотой и шириной всегда будут одинаковыми. |
creative _format | повторный | перечисление | Это форматы объявлений, разрешенные в этом рекламном месте для сопутствующих объявлений. |
Объект ContentAttributes
РодительАтрибуты видео, которое просматривает пользователь, а не видеообъявления.
Эти поля основаны на доступности метаданных видео от издателя видео и не всегда могут быть заполнены.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
duration _seconds | необязательный | int32 | Продолжительность видео в секундах. |
Объект AdSlot
Информация о рекламных местах на странице.
| Атрибут | Обязательно/необязательно | Тип | Детали реализации |
|---|---|---|---|
id | необходимый | int32 | Произвольно назначаемый идентификатор слота, уникальный на данной странице и обычно начинающийся с 1. Вы используете его, чтобы определить, на какой слот сделать ставку в BidResponse. |
ad _block _key | необязательный | uint64 | Стабильный идентификатор для комбинации издателя, рекламного места и страницы. |
targetable _channel | повторный | нить | Набор каналов, участником которых является данное рекламное место. Канал — это набор рекламных мест на сайте. Вы можете настроить таргетинг на канал (например, на "спортивный раздел" или "все верхние баннеры"), чтобы получить более точный контроль над тем, где будет показываться ваша реклама. Названия каналов предоставляются издателем. |
width | повторный | int32 | Для мобильных межстраничных объявлений (в том числе тех, для которых разрешены видеообъявления) первая пара "ширина-высота" – это размер экрана (это также размер видеопроигрывателя для видеообъявлений VAST). Последующие пары представляют рекомендуемые размеры межстраничных объявлений, соответствующие ограничениям на размер межстраничных объявлений; например, не больше размера экрана и не меньше 50% ширины и 40% высоты. |
flexible_adslot _settings | необязательный | Гибкие настройки рекламного места | Если рекламный слот является гибким, он содержит настройки того, как можно изменить размер рекламного места. |
excluded _attribute | повторный | int32 | Идентификаторы запрещенных атрибутов для объявлений, которые могут показываться в этом рекламном месте. Список идентификаторов см. в файле publisher-excludable-creative-attributes.txt в технической документации. |
allowed _vendor _type | повторный | int32 | Допустимые типы поставщиков. Список идентификаторов см. в файле vendors.txt в технической документации. Это поле не относится к сделкам с переопределением блокировки (см. эту статью Справочного центра ). |
consented _providers _settings | необязательный | Консентедпровидерссеттингс | Информация о поставщиках, для которых издатель сообщил Google, что его пользователи из ЕЭЗ дали согласие на использование их личных данных для персонализации рекламы. Это поле будет заполнено только в том случае, если regs_gdpr имеет значение true. |
regs_gdpr | необязательный | логический | Authorized Buyers fills this field solely based on whether the impression will serve to an EEA user, based on information available to Google. It does not constitute legal guidance on GDPR. |
regs_lgpd | optional | bool | This field will be set to true when, based on information available to Google, this impression will serve to a user in Brazil. See https://storage.googleapis.com/adx-rtb-dictionaries/lgpd-providers.csv for the list of ad tech providers that are allowed to serve on LGPD-enforced requests. See this article for more information on LGPD. |
excluded _sensitive _category | repeated | int32 | The disallowed sensitive ad categories. Refer to the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should enforce these exclusions if you have the ability to classify ads into the listed categories. This field does not apply to deals with block overrides ( this Help Center article has more information). |
allowed _restricted _category | repeated | int32 | The allowed restricted ad categories for private and open auctions. Refer to the ad-restricted-categories.txt file in the technical documentation for a list of IDs. These only apply for private and open auction bids. Refer to the allowed_restricted_category_for_deals field for preferred deals or programmatic guarantees. |
allowed _restricted _category_for_deals | repeated | int32 | The allowed restricted ad categories for preferred deals or programmatic guarantees. The ad-restricted-categories.txt file in the technical documentation has a list of IDs. These only apply for preferred deals or programmatic guarantees. Refer to the allowed_restricted_category field for private and open auctions. In some cases, restricted categories are only allowed on preferred deals or programmatic guarantees, so this field lists all categories in allowed_restricted_category , and additionally, restricted categories that are only allowed for preferred deals or programmatic guarantees. |
allowed _languages | repeated | string | List of creative languages allowed by the publisher. The order is arbitrary. The codes are 2 or 5 characters and are documented in the language codes table . When not set, all languages are allowed. |
excluded _product _category | repeated | int32 | The disallowed ad product categories. Refer to the ad-product-categories.txt file in the technical documentation for a list of IDs. You should enforce these exclusions if you have the ability to classify ads into the listed categories. This field does not apply to deals with block overrides (as in this Help Center article ). |
excluded_creatives | repeated | ExcludedCreative | Creatives that are disallowed for the impression. Submitting a bid with one of the creatives in this list will result in such bid being filtered before the auction. Contact your account manager if you would like to enable this feature. |
only_deal_bids_accepted | optional | bool | Whether the adslot is only eligible for deals bids. Bids for the open auction will be filtered when this field is set to true. Bidders can bid on the open auction or deals when this field is set to false. |
matching _ad_data | repeated | MatchingAdData | Information about the pre-targeting configs that matched. |
exchange _bidding | optional | ExchangeBidding | Parameters related to exchange bidding (third-party exchanges doing real-time bidding on Google Ad Manager). This is never populated in calls to Authorized Buyers real-time bidders. |
open _bidding | optional | OpenBidding | Parameters sent in all Open Bidding requests. |
ad_unit _mapping | optional | AdUnitMapping | Ad unit mappings that match the given adslot. |
dfp_ad _unit_code | optional | string | The Ad Manager ad unit code . This is currently only set for Open Bidding requests. |
slot _visibility | optional | enum | Visibility information for the slot. Default = NO_DETECTION . |
viewability | optional | int32 | Viewability percentage for the ad slot. This is an estimate of the likelihood that this slot will be viewable by the end user based on historical and environment data. It is expressed as a percentage in the range of [0, 100]. The default value -1 indicates that viewability could not be estimated. |
click _through _rate | optional | float | Historical click-through rate for ads served in the ad slot. This is expressed as a fraction in the range [0.0, 1.0]. The default value of -1.0 indicates that historical click-through rate data is not available. This figure does not include data aggregated from Google Ads. |
video _completion _rate | optional | float | Historical completion rate for video ads served in the ad slot. This is expressed as a fraction in the range [0.0, 1.0]. The default value of -1.0 indicates that historical completion rate data is not available. This field is only applicable to video inventory, and does not include data aggregated from Google Ads. |
iframing _state | optional | enum | iFraming state of the ad slot on the webpage where it is present. Default = UNKNOWN_IFRAME_STATE . |
iframing _depth | optional | enum | iFrame depth of the ad slot on the webpage where it is present. Currently only set for video ad requests. Default = UNKNOWN_IFRAME_DEPTH . |
native _ad _template | repeated | NativeAdTemplate | A native ad consists of pieces that are rendered by the publisher. A publisher may support multiple distinct native ad templates. If the request also allows banners or videos, you can respond with other types of ads by setting html_snippet or video_url instead. If only native templates exist, you must set the native_ad field in any response you send. |
native _placement _type | optional | enum | Describes placement of native ad slot with respect to surrounding context. |
mediation _status | optional | enum | Whether the ad request has been determined to come directly from the publisher. Default = UNKNOWN . |
auto _refresh | optional | AutoRefresh | |
sticky _settings | optional | StickySettings | |
non _browser _slot _source | optional | enum | Publisher declaration stating that this ad slot may serve on non-browser inventory, like desktop apps. Default = UNDECLARED_SOURCE . |
renderer | optional | enum | Defines who controls the environment that made the ad request and will render the ad. On platforms where code written by Google will handle the ad this field is set to GOOGLE . When this field is PUBLISHER the publisher has placed their own code on the device to handle playback of the ad. There is no technical difference in how these request are handled. You may use this field to differentiate between different environments for non-technical reasons. This field is only set for requests that allow VAST video ads. |
amp_ad _request _type | optional | enum | Whether this request is for an Accelerated Mobile Page (AMP). AMP HTML pages load faster, by restricting parts of HTML, CSS and JavaScript. For more information on how AMP ads render, refer to the AMP ads README . Default = NON_AMP_PAGE . |
is _amp_page | optional | enum | Whether this is an AMP page or not. |
amp_ad _requirement_type | optional | enum | Possible requirement types for AMP ads. |
is _rewarded | optional | bool | Whether the user receives a reward for viewing the ad. For video ads, typical implementations allow users to read an additional news article for free, receive an extra life in a game, or get a sponsored ad-free music session. The reward is typically distributed after the video ad is completed. |
allowed _ad_types | repeated | enum | Possible ad types that are allowed in the bid response. allowed_ad_types always contains one or more values. Interstitial slots may also support banner ads. An ad slot with ALLOWED_AD_TYPE_NATIVE may or may not support native video, regardless of whether ALLOWED_AD_TYPE_VIDEO is set. Likewise, an ad slot without ALLOWED_AD_TYPE_NATIVE does not support native video, regardless of whether ALLOWED_AD_TYPE_VIDEO is set. |
session_depth | optional | int32 | Total number of impressions served to this user (within this specific site or app) in this browsing session, plus 1. A session ends after 30 minutes inactivity. The default value of -1 indicates that the session depth cannot be estimated. |
publisher _settings _list_id | repeated | fixed64 | The publisher settings list IDs that apply to this slot. Refer to the RTB Publisher Settings guide for details. |
secure_signals | repeated | Secure Signal | Secure signals passed by the publisher. |
api | repeated | enum | List of supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. Can be one of the following: |
billable_event _rate_adjustment | optional | double | For ads rendered using a custom SDK only: multiplier applied to bid in the auction. The adjustment reflects the likelihood that your bid would generate a billable event (for example, the ad renders successfully) if it won the auction, relative to the probability that other bids generate a billable event if they won the auction. This adjustment can be larger or smaller than 1. This affects the final ranking in the auction only; in particular, this multiplier does not affect the payment. Default = 1.0. |
omidpn | optional | string | Identifier of the OM SDK integration. For more info, see the OpenRTB Advisory for Open Measurement SDK . |
omidpv | optional | string | Version of the OM SDK integration. For more info, see the OpenRTB Advisory for Open Measurement SDK . |
impression_expiration_seconds | optional | int32 | The expected time period when an impression can occur in seconds following a winning bid. The impression may be billable only if it serves within this time. To learn more about impression expiration, see the following guide: https://developers.google.com/authorized-buyers/rtb/billing-event-guide |
frequency_capping_scope | required | FrequencyCappingScope enum | Experimental feature; may be subject to change. See Set Google-hosted frequency caps for RTB bids for more information. Describes the scope of frequency cap enforcement available for this request. Frequency caps to be enforced for a bid can be specified in the BidResponse.ad.adslot.frequency_cap field. |
excluded_app_ids | repeated | string | Block list of applications by their platform-specific exchange-independent application identifiers. On Android, these should be bundle or package names (for example, com.foo.mygame). On iOS, these are numeric IDs. |
FlexibleAdSlotSettings object
ParentSettings on how the slot may be resized.
| Attribute | Required/Optional | Type |
|---|---|---|
max_width | optional | int32 |
max_height | optional | int32 |
min_width | optional | int32 |
min_height | optional | int32 |
ConsentedProvidersSettings object
ParentInformation about the providers for whom the publisher has told Google that its EEA users have consented to the use of their personal data for ads personalization. This field will only be populated when regs_gdpr is true.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
consented_providers | repeated | int64 | Set of IDs corresponding to ad tech providers (ATPs) for whom the publisher has specified to Google that its EEA users have given legally valid consent to: 1) the use of cookies or other local storage where legally required; and 2) the collection, sharing, and use of personal data for personalization of ads by an ATP in accordance with Google's EU User Consent Policy. If a publisher is using the IAB Transparency and Consent Framework (TCF) v2 to manage user consent, this is the set of ATPs consented through the Additional Consent string (see this article for details about Google's Additional Consent mode). ATPs consented through the TCF v2 consent string are represented in the ConsentedProvidersSettings.tcf_consent_string field. A mapping of ATP ID to ATP name is posted at providers.csv. |
tcf_consent_string | optional | string | The web-safe base64-encoded IAB Transparency and Consent Framework (TCF) v2 consent string fetched from the publisher's IAB Consent Management Platform (CMP). The structure of the string is defined by the IAB TCF v2. This field will be populated if the publisher has integrated with a CMP for TCF v2 and that CMP indicates that GDPR applies to this ad request and provides a valid consent string. See this article for additional information about the Google TCF v2 integration. See the IAB Global Vendor List at vendor-list.consensu.org/v2/vendor-list.json for details about the vendors listed in the consent string. |
ExcludedCreative object
ParentA creative that is disallowed to bid on this impression due to Google policies or creative disapproval, excluded creative attributes, excluded product or sensitive categories, allowed vendor types, restricted categories or languages applicable to the bid request.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
buyer_creative_id | optional | string | Buyer creative ID of the disallowed creative. |
MatchingAdData object
ParentThe billing IDs corresponding to the pretargeting configs that matched.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
billing_id | repeated | int64 | The billing IDs corresponding to the pretargeting configs that matched. |
minimum _cpm_micros | optional | int64 | The minimum CPM value that you can bid to not be filtered before the auction. This may be a global minimum, or it may be a minimum set by the publisher. The value is in micros of your account currency. |
direct _deal | repeated | DirectDeal |
DirectDeal object
ParentInformation about any deals that matched for this inventory.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
direct _deal_id | optional | int64 | An ID identifying the deal. |
fixed _cpm _micros | optional | int64 | You must bid at least fixed_cpm_micros (in micros of your account currency) in order to participate in the deal. If you win, you will be charged fixed_cpm_micros . This does not apply when deal_type=PRIVATE_AUCTION . For private auctions, you must bid at least fixed_cpm_micros . Bidding higher CPM than fixed_cpm_micros will increase your chance to win when deal_type=PRIVATE_AUCTION , however it will not increase your chance to win in other types of deals. |
deal_type | optional | enum | The type of the deal. Default = UNKNOWN_DEAL_TYPE . |
publisher _blocks _overridden | optional | bool | Whether the publisher has exempted this deal from configured blocks. This setting does not override Authorized Buyers policies or Ad Review Center decisions. |
creative_source | optional | enum | Experimental field; subject to change. An enum declaring the host of the creative, which will only be populated for Programmatic Guaranteed deals. Currently, this field should only ever be set to CREATIVE_SOURCE_ADVERTISER (Default). | must _bid | optional | bool | This field is only applicable to Programmatic Guaranteed deals. The buyer is allowed to skip bidding on the impression if this field is false. When it is true, the buyer is required to bid on this deal for this impression opportunity. |
ExchangeBidding object
ParentParameters related to exchanges participating in Open Bidding (third party exchanges doing real-time bidding on Ad Manager). This is never populated in calls to Authorized Buyers real-time bidders.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
publisher _parameter | repeated | string | UTF8 strings optionally provided by the publisher as part of their matching yield group configurations in the Ad Manager UI. The format is arbitrary and should be agreed upon by the publisher and the exchange bidder. |
key_value | repeated | KeyValue | Repeated KeyValue pairs to be sent from the publisher to the exchange. |
OpenBidding object
ParentParameters sent in all Open Bidding requests.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
is_open_bidding | optional | bool | This field is set to true if the publisher set up a yield group or a mediation group that targets this adslot and this bidder. Visit our Help Center for information on Open Bidding and its effects on the bidding process. |
AdUnitMapping object
ParentAdUnitMapping is used to identify publisher inventory units in the bidder's namespace. The mappings are only populated when the bidder works directly with a publisher, and provides the mapping from Google's ad unit namespace to the bidder's inventory namespace. The ad unit mapping is only applicable for requests that use a custom SDK. https://support.google.com/admanager/answer/9601810.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
Keyval | Optional | Keyval | Key-value pair used to specify the inventory unit in the bidder's namespace. |
FormatType | Optional | enum | Possible ad unit formats that can be used for the mapping. Corresponds to the adapter that will be used on the SDK. Possible values:
|
Keyval object
ParentMultiple key-value pairs can be specified in order to support bidders whose inventory unit space is hierarchical and has multiple identifiers. The key-value pairs for the chosen AdUnitMapping should be sent back in the bid response as BidResponse.ad.sdk_rendered_ad.sdk_params. This is passed to the bidder's SDK.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
key | Optional | string | The key is the name of the bidder's inventory unit identifier for the SDK. |
value | Optional | string | The value of the bidder's inventory unit identifier for the given format. |
NativeAdTemplate object
Parent A native ad consists of pieces that are rendered by the publisher. A publisher may support multiple distinct native ad templates. If the request also allows banners or videos, you can respond with other types of ads by setting html_snippet , video_url , or video_vast_xml instead. If only native templates exist, you must set the native_ad field in any response you send.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
required_ fields | optional | int64 | Bitfield describing which fields are required by the publisher. Bid responses with no value for these fields will be rejected. Click and view tracking urls are always implicitly required. HEADLINE = 0x1 |
recommended _fields | optional | int64 | Bitfield describing which fields are recommended by the publisher. All recommended fields are supported, but not all recommended fields are required. HEADLINE = 0x1 |
headline_max_safe_length | optional | int32 | max_safe_length indicates the maximum number of Unicode characters that are guaranteed to be shown without truncation. Longer strings will be truncated by the publisher during rendering. |
image_width | optional | int32 | The width and height from which to calculate the required aspect ratio. You can provide a larger image in the response. Images that have aspect ratios substantially different than those implied by the height and width may be filtered. |
style_id | optional | int32 | Globally distinct ID for the specific style, HTML, and CSS with which the native ad is rendered. |
style _layout_type | optional | enum | Type of style layout for each native ad template. Default = PIXEL . |
style_height | optional | int32 | If the style_layout_type is PIXEL , width and height of the entire native ad after rendering. If the style_layout_type is FLUID , the style_height and style_width may optionally not be populated. |
AutoRefresh object
ParentAuto refresh settings.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
refresh _settings | repeated | AutoRefreshSettings | The auto-refresh settings that the publisher has on this inventory. This is repeated because publishers may do multiple types of auto refresh on one piece of inventory. |
refresh _count | optional | int32 | The number of times this ad slot had been refreshed since last page load. |
AutoRefreshSettings object
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
refresh _type | optional | enum | The type of the declared auto refresh. Default = UNKNOWN_AUTO_REFRESH_TYPE . |
min _refresh _interval _seconds | optional | int32 | The minimum refresh interval. This applies to all refresh types. |
StickySettings object
ParentStickiness settings declared by the publisher.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
vertical _stickiness | optional | enum | Whether the ad slot is a sidebar that sticks on screen when user scrolls. Default = UNKNOWN_STICKINESS . |
top _horizontal _stickiness | optional | enum | Whether the ad slot is a horizontal slot that sticks on the top of the screen when the user scrolls. Default = UNKNOWN_STICKINESS . |
bottom _horizontal _stickiness | optional | enum | Whether the ad slot is a horizontal slot that sticks on the bottom of the screen when the user scrolls. Default = UNKNOWN_STICKINESS . |
SecureSignal object
ParentSecure signals passed by the publisher.
| Attribute | Required/Optional | Type | Implementation Details |
|---|---|---|---|
data | optional | string | The secure signal. |
source_js | optional | SourceJs | Deprecated. This will be removed in February 2023. Use BidRequest.adslot.secure_signals.source instead. |
source | optional | string | The source of the signal. Identifier for the library or SDK that generated this data. |
SourceJs object
Parent Deprecated. This will be removed in February 2023. Use BidRequest.adslot.secure_signals.source instead.
| Attribute | Required/Optional | Type | Implementation Details |
|---|---|---|---|
id | optional | string | Identifier of the JavaScript library that generated this data. |
BidResponseFeedback object
Feedback on bids submitted in previous responses. This is only set if real-time feedback is enabled for your bidder. Contact your account manager if you want to enable real-time feedback.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
request _id | optional | bytes | The unique ID from BidRequest.id |
creative _index | optional | int32 | The index of the BidResponse_Ad if there was more than one. The index starts at zero for the first creative. |
creative _status _code | optional | int32 | The status code for the ad. Refer to creative-status-codes.txt in the technical documentation for a list of IDs. |
cpm _micros | optional | int64 | If the bid won the auction, this is the price paid in your account currency. If the bid participated in the auction but was out-bid, this is the CPM that should have been exceeded in order to win. This is not set if the bid was filtered prior to the auction, if the publisher or winning bidder has opted out of price feedback or if your account has opted out of sharing winning prices with other bidders. For 1st price auctions, BidRequest.bid_response_feedback[].minimum_bid_to_win is also populated. |
minimum_bid _to_win | optional | int64 | The minimum bid value necessary to have won the auction, in micros of your account currency. If your bid won the auction, this is the second highest bid that was not filtered (including the floor price). If your bid did not win the auction, this is the winning candidate's bid. This field will only be populated if your bid participated in a first-price auction, and will not be populated if your bid was filtered prior to the auction. |
sampled _mediation _cpm_ahead_of_ auction_winner | optional | int64 | When a publisher uses an RTB auction and waterfall-based SDK mediation on the same query, the winner of the real-time auction must also compete in a mediation waterfall (which is ordered by price) to win the impression. If the bid participated in the auction and there was no waterfall, the value of this field is 0. If the bid participated in the auction and there was a waterfall, the value of this field is a price representing a sample bid from the eligible mediation networks that were higher than the auction winner, weighted by expected fill rate. This field can be used in conjunction with minimum_bid_to_win to train bidding models. The CPM is in micros of your account currency. |
event _notification _token | optional | bytes | Event notification token that was included in the bid response. |
buyer _creative_id | optional | string | Buyer creative ID that was included in the bid response. |
SupplyChain object
SupplyChain object. For more information, see this article .
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
complete | optional | bool | Option indicating whether the chain contains all nodes involved in the transaction leading back to the owner of the site, app or other medium of the inventory. |
nodes | repeated | SupplyChainNode | Array of SupplyChainNode objects in the order of the chain. In a complete supply chain, the first node represents the initial advertising system and seller ID involved in the transaction, for example, the owner of the site, app, or other medium. In an incomplete supply chain, it represents the first known node. The last node represents the entity sending this bid request. |
version | optional | string | Version of the supply chain specification in use, in the format of "major.minor". For example, for version 1.0 of the spec, use the string "1.0". |
SupplyChainNode object
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
advertising_system_identifier | optional | string | The canonical domain name of the SSP, Exchange, Header Wrapper, etc system that bidders connect to. This may be the operational domain of the system, if that is different than the parent corporate domain, to facilitate WHOIS and reverse IP lookups to establish clear ownership of the delegate system. This should be the same value as used to identify sellers in an ads.txt file if one exists. |
seller_identifier | optional | string | The identifier associated with the seller or reseller account within the advertising system. This must contain the same value used in transactions, for example, "publisher_id" in Google protocol. Should be limited to 64 characters in length. |
handles_payment | optional | bool | Indicates whether this node will be involved in the flow of payment for the inventory. When set to true, the advertising system in the advertising_system_identifier field pays the seller in the seller_identifier field, who is responsible for paying the previous node in the chain. When set to false, this node is not involved in the flow of payment for the inventory. |
BidResponse object
This is the message that you return in response to a BidRequest. You may specify zero or more ads. For each ad, you should provide an ad slot on which the ad can run. An ad slot is identified by the AdSlot.id from the BidRequest. If you do not want to bid, submit a response with no ads and with only the processing_time_ms set.
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
ad | repeated | Ad | |
debug _string | optional | string | If is_test was set in the BidRequest, then you may return debug information as plain text in this field. Do not set this field under normal conditions, or set it to values longer than 100 characters. You should only use this field when asked to do so as part of troubleshooting particular problems. |
processing _time_ms | optional | int32 | Set this to the processing time in milliseconds from when you received the request to when you returned the response. |
no_bid_reason | optional | int32 | An optional, bidder-specified reason for not submitting a bid. This field is equivalent to BidResponse.nbr in the OpenRTB protocol and uses the same namespace of no-bid reason codes. See developers.google.com/authorized-buyers/rtb/downloads/no-bid-reasons.txt for the full set of no-bid reason codes. |
Ad object
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
event _notification _token | optional | bytes | The event notification token is sent to Authorized Buyers by bidders for troubleshooting. Authorized Buyers will include the token in real-time feedback for the bid. The content of the token will not be logged by Authorized Buyers. Authorized Buyers will ignore any token longer than 128 bytes. |
buyer _creative _id | optional | string | A unique identifier chosen by you for the creative in this response. This must always be set, must be limited to at most 64 bytes, and must be a valid UTF8 string. Every buyer_creative_id you use must always be associated with the same creative. This field is used to communicate approval statuses when issues are found. Do not specify the same ID for different creatives, or all creatives will be disapproved if a problem with a single creative is found. Do not specify different IDs for the same creative in different responses or no creatives will be served since approval status is assigned on a per-ID basis. |
html _snippet | optional | string | The HTML snippet that will be placed on the web page to display the ad. Use BidResponse.Ad.AdSlot.billing_id to indicate which billing ID this snippet is attributed to. |
video _url | optional | string | The URL to fetch a video ad. The URL should return an XML response that conforms to the VAST 2.0 or 3.0 standard. Use BidResponse.Ad.AdSlot.billing_id to indicate which billing ID to attribute this ad to. Only one of html_snippet , video_url , native_ad , sdk_rendered_ad , amp_ad_url , or video_vast_xml should be set. Only set this field if the BidRequest is for an in-video ad ( BidRequest.video is present). |
video _vast_xml | optional | string | The VAST document to be returned. This document should conform to the VAST 2.0 or 3.0 standard. Use BidResponse.Ad.AdSlot.billing_id to indicate which billing ID to attribute this ad to. Only set this field if the BidRequest is for an in-video ad and the response is VAST XML. Only one of html_snippet , video_url , native_ad , sdk_rendered_ad , amp_ad_url , or video_vast_xml should be set. |
amp_ad_url | optional | string | The URL to fetch an AMPHTML ad. Only one of the following should be set: html_snippet , video_url , native_ad , sdk_rendered_ad , amp_ad_url , or video_vast_xml . |
native _ad | optional | NativeAd | The content of a native ad. Native ads consist of multiple building blocks, which are rendered by the publisher. |
click _through _url | repeated | string | The set of destination URLs for the snippet. This includes the URLs that the user will go to if they click on the displayed ad, and any URLs that are visible in the rendered ad. Do not include intermediate calls to the adserver that are unrelated to the final landing page. This data is used for post-filtering of publisher-blocked URLs among other things. A BidResponse that returns a snippet or video ad but declares no click_through_url will be discarded. For native ads, only the first value is used as the click URL, though all values are subject to categorization and review. Only set this field if html_snippet or video_url or native_ad are set. For native ads, if NativeAd.click_link_url is not set, the first value of click_through_url is used to direct the user to the landing page. For native ads, we recommend using click_link_url as the field to set the destination where the user will ultimately go. It is required to use this field in the case of dynamic landing pages. |
vendor _type | repeated | int32 | All vendor types for the ads that may be shown from this snippet. You should only declare vendor IDs listed in the vendors.txt file in the technical documentation. We will check to ensure that the vendors you declare are in the allowed_vendor_type list sent in the BidRequest. |
attribute | repeated | int32 | All attributes for the ads that may be shown from this snippet. Refer to buyer-declarable-creative-attributes.txt in the technical documentation for a list of IDs. We will check to ensure none of these attributes are in the excluded_attribute list in the BidRequest. |
category | repeated | int32 | All sensitive categories for the ads that may be shown from this snippet. Refer to ad-sensitive-categories.txt in the technical documentation for a list of IDs. We will check to ensure none of these categories were in the excluded_sensitive_category list in the BidRequest. |
restricted _category | repeated | int32 | All restricted categories for the ads that may be shown from this snippet. Refer to ad-restricted-categories.txt in the technical documentation for a list of IDs. We will check to ensure these categories were listed in the allowed_restricted_category list in the BidRequest. |
advertiser _name | repeated | string | All names of the ad's advertisers. |
bidder _name | optional | string | For exchange bidders (third party exchanges doing real-time bidding on Ad Manager), the name of the bidder that the exchange called to provide the ad. This is arbitrary UTF8 text but should be sufficient to identify the bidder and should be set consistently to the same value for the same bidder. |
width | optional | int32 | The width and the height in pixels of the ad. Setting these is optional. However, these must be set if the bid BidRequest.AdSlot has more than one width and height or if BidRequest.Mobile.is_interstitial_request is true. |
agency _id | optional | int64 | The Agency associated with this ad. Refer to the agencies.txt file in the technical documentation for a list of IDs. If this ad has no associated agency then the value NONE ( agency_id: 1 ) should be used rather than leaving this field unset. |
adslot | repeated | AdSlot | |
impression _tracking_url | repeated | string | The URLs to call when the impression is rendered. This is supported for all inventory types and all formats. |
click _tracking_url | repeated | string | The URLs to call when the user clicks on the ad. Currently supported only for native ads and Programmatic Guaranteed deals with publisher-managed creatives. In the publisher managed case, these click trackers will be sent to the bidder server to server. In all other cases, these will be sent from the user's device. For more information on publisher-managed creatives, see Publisher-managed creatives . |
ad_choices _destination_url | optional | string | Link to ad preferences page. This is only supported for native ads. If present, a standard AdChoices icon is added to the native creative and linked to this URL. |
impression _tracking_resource | repeated | ImpressionTrackingResource | Resources to invoke when the impression is rendered. This is supported for native and banner formats only and explicitly whitelisted scripts only. |
sdk_rendered_ad | optional | SdkRenderedAd | An ad that will be rendered by an SDK known to the buyer. This can only be used when the BidRequest includes a mobile.installed_sdk submessage. |
skadn | optional | SKAdNetworkResponse | Advertiser's SKAdNetwork information to support app installation attribution for iOS 14 and later. Apple's SKAdNetwork API helps advertisers measure ad-driven app installation by sending a postback to the ad network after a successful install. Ad networks will need to send their network ID and signed advertiser information to allow an install to be attributed to the ad impression. For more info, see this article . |
advertised_app_id | optional | string | ID of the advertised app (only for app promotion). On Android, this should be a bundle or package name such as com.foo.mygame. On iOS, it is a numeric ID. In addition to this field, set the app_promotion_type field below to take advantage of features specific to app promotion types. |
app_promotion_type | optional | enum | Type of the app promotion corresponding to the advertised app specified in the advertised_app_id field above. If the advertised app is not specified, this field will be ignored. Starting May 2023, setting advertised_app_id field without this field will be treated as if this field were set to OTHER. Until then, the default value will be INSTALLS. |
NativeAd object
Parent The content of a native ad. Native ads consist of multiple building blocks, which are rendered by the publisher. Only one of the following should be set: html_snippet , video_url , video_vast_xml , or native_ad . Only set this field if the BidRequest is for a native ad ( BidRequest.adslot.native is present).
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
headline | optional | string | A short title for the ad. |
body | optional | string | A long description of the ad. |
call_to _action | optional | string | A label for the button that the user is supposed to click. |
advertiser | optional | string | The name of the advertiser or sponsor, to be displayed in the ad creative. |
image | optional | Image | A large image. |
logo | optional | Image | A smaller image, for the advertiser's logo. |
app_icon | optional | Image | The app icon, for app download ads. |
video _url | optional | string | The URL to fetch a video ad. The URL should return an XML response that conforms to the VAST 2.0 standard. Only set this field if the BidRequest is for native ads and the video field is requested. |
star _rating | optional | double | The app rating in the app store. Must be in the range [0-5]. |
click _link _url | optional | string | The URL that the browser/SDK will load when the user clicks the ad. This can be the landing page directly, or the first step of a redirect chain that eventually leads to it. For backward compatibility, if this is not set, the first Ad.click_through_url is used. For native ads, we recommend using click_link_url instead of click_through_url . |
click _tracking _url | optional | string | Deprecated. The URL to use for click tracking. The SDK pings click tracking url on a background thread. When resolving the url, HTTP 30x redirects are followed. The SDK ignores the contents of the response; this URL has no effect on the landing page for the user. |
price | optional | string | The price of the promoted app including the currency info. |
Image object
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
url | optional | string | |
width | optional | int32 | Image width and height are specified in pixels. You may provide a larger image than was requested, so long as the aspect ratio is preserved. |
AdSlot object
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
id | required | int32 | The slot ID from the BidRequest that the ad may appear in. |
max_cpm _micros | required | int64 | The maximum CPM you want to be charged if you win the auction for this ad slot, expressed in micros of the specified currency or default bidding currency. For example, to bid a CPM of 1.29 USD, set max_cpm_micros = 1290000. Winning bids are rounded up to billable units. For example, in USD, bids are rounded up to the next multiple of 10,000 micros (one cent). |
min_cpm _micros | optional | int64 | The minimum CPM you want to be charged if you win the auction for this ad slot, expressed in micros of the specified currency or default bidding currency. This may represent a second price if you choose max_cpm_micros as the highest of several bids, or some form of reserve price if you want to override the reserve price set by the publisher. The bid must be less than or equal to max_cpm_micros or it will be ignored. This field is optional and does not need to be set. This field is not applicable when responding to bid requests with auction_type set to FIRST_PRICE . |
billing _id | optional | int64 | Billing ID to attribute this impression to. The value must be in the set of billing IDs for this slot that were sent in the BidRequest.AdSlot.matching_ad_data.billing_id . This must always be set if the BidRequest has more than one BidRequest.AdSlot.matching_ad_data.billing_id . |
deal_id | optional | int64 | The deal ID that you want this bid to participate in. Leave unset or set it to "1" if a deal is available but you want to ignore the deal and participate in the open auction. |
exchange _deal_id | optional | string | For exchange bidders (third-party exchanges doing real-time bidding on Ad Manager), the deal ID from the exchange's namespace that is associated with this bid and reported to publishers. Leave unset if there is no associated deal. This is arbitrary UTF8 text and must be at most 64 bytes. |
exchange _deal_type | optional | enum | When exchange_deal_id is set, the type of deal. This is reported to publishers and affects how the deal is treated in the auction. |
buyer_reporting_id | optional | string | Buyer declared ID which will be used to break down spend and invalid traffic metrics in IVT transparency reporting in Query Tool. Note that IDs with fewer than 1000 impressions will not be used to break down metrics. IDs longer than 64 bytes will be ignored. |
third_party_buyer_token | optional | string | Token used to identify end third party buyer information if an exchange as an open bidder is an intermediary. This is obtained from the third party buyer and must be passed to Google unaltered in the bid response. |
frequency_cap | repeated | FrequencyCap | Experimental feature; may be subject to change. See github.com/google/ads-privacy/tree/master/experiments/frequency-capping for more information about the experiment on exchange-enforced frequency capping. To enable frequency capping for your account, contact your account manager. Specifies frequency capping to be applied to the bid. Impressions for each user are capped at the level specified by frequency_cap_id. A bid will not participate in the auction if an additional impression for the user would violate any of the specified caps. Multiple frequency caps can be specified for the same frequency_cap_id. A bid is filtered before the auction if the frequency cap is malformed. Instances where the cap is malformed include: Note that if a subsequent bid with the same frequency_cap_id uses a different duration (represented by time_unit and time_range) then impressions counted against the old frequency cap will not count against the new one and the reverse. |
currency | optional | string | The currency used by max_cpm_micros and min_cpm_micros, using ISO-4217 alpha codes. If this field is populated, the specified currency will be used to interpret the bid. Otherwise, the default bidding currency will be used, which is determined in the following priority:
The currency of a buyer account is set on account creation and can be checked by contacting a Technical Account Manager. |
FrequencyCap object
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
frequency_cap_id | optional | string | An ID that can represent a bidder's use-case for frequency capping; for example, it could represent their campaign, ad, line item, etc. It should not contain any user-specific information or identifiers. |
time_unit | optional | enum | The time units for which frequency caps can be enforced. |
time_range | optional | int32 | The length of the time window, in units specified by time_unit, for which the frequency cap applies. For instance, if time_unit=WEEK and time_range=3, then capping is applied for a three week period. If the time_unit=INDEFINITE, this will be ignored. |
max_impressions | optional | int32 | The maximum number of impressions allowed to be shown to a user for the provided frequency_cap_id within the time window described by time_unit and time_range. |
ImpressionTrackingResource object
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
script_url | optional | string | The URL of a JavaScript resource. The URLs should not contain script tags. For example: "https://mycdn.com/tracker.js". |
context | repeated | enum | Additional context provided for rendering. |
verification_parameters | optional | string | Parameters associated with the resource that will be passed to the resource when it is loaded. The format of the parameters is dependent on the script vendor. |
vendor_key | optional | string | Used to uniquely identify the verification script provider. |
SdkRenderedAd object
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
id | optional | string | The identifier for the SDK that will render the ad. Must match a mobile.installed_sdk.id sent in the corresponding bid request. |
rendering_data | optional | string | Data to pass to the SDK in order to render the ad. This data is opaque to the publisher and to Google. |
declared_ad | optional | DelcaredAd object | Declared ad assets to support creative scanning, classification, and enforcement of ad policy and publisher blocks for ads rendered with a custom SDK. Set only one of html_snippet , video_url , video_vast_xml , or native_ad . |
DeclaredAd object
Declared ad assets to support creative scanning, classification, and enforcement of ad policy and publisher blocks for ads rendered with a custom SDK. Set only one of html_snippet , video_url , video_vast_xml , or native_ad .
| Attribute | Required/optional | Type | Implementation details |
|---|---|---|---|
html_snippet | optional | string | The HTML snippet representative of the SDK-rendered ad. |
video_url | optional | string | The URL to the VAST asset used in the SDK-rendered ad. |
video_vast_xml | optional | string | The VAST document used to render custom SDK-rendered ad. This document should conform to the VAST 2.0 or 3.0 standard. |
native_ad | optional | NativeAd | The content of a native ad. Native ads consist of multiple building blocks, which are rendered by the buyer SDK. |
click_through_url | optional | string | The final landing pages of the SDK-rendered ad. |
SKAdNetworkResponse object
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
version | optional | string | Version of SKAdNetwork supported by the advertiser. Also used to specify how the signature was generated by the advertiser. This should match one of the versions from BidRequest.mobile.skad.versions. |
network | optional | string | Ad network identifier used in signature. This should match one of the items in BidRequest.mobile.skad.skadnetids. |
campaign | optional | int64 | Campaign ID compatible with Apple's spec. Used in SKAdNetwork 3.0 and below. Replaced BidResponse.ad.skad.source_identifier field in SKAdNetwork 4.0 and above. |
source_identifier | optional | int64 | A four-digit integer that ad networks define to represent the ad campaign. Used in SKAdNetwork 4.0+ and replaces the BidResponse.ad.skad.campaign field. |
itunesitem | optional | string | ID of advertiser's app in Apple's app store. |
product_page_id | optional | string | ID of custom product page to display (for iOS 15 or later). If not specified, default product page will be displayed. See this article for more details about custom product pages. |
fidelities | repeated | Fidelity | SKAdNetwork API starting from version 2.2 supports multiple ad presentation options specified by the fidelity-type parameter of the SKAdNetwork signature. This holds parameters used to generate the signature that would be different for each fidelity type supported. For more info, see this article . |
nonce | optional | string | A unique all-lowercase UUID generated by the advertiser to use for generating the signature. Note: This field will be deprecated in favor of the BidResponse.ad.skadn.fidelities.nonce field to support multiple fidelity types. |
sourceapp | optional | string | ID of publisher's app in Apple's app store. This should match the ID from BidRequest.mobile.skad.sourceapp. |
timestamp | optional | int64 | Unix time in millis used at the time of signature generation. Note: This field will be deprecated in favor of the BidResponse.ad.skadn.fidelities.timestamp field to support multiple fidelity types. |
signature | optional | string | SKAdNetwork signature as specified by Apple. Note: This field will be deprecated in favor of the BidResponse.ad.skadn.fidelities.signature field to support multiple fidelity types. |
skoverlay | optional | SKOverlay object | These options indicate how to present SKOverlay recommending the advertised app. Supported by iOS 14 and later. |
Fidelity object
Parent SKAdNetwork API starting from version 2.2 supports multiple ad presentation options specified by the fidelity-type parameter of the SKAdNetwork signature. This holds parameters used to generate the signature that would be different for each fidelity type supported. For more info, see this article .
| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
fidelity_type | optional | enum | The fidelity type of the attribution to track. Default = STOREKIT_RENDERED_ADS . |
nonce | optional | string | A unique all-lowercase UUID generated by the advertiser to use for generating the signature. |
timestamp | optional | int64 | Unix time in millis used at the time of signature generation. |
signature | optional | string | SKAdNetwork signature as specified by Apple. |
SKOverlay
Parent| Attribute | Required/Optional | Type | Implementation details |
|---|---|---|---|
delay_seconds | optional | int32 | Delay in seconds after the ad begins before presenting the overlay. If this field is set to 0, the overlay will be shown immediately after the ad begins. If this field is unset, the overlay will not be shown for the ad. |
endcard_delay_seconds | optional | int32 | Delay in seconds after the endcard shows before presenting the overlay. (This field only applies to rewarded or interstitial video creatives.) If this field is set to 0, the overlay will be shown immediately after the endcard shows. If this field is unset, the overlay will not be shown for the endcard. If both delay and endcard_delay_seconds are set, the overlay will be automatically dismissed when the ad ends, and shown again after the endcard shows. |
dismissible | optional | bool | Whether this overlay can be dismissed by the user. Default to be true. |