Skip to content

API Reference

im-kashi edited this page Dec 2, 2016 · 6 revisions

Maio Class

Properties

Methods

Events

Delegates

Maio Class

Properties

--

SdkVersion

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

Version

v1.0.1 以降

Declaration
public static string SdkVersion { get; }

Methods

--

SetAdTestMode(bool adTestMode)

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

Parameters
  • adTestMode

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

Declaration
public static void SetAdTestMode(bool adTestMode);

--

Start(string mediaId)

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

Parameters
  • mediaId

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

Declaration
public static void Start(string mediaId);

--

CanShow()

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

Declaration
public static bool CanShow();

--

CanShow(string zoneId)

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

Parameters
  • zoneId

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

Declaration
public static bool CanShow(string zoneId);

--

Show()

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

Declaration
public static void show();

--

Show(string zoneId)

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

Parameters
  • zoneId

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

Declaration
public static void Show(string zoneId);

Events

--

OnInitialized

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

Declaration
public static event InitializedEventHandler OnInitialized;
See also

InitializedEventHandler

--

OnChangedCanShow

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

Declaration
public static event ChangedCanShowEventHandler OnChangedCanShow;
See also

ChangedCanShowEventHandler

--

OnStartAd

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

Declaration
public static event StartAdEventHandler OnStartAd;
See also

StartAdEventHandler

--

OnFinishedAd

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

Declaration
public static event FinishedAdEventHandler OnFinishedAd;
See also

FinishedAdEventHandler

--

OnClickedAd

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

Declaration
public static event ClickedAdEventHandler OnClickedAd;
See also

ClickedAdEventHandler

--

OnClosedAd

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

Declaration
public static event ClosedAdEventHandler OnClosedAd;
See also

ClosedAdEventHandler

--

OnFailed

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

Declaration
public static event FailedEventHandler OnFailed;
See also

FailedEventHandler

Delegates

--

InitializedEventHandler

OnInitialized のイベントハンドラです。

Declaration
public delegate void InitializedEventHandler();

--

ChangedCanShowEventHandler

OnChangedCanShow のイベントハンドラです。

Declaration
public delegate void ChangedCanShowEventHandler(string zoneId, bool newValue);

--

StartAdEventHandler

OnStartAd のイベントハンドラです。

Declaration
public delegate void StartAdEventHandler(string zoneId);

--

FinishedAdEventHandler

OnFinishedAd のイベントハンドラです。

Declaration
public delegate void FinishedAdEventHandler
(string zoneId, int playtime, bool skipped, string rewardParam);

--

ClickedAdEventHandler

OnClickedAd のイベントハンドラです。

Declaration
public delegate void ClickedAdEventHandler(string zoneId);

--

ClosedAdEventHandler

OnClosedAd のイベントハンドラです。

Declaration
public delegate void ClosedAdEventHandler(string zoneId);

--

FailedEventHandler

OnFailed のイベントハンドラです。

Declaration
public delegate void FailedEventHandler(string zoneId, FailReason reason);

--

FailReason Enum

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

  • AdStockOut

    広告在庫切れ

  • NetworkConnection

    ネットワーク接続エラー

  • NetworkClient

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

  • NetworkServer

    HTTP status 5xx サーバーエラー

  • Sdk

    SDK エラー

  • DownloadCancelled

    クリエイティブダウンロードのキャンセル

  • VideoPlayback

    動画再生エラー

  • Unknown

    不明なエラー