Skip to Content
defold-typescript libraries
potatojamdefold-ads-wrapper

potatojam/defold-ads-wrapper/ads_wrapper.ads_networks.admob_legacy

Ads Wrapper legacy network for AdMob on Android and iOS, through the defold/extension-admob extension.

  • GitHub: potatojam/defold-ads-wrapper — pinned to 1.5.1
    1. Pick a release from potatojam/defold-ads-wrapper releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as ads_networks_admob_legacy from "ads_wrapper.ads_networks.admob_legacy"

Functions

setup(params: LuaTable)

Api setup

Parameters

  • params: LuaTable

init(callback?: ads_callback | undefined)

Initializes admob sdk.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

request_idfa(callback?: ads_callback | undefined)

Requests IDFA

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

is_supported(): boolean

Check if the environment supports admob api

Returns

  • boolean

is_initialized(): boolean

Check if the admob is initialized

Returns

  • boolean

show_rewarded(callback?: ads_callback | undefined)

Shows rewarded ads.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

load_rewarded(callback?: ads_callback | undefined)

Loads rewarded ads

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

is_rewarded_loaded(): boolean

Check if the rewarded ads is loaded

Returns

  • boolean

show_interstitial(callback?: ads_callback | undefined)

Shows interstitial ads.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

load_interstitial(callback?: ads_callback | undefined)

Loads interstitial ads

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

is_interstitial_loaded(): boolean

Check if the interstitial ads is loaded

Returns

  • boolean

is_banner_setup(): boolean

Check if the banner is set up

Returns

  • boolean

load_banner(callback?: ads_callback | undefined)

Loads banner. Use ads.T_BANNER parameter.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

unload_banner(callback?: ads_callback | undefined)

Unloads active banner.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

is_banner_loaded(): boolean

Check if the banner is loaded

Returns

  • boolean

show_banner(callback?: ads_callback | undefined)

Shows loaded banner.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

hide_banner(callback?: ads_callback | undefined)

Hides loaded banner.

Parameters

  • callback?: ads_callback | undefined — the function is called after execution.

set_banner_position(position: number): ads_response

Sets banner position. It is imperative to hide and show the banner again after this function. Possible positions: admob.POS_NONE(default) admob.POS_TOP_LEFT admob.POS_TOP_CENTER admob.POS_TOP_RIGHT admob.POS_BOTTOM_LEFT admob.POS_BOTTOM_CENTER admob.POS_BOTTOM_RIGHT admob.POS_CENTER

Parameters

  • position: number — banner position

Returns

  • ads_response

set_banner_size(size: number): ads_response

Sets banner size. It is imperative to reload the banner again after this function. Possible sizes: admob.SIZE_ADAPTIVE_BANNER(default) admob.SIZE_BANNER admob.SIZE_FLUID admob.SIZE_FULL_BANNER admob.SIZE_LARGE_BANNER admob.SIZE_LEADEARBOARD admob.SIZE_MEDIUM_RECTANGLE admob.SIZE_SEARH admob.SIZE_SKYSCRAPER admob.SIZE_SMART_BANNER

Parameters

  • size: number

Returns

  • ads_response

is_banner_showed(): boolean

Check if the banner is showed

Returns

  • boolean

On this page