Advertising

Overview

GamePush allows you to implement the display of advertisements or rewarded videos in the game. Advertising in GamePush is handled using the Ads Manager gp.ads. The manager manages banners on the game page:

ad display
automatic update timer management
advertising frequency showing

tip

To display this section correctly, disable AdBlock.

Ad Manager

The ad manager rules over the banners on the page. Its responsibility consists in displaying ads, managing auto-refresh and ads frequency timers.

Available ad manager properties:

// Is AdBlock enabled
gp.ads.isAdblockEnabled

// Is the banner available
gp.ads.isStickyAvailable
gp.ads.isFullscreenAvailable
gp.ads.isRewardedAvailable
gp.ads.isPreloaderAvailable

// Is the ads playing now
gp.ads.isStickyPlaying
gp.ads.isFullscreenPlaying
gp.ads.isRewardedPlaying
gp.ads.isPreloaderPlaying

// Check enabled advertising overlays
// Countdown overlay before displaying fullscreen ads is enabled
gp.ads.showCountdownOverlay;
// Overlay is enabled for failed display of rewarded video
gp.ads.showRewardedFailedOverlay;

// Can fullscreen ads be shown on the platform before gameplay starts
gp.ads.canShowFullscreenBeforeGamePlay;

You can subscribe for the following basic events:

// Ads show started
gp.ads.on('start', () => {});
// Ads show ended
gp.ads.on('close', (success) => {});

Fullscreen

Fullscreen banner or interstitial is pop-up, often fullscreen skippable (sometimes only after a few seconds) advertising. Usually it is shown in transition between levels. Its displaying is prohibited during the gameplay on many platforms. It is allowed to show only in pause between game sessions.

It is also prohibited during the navigation by the VK Games platform. So, we will consider this a bad practice on other platforms too.

Call example:

// Show fullscreen, returns a promise
gp.ads.showFullscreen();

// Show fullscreen with a countdown overlay before displaying the advertisement
gp.ads.showFullscreen({ showCountdownOverlay: true });

// Showing started
gp.ads.on('fullscreen:start', () => {});
// Showing ended
gp.ads.on('fullscreen:close', (success) => {});

Preloader

Pleloader is a banner that appears when loading the game. On many platforms, it is implemented through Fullscreen, but is not tied to its timers (except for Yandex.Games).

Displaying is allowed only before the start of the game.

Call example:

// Show preloader, returns a promise
gp.ads.showPreloader();

// Showing started
gp.ads.on('preloader:start', () => {});
// Showing ended
gp.ads.on('preloader:close', (success) => {});

Rewarded Video

Rewarded Video is a non-skippable video ad that aims to give the player a reward for watching. It is forbidden to show without a reward.

Call example:

// Show rewarded video, returns a promise
gp.ads.showRewardedVideo();

// Show rewarded video with an option to display an overlay
// in case of an unsuccessful display of the rewarded video
gp.ads.showRewardedVideo({ showFailedOverlay: true });

// Asynchronously
const success = await gp.ads.showRewardedVideo();
if (success) {
    gp.player.add('gold', 5000);
}

// Showing started
gp.ads.on('rewarded:start', () => {});
// Showing ended
gp.ads.on('rewarded:close', (success) => {});
// Reward is received
gp.ads.on('rewarded:reward', () => {});

Sticky banner is a fixed bottom banner. It takes ~50-100px (110px VK Direct Games). The banner must not cover the play region.

In the panel, you can customize the auto-refresh frequency. The banner will be updated according to the specified frequency immediately of the start.

Call example:

// Show the sticky banner, then it will auto-update itself
gp.ads.showSticky();
// Refresh the sticky banner, forced refreshing
gp.ads.refreshSticky();
// Close the sticky banner
gp.ads.closeSticky();

// Open the banner
gp.ads.on('sticky:start', () => {});
// The banner appears on the screen
gp.ads.on('sticky:render', () => {});
// The banner updated
gp.ads.on('sticky:refresh', () => {});
// Close the banner
gp.ads.on('sticky:close', () => {});