リワード広告

リワード広告は、ユーザーが広告を操作することと引き換えにアプリ内で報酬を獲得できる広告です。このガイドでは、AdMob のリワード広告を Unity アプリに組み込む方法を説明します。次の成功事例もご覧ください。事例紹介 1、事例紹介 2

Google Mobile Ads SDK には、改善された新しいリワード広告用 API が導入されています。この新しいリワード広告用 API では、以前の API から次の点が改善されています。

• 複数の広告のキャッシュ。以前の実装では一度に 1 つの広告しか読み込めないため、最初の広告が終了するまで次の広告を読み込むことができませんでした。新しいリワード広告用 API では、一度に複数の広告をキャッシュできます。
• 広告を読み込む時点で、報酬値にアクセス。以前の実装では、ユーザーに報酬を付与するときしか報酬にアクセスできませんでした。この点が改善され、AdMob 管理画面で設定された報酬値を使うアプリでは、ユーザーが広告を視聴する前に報酬を示すことが可能になります。
• メディエーション パートナーの初期化。リワード メディエーションを使用する場合、新しいリワード広告用 API では最初の広告を読み込む前にメディエーション アダプタを初期化することができます。以前のリワード広告用 API ではアダプタが初期化されないため、ほとんどの場合はセッションの最初のリクエストでメディエーション アダプタがタイムアウトしていました。

前提条件

• Unity プラグイン 3.16.0 以降
• スタートガイドの手順を完了し、Unity アプリに Google Mobile Ads Unity プラグインをインポートしておく必要があります。

リワード広告オブジェクトを作成する

リワード広告のリクエストと表示には、RewardedAd オブジェクトを使います。リワード広告を表示するための最初のステップは、広告の読み込みに使う広告ユニット ID を指定してコンストラクタを呼び出し、RewardedAd オブジェクトをインスタンス化することです。次のコード スニペットでその方法を示します。

Unity Editor を使用して広告を簡単に組み込むには、新しい広告プレースメント（ベータ版）をお試しください。

using UnityEngine.Events;
using UnityEngine;
using GoogleMobileAds.Api;
using GoogleMobileAds.Common;
using UnityEngine.UI;
using System;
using System.Collections.Generic;

public class GoogleMobileAdsDemoScript : MonoBehaviour
{
    private RewardedAd rewardedAd;
    ...

    public void Start()
    {
        ...

        this.rewardedAd = new RewardedAd(adUnitId);
    }
}

常にテスト広告でテストする

アプリの開発とテストでは必ずテスト広告を使用し、配信中の実際の広告は使用しないでください。実際の広告を使用すると、アカウントが停止される可能性があります。

テスト広告を読み込む際は、次に示すリワード広告（Android と iOS）向けのテスト専用広告ユニット ID を使うと簡単です。

Android

ca-app-pub-3940256099942544/5224354917

iOS

ca-app-pub-3940256099942544/1712485313

この ID は、すべてのリクエストに対してテスト広告を返す特別な ID で、アプリのコーディング、テスト、デバッグで自由に使うことができます。なお、このテスト用 ID は、アプリを公開する前に必ずご自身の広告ユニット ID に置き換えてください。

Mobile Ads SDK のテスト広告の仕組みについて詳しくは、テスト広告をご覧ください。

広告を読み込む

リワード広告を読み込むには、RewardedAd オブジェクトの loadAd() メソッドを呼び出します。このメソッドでは、引数として AdRequest のインスタンスが使用されます。

...
public class GoogleMobileAdsDemoScript : MonoBehaviour
{
    private RewardedAd rewardedAd;
    ...

    public void Start()
    {
        ...

        this.rewardedAd = new RewardedAd(adUnitId);

        // Create an empty ad request.
        AdRequest request = new AdRequest.Builder().Build();
        // Load the rewarded ad with the request.
        this.rewardedAd.LoadAd(request);
    }
}

広告イベント

広告の動作をより細かくカスタマイズするには、広告のライフサイクルで生じるさまざまなイベント（読み込み、開始、終了など）を利用します。適切なイベント ハンドラにデリゲートを登録して、これらのイベントをリッスンします。最も重要なイベントは OnUserEarnedReward で、ユーザーが動画の視聴と引き換えに報酬を受け取るときに呼び出されます。以下に示すように、他の広告イベントを実装することもできます。

using GoogleMobileAds.Api;
...
public class GoogleMobileAdsDemoScript : MonoBehaviour
{
    private RewardedAd rewardedAd;
    ...

    public void Start()
    {
        string adUnitId;
        #if UNITY_ANDROID
            adUnitId = "ca-app-pub-3940256099942544/5224354917";
        #elif UNITY_IPHONE
            adUnitId = "ca-app-pub-3940256099942544/1712485313";
        #else
            adUnitId = "unexpected_platform";
        #endif

        this.rewardedAd = new RewardedAd(adUnitId);

        // Called when an ad request has successfully loaded.
        this.rewardedAd.OnAdLoaded += HandleRewardedAdLoaded;
        // Called when an ad request failed to load.
        this.rewardedAd.OnAdFailedToLoad += HandleRewardedAdFailedToLoad;
        // Called when an ad is shown.
        this.rewardedAd.OnAdOpening += HandleRewardedAdOpening;
        // Called when an ad request failed to show.
        this.rewardedAd.OnAdFailedToShow += HandleRewardedAdFailedToShow;
        // Called when the user should be rewarded for interacting with the ad.
        this.rewardedAd.OnUserEarnedReward += HandleUserEarnedReward;
        // Called when the ad is closed.
        this.rewardedAd.OnAdClosed += HandleRewardedAdClosed;

        // Create an empty ad request.
        AdRequest request = new AdRequest.Builder().Build();
        // Load the rewarded ad with the request.
        this.rewardedAd.LoadAd(request);
    }

    public void HandleRewardedAdLoaded(object sender, EventArgs args)
    {
        MonoBehaviour.print("HandleRewardedAdLoaded event received");
    }

    public void HandleRewardedAdFailedToLoad(object sender, AdErrorEventArgs args)
    {
        MonoBehaviour.print(
            "HandleRewardedAdFailedToLoad event received with message: "
                             + args.Message);
    }

    public void HandleRewardedAdOpening(object sender, EventArgs args)
    {
        MonoBehaviour.print("HandleRewardedAdOpening event received");
    }

    public void HandleRewardedAdFailedToShow(object sender, AdErrorEventArgs args)
    {
        MonoBehaviour.print(
            "HandleRewardedAdFailedToShow event received with message: "
                             + args.Message);
    }

    public void HandleRewardedAdClosed(object sender, EventArgs args)
    {
        MonoBehaviour.print("HandleRewardedAdClosed event received");
    }

    public void HandleUserEarnedReward(object sender, Reward args)
    {
        string type = args.Type;
        double amount = args.Amount;
        MonoBehaviour.print(
            "HandleRewardedAdRewarded event received for "
                        + amount.ToString() + " " + type);
    }
}

OnUserEarnedReward イベントは、特別なイベント引数を提供します。このイベントが渡す Reward のインスタンスには、ユーザーに提供する報酬について説明する Type と Amount が含まれます。

public void HandleUserEarnedReward(object sender, Reward args)
{
    string type = args.Type;
    double amount = args.Amount;
     MonoBehaviour.print(
          "HandleRewardedAdRewarded event received for "
              + amount.ToString() + " " + type);
}

警告: 広告の読み込みに失敗したときに、広告リクエストの完了ブロックから新しい広告の読み込みを試行することは避けてください。広告リクエストの完了ブロックから広告を読み込む必要がある場合は、読み込みの試行回数に制限を設けてください。これは、ネットワーク接続が制限されている場合などに、広告リクエストが連続して失敗することを防ぐためです。

利用できる広告イベント

OnAdLoaded

広告の読み込みが完了すると呼び出されます。

OnAdFailedToLoad

広告の読み込みが失敗すると呼び出されます。提供される AdErrorEventArgs の Message プロパティは、発生した障害のタイプを示します。

OnAdOpening

広告がデバイスの画面いっぱいに表示されると呼び出されます。必要な場合は、ここでアプリの音声出力やゲームループを一時停止します。

OnAdFailedToShow

広告の表示に失敗すると呼び出されます。提供される AdErrorEventArgs の Message プロパティは、発生した障害のタイプを示します。

OnUserEarnedReward

動画を視聴したユーザーに報酬を付与するときに呼び出されます。Reward は、ユーザーに付与される報酬を説明するパラメータです。

OnAdClosed

ユーザーが「閉じる」アイコンまたは「戻る」ボタンをタップして、動画リワード広告を閉じると呼び出されます。アプリで音声出力やゲームループを一時停止している場合は、ここで再開すると効果的です。

広告を表示する

リワード広告をユーザーに表示する前に、リワード広告のコンテンツを視聴して報酬を受け取るかどうか、明確な選択肢をユーザーに提示する必要があります。リワード広告は、必ずユーザーの許可を受けてから表示しなければなりません。

リワード広告を表示するには、広告の読み込みが完了したことを IsLoaded() メソッドで確認してから、show() を呼び出します。以下はその方法の例です。

private void UserChoseToWatchAd()
{
  if (this.rewardedAd.IsLoaded()) {
    this.rewardedAd.Show();
  }
}

OnAdClosed を使用して次のリワード広告をプリロードする

RewardedAd は使い捨てオブジェクトです。つまり、リワード広告を一度表示すると、このオブジェクトを使って他の広告を読み込むことはできません。他のリワード広告をリクエストするには、新しい RewardedAd オブジェクトを作成します。

おすすめの方法は、OnAdClosed 広告イベントで別のリワード広告を読み込んでおき、前のリワード広告の表示が終了したらすぐに次のリワード広告の読み込みを開始できるようにする方法です。

...
public class GoogleMobileAdsDemoScript : MonoBehaviour
{
    private RewardedAd rewardedAd;
    ...

    public void CreateAndLoadRewardedAd()
    {
        #if UNITY_ANDROID
            string adUnitId = "ca-app-pub-3940256099942544/5224354917";
        #elif UNITY_IPHONE
            string adUnitId = "ca-app-pub-3940256099942544/1712485313";
        #else
            string adUnitId = "unexpected_platform";
        #endif

        this.rewardedAd = new RewardedAd(adUnitId);

        this.rewardedAd.OnAdLoaded += HandleRewardedAdLoaded;
        this.rewardedAd.OnUserEarnedReward += HandleUserEarnedReward;
        this.rewardedAd.OnAdClosed += HandleRewardedAdClosed;

        // Create an empty ad request.
        AdRequest request = new AdRequest.Builder().Build();
        // Load the rewarded ad with the request.
        this.rewardedAd.LoadAd(request);
    }

...

    public void HandleRewardedAdClosed(object sender, EventArgs args)
    {
        this.CreateAndLoadRewardedAd();
    }
}

複数のリワード広告を読み込む

複数のリワード広告を読み込むには、広告ごとにリワード広告のオブジェクトを作成するおよび広告を読み込むで説明されている手順を行います。次のコード スニペットは、2 つの異なる広告プレースメントに 2 つのリワード広告を読み込む方法を示しています。

...
public class GoogleMobileAdsDemoScript : MonoBehaviour
{
    private RewardedAd gameOverRewardedAd;
    private RewardedAd extraCoinsRewardedAd;
    ...
    public void Start()
    {
        ...

        this.gameOverRewardedAd = CreateAndLoadRewardedAd(adUnitId);
        this.extraCoinsRewardedAd = CreateAndLoadRewardedAd(adUnitId);
    }

    public RewardedAd CreateAndLoadRewardedAd(string adUnitId)
    {
        RewardedAd rewardedAd = new RewardedAd(adUnitId);

        rewardedAd.OnAdLoaded += HandleRewardedAdLoaded;
        rewardedAd.OnUserEarnedReward += HandleUserEarnedReward;
        rewardedAd.OnAdClosed += HandleRewardedAdClosed;

        // Create an empty ad request.
        AdRequest request = new AdRequest.Builder().Build();
        // Load the rewarded ad with the request.
        rewardedAd.LoadAd(request);
        return rewardedAd;
    }
}

その他のリソース

サンプル

• HelloWorld の例 - すべての広告フォーマットの最小限の実装

今後の流れ

• AdMob 管理画面で独自のバナー広告ユニットを作成します。
• 次のような別の広告フォーマットを試します。
  • バナー
  • インタースティシャル