Defold C

Defold C++

dmGameObject

dmGameSystem

dmGraphics

dmResource

dmScript

Defold Lua

Extension

firebase

Version

levelplay

Version: stable

FUNCTIONS
levelplay.set_callback()
levelplay.init()
levelplay.get_sdk_version()
levelplay.set_gdpr_consent()
levelplay.set_ccpa()
levelplay.set_coppa()
levelplay.set_metadata()
levelplay.set_meta_limited_data_use()
levelplay.set_meta_advertiser_tracking()
levelplay.set_dynamic_user_id()
levelplay.set_adapters_debug()
levelplay.validate_integration()
levelplay.launch_test_suite()
levelplay.request_tracking_authorization()
levelplay.get_tracking_authorization_status()
levelplay.create_interstitial_ad()
levelplay.destroy_interstitial_ad()
levelplay.load_interstitial_ad()
levelplay.is_interstitial_ad_ready()
levelplay.show_interstitial_ad()
levelplay.is_interstitial_placement_capped()
levelplay.create_rewarded_ad()
levelplay.destroy_rewarded_ad()
levelplay.load_rewarded_ad()
levelplay.is_rewarded_ad_ready()
levelplay.show_rewarded_ad()
levelplay.is_rewarded_placement_capped()
levelplay.get_reward()
levelplay.create_banner_ad()
levelplay.load_banner_ad()
levelplay.show_banner_ad()
levelplay.hide_banner_ad()
levelplay.pause_banner_auto_refresh()
levelplay.resume_banner_auto_refresh()
levelplay.destroy_banner_ad()

CONSTANTS
MSG_INIT
MSG_INTERSTITIAL
MSG_REWARDED
MSG_BANNER
MSG_TRACKING
EVENT_INIT_SUCCEEDED
EVENT_INIT_FAILED
EVENT_AD_LOADED
EVENT_AD_LOAD_FAILED
EVENT_AD_INFO_CHANGED
EVENT_AD_DISPLAYED
EVENT_AD_DISPLAY_FAILED
EVENT_AD_CLICKED
EVENT_AD_CLOSED
EVENT_AD_REWARDED
EVENT_AD_EXPANDED
EVENT_AD_COLLAPSED
EVENT_AD_LEFT_APPLICATION
EVENT_JSON_ERROR
TRACKING_STATUS_NOT_DETERMINED
TRACKING_STATUS_RESTRICTED
TRACKING_STATUS_DENIED
TRACKING_STATUS_AUTHORIZED
BANNER_SIZE_BANNER
BANNER_SIZE_LARGE
BANNER_SIZE_MEDIUM_RECTANGLE
BANNER_SIZE_LEADERBOARD
BANNER_SIZE_ADAPTIVE
BANNER_POSITION_TOP
BANNER_POSITION_BOTTOM

Functions

levelplay.set_callback()

levelplay.set_callback(callback)

Sets the callback used for all LevelPlay events. Pass nil to remove it.

PARAMETERS

callback

function

self object The script instance that installed the callback.

message_id number One of MSG_INIT, MSG_INTERSTITIAL, MSG_REWARDED, MSG_BANNER, or MSG_TRACKING.

message

table

Event data. Every asynchronous SDK event contains `event`. Events from a created ad object also contain `handle`; pre-creation validation errors do not.

`event`	`number`	An EVENT_* constant, or a TRACKING_STATUS_* constant for MSG_TRACKING.
`handle`	`number`	The ad object that emitted the event.
`error_code`	`number`
`error_message`	`string`
`error_domain`	`string`	Native error domain when supplied by iOS.
`operation`	`string`	Bridge operation associated with a validation error.
`error`	`string`	Serialization error detail for EVENT_JSON_ERROR.
`ad_quality_enabled`	`boolean`	Whether Ad Quality is enabled, when reported during initialization.
`ad_id`	`string`
`ad_unit_id`	`string`
`ad_unit_name`	`string`
`ad_format`	`string`
`placement_name`	`string`
`auction_id`	`string`
`country`	`string`
`ab`	`string`
`segment_name`	`string`
`ad_network`	`string`
`instance_name`	`string`
`instance_id`	`string`
`revenue`	`number`
`precision`	`string`
`encrypted_cpm`	`string`
`creative_id`	`string`
`conversion_value`	`number`	Conversion value when supplied by iOS.
`reward_name`	`string`
`reward_amount`	`number`
`ad_width`	`number`
`ad_height`	`number`
`ad_size_description`	`string`
`ad_size_is_adaptive`	`boolean`

levelplay.init()

levelplay.init(app_key,user_id)

Initializes LevelPlay. Configure privacy before calling this function. Create ad objects only after EVENT_INIT_SUCCEEDED.

PARAMETERS

`app_key`	`string`	Application key from the LevelPlay dashboard. This is not an ad-unit ID.
`user_id`	`string`	Stable application user ID included in the initialization request.

levelplay.get_sdk_version()

levelplay.get_sdk_version()

Returns the native LevelPlay SDK version.

PARAMETERS

None

RETURNS

string

levelplay.set_gdpr_consent(consent)

Passes the user's GDPR consent choice to LevelPlay and supported mediated networks. It does not display a consent form or read another extension's private state. For a custom or non-compatible CMP, call it before init with the collected choice. LevelPlay SDK 7.7.0 and newer automatically reads Google UMP and compatible Google Additional Consent signals, so do not also pass the same choice with this function in that setup.

PARAMETERS

consent boolean

levelplay.set_ccpa()

levelplay.set_ccpa(opted_out)

Passes a US privacy "do not sell or share" choice. True means the user opted out. Call before init.

PARAMETERS

opted_out boolean

levelplay.set_coppa()

levelplay.set_coppa(child_directed)

Sets whether the user is child-directed for COPPA treatment. True flags the user as child-directed. Call before init.

PARAMETERS

child_directed boolean

levelplay.set_metadata()

levelplay.set_metadata(key,value)

Sets an SDK or mediated-network metadata value. Set network-required values before init.

PARAMETERS

`key`	`string`
`value`	`string`

levelplay.set_meta_limited_data_use()

levelplay.set_meta_limited_data_use(enabled,country,state)

Configures Meta Audience Network Limited Data Use before init. This calls Meta's SDK directly and returns false if the Meta adapter is not linked or initialization already started.

PARAMETERS

`enabled`	`boolean`	True supplies the LDU option; false clears Meta data-processing options.
`country`	`number`	Meta country code. Zero, the default, asks Meta to geolocate.
`state`	`number`	Meta state code. Zero, the default, asks Meta to geolocate.

RETURNS

boolean

levelplay.set_meta_advertiser_tracking()

levelplay.set_meta_advertiser_tracking(enabled)

Sets Meta Audience Network's iOS advertiser-tracking flag before init. Returns false on Android, when Meta is not linked, or after initialization starts.

PARAMETERS

enabled boolean

RETURNS

boolean

levelplay.set_dynamic_user_id()

levelplay.set_dynamic_user_id(user_id)

Sets the dynamic user ID used by server-to-server rewarded callbacks. The value must contain 1–64 alphanumeric characters. Call before showing the rewarded ad it should apply to.

PARAMETERS

user_id string

RETURNS

boolean

levelplay.set_adapters_debug()

levelplay.set_adapters_debug(enabled)

Enables or disables mediated-network debug logging. Disable it in production.

PARAMETERS

enabled boolean

levelplay.validate_integration()

levelplay.validate_integration()

Runs the native LevelPlay integration validator.

PARAMETERS

None

levelplay.launch_test_suite()

levelplay.launch_test_suite()

Opens the LevelPlay integration test suite after initialization succeeds. Enable the is_test_suite metadata before init and call this before creating ad objects or invoking other LevelPlay SDK operations.

PARAMETERS

None

levelplay.request_tracking_authorization()

levelplay.request_tracking_authorization()

Requests App Tracking Transparency authorization on iOS 14 or newer. Request it before init when mediation partners should receive the IDFA. The result is sent through MSG_TRACKING. It is a no-op on Android and unsupported iOS versions.

PARAMETERS

None

levelplay.get_tracking_authorization_status()

levelplay.get_tracking_authorization_status()

Returns the current App Tracking Transparency state on iOS, or nil when unsupported.

PARAMETERS

None

RETURNS

number One of TRACKING_STATUS_NOT_DETERMINED, TRACKING_STATUS_RESTRICTED, TRACKING_STATUS_DENIED, or TRACKING_STATUS_AUTHORIZED.

levelplay.create_interstitial_ad()

levelplay.create_interstitial_ad(ad_unit_id,bid_floor)

Creates a reusable interstitial ad object after successful initialization. Its ad-unit ID and optional bid floor are fixed for the object's lifetime. Create it once, then use the returned handle for multiple load/show cycles with the same ad-unit ID and creation configuration.

PARAMETERS

`ad_unit_id`	`string`	Interstitial ad-unit ID from the LevelPlay dashboard.
`bid_floor`	`number`	Optional minimum eCPM in USD. It applies to every load by this object; changing it requires destroying the handle and creating a new object.

RETURNS

number Positive handle, or nil when native creation is rejected.

levelplay.destroy_interstitial_ad()

levelplay.destroy_interstitial_ad(handle)

Permanently releases an interstitial ad object, invalidates its handle, and stops callbacks for it. Do not destroy between ordinary impressions or during load/display when terminal callbacks are still required.

PARAMETERS

handle number

levelplay.load_interstitial_ad()

levelplay.load_interstitial_ad(handle)

Loads the next interstitial impression into an existing object. After an impression closes, call this again on the same handle instead of creating another object.

PARAMETERS

handle number

levelplay.is_interstitial_ad_ready()

levelplay.is_interstitial_ad_ready(handle)

Returns whether the interstitial object has an ad ready to display.

PARAMETERS

handle number

RETURNS

boolean

levelplay.show_interstitial_ad()

levelplay.show_interstitial_ad(handle,placement)

Shows one loaded interstitial impression. The optional placement is a dashboard presentation point, not an ad object, and can be selected separately on every show.

PARAMETERS

`handle`	`number`
`placement`	`string`

levelplay.is_interstitial_placement_capped()

levelplay.is_interstitial_placement_capped(placement)

Returns whether the named interstitial placement has reached its configured cap.

PARAMETERS

placement string

RETURNS

boolean

levelplay.create_rewarded_ad()

levelplay.create_rewarded_ad(ad_unit_id,bid_floor)

Creates a reusable rewarded ad object after successful initialization. Its ad-unit ID and optional bid floor are fixed for the object's lifetime. Create it once, then use the returned handle for multiple load/show cycles with the same ad-unit ID and creation configuration.

PARAMETERS

`ad_unit_id`	`string`	Rewarded ad-unit ID from the LevelPlay dashboard.
`bid_floor`	`number`	Optional minimum eCPM in USD. It applies to every load by this object; changing it requires destroying the handle and creating a new object.

RETURNS

number Positive handle, or nil when native creation is rejected.

levelplay.destroy_rewarded_ad()

levelplay.destroy_rewarded_ad(handle)

Permanently releases a rewarded ad object, invalidates its handle, and stops callbacks for it. Do not destroy between ordinary impressions, and never destroy a displayed rewarded ad before its reward and close callbacks are received.

PARAMETERS

handle number

levelplay.load_rewarded_ad()

levelplay.load_rewarded_ad(handle)

Loads the next rewarded impression into an existing object. After reward and close callbacks complete, call this again on the same handle instead of creating another object.

PARAMETERS

handle number

levelplay.is_rewarded_ad_ready()

levelplay.is_rewarded_ad_ready(handle)

Returns whether the rewarded object has an ad ready to display.

PARAMETERS

handle number

RETURNS

boolean

levelplay.show_rewarded_ad()

levelplay.show_rewarded_ad(handle,placement)

Shows one loaded rewarded impression. The optional placement is a dashboard presentation point, not an ad object, and can be selected separately on every show.

PARAMETERS

`handle`	`number`
`placement`	`string`

levelplay.is_rewarded_placement_capped()

levelplay.is_rewarded_placement_capped(placement)

Returns whether the named rewarded placement has reached its configured cap.

PARAMETERS

placement string

RETURNS

boolean

levelplay.get_reward()

levelplay.get_reward(handle,placement)

Returns the configured reward for the object's default placement or for the supplied placement.

PARAMETERS

`handle`	`number`
`placement`	`string`

RETURNS

table

levelplay.create_banner_ad()

levelplay.create_banner_ad(ad_unit_id,options)

Creates a reusable banner ad view after successful initialization. Its ad-unit ID and all options are fixed for the view's lifetime. Create it once, then load, hide, show, and auto-refresh the same handle until it is permanently destroyed.

PARAMETERS

ad_unit_id string Banner ad-unit ID from the LevelPlay dashboard.

options

table

Creation-time banner configuration. These fields apply to every load and show; changing one requires destroying the handle and creating a new banner.

`size`	`number`	A BANNER_SIZE_* constant. Defaults to BANNER_SIZE_ADAPTIVE.
`position`	`number`	BANNER_POSITION_TOP or BANNER_POSITION_BOTTOM. Defaults to BANNER_POSITION_BOTTOM.
`placement`	`string`	Dashboard placement used for reporting by this banner object.
`bid_floor`	`number`	Minimum eCPM in USD applied to every load by this banner object.
`respect_safe_area`	`boolean`	Whether the banner avoids system bars and display cutouts. Defaults to true.