-
Notifications
You must be signed in to change notification settings - Fork 1
API Rererences
Welcome to the MaioSDK-v2-Android wiki!
2.0.0 +
class MaioRequest広告リクエストを表すクラス。
2.0.0 +
constructor(zoneId: String, testMode: Bool)-
zoneId- maio の管理画面から発行されるゾーン識別子
-
testMode- テストモードとしてリクエストするかどうかのフラグ。
true: テストモード有効false: 本番稼働
- テストモードとしてリクエストするかどうかのフラグ。
2.0.0 +
val zoneId: Stringパラメータに与えた、maio の管理画面から発行されるゾーン識別子。
2.0.0 +
val testMode : Booleanパラメータに与えた、テストモードとしてリクエストするかどうかのフラグ。
true: テストモード有効 false: 本番稼働
2.0.0 +
class Interstitialインタースティシャル広告の読み込みと表示を管理するクラス。
static fun loadAd(request: MaioRequest, context: Context, callback: IInterstitialLoadCallback?) -> Interstitial
2.0.0 +
static fun loadAd(request: MaioRequest, context: Context, callback: IInterstitialLoadCallback?) -> Interstitial広告を非同期にロードします。ロードに関するイベントは callback パラメーターに通知されます。
-
request- 広告リクエスト。
-
context- 広告の読み込みに使われる
context。
- 広告の読み込みに使われる
-
callback- 広告の読み込みに関するイベントのコールバック。
生成された Interstitial オブジェクト。
2.0.0 +
fun show(context: Context, callback: IInterstitialShowCallback?)広告を非同期に表示します。表示に関するイベントは callback パラメーターに通知されます。
-
context- 広告表示に使われる
context。
- 広告表示に使われる
-
callback- 広告の表示に関するイベントのコールバック。
2.0.0 +
interface IInterstitialShowCallbackインタースティシャル広告の読み込みに関するコールバックを処理するプロトコル。
2.0.0 +
fun loaded(interstitial: Interstitial)広告の読み込みが完了した時に呼ばれるイベント。
-
interstitial- 呼び出し元の広告インスタンス。
2.0.0 +
fun failed(interstitial: Interstitial, errorCode: Int)広告の読み込みが完了した時に呼ばれるイベント。
-
interstitial- 呼び出し元の広告インスタンス。
-
errorCode- エラー理由を示す値。詳細は
ErrorCodeを参照。
- エラー理由を示す値。詳細は
2.0.0 +
interface IInterstitialShowCallbackインタースティシャル広告の表示に関するコールバックを処理するプロトコル。
2.0.0 +
fun opened(interstitial: Interstitial)広告がオープンされた時に呼ばれるイベント。
-
interstitial- 呼び出し元の広告インスタンス。
2.0.0 +
fun closed(interstitial: Interstitial)広告がクローズされた時に呼ばれるイベント。
-
interstitial- 呼び出し元の広告インスタンス。
2.0.0 +
fun failed(interstitial: Interstitial)広告の表示に失敗した時に呼ばれるイベント。
-
interstitial- 呼び出し元の広告インスタンス。
-
errorCode- エラー理由を示す値。詳細は
ErrorCodeを参照。
- エラー理由を示す値。詳細は
2.0.0 +
class Rewardedリワード広告の読み込みと表示を管理するクラス。
static fun loadAd(request: MaioRequest, context: Context, callback: MaioRewardedLoadCallback?) -> MaioRewarded
2.0.0 +
static fun loadAd(request: MaioRequest, context: Context, callback: MaioRewardedLoadCallback?) -> MaioRewarded広告を非同期にロードします。ロードに関するイベントは callback パラメーターに通知されます。
-
request- 広告リクエスト。
-
context- 広告の読み込みに使われる
context。
- 広告の読み込みに使われる
-
callback- 広告の読み込みに関するイベントのコールバック。
生成された MaioRewarded オブジェクト。
2.0.0 +
fun show(context: Context, callback: MaioRewardedShowCallback?)広告を非同期に表示します。表示に関するイベントは callback パラメーターに通知されます。
-
context- 広告表示に使われる
Context。
- 広告表示に使われる
-
callback- 広告の表示に関するイベントのコールバック。
2.0.0 +
class RewardDataユーザーに与える報酬に関するデータを扱うクラス。
2.0.0 +
val: Stringmaio 管理画面にて当該ゾーンに設定したリワード データ文字列。 未設定の場合は空文字。
2.0.0 +
interface IRewardedLoadCallbackリワード広告の読み込みに関するコールバックを処理するプロトコル。
2.0.0 +
fun loaded(rewarded: Rewarded)広告の読み込みが完了した時に呼ばれるイベント。
-
rewarded- 呼び出し元の広告インスタンス。
2.0.0 +
fun failed(rewarded: Rewarded, errorCode: Int)広告の読み込みが完了した時に呼ばれるイベント。
-
rewarded- 呼び出し元の広告インスタンス。
-
errorCode- エラー理由を示す値。詳細は
ErrorCodeを参照。
- エラー理由を示す値。詳細は
2.0.0 +
interface IRewardedShowCallbackリワード広告の表示に関するコールバックを処理するプロトコル。
2.0.0 +
fun opened(rewarded: Rewarded)広告がオープンされた時に呼ばれるイベント。
-
rewarded- 呼び出し元の広告インスタンス。
2.0.0 +
fun closed(rewarded: Rewarded)広告がクローズされた時に呼ばれるイベント。
-
rewarded- 呼び出し元の広告インスタンス。
2.0.0 +
fun rewarded(rewarded: Rewarded, reward: RewardData)リワード付与のタイミングで通知されるイベント。 リワード動画広告の場合は視聴完了時、リワードプレイアブル広告の場合は広告で定められたタイミングで通知されます。
-
rewarded- 呼び出し元の広告インスタンス。
-
reward- maio 管理画面にてゾーンに設定したリワード データ。
2.0.0 +
fun failed(rewarded: Rewarded, errorCode: Int)広告の表示に失敗した時に呼ばれるイベント。
-
rewarded- 呼び出し元の広告インスタンス。
-
errorCode- エラー理由を示す値。詳細は
ErrorCodeを参照。
- エラー理由を示す値。詳細は
2.0.0 +
class Versionmaio SDK のバージョンを表すオブジェクト。
2.0.0 +
static fun Version.Instance.toString() : StringSDK のバージョンを表す String を返す。
SDK のバージョンを示す、Semantic Versioning 2.0.0 形式の文字列。
2.0.6 +
data class MaioBannerSizeバナー広告のサイズを表すクラス。
2.0.6 +
val BANNER: MaioBannerSize320 x 50 の大きさを表す。
2.0.6 +
val BIG_BANNER: MaioBannerSize320 x 100 の大きさを表す。
2.0.6 +
val MEDIUM_RECTANGLE: MaioBannerSize300 x 250 の大きさを表す。
2.0.6 +
class MaioBannerView : FrameLayoutバナー広告の読み込みと表示を管理するクラス。
2.0.6 +
var zoneId: String?maio の管理画面から発行されるゾーン識別子。
2.0.6 +
var size: MaioBannerSize?要求するバナーのサイズ。
2.0.6 +
var listener: MaioBannerListener?PlayStore をアプリ内で表示する際のベースとなる 。
2.0.6 +
var isReady: Boolバナー広告が読み込み済みかどうかを示すフラグ。true: 読み込み済み false: 未読み込み。
2.0.6 +
init(Context: context, zoneId: String, size: MaioBannerSize? = null)コードベースで MaioBannerView を生成する際に用いるコンストラクタ。
- zoneId
- maio の管理画面から発行されるゾーン識別子
- size
- 要求するバナーのサイズ
2.0.6 +
func load(test: Boolean= false)- testMode
- テストモードとしてリクエストするかどうかのフラグ。true: テストモード有効 false: 本番稼働。
2.0.6 +
fun pause()広告に、一時停止のメッセージを送ります。
2.0.6 +
fun resume()広告に、再開のメッセージを送ります。
2.0.6 +
fun destroy()手動で広告のリソースを破棄します。以後、インスタンスは広告を動作させられません。
2.0.6 +
interface MaioBannerListenerバナー広告に関する通知を受け取るためのプロトコル。
2.0.6 +
optional fun loaded(ad: MaioBannerView)広告の読み込みが完了した時に呼ばれるイベント。
- ad
- 呼び出し元の広告インスタンス
2.0.6 +
optional fun failedToLoad(ad: MaioBannerView, errorCode: Int)広告の読み込みに失敗した時に呼ばれるイベント。
- ad
- 呼び出し元の広告インスタンス
- errorCode
- エラー理由を示す値。詳細は ErrorCode を参照。
2.0.6 +
optional fun impression(ad: MaioBannerView)広告のインプレッションが記録された時に呼ばれるイベント。
- ad
- 呼び出し元の広告インスタンス
2.0.6 +
optional fun clicked(ad: MaioBannerView)広告のクリックが発生した時に呼ばれるイベント。
- ad
- 呼び出し元の広告インスタンス
2.0.6 +
optional fun leftApplication(ad: MaioBannerView)アプリケーションからの離脱が発生した時に呼ばれるイベント。
- ad
- 呼び出し元の広告インスタンス
2.0.6 +
optional fun failedToShow(ad: MaioBannerView, errorCode: Int)広告の表示に失敗した時に呼ばれるイベント。
- ad
- 呼び出し元の広告インスタンス
- errorCode
- エラー理由を示す値。詳細は ErrorCode を参照。
2.0.0 +
ErrorCode = Intコールバックから得られるエラーコード。
- 先頭の数字は発生する場面を表しています。
-
1xxxx: 広告の読み込み時に起こるもの -
2xxxx: 広告の表示時に起こるもの
-
- 各エラーコードの末尾にある
xxは、発生箇所やエラー要因の特定に用います。
| ErrorCode | 意味 |
|---|---|
| 0 | 不明、あるいは公開を想定していないもの。包括的なエラー処理などによって発生する。 |
| 101xx | ネットワーク接続がありません。 |
| 102xx | ネットワーク接続がタイムアウトしました。 |
| 103xx | 広告の取得中に中断されました。 |
| 104xx | サーバーから正しくないレスポンスが返ってきました。 |
| 105xx | 存在しないゾーンが指定されました。 |
| 106xx | 無効なゾーンが指定されました。 |
| 107xx | 表示可能な広告がありません。 |
| 108xx |
MaioRequest が null でした。 |
| 109xx | ディスク容量が不十分でした。 |
| 110xx | 対応していない Android バージョンです。 |
| 111xx | バナーサイズがありません。 |
| 201xx | 広告の有効期限が切れました。 |
| 202xx | 広告の準備ができていません。 |
| 203xx | 広告はすでに表示されています。 |
| 204xx | 広告の再生中に問題が発生しました。 |
| 205xx |
Context が null でした。 |