API Reference

MaioExtension Class

Methods

• getSdkVersion():String
• setAdTestMode(isAdTestMode:Boolean):void
• start(mediaId:String, listener:Object):void
• canShow(zoneId:String = ""):Boolean
• show(zoneId:String = ""):void
• setListener(listener:Object):void
• removeListener():void

Maio Listener Invokes

リスナー用オブジェクトについて

Invokes

• onInitialized():void
• onChangedCanShow(zoneId:String, newValue:Boolean):void
• onStartAd(zoneId:String):void
• onFinishedAd(zoneId:String, playtime:int, skipped:Boolean, rewardParam:String):void
• onClickedAd(zoneId:String):void
• onCloseAd(zoneId:String):void
• onFailed(zoneId:String, reason:String):void

FailReason

MaioExtension Class

Methods

--

getSdkVersion():String

maio SDK のバージョンを返します。

Declaration

public static function getSdkVersion():String

--

setAdTestMode(isAdTestMode:Boolean):void

広告の配信テストを行うかどうかを設定します。

Parameters

• adTestMode

  広告のテスト配信を行う場合には true 、 それ以外の場合は false。
  アプリ開発中は true にし、ストアに提出する際は false にしてください。（既定値は false）

Declaration

public static function setAdTestMode(isAdTestMode:Boolean):void

--

start(mediaId:String, listener:Object):void

SDK の初期化を開始します。

Parameters

• mediaId

  管理画面にて発行されるアプリ識別子

• listener

  イベントの通知を受け取るリスナーオブジェクト

Declaration

public static function start(mediaId:String, listener:Object):void

--

canShow(zoneId:String = ""):Boolean

指定したゾーンの広告表示準備が整っていれば true 、そうでなければ false を返します。 ゾーンを指定しない場合、既定のゾーンの広告表示準備を確認します。

Parameters

• zoneId

  広告の表示準備が整っているか確認したいゾーンの識別子

Declaration

public static function canShow(zoneId:String = ""):Boolean

--

show(zoneId:String = ""):void

指定したゾーンの広告を表示します。 ゾーンを指定しない場合、既定のゾーンの広告を表示します。

Parameters

• zoneId

  広告を表示したいゾーンの識別子

Declaration

public static function show(zoneId:String = ""):void

--

setListener(listener:Object):void

イベントを受け取るリスナーをセットします。 イベントを受け取る必要がない場合は、nullを代入してください。

Parameters

• listener

  セットされるイベントリスナー

Declaration

public static function setListener(listener:Object):void

--

removeListener():void

イベントを受け取るリスナーを解除します。

Declaration

public static function removeListener():void

--

Maio Listener Invokes

リスナー用オブジェクトについて

リスナー用のオブジェクトには、無名オブジェクトを利用することができます。 以下のコードをご参考ください。

var listener:Object = {
    "onInitialized" : function()
    {
        // 広告表示準備完了時の処理
    },
    "onChangedCanShow" : function(mediaId:String, newValue:Boolean)
    {
        // 変更時の処理
    },
    "onStartAd": function(zoneId:String)
    {
        // 再生直前に呼ばれる処理
    },
    "onFinishedAd": function(zoneId:String, playtime:int, skipped:Boolean, rewardParam:String)
    {
        // 再生終了時に呼ばれる処理
    },
    "onClickedAd": function(zoneId:String)
    {
        // 広告がクリックされた際に呼び出される処理
    },
    "onCloseAd" : function(zoneId:String)
    {
        // 広告が閉じられた際に呼び出される処理
    },
    "onFailed" : function(zoneId:String, reason:String) {
        // 広告の表示に失敗した際に呼び出されます。
    }
};

Invokes

--

onInitialized():void

全てのゾーンの広告表示準備が完了した際に呼ばれます。

Declaration

function onInitialized():void

--

onChangedCanShow(zoneId:String, newValue:Boolean):void

広告の配信可能状態が変更された際に呼ばれます。

Parameters

• zoneId

  広告の配信可能状態が変更されたゾーンの識別子

• newValue

  変更後のゾーンの状態。true なら配信可能

Declaration

function onChangedCanShow(zoneId:String, newValue:Boolean):void

--

onStartAd(zoneId:String):void

広告が再生される直前に呼ばれます。
最初の再生開始の直前にのみ呼ばれ、リプレイ再生の直前には呼ばれません。

Parameters

• zoneId

  広告が表示されるゾーンの識別子

Declaration

function onStartAd(zoneId:String):void

--

onFinishedAd(zoneId:String, playtime:int, skipped:Boolean, rewardParam:String):void

広告の再生が終了したら呼ばれます。
最初の再生終了時にのみ呼ばれ、リプレイ再生の終了時には呼ばれません。

Parameters

• zoneId

  広告を表示したゾーンの識別子

• playtime

  動画の再生時間（秒）

• skipped

  動画がスキップされていたら true、それ以外なら false

• rewardParam

  ゾーンがリワード型に設定されている場合、予め管理画面にて設定してある任意の文字列パラメータが渡されます。
  それ以外の場合は文字列0が返されます。

Declaration

function onFinishedAd(zoneId:String, playtime:int, skipped:Boolean, rewardParam:String):void

--

onClickedAd(zoneId:String):void

広告がタップされ、ストアや外部リンクへ遷移した時に呼ばれます。

Parameters

• zoneId

  広告がタップされたゾーンの識別子

Declaration

function onClickedAd(zoneId:String):void

--

onCloseAd(zoneId:String):void

広告が閉じられた際に呼ばれます。

Parameters

• zoneId

  広告が閉じられたゾーンの識別子

Declaration

function onCloseAd(zoneId:String):void

--

onFailed(zoneId:String, reason:String):void

SDK 内でエラーを検知した際に呼ばれます。
発生タイミングは不定ですので、ログ出力やエラー計測以外の具体的な処理（ビジネスロジック等）を行わないで下さい。

Parameters

• zoneId

  エラーに関連するゾーンの識別子。
  ネットワークエラーなどゾーンに紐づかないエラーの場合には 空文字 が入ります。

• reason

  エラーの理由を示す列挙値

Declaration

function onFailed(zoneId:String, reason:String):void

FailReason

• maio-iOS-SDK/wiki/API-Reference#MaioFailReason Enum
• maio-Android-SDK/wiki/API-Reference#FailNotificationReason Enum