Skip to content

API Reference (EN)

Jump to bottom
moe-ichihara edited this page Jul 1, 2019 · 3 revisions

MaioAds Class

getSdkVersion()
init(Activity activity, String mediaId, MaioAdsListener listener)
setAdTestMode(boolean testMode)
setMaioAdsListener(MaioAdsListener listener)
canShow()
canShow(String zoneId)
show()
show(String zoneId)

MaioAdsListener Class

onInitialized()
onChangedCanShow(String zoneId, boolean newValue)
onOpenAd(String zoneId)
onStartedAd(String zoneId)
onFinishedAd(int playtime, boolean skipped, int duration, String zoneId)
onClickedAd(String zoneId)
onClosedAd(String zoneId)
onFailed(FailNotificationReason reason, String zoneId)

FailNotificationReason Enum

MaioAds Class

getSdkVersion()

Get maio SDK version number.

Version

v1.0.2 +

Declaration
    public static String getSdkVersion()

init(Activity activity, String mediaId, MaioAdsListener listener)

Initialize the SDK.

Declaration
    public static void init(Activity activity, String mediaId, MaioAdsListener listener)
Parameters

  • activity

    Application activity

  • mediaId

    The mediaid generated for your application located in the maio dashboard

  • listener

    Listener to capture SDK events

Example
    MaioAds.init(this, MEDIA_ID, new MaioAdsListener() {

        // SDK prepared event
        @Override
        public void onInitialized() {}

        // SDK status change from Can Show video to Cannot Show Video event
        @Override
        public void onChangedCanShow(String zoneId, boolean newValue) {}
        
        // Video about to play event
        @Override
        public void onOpenAd(String zoneId) {}
        
        // Video started event
        @Override
        public void onStartedAd(String zoneId) {}
        
        // Video finished event
        @Override
        public void onFinishedAd(int playtime, boolean skipped, int duration, String zoneId) {}
        
        // Video Endcard closed event
        @Override
        public void onClosedAd(String zoneId) {}
        
        // Video Endcard clicked event
        @Override
        public void onClickedAd(String zoneId) {}
        
        // Error event
        @Override
        public void onFailed(FailNotificationReason reason, String zoneId) {}
    });

setAdTestMode(boolean testMode)

Set SDK to test mode.

Declaration
public static void setAdTestMode(boolean testMode)
Parameters

  • testMode

    To run the SDK in test mode use true, otherwise use false. Set test mode to true while developing your app and false once released to Play Store （default value is false）.

Example
    // Sets SDK to test mode. Comment out when it is time to release your app.
    MaioAds.setAdTestMode(true);

    // SDK inititialize
    MaioAds.init(this, MEDIA_ID, new MaioAdsListener() {
    });

setMaioAdsListener(MaioAdsListener listener)

Set listener to capture SDK events.

Declaration
    public static void setMaioAdsListener(MaioAdsListener listener)
Parameters

  • listener

    Listener to capture SDK events

canShow()

Default zone is ready to show a video ad true is returned, else false is returned. ※Used when running 1 zone.

Declaration
    public static boolean canShow()
Example
    if (MaioAds.canShow()) {
        MaioAds.show();
    }

canShow(String zoneId)

Specified zone is ready to show a video ad true is returned, else false is returned. ※Used when running multiple zones.

Declaration
    public static boolean canShow(String zoneId)
Parameters

  • zoneId

    ZoneId of the zone you want to display a video ad for.

Example
    if(MaioAds.canShow(ZONE_ID1)) {
        MaioAds.show(ZONE_ID1);
    }

show()

Display video ad for default zone. ※Used when running 1 zone.

Declaration
    public static void show()
Example
    if (MaioAds.canShow()) {
        MaioAds.show();
    }

show(String zoneId)

Display video ad for specified zone. ※Used when running multiple zones.

Declaration
    public static void show(String zoneId)
Parameters

  • zoneId

    ZoneId of the zone you want to display a video ad for.

Example
    if(MaioAds.canShow(ZONE_ID1)) {
        MaioAds.show(ZONE_ID1);
    }

MaioAdsListener Class

onInitialized()

Called when all zones have been prepared

Declaration
public void onInitialized()

onChangedCanShow(String zoneId, boolean newValue)

Called when a zones status has changed from Can Show Video to Cannot Show Video

Declaration
public void onChangedCanShow(String zoneId, boolean newValue)
Parameters

  • zoneId

    Status changed zoneId

  • newValue

    Current Status. true = Can Show Video false = Cannot Show Video

Example
void onChangedCanShow(String zoneId, boolean newValue) {
    if(newValue){
        MaioAds.show(zoneId);
    }
}

onOpenAd(String zoneId)

Called when video is about to play. Only called once, not called on replays.

Declaration
public void onOpenAd(String zoneId)
Parameters

  • zoneId

    ZoneId for ad being played

onStartedAd(String zoneId)

Called when video starts.

Declaration
public void onStartedAd(String zoneId)
Parameters

  • zoneId

    ZoneId for ad being played

onFinishedAd(int playtime, boolean skipped, int duration, String zoneId)

Called when video finished playing. Only called once, not called on replays.

Declaration
public void onFinishedAd(int playtime, boolean skipped, int duration, String zoneId)
Parameters

  • zoneId

    ZoneId for ad being played

  • playtime

    Amount of seconds video was actually played

  • skipped

    If video was skipped true else false

  • duration

    Actual video length in seconds

Example
    public void onFinishedAd(int playtime, boolean skipped, int duration, String zoneId) {
        // TODO: code to reward user
    }

onClickedAd(String zoneId)

Called when end card is clicked going to store/website.

Declaration
public void onClickedAd(String zoneId)
Parameters
  • zoneId

ZoneId for clicked ad

onClosedAd(String zoneId)

Called when the ad is closed.

Declaration
public void onClosedAd(String zoneId)
Parameters

  • zoneId

    ZoneId for closed ad

onFailed(FailNotificationReason reason, String zoneId)

Called when there is an SDK error. SDK error are for debugging purpose only.

Declaration
public void onFailed(FailNotificationReason reason, String zoneId)
Parameters

  • zoneId

    Zone that caused error

  • reason

    Reason for error

FailNotificationReason Enum

maio SDK error types

  • AD_STOCK_OUT

    Out of ads

  • RESPONSE

    Problem with response from server

  • NETWORK_NOT_READY

    No network

  • NETWORK

    Network error (timeout, client error etc)

  • UNKNOWN

    Unknown error (threading/async tasks, file server errors etc)

  • VIDEO

    Video ad error

Clone this wiki locally