VKWebAppCheckBannerAd
VKWebAppCheckBannerAd проверяет, что баннерная реклама, открытая событием VKWebAppShowBannerAd, показана в игре или мини-приложении.
- •
- •
Пример
bridge.send('VKWebAppCheckBannerAd')
.then((data) => {
if (data.result) {
// Баннерная реклама отображается в данный момент
}
})
.catch((error) => {
// Ошибка
console.log(error);
});
Платформы
Android, iOS, Mobile Web, Web
Параметры
—
Результат
Проверить результат можно:
- •
Используя объект
Promise, который возвращается вызовомbridge.send(...). - •
С помощью событий
VKWebAppCheckBannerAdResultиVKWebAppCheckBannerAdFailed.
Подробнее о проверке результатов при вызовах 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.
События
VKWebAppCheckBannerAdResult
Сигнализирует, что баннерная реклама показана. В обработчик события на стороне пользователя передаются следующие данные:
{
detail: {
type: "VKWebAppCheckBannerAdResult",
data: {
"result" : true,
"banner_width": 100,
"banner_height": 64,
"banner_location": "bottom",
"banner_align": "center",
"orientation": "horizontal",
"layout_type": "resize"
}
}
}
Передаваемый объект подобен объекту, возвращаемому при успешном выполнении промиса.
VKWebAppCheckBannerAdFailed
Информирует об ошибке, которая произошла при взаимодействии с платформой.
В обработчик события на стороне пользователя передаётся объект с информацией об ошибке, общий для всех методов VK Bridge.
Пример обработки событий
Подробнее — в разделе Обработка результата.
Материалы по теме
- •
- •
- •
- •
- •
