Skip to content

Get Started

Jump to bottom
Ichiro Dohi edited this page May 22, 2017 · 13 revisions

1. Unity による Plugin の設定

1.1 Unity によるプロジェクトの作成

1.1.1 新規にプロジェクトを作成します。

1.1.2 必須項目を入力します。この例では以下のように入力します。

項目 入力値
Project name MaioUnitySample
3D / 2D 2D

1.1.3 [Create]をクリックし、 プロジェクトを作成します。

1.2 Maio Plugin をプロジェクトに追加する

1.2.1 プロジェクトを開いた位状態で maio.unitypackage を開きます。

1.2.2 全てにチェックが入っていることを確認し、[Import]をクリックします。

1.2.3 Plugins/iOS に Maio.framework、Plugins/Android に maio.aar が含まれていることを確認してください。

各SDKが最新版でない場合、以下より最新版を取得し、上書きしてください。

2. 広告の表示方法

2.1 コードの実装例

  • 初期化を行うコードと、視聴完了時のイベントを登録します。
// Sample01.cs

using UnityEngine;
using System.Collections;

public class Sample01 : MonoBehaviour
{
    #if UNITY_IOS
    public const string MaioMediaId = "DemoPublisherMedia";
    #elif UNITY_ANDROID
    public const string MaioMediaId = "DemoPublisherMediaForAndroid";
    #else
    public const string MaioMediaId = "DemoPublisherMedia";
    #endif

    // Use this for initialization
    void Start ()
    {
        // イベントの登録を行います。
	// これによって、Plugin からのイベント通知を取得することが可能になります。
	Maio.OnFinishedAd += OnFinishedAd;

	// 広告の配信テスト設定を行います。アプリをリリースする際にはコメントアウトしてください。
	Maio.SetAdTestMode (true);
	// maio SDKの初期化を開始します。
	// MaioMediaId は、Maio管理画面より割り当てられたメディアIDに差し替えてください。
	Maio.Start (MaioMediaId);

        // ... 略 ...

    }

    // ... 略 ...

}
  • 再生ボタンの実装と、動画再生後のリワードを付与する処理を宣言します。
    // ... 略 ...

    // エディタ上のこのメソッドに紐付けられたボタンがタップされた際に呼び出されます。
    public void OnShowAd()
    {
        if (Maio.CanShow())
        {
	    Maio.Show();
	}
    }

    // 広告表示完了時に呼び出すイベントを設定します。
    // これによって、Plugin からのイベント通知を取得することが可能になります。
    // 本メソッドは、ユーザが動画を見終わった直後に呼び出されます。  
    // ”skipped”が”false”であれば最後まで動画が再生された事を示しますので、  
    // その際にユーザに報酬を付与する事が可能になります。  
    public void OnFinishedAd(string zoneId,
        int playtime,
        bool skipped,
        string rewardParam)
    {
    }

    // ... 略 ...
  • シーンが遷移する際に紐付けられたイベントを解放します。
    // ... 略 ...

    // このゲームオブジェクトが破壊される際に呼び出されます。
    public void OnDestroy()
    {
        // ゲームオブジェクトが破壊される際に、イベントを解放します。
	Maio.OnFinishedAd -= HandleOnFinishedAd;
    }

    // ... 略 ...

3. 各種イベントを受け取る

イベントを設定することで、 Plugin からのイベント通知を取得することが可能になります。 イベントの設定方法に関しては、「2.1 コードの実装例」をご参照ください。

  • 広告表示準備完了時に呼ばれるイベント
/// <summary>
/// 全てのゾーン（広告スポット）の広告表示準備が完了した際に呼ばれます。
/// </summary>
public void OnInitialized()
{
    // 広告表示準備完了時の処理
}
  • 広告配信可能状態の変更時に呼ばれるメソッド
/// <summary>
/// 広告の配信可能状態が変更された際に呼ばれます。
/// </summary>
/// <param name="zoneId">広告の配信可能状態が変更されたゾーンの識別子</param>
/// <param name="newValue">変更後のゾーンの状態 ※YESの場合配信可能</param>
public void OnChangedCanShow(string zoneId, bool newValue)
{
    // 変更時の処理
}
  • 動画広告再生直前に呼ばれるメソッド
/// <summary>
/// 動画が再生される直前に呼ばれます。  
/// 最初の再生開始の直前にのみ呼びだされ、リプレイ再生の直前には呼ばれません。
/// </summary>
/// <param name="zoneId">広告が表示されるゾーンの識別子</param>
public void OnStartAd(string zoneId)
{
    // 再生直前に呼ばれる処理
}
  • 広告再生終了時に呼ばれるメソッド
/// <summary>
/// 広告の再生が終了したら呼ばれます。
/// 最初の再生終了時にのみ呼ばれ、リプレイ終了時には呼ばれません。
/// </summary>
/// <param name="zoneId">広告を表示したゾーンの識別子</param>
/// <param name="playtime">動画の再生時間（秒）</param>
/// <param name="skipped">動画がスキップされているかどうか。されていたらtrue,それ以外ではfalse</param>
/// <param name="rewardParam">ゾーン（広告枠）の広告タイプがリワード型に設定されている場合、
/// 						  予め管理画面にて設定してある任意の文字列パラメータが渡されます。
/// 						  それ以外の場合はnullが渡されます。</param>
public void OnFinishedAd(string zoneId, 
    int playtime,
    bool skipped,
    string rewardParam)
{
    // 再生終了時に呼ばれる処理
}
  • 広告がクリックされた際に呼ばれるメソッド
/// <summary>
/// 広告がクリックされ、AppStoreや外部リンクへ遷移した際に呼ばれます。
/// </summary>
/// <param name="zoneId">広告がクリックされたゾーンの識別子</param>
public void OnClickedAd(string zoneId)
{
    // 広告がクリックされた際に呼び出される処理
}
  • 広告が閉じられた際に呼ばれるメソッド
/// <summary>
/// 広告が閉じられた際に呼び出されます。
/// </summary>
/// <param name="zoneId">広告が閉じられたゾーンの識別子</param>
public void OnClosedAd(string zoneId)
{
    // 広告が閉じた際に呼び出される処理
}
  • エラー時に呼ばれるメソッド
/// <summary>
/// エラーが発生した際に呼び出されます。
/// </summary>
/// <param name="zoneId">エラーに関連するゾーンの識別子</param>
/// <param name="reason">エラーの理由を示す列挙値</param>
public void OnFailed(string zoneId, Maio.FailReason reason)
{
    // 広告の取得時にエラーが発生した際に呼び出される処理
}
Clone this wiki locally