Skip to content

API Reference

Jump to bottom
moe-ichihara edited this page Dec 6, 2018 · 44 revisions

MaioAds Class

getSdkVersion()
init(Activity activity, String mediaId, MaioAdsListener listener)
initWithNonDefaultMediaId(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

MaioAdsInstance Class

setAdTestMode(boolean testMode)
setMaioAdsListener(MaioAdsListener listener)
canShow()
canShow(String zoneId)
show()
show(String zoneId)

MaioAds Class

getSdkVersion()

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

Version

v1.0.2 以降

Declaration
    public static String getSdkVersion()

init(Activity activity, String mediaId, MaioAdsListener listener)

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

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

  • activity

    アプリのアクティビティ

  • mediaId

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

  • listener

    SDK からの通知を受け取るデリゲート

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

        // SDK準備完了の処理
        @Override
        public void onInitialized() {}

        // 変更時の処理
        @Override
        public void onChangedCanShow(String zoneId, boolean newValue) {}
        
        // 再生直前に呼ばれる処理
        @Override
        public void onOpenAd(String zoneId) {}
        
        // 再生時に呼ばれる処理
        @Override
        public void onStartedAd(String zoneId) {}
        
        // 再生終了時に呼ばれる処理        
        @Override
        public void onFinishedAd(int playtime, boolean skipped, int duration, String zoneId) {}
        
        // 広告が閉じられた際の処理
        @Override
        public void onClosedAd(String zoneId) {}
        
        // 広告クリック時に呼ばれる処理
        @Override
        public void onClickedAd(String zoneId) {}
        
        // エラー時に呼ばれる処理
        @Override
        public void onFailed(FailNotificationReason reason, String zoneId) {}
    });

initWithNonDefaultMediaId(Activity activity, String mediaId, MaioAdsListener listener)

既定でない maio MediaId を使用して SDK の初期化を開始します。

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

  • activity

    アプリのアクティビティ

  • mediaId

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

  • listener

    SDK からの通知を受け取るデリゲート

Example
  MaioAdsInstance maio = MaioAds.initWithNonDefaultMediaId(this, MEDIA_ID, new MaioAdsListener() {

        // SDK準備完了の処理
        @Override
        public void onInitialized() {}

        // 変更時の処理
        @Override
        public void onChangedCanShow(String zoneId, boolean newValue) {}
        
        // 再生直前に呼ばれる処理
        @Override
        public void onOpenAd(String zoneId) {}
        
        // 再生時に呼ばれる処理
        @Override
        public void onStartedAd(String zoneId) {}
        
        // 再生終了時に呼ばれる処理        
        @Override
        public void onFinishedAd(int playtime, boolean skipped, int duration, String zoneId) {}
        
        // 広告が閉じられた際の処理
        @Override
        public void onClosedAd(String zoneId) {}
        
        // 広告クリック時に呼ばれる処理
        @Override
        public void onClickedAd(String zoneId) {}
        
        // エラー時に呼ばれる処理
        @Override
        public void onFailed(FailNotificationReason reason, String zoneId) {}
    });

setAdTestMode(boolean testMode)

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

Declaration
public static void setAdTestMode(boolean testMode)
Parameters

  • testMode

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

Example
    // 広告の配信テスト設定を行います。アプリをリリースする際にはコメントアウトして下さい。
    MaioAds.setAdTestMode(true);

    // 動画広告初期化
    MaioAds.init(this, MEDIA_ID, new MaioAdsListener() {
    });

setMaioAdsListener(MaioAdsListener listener)

maio SDK からの通知を受け取るデリゲートをセットします。

Declaration
    public static void setMaioAdsListener(MaioAdsListener listener)
Parameters

  • listener

    maio SDK から通知を受け取るデリゲート

canShow()

既定のゾーンの広告表示準備が整っていれば true、そうでなければ false を返します。
※ゾーンを１枠のみ運用する場合。

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

canShow(String zoneId)

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

Declaration
    public static boolean canShow(String zoneId)
Parameters

  • zoneId

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

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

show()

既定のゾーンの広告を表示します。
※ゾーンを１枠のみ運用する場合。

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

show(String zoneId)

指定したゾーンの広告を表示します。
※複数のゾーンを運用する場合。

Declaration
    public static void show(String zoneId)
Parameters

  • zoneId

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

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

MaioAdsListener Class

onInitialized()

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

Declaration
public void onInitialized()

onChangedCanShow(String zoneId, boolean newValue)

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

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

  • zoneId

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

  • newValue

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

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

onOpenAd(String zoneId)

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

Declaration
public void onOpenAd(String zoneId)
Parameters

  • zoneId

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

onStartedAd(String zoneId)

広告再生時に呼ばれます。

Declaration
public void onStartedAd(String zoneId)
Parameters

  • zoneId

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

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

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

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

  • zoneId

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

  • playtime

    実際に再生された時間（秒）

  • skipped

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

  • duration

    動画の再生時間（秒）

Example
    public void onFinishedAd(int playtime, boolean skipped, int duration, String zoneId) {
        // TODO: ユーザへのリワード付与処理
    }

onClickedAd(String zoneId)

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

Declaration
public void onClickedAd(String zoneId)
Parameters
  • zoneId

広告がクリックされたゾーンの識別子

onClosedAd(String zoneId)

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

Declaration
public void onClosedAd(String zoneId)
Parameters

  • zoneId

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

onFailed(FailNotificationReason reason, String zoneId)

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

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

  • zoneId

    エラーに関連するゾーンの識別子

  • reason

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

FailNotificationReason Enum

maio SDK のエラー種別（アプリ側への通知内容）

  • AD_STOCK_OUT

    広告在庫切れ

  • RESPONSE

    レスポンスエラー(サーバからのレスポンスの形式に問題がある)

  • NETWORK_NOT_READY

    ネットワークエラー(ネットワークを利用できない)

  • NETWORK

    ネットワークエラー(タイムアウト等の通信エラー全般)

  • UNKNOWN

    不明なエラー(非同期処理中の予期しないエラー、広告を閉じようとしたときにViewが存在していない等)

  • VIDEO

    動画の再生エラー

MaioAdsInstance Class

setAdTestMode(boolean testMode)

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

Declaration
public static void setAdTestMode(boolean testMode)
Parameters

  • testMode

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

setMaioAdsListener(MaioAdsListener listener)

maio SDK からの通知を受け取るデリゲートをセットします。

Declaration
    public static void setMaioAdsListener(MaioAdsListener listener)
Parameters

  • listener

    maio SDK から通知を受け取るデリゲート

canShow()

既定のゾーンの広告表示準備が整っていれば true、そうでなければ false を返します。
※ゾーンを１枠のみ運用する場合。

Declaration
    public static boolean canShow()
Example
  MaioAdsInstance maio = MaioAds.initWithNonDefaultMediaId(this, MEDIA_ID, new MaioAdsListener() 

    ...

    if (maio.canShow()) {
        maio.show();
    }

canShow(String zoneId)

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

Declaration
    public static boolean canShow(String zoneId)
Parameters

  • zoneId

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

Example
    MaioAdsInstance maio = MaioAds.initWithNonDefaultMediaId(this, MEDIA_ID, new MaioAdsListener() 

    ...

    if(maio.canShow(ZONE_ID1)) {
        maio.show(ZONE_ID1);
    }

show()

既定のゾーンの広告を表示します。
※ゾーンを１枠のみ運用する場合。

Declaration
    public static void show()
Example
    MaioAdsInstance maio = MaioAds.initWithNonDefaultMediaId(this, MEDIA_ID, new MaioAdsListener() 

    ...

    if (maio.canShow()) {
        maio.show();
    }

show(String zoneId)

指定したゾーンの広告を表示します。
※複数のゾーンを運用する場合。

Declaration
    public static void show(String zoneId)
Parameters

  • zoneId

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

Example
    MaioAdsInstance maio = MaioAds.initWithNonDefaultMediaId(this, MEDIA_ID, new MaioAdsListener() 

    ...

    if(maio.canShow(ZONE_ID1)) {
        maio.show(ZONE_ID1);
    }
Clone this wiki locally