Banner

You are reading the documentation for Bridge SDK v2. If you need the obsolete v1 documentation, see Documentation (v1).

Banners are persistent ads pinned to the top or bottom of the screen. Use them on idle screens — main menu, lobby, pause overlay — and hide them during active gameplay.

When to use

You have a stable UI region where a banner won't overlap with controls.
You want medium-tier passive monetization without interrupting the player.
For more flexible placements (multiple banners, custom positions, responsive layouts) use Advanced Banners instead.

Configuration

Banner settings live in the config under the advertisement.banner key.

{
    "advertisement": {
        "banner": {
            "disable": false, // disable banners entirely
            "placementFallback": "main_menu", // placement used when showBanner() is called without one
            "placements": [ // map a game-level placement id to native placement ids, keyed by platform id
                { "id": "main_menu", "yandex": "native_placement_id" }
            ]
        }
    }
}

Is Banner Supported

Check this before reserving screen space or showing banner UI. Hide banner areas on platforms that do not support banners.

bridge.advertisement.isBannerSupported

Platform support · 11 of 26 platforms

Supports: crazy_games, dlightek, facebook, game_distribution, gamepush, jio_games, msn, ok, vk, xiaomi, yandex

Does not support: discord, gamesnacks, huawei, lagged, microsoft_store, playdeck, playgama, poki, portal, reddit, samsung, telegram, tiktok, y8, youtube

Show Banner

Show a banner in a stable UI area where it will not overlap gameplay controls.

let position = 'bottom' // optional, 'top' | 'bottom', default = bottom
let placement = 'test_placement' // optional
bridge.advertisement.showBanner(position, placement)

private void Start()
{
    var position = BannerPosition.Bottom; // optional, 'Top' | 'Bottom', default = Bottom
    var placement = "test_placement"; // optional
    Bridge.advertisement.ShowBanner(position, placement);
}

Add the PlaygamaBridge Show Banner action (e.g. on System → On start of layout). Parameters:

Position Top | Bottom
Placement (optional)

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-start-of-layout","objectClass":"System"}],"actions":[{"id":"show-banner","objectClass":"PlaygamaBridge","parameters":{"position":"bottom","placement":"\"test_placement\""}}]}]}

Add the Show Banner action (e.g. on At the beginning of the scene). Parameters:

Position (top | bottom)
Placement (optional)

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"DepartScene"},"parameters":[""]}],"actions":[{"type":{"value":"PlaygamaBridge::ShowBanner"},"parameters":["","\"bottom\"","\"test_placement\"",""]}]}],"eventsCount":1,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

local bridge = require("bridge.bridge")

function init(self)
	local position = "bottom" -- optional, "top" | "bottom", default = "bottom"
	local placement = "test_placement" -- optional
	bridge.advertisement.show_banner(position, placement)
end

Hide Banner

Hide the current banner before gameplay resumes or when the screen no longer has safe space for it.

bridge.advertisement.hideBanner()

Banner State

Track banner state to adjust layout, avoid empty ad space, and debug failed loads.

bridge.advertisement.bannerState

// Listen for banner state changes
bridge.advertisement.on(bridge.EVENT_NAME.BANNER_STATE_CHANGED, state => {
    console.log('Banner state: ', state)
})

Possible values: loading, shown, hidden, failed.

Bridge.advertisement.bannerState

Possible values: Loading, Shown, Hidden, Failed.

// To track banner state changes, subscribe to the event
private void Start()
{
    Bridge.advertisement.bannerStateChanged += OnBannerStateChanged;
}

private void OnBannerStateChanged(BannerState state)
{
    Debug.Log(state);
}

Bridge.advertisement.banner_state

Returns the current state of the banner. Possible values: loading, shown, hidden, failed.

# To track banner state changes, connect to the signal
func _ready():
    Bridge.advertisement.connect("banner_state_changed", self, "_on_banner_state_changed")

func _on_banner_state_changed(state):
    print(state)

# To track banner state changes, connect to the signal
func _ready():
    Bridge.advertisement.connect("banner_state_changed", Callable(self, "_on_banner_state_changed"))

func _on_banner_state_changed(state):
    print(state)

playgama_bridge_advertisement_banner_state()

// Listen for banner state changes

// via Async Social Event
if async_load[? "type"] == "playgama_bridge_advertisement_banner_state_changed" {
    switch async_load[? "data"] {
        case "loading":
            // your logic here
            break
        case "shown":
            // your logic here
            break
        case "hidden":
            // your logic here
            break
        case "failed":
            // your logic here
            break
    }
}

Possible values: loading, shown, hidden, failed.

bridge.advertisement.banner_state()

local bridge = require("bridge.bridge")

function init(self)
	bridge.advertisement.on("banner_state_changed", function (_, state)
		print("Banner state changed: ", state)
	end)
end

Possible values: loading, shown, hidden, failed.

bridge.advertisement.bannerState

bridge.advertisement.on(EVENT_NAME.BANNER_STATE_CHANGED, this.onBannerStateChanged.bind(this));

onBannerStateChanged(state: BANNER_STATE) {
   console.log('Banner state: ', state)
}

Possible values: loading, shown, hidden, failed.

PreviousRewarded NextAdvanced Banners

Last updated 11 days ago