startapp.load()

Type Function
Return value none
Revision Release 2025.3721
Keywords ads, advertising, StartApp, load
See also startapp.show()
startapp.*

Overview

Preloads a StartApp ad for display upon a future call to startapp.show(). You can also call startapp.isLoaded() to verify that the ad has been loaded.

Syntax

startapp.load( adType )
adType (required)

String. One of the following values: "interstitial", "video", "rewardedVideo", "offerwall".

Example

local startapp = require( "plugin.startapp" )

local function adListener( event )
    if ( event.phase == "init" ) then  -- Successful initialization
        print( event.provider )
        -- Load an StartApp ad
        startapp.load( "interstitial" )
    elseif ( event.phase == "loaded" ) then  -- The ad was successfully loaded
        print( event.type )
    elseif ( event.phase == "failed" ) then  -- The ad failed to load
        print( event.type )
        print( event.isError )
        print( event.response )
    end
end

-- Initialize the StartApp plugin
startapp.init( adListener, { appId="Your App ID" } )