Skip to content

API Reference

Jump to bottom
Ichiro Dohi edited this page Oct 16, 2017 · 13 revisions

MaioPlugin Class

Methods

MaioListener Class

Methods

FailReason Enum

MaioPlugin Class

Methods

--

setAdTestMode(bool adTestMode)

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

Parameters

  • adTestMode

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

Declaration
static void setAdTestMode(bool adTestMode);

--

getSdkVersion()

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

Declaration
static const char* getSdkVersion();

--

start( const char *mediaId, MaioListener *listener )

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

Parameters

  • mediaId

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

  • listener

    デリゲートを受け取るリスナー

Declaration
static void start(const char *mediaId, MaioListener *listener);

--

canShow()

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

Declaration
static bool canShow();

--

canShow( const char *zoneId )

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

Parameters

  • zoneId

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

Declaration
static bool canShow( const char *zoneId );

--

show()

既定のゾーンの広告を表示します。

Declaration
static void show();

--

show( const char *zoneId )

指定したゾーンの広告を表示します。

Parameters

  • zoneId

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

Declaration
static void show( const char *zoneId );

--

setListener(MaioListener *listener)

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

Parameters

  • listener

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

Declaration
static void setListener(MaioListener *listener);

--

removeListener()

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

Declaration
static void removeListener();

--

MaioListener Class

Methods

--

onInitialized()

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

Declaration
virtual void onInitialized() {};

--

onChangedCanShow( const char *zoneId, const bool newValue )

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

Parameters

  • zoneId

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

  • newValue

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

Declaration
virtual void onChangedCanShow( const char *zoneId, const bool newValue ) {};

--

onStartAd( const char *zoneId )

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

Parameters

  • zoneId

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

Declaration
virtual void onStartAd( const char *zoneId ) {};

--

onFinishedAd( const char *zoneId, const int playtime, const bool skipped, const char *rewardParam )

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

Parameters

  • zoneId

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

  • playtime

    動画の再生時間（秒）

  • skipped

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

  • rewardParam

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

Declaration
virtual void onFinishedAd( const char *zoneId,
                           const int playtime,
                           const bool skipped,
                           const char *rewardParam ) {};

--

onClickedAd( const char *zoneId )

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

Parameters

  • zoneId

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

Declaration
virtual void onClickedAd( const char *zoneId ) {};

--

onClosedAd( const char *zoneId )

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

Parameters

  • zoneId

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

Declaration
virtual void onClosedAd( const char *zoneId ) {};

--

onFailed( const char *zoneId, const FailReason reason )

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

Parameters

  • zoneId

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

  • reason

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

Declaration
virtual void onFailed(const char* &zoneId, const FailReason reason);

FailReason Enum

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

  • Unknown

    不明なエラー

  • AdStockOut

    広告在庫切れ

  • NetworkConnection

    ネットワーク接続エラー

  • NetworkClient

    HTTP status 4xx クライアントエラー

  • NetworkServer

    HTTP status 5xx サーバーエラー

  • Sdk

    SDK エラー

  • VideoPlayback

    動画再生エラー

Clone this wiki locally