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

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

Ads Wrapper network for AdMob on Android and iOS, through the defold/extension-admob extension, using test ad units in debug mode.

  • 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 from "ads_wrapper.ads_networks.admob"

Functions

_on_event(self: unknown, message_id: number, message?: LuaTable)

Internal. Handles an AdMob extension event. The module registers it with admob.set_callback itself during init and request_idfa, so a project never calls it.

Parameters

  • self: unknown
  • message_id: number
  • message?: LuaTable

setup(params?: LuaTable)

Api setup. Takes the network parameters given to register_network: the unit id for ads_wrapper.T_REWARDED and ads_wrapper.T_INTERSTITIAL, and for ads_wrapper.T_BANNER a table with id and optional size and position. In debug mode AdMob's test unit ids replace them. Cancels every pending operation except an IDFA request.

Parameters

  • params?: LuaTable

is_supported(): boolean

Check if the environment supports admob api: Android or iOS with the extension.

Returns

  • boolean

init(callback?: ads_callback, params?: LuaTable)

Initializes admob sdk.

Parameters

  • callback?: ads_callback
  • params?: LuaTable

is_initialized(): boolean

Check if the admob is initialized

Returns

  • boolean

request_idfa(callback?: ads_callback, params?: LuaTable)

Requests IDFA. Off iOS it succeeds without asking. The response is cached and given to every later call.

Parameters

  • callback?: ads_callback
  • params?: LuaTable

load_rewarded(callback?: ads_callback, params?: LuaTable)

Loads rewarded ads

Parameters

  • callback?: ads_callback
  • params?: LuaTable

is_rewarded_loaded(params?: LuaTable): boolean

Check if the rewarded ads is loaded

Parameters

  • params?: LuaTable

Returns

  • boolean

show_rewarded(callback?: ads_callback, params?: LuaTable)

Shows rewarded ads. The response succeeds when the ad closes after the reward was earned, and is skipped when it closes without one.

Parameters

  • callback?: ads_callback
  • params?: LuaTable

load_interstitial(callback?: ads_callback, params?: LuaTable)

Loads interstitial ads

Parameters

  • callback?: ads_callback
  • params?: LuaTable

is_interstitial_loaded(params?: LuaTable): boolean

Check if the interstitial ads is loaded

Parameters

  • params?: LuaTable

Returns

  • boolean

show_interstitial(callback?: ads_callback, params?: LuaTable)

Shows interstitial ads.

Parameters

  • callback?: ads_callback
  • params?: LuaTable

is_banner_setup(): boolean

Check if the banner is set up

Returns

  • boolean

load_banner(callback?: ads_callback, params?: LuaTable)

Loads banner. Use ads.T_BANNER parameter.

Parameters

  • callback?: ads_callback
  • params?: LuaTable

unload_banner(callback?: ads_callback, params?: LuaTable)

Unloads active banner.

Parameters

  • callback?: ads_callback
  • params?: LuaTable

is_banner_loaded(params?: LuaTable): boolean

Check if the banner is loaded

Parameters

  • params?: LuaTable

Returns

  • boolean

show_banner(callback?: ads_callback, params?: LuaTable)

Shows loaded banner.

Parameters

  • callback?: ads_callback
  • params?: LuaTable

hide_banner(callback?: ads_callback, params?: LuaTable)

Hides loaded banner.

Parameters

  • callback?: ads_callback
  • params?: LuaTable

is_banner_showed(params?: LuaTable): boolean

Check if the banner is showed

Parameters

  • params?: LuaTable

Returns

  • boolean

set_banner_position(position: number): ads_response

Sets the banner position, one of the extension's admob.POS_* constants. It applies the next time the banner is shown.

Parameters

  • position: number

Returns

  • ads_response

set_banner_size(size: number): ads_response

Sets the banner size, one of the extension's admob.SIZE_* constants. It applies the next time the banner is loaded.

Parameters

  • size: number

Returns

  • ads_response

cancel_rewarded(operation?: "load" | "show", reason?: string)

Cancels a pending rewarded load ("load") or show (any other value), completing its callbacks with an error that carries reason.

Parameters

  • operation?: "load" | "show"
  • reason?: string

cancel_interstitial(operation?: "load" | "show", reason?: string)

Cancels a pending interstitial load ("load") or show (any other value), completing its callbacks with an error that carries reason.

Parameters

  • operation?: "load" | "show"
  • reason?: string

cancel_banner(operation?: "load" | "unload", reason?: string)

Cancels a pending banner load ("load") or unload (any other value), completing its callbacks with an error that carries reason.

Parameters

  • operation?: "load" | "unload"
  • reason?: string

Variables

NAME: "admob"

The network's name, "admob", reported as networkName in every response.

On this page