VKWebAppShowBannerAd

VKWebAppShowBannerAd отображает баннерную рекламу в игре или мини-приложении.

Используйте это событие вместо устаревшего VKWebAppGetAds.

Чтобы скрыть баннерную рекламу, используйте событие VKWebAppHideBannerAd.

Баннерная реклама в мини-приложенииБаннерная реклама в мини-приложении
Баннерная реклама в игреБаннерная реклама в игре

Пример

JavaScript
bridge.send('VKWebAppShowBannerAd', { banner_location: 'bottom' }) .then((data) => { if (data.result) { // Баннерная реклама отобразилась } }) .catch((error) => { // Ошибка console.log(error); });

Платформы

Android, iOS, Mobile Web, Web

Параметры

Поле
Тип
Описание
banner_location
string
Расположение баннера по вертикали. Возможные значения:    • top — баннер будет прижат к верху экрана приложения.    • bottom — баннер будет прижат к низу экрана приложения. По умолчанию используется bottom. Значение top работает только для игр, у которых в настройке Отображение → Мобильный формат → Элементы управления указано значение Над окном.
banner_align необязательное
string
Расположение баннера по горизонтали. Используется при следующих условиях:    • Поле layout_type равно overlay.    — и —    • Игра запущена в десктопной версии сайта ВКонтакте.       — или —       Игра запущена на мобильном устройстве,       которое работает в горизонтальной ориентации. Возможные значения:    • left — баннер прижат к левому краю экрана.    • right — баннер прижат к правому краю экрана.     • center — баннер расположен по центру экрана. По умолчанию используется center.
height_type необязательное
string
Компактность баннера. Применяется в играх с горизонтальной ориентацией в мобильном приложении ВКонтакте и мобильной версии сайта. Возможные значения:    • regular — стандартный по высоте баннер.     • compact — баннер с уменьшенной высотой. По умолчанию используется значение regular. Параметр игнорируется при использовании banner_align.
orientation необязательное
string
Ориентация баннера. Используется только для игр, работающих в десктопной версии сайта. На остальных платформах игнорируется. Возможные значения:    • vertical — баннер вытянут по вертикали. Изображение расположено сверху.    • horizontal — баннер вытянут по горизонтали. Изображение расположено слева. По умолчанию используется horizontal.
layout_type необязательное
string
Тип фона баннера. Возможные значения:    • resize — экран игры или мини-приложения станет меньше на размер баннера.    • overlay — баннер будет расположен поверх экрана игры или мини-приложения. Контент не будет сдвинут автоматически. Разработчики должны реализовать сдвиг самостоятельно. Значение работает, только когда поле banner_location равно bottom. По умолчанию используется resize.

Результат

Проверить результат можно:

  • •

    Используя объект Promise, который возвращается вызовом bridge.send(...).

  • •

    С помощью событий VKWebAppShowBannerAdResult и VKWebAppShowBannerAdFailed.

Подробнее о проверке результатов при вызовах VK Bridge.

Объект Promise

Если обращение к платформе прошло успешно, управление будет передано в then-обработчик объекта Promise. В качестве ответа платформа возвращает объект с информацией об отображённом баннере:

Поле
Тип
Описание
result
boolean
true, если баннерная реклама отобразилась, false — в ином случае.
banner_width
integer
Ширина баннера в пикселях.
banner_height
integer
Высота баннера в пикселях.
banner_location
string
Расположение баннера по вертикали. Возможные значения:    • top — баннер прижат к верху экрана приложения.    • bottom — баннер прижат к низу экрана приложения.
banner_align
string
Расположение баннера по горизонтали. Используется при следующих условиях:    • Поле layout_type равно overlay.    — и —    • Игра запущена в десктопной версии сайта ВКонтакте.       — или —       Игра запущена на мобильном устройстве,       которое работает в горизонтальной ориентации. Возможные значения:    • left — баннер прижат к левому краю экрана.    • right — баннер прижат к правому краю экрана.     • center — баннер расположен по центру экрана.
height_type
string
Компактность баннера. Используется в играх с горизонтальной ориентацией в мобильном приложении ВКонтакте и мобильной версии сайта. Возможные значения:    • regular — стандартный по высоте баннер.     • compact — баннер с уменьшенной высотой.
orientation
string
Ориентация баннера. Используется только для игр, работающих в десктопной версии сайта. Возможные значения:    • vertical — баннер вытянут по вертикали. Изображение расположено сверху.    • horizontal — баннер вытянут по горизонтали. Изображение расположено слева.
layout_type
string
Тип фона баннера. Возможные значения:    • resize — экран игры или мини-приложения уменьшен на размер баннера.    • overlay — баннер расположен поверх экрана игры или мини-приложения.

Если при обращении к платформе произошла ошибка, управление передаётся в метод catch. В качестве ответа платформа возвращает объект с информацией об ошибке, общий для всех событий VK Bridge.

События

VKWebAppShowBannerAdResult

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

JavaScript
{ detail: { type: "VKWebAppShowBannerAdResult", data:{ "result" : true, "banner_width": 100, "banner_height": 64, "banner_location": "bottom", "banner_align": "center", "orientation": "horizontal", "layout_type": "resize" } } }

Передаваемый объект подобен объекту, возвращаемому при успешном выполнении промиса.

VKWebAppShowBannerAdFailed

Информирует об ошибке, которая произошла при взаимодействии с платформой, или о том, что баннер не найден или уже показан.

В обработчик события на стороне пользователя передаётся объект с информацией об ошибке, общий для всех методов VK Bridge.

Пример обработки событий

Подробнее — в разделе Обработка результата.

Материалы по теме