Plugin導入手順

UnityへのGeniee 動画リワードDFP広告 SDK Unity Plugin導入手順を説明します。

1. Google Mobile Ads Unity pluginをUnityプロジェクトへインポート
2. GNSAdSDKDfpUnityPlugin-X.X.XをUnityプロジェクトへインポート
3. Plugin APIを使用し、動画リワード広告のイベントを登録
4. 動画リワード広告のロード
5. 動画リワード広告の表示
6. 広告の事前呼び出しについて
7. テストデバイスID設定方法
8. Androidパッケージ名について

1. Google Mobile Ads Unity pluginをUnityプロジェクトへインポート

1. https://developers.google.com/admob/unity/startから Mobile Ads Unity pluginをダウンロードしてください。
2. Pluginを組み込むUnityプロジェクトを開きます。
3. メニューバーの Assets -> Import Package -> Custom Packageの順に選択します。
4. ダウンロードしたGoogleMobileAdsPlugin.unitypackageファイルを選択します。
5. すべてのファイルのチェックボックスがオンになっていることを確認して、Import をクリックします。

2. GNSAdSDKDfpUnityPlugin-X.X.XをUnityプロジェクトへインポート

1. Pluginを組み込むUnityプロジェクトを開きます。

2. メニューバーの Assets -> Import Package -> Custom Packageの順に選択します。

3. reward_dfp側のDistフォルダのGNSAdSDKDfpUnityPlugin-X.X.X.unitypackageファイルを選択します。

4. 以下ファイルのチェックボックスがオンになっていることを確認して、Import をクリックします。

   • PlayServicesResolver
     • Editor
       • GNDependencies.xml
   • Plugins
     • Android
       • AndroidManifest.xml
       • GNSExtendsDfpUnityPlayerActivity.jar
       • mainTemplate.gradle

3. Plugin APIを使用し、動画リワード広告のイベントを登録

以下は、動画リワード広告を作成してイベントを登録するために必要なコードです。 イベントを登録する際は、動画のロードをする前に登録処理を完了させてください。

using GoogleMobileAds.Api;

...

static bool isRegistedRewardVideoEventHandler = false;
void RegistRewardVideoAdEventHandler()
{
    if (!isRegistedRewardVideoEventHandler)
    {
        // Get singleton reward based video ad reference.
        RewardBasedVideoAd rewardBasedVideo = RewardBasedVideoAd.Instance;
        // Called when an ad request has successfully loaded.
        rewardBasedVideo.OnAdLoaded += HandleRewardBasedVideoLoaded;
        // Called when an ad request failed to load.
        rewardBasedVideo.OnAdFailedToLoad += HandleRewardBasedVideoFailedToLoad;
        // Called when an ad is shown.
        rewardBasedVideo.OnAdOpening += HandleRewardBasedVideoOpened;
        // Called when the ad starts to play.
        rewardBasedVideo.OnAdStarted += HandleRewardBasedVideoStarted;
        // Called when the user should be rewarded for watching a video.
        rewardBasedVideo.OnAdRewarded += HandleRewardBasedVideoRewarded;
        // Called when the ad is closed.
        rewardBasedVideo.OnAdClosed += HandleRewardBasedVideoClosed;
        // Called when the ad click caused the user to leave the application.
        rewardBasedVideo.OnAdLeavingApplication += HandleRewardBasedVideoLeftApplication;
    }
    isRegistedRewardVideoEventHandler = true;
}
public void HandleRewardBasedVideoLoaded(object sender, EventArgs args)
{
    MonoBehaviour.print("HandleRewardBasedVideoLoaded event received");
}
public void HandleRewardBasedVideoFailedToLoad(object sender, AdFailedToLoadEventArgs args)
{
    MonoBehaviour.print(
        "HandleRewardBasedVideoFailedToLoad event received with message: "
                         + args.Message);
}
public void HandleRewardBasedVideoOpened(object sender, EventArgs args)
{
    MonoBehaviour.print("HandleRewardBasedVideoOpened event received");
}
public void HandleRewardBasedVideoStarted(object sender, EventArgs args)
{
    MonoBehaviour.print("HandleRewardBasedVideoStarted event received");
}
public void HandleRewardBasedVideoClosed(object sender, EventArgs args)
{
    MonoBehaviour.print("HandleRewardBasedVideoClosed event received");
}
public void HandleRewardBasedVideoRewarded(object sender, Reward args)
{
    string type = args.Type;
    double amount = args.Amount;
    RewardBasedVideoAd rewardBasedVideo = RewardBasedVideoAd.Instance;
    MonoBehaviour.print(
        "HandleRewardBasedVideoRewarded event received for "
        + amount.ToString() + " " + type + " " + rewardBasedVideo.MediationAdapterClassName());
}
public void HandleRewardBasedVideoLeftApplication(object sender, EventArgs args)
{
    MonoBehaviour.print("HandleRewardBasedVideoLeftApplication event received");
}

• RewardBasedVideoAdインスタンスは、動画リワード広告を操作するためのシングルトンオブジェクトとなります。
• RewardBasedVideoAdインスタンスがシングルトンオブジェクトのため、イベント重複を避けるためにイベント登録は1回だけにすることを推奨します。

Reward は下記プロパティを所持しています。

public class Reward : EventArgs
{
    // 金額
    public double Amount { get; set; }
    // 種類
    public string Type { get; set; }
}

AdFailedToLoadEventArgs は下記プロパティを所持しています。

public class AdFailedToLoadEventArgs : EventArgs
{
    // メッセージ
    public string Message { get; set; }
}

4. 動画リワード広告のロード

以下は、動画リワード広告のロードに必要なコードです。

using GNSAdSDK.Api;

...

void LoadRewardVideoAd()
{
    string defaultUnitId = "";
#if UNITY_ANDROID
        defaultUnitId = "ここにUnitIdを入れてください";
#elif UNITY_IPHONE
        defaultUnitId = "ここにUnitIdを入れてください";
#endif
    RewardBasedVideoAd rewardBasedVideo = RewardBasedVideoAd.Instance;
    AdRequest request = new AdRequest.Builder()
                               // .AddTestDevice("YOUR_TEST_DEVICE_ID")
                               .Build();
    rewardBasedVideo.LoadAd(request, defaultUnitId);
}

• RewardBasedVideoAdインスタンスは、動画リワード広告を操作するためのシングルトンオブジェクトとなります。
• ロードには数秒以上かかることがあるので、早い段階で動画広告をロードしてください。
• １つの動画の再生完了後に別の動画を見せる場合、再びロードを行う必要があります。

5. 動画リワード広告の表示

以下は、動画リワード広告の表示に必要なコードです。動画のロードが完了されるとShowAd()の呼び出しが可能となります。

using GNSAdSDK.Api;

...

void ShowRewardVideoAd()
{
    RewardBasedVideoAd rewardBasedVideo = RewardBasedVideoAd.Instance;
    // 動画が表示出来るか確認
    if (rewardBasedVideo.IsLoaded())
    {
        // 動画の表示
        rewardBasedVideo.Show();
    }
}

6. 広告の事前呼び出しについて

広告表示後、事前に次の広告をロードしたい場合の注意点

報酬付与イベントHandleRewardBasedVideoRewarded内ではなく、広告クローズイベントHandleRewardBasedVideoClosed内へrewardBasedVideo.LoadAd(request, adUnitId);を実装してください。

7. テストデバイスID設定方法

• 開発中にテスト広告を有効にすることができます。
• テストモードにすることなく、多くの広告をクリックした場合は、アカウントが無効となる危険性があります。
• 本番リリース時にはこの設定を必ず削除してください。

1. 設定するにはまずこのようなメッセージがコンソールまたはlogcat出力を確認します。

OS	出力例
Android	request.testDevices = @[ "YOUR_TEST_DEVICE_ID" ];
iOS	I/Ads: Use AdRequest.Builder.addTestDevice("YOUR_TEST_DEVICE_ID")

2. AddTestDeviceメソッドをRequestに追加します。

AdRequest request = new AdRequest.Builder()
                           .AddTestDevice("YOUR_TEST_DEVICE_ID")
                           .Build();
rewardBasedVideo.LoadAd(request, defaultUnitId);

8. Androidパッケージ名について

Assets/Plugins/Android/AndroidManifest.xml内のpackage名は適宜修正ください。

 package="jp.co.geniee.GNSUnitySampleDfpRewardVideo"