Skip to Content
defold-typescript libraries
AGulev

AGulev/defold-extension-unity-ads/unityads

Functions and constants for interacting with UnityAds APIs

  • GitHub: AGulev/defold-extension-unity-ads — pinned to 4.21.1 (released while Defold 1.14.0 was current)
    1. Pick a release from AGulev/defold-extension-unity-ads 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 unityads from "unityads"
  • Asset Portal: defold-extension-unity-ads

Functions

unityads.initialize(game_id: table, callback: function, test_mode: boolean)

Parameters

  • game_id: table
  • callback: function
  • test_mode: boolean

unityads.request_idfa()

unityads.set_callback(callback: function)

Parameters

  • callback: function

unityads.set_debug_mode(is_debug: boolean)

Parameters

  • is_debug: boolean

unityads.get_debug_mode()

unityads.is_initialized()

unityads.is_supported()

unityads.get_version()

unityads.show(placement_id: string)

Parameters

  • placement_id: string

unityads.load_banner(placement_id: string)

Parameters

  • placement_id: string

unityads.unload_banner()

unityads.show_banner()

unityads.hide_banner()

unityads.set_banner_position(position: number)

Parameters

  • position: number

Constants

unityads.MSG_INIT

unityads.MSG_SHOW

unityads.MSG_LOAD

unityads.MSG_BANNER

unityads.MSG_IDFA

unityads.EVENT_COMPLETED

unityads.EVENT_SDK_ERROR

unityads.EVENT_JSON_ERROR

unityads.EVENT_CLICKED

unityads.EVENT_START

unityads.EVENT_LOADED

unityads.EVENT_LEFT_APPLICATION

unityads.EVENT_SKIPPED

unityads.EVENT_NOT_SUPPORTED

unityads.EVENT_STATUS_AUTORIZED

unityads.EVENT_STATUS_DENIED

unityads.EVENT_STATUS_NOT_DETERMINED

unityads.EVENT_STATUS_RESTRICTED

unityads.EVENT_DID_SHOW

unityads.ERROR_INTERNAL

unityads.ERROR_INVALID_ARGUMENT

unityads.ERROR_NOT_INITIALIZED

unityads.ERROR_NOT_READY

unityads.ERROR_VIDEO_PLAYER

unityads.ERROR_NO_CONNECTION

unityads.ERROR_ALREADY_SHOWING

unityads.ERROR_NO_FILL

unityads.ERROR_TIMEOUT

unityads.ERROR_UNKNOWN

unityads.ERROR_NATIVE

unityads.ERROR_WEBVIEW

unityads.ERROR_AD_BLOCKER_DETECTED

unityads.BANNER_POSITION_TOP_LEFT

unityads.BANNER_POSITION_TOP_CENTER

unityads.BANNER_POSITION_TOP_RIGHT

unityads.BANNER_POSITION_BOTTOM_LEFT

unityads.BANNER_POSITION_BOTTOM_CENTER

unityads.BANNER_POSITION_BOTTOM_RIGHT

unityads.BANNER_POSITION_CENTER

unityads.BANNER_POSITION_NONE

On this page

Functionsunityads.initialize(game_id: table, callback: function, test_mode: boolean)unityads.request_idfa()unityads.set_callback(callback: function)unityads.set_debug_mode(is_debug: boolean)unityads.get_debug_mode()unityads.is_initialized()unityads.is_supported()unityads.get_version()unityads.show(placement_id: string)unityads.load_banner(placement_id: string)unityads.unload_banner()unityads.show_banner()unityads.hide_banner()unityads.set_banner_position(position: number)Constantsunityads.MSG_INITunityads.MSG_SHOWunityads.MSG_LOADunityads.MSG_BANNERunityads.MSG_IDFAunityads.EVENT_COMPLETEDunityads.EVENT_SDK_ERRORunityads.EVENT_JSON_ERRORunityads.EVENT_CLICKEDunityads.EVENT_STARTunityads.EVENT_LOADEDunityads.EVENT_LEFT_APPLICATIONunityads.EVENT_SKIPPEDunityads.EVENT_NOT_SUPPORTEDunityads.EVENT_STATUS_AUTORIZEDunityads.EVENT_STATUS_DENIEDunityads.EVENT_STATUS_NOT_DETERMINEDunityads.EVENT_STATUS_RESTRICTEDunityads.EVENT_DID_SHOWunityads.ERROR_INTERNALunityads.ERROR_INVALID_ARGUMENTunityads.ERROR_NOT_INITIALIZEDunityads.ERROR_NOT_READYunityads.ERROR_VIDEO_PLAYERunityads.ERROR_NO_CONNECTIONunityads.ERROR_ALREADY_SHOWINGunityads.ERROR_NO_FILLunityads.ERROR_TIMEOUTunityads.ERROR_UNKNOWNunityads.ERROR_NATIVEunityads.ERROR_WEBVIEWunityads.ERROR_AD_BLOCKER_DETECTEDunityads.BANNER_POSITION_TOP_LEFTunityads.BANNER_POSITION_TOP_CENTERunityads.BANNER_POSITION_TOP_RIGHTunityads.BANNER_POSITION_BOTTOM_LEFTunityads.BANNER_POSITION_BOTTOM_CENTERunityads.BANNER_POSITION_BOTTOM_RIGHTunityads.BANNER_POSITION_CENTERunityads.BANNER_POSITION_NONE