Method signature

Method returns a list of supported display formats for banner ads.

List of supported formats depends on:

  • current platform;
  • android OK app version;
  • current mobile device layout.
FAPI.invokeUIMethod("getBannerFormats")

Call example

function getBannerFormats() {
FAPI.invokeUIMethod("getBannerFormats")
}

Callback example

Method’s callback will contain a list of supported display formats, currently selected display format and display option for each format.

method: “getBannerFormats”

result: “ok”

data: ‘{“current”:”bar”,”current_count”:1,”count_options”:[1,2],”supported”:{“bar”:[“top”,”bottom”],”bar_outer”:[“top”,”bottom”],”outer”:[“top”,”bottom”],”thin”:[“top”,”bottom”],”thin_outer”:[“top”,”bottom”],”vertical”:[“left”,”right”],”vertical_outer”:[“left”,”right”]}}’

Where:

  • current - currently selected display format;
  • supported - list of supported display formats with their options;
  • restrictions - list of restrictions for each format;
  • current_count - current amount of banners to show at once;
  • count_options - options for amount of banners to show at once.

Supported formats

At the moment following formats are supported:

FormatDescriptionPlatformsDisplay
options
Supported
layouts
barHorizontal banner displayed on top of game containerdesktop
mobile
android (from 22.11.17)
ios (from 10.50)
top
bottom
landscape
portrait
outer (deprecated)
bar_outer
Horizontal banner displayed which offsets game containerdesktop
mobile
android (from 23.9.4)
ios (from 10.50)
top
bottom
landscape
portrait
thinThin horizontal banner displayed on top of game containerweb
mobile
android (from 24.3.4)
top
bottom
landscape
thin_outerThin horizontal banner displayed which offsets game containerweb
mobile
android (from 24.3.4)
top
bottom
landscape
verticalVertical banner displayed on top of game containerweb
mobile
android (from 24.3.4)
ios (from 10.50)
left
right
landscape
vertical_outerVertical banner displayed which offsets game containerweb
mobile
android (from 24.3.4)
ios (from 10.50)
left
right
landscape