このページは Cloud Translation API によって翻訳されました。

リワードインタースティシャル（ベータ版）

リワードインタースティシャルは、アプリの画面が変わる自然なタイミングで自動的に表示される広告に対して報酬を提供できる、インセンティブ広告フォーマットの一種です。リワード広告とは異なり、ユーザーはリワードインタースティシャルを表示するためにオプトインする必要はありません。

前提条件

スタートガイドを完了している。

必ずテスト広告でテストする

次のサンプルコードには、テスト広告のリクエストに使用できる広告ユニット ID が含まれています。この ID は、すべてのリクエストに対して実際の広告ではなくテスト広告を返すように設定されており、安全に使用できます。

ただし、管理画面でアプリを登録し、アプリで使用する独自の広告ユニット ID を作成したら、開発中に明示的にデバイスをテストデバイスとして設定します。

Android

iOS

Initialize the Mobile Ads SDK

Before loading ads, have your app initialize the Mobile Ads SDK by calling MobileAds.Initialize(). This needs to be done only once, ideally at app launch.

using GoogleMobileAds;
using GoogleMobileAds.Api;

public class GoogleMobileAdsDemoScript : MonoBehaviour
{
    public void Start()
    {
        // Initialize the Google Mobile Ads SDK.
        MobileAds.Initialize((InitializationStatus initStatus) =>
        {
            // This callback is called once the MobileAds SDK is initialized.
        });
    }
}

If you're using mediation, wait until the callback occurs before loading ads as this will ensure that all mediation adapters are initialized.

実装

リワードインタースティシャル広告を実装する主な手順は次のとおりです。

リワードインタースティシャル広告を読み込む
[省略可] サーバー側の検証（SSV）コールバックを検証する
リワードインタースティシャル広告と報酬コールバックを表示する
リワードインタースティシャル広告のイベントをリッスンする
リワードインタースティシャル広告をクリーンアップする
次のリワードインタースティシャル広告をプリロードする

リワードインタースティシャル広告を読み込む

リワードインタースティシャル広告の読み込みは、RewardedInterstitialAd クラスの Load() 静的メソッドを使って行います。読み込みメソッドには、広告ユニット ID、AdRequest オブジェクト、広告の読み込みの成功時または失敗時に呼び出される完了ハンドラが必要です。読み込まれた RewardedInterstitialAd オブジェクトは、完了ハンドラのパラメータとして提供されます。以下の例は、RewardedInterstitialAd を読み込む方法を示しています。


  // These ad units are configured to always serve test ads.
#if UNITY_ANDROID
  private string _adUnitId = "ca-app-pub-3940256099942544/5354046379";
#elif UNITY_IPHONE
  private string _adUnitId = "ca-app-pub-3940256099942544/6978759866";
#else
  private string _adUnitId = "unused";
#endif

  private RewardedInterstitialAd _rewardedInterstitialAd;

  /// <summary>
  /// Loads the rewarded interstitial ad.
  /// </summary>
  public void LoadRewardedInterstitialAd()
  {
      // Clean up the old ad before loading a new one.
      if (_rewardedInterstitialAd != null)
      {
            _rewardedInterstitialAd.Destroy();
            _rewardedInterstitialAd = null;
      }

      Debug.Log("Loading the rewarded interstitial ad.");

      // create our request used to load the ad.
      var adRequest = new AdRequest();
      adRequest.Keywords.Add("unity-admob-sample");

      // send the request to load the ad.
      RewardedInterstitialAd.Load(_adUnitId, adRequest,
          (RewardedInterstitialAd ad, LoadAdError error) =>
          {
              // if error is not null, the load request failed.
              if (error != null || ad == null)
              {
                  Debug.LogError("rewarded interstitial ad failed to load an ad " +
                                 "with error : " + error);
                  return;
              }

              Debug.Log("Rewarded interstitial ad loaded with response : "
                        + ad.GetResponseInfo());

              _rewardedInterstitialAd = ad;
          });
  }

[省略可] サーバー側の検証（SSV）コールバックを検証する

サーバーサイド検証のコールバックで追加データを必要とするアプリでは、リワードインタースティシャル広告のカスタムデータ機能を使用する必要があります。リワード広告オブジェクトに設定されている文字列値は、SSV コールバックの custom_data クエリパラメータに渡されます。カスタムデータ値が設定されていない場合、custom_data クエリパラメータ値は SSV コールバックに含まれません。

次のコードサンプルは、リワードインタースティシャル広告の読み込み後に SSV オプションを設定する方法を示しています。

// send the request to load the ad.
RewardedInterstitialAd.Load(_adUnitId,
                            adRequest,
                            (RewardedInterstitialAd ad, LoadAdError error) =>
    {
        // If the operation failed, an error is returned.
        if (error != null || ad == null)
        {
            Debug.LogError("Rewarded interstitial ad failed to load an ad " +
                           " with error : " + error);
            return;
        }

        // If the operation completed successfully, no error is returned.
        Debug.Log("Rewarded interstitial ad loaded with response : " +
                   ad.GetResponseInfo());
        
        // Create and pass the SSV options to the rewarded ad.
        var options = new ServerSideVerificationOptions
                              .Builder()
                              .SetCustomData("SAMPLE_CUSTOM_DATA_STRING")
                              .Build()
        ad.SetServerSideVerificationOptions(options);
        
});

カスタムのリワード文字列を設定する場合は、広告を表示する前に設定する必要があります。

リワードインタースティシャル広告と報酬コールバックを表示する

広告を表示する際には、ユーザーへの報酬を処理するコールバックを提供する必要があります。広告は読み込みごとに 1 回だけ表示できます。CanShowAd() メソッドを使用して、広告を表示する準備ができていることを確認します。

次のコードは、リワードインタースティシャル広告の最適な表示方法を示しています。

public void ShowRewardedInterstitialAd()
{
    const string rewardMsg =
        "Rewarded interstitial ad rewarded the user. Type: {0}, amount: {1}.";

    if (rewardedInterstitialAd != null && rewardedInterstitialAd.CanShowAd())
    {
        rewardedInterstitialAd.Show((Reward reward) =>
        {
            // TODO: Reward the user.
            Debug.Log(String.Format(rewardMsg, reward.Type, reward.Amount));
        });
    }
}

リワードインタースティシャル広告のイベントをリッスンする

広告の動作をさらにカスタマイズするには、広告のライフサイクルのさまざまなイベントを利用します。以下に示すようにデリゲートを登録して、これらのイベントをリッスンします。

private void RegisterEventHandlers(RewardedInterstitialAd ad)
{
    // Raised when the ad is estimated to have earned money.
    ad.OnAdPaid += (AdValue adValue) =>
    {
        Debug.Log(String.Format("Rewarded interstitial ad paid {0} {1}.",
            adValue.Value,
            adValue.CurrencyCode));
    };
    // Raised when an impression is recorded for an ad.
    ad.OnAdImpressionRecorded += () =>
    {
        Debug.Log("Rewarded interstitial ad recorded an impression.");
    };
    // Raised when a click is recorded for an ad.
    ad.OnAdClicked += () =>
    {
        Debug.Log("Rewarded interstitial ad was clicked.");
    };
    // Raised when an ad opened full screen content.
    ad.OnAdFullScreenContentOpened += () =>
    {
        Debug.Log("Rewarded interstitial ad full screen content opened.");
    };
    // Raised when the ad closed full screen content.
    ad.OnAdFullScreenContentClosed += () =>
    {
        Debug.Log("Rewarded interstitial ad full screen content closed.");
    };
    // Raised when the ad failed to open full screen content.
    ad.OnAdFullScreenContentFailed += (AdError error) =>
    {
        Debug.LogError("Rewarded interstitial ad failed to open " +
                       "full screen content with error : " + error);
    };
}

リワードインタースティシャル広告をクリーンアップする

RewardedInterstitialAd の使用を終えた場合は、その参照を破棄する前に必ず Destroy() メソッドを呼び出してください。

_rewardedInterstitialAd.Destroy();

これにより、オブジェクトが使用されなくなり、占有していたメモリを再利用できることがプラグインに通知されます。このメソッドを呼び出さないと、メモリリークが発生します。

次のリワードインタースティシャル広告をプリロードする

RewardedInterstitialAd は使い捨てオブジェクトです。つまり、一度リワードインタースティシャル広告を表示すると、同じオブジェクトを再度使用することはできません。別のリワードインタースティシャル広告をリクエストするには、新しい RewardedInterstitialAd オブジェクトを読み込む必要があります。

次のインプレッションの機会に備えてリワードインタースティシャル広告を準備するには、OnAdFullScreenContentClosed 広告イベントまたは OnAdFullScreenContentFailed 広告イベントが発生したら、リワードインタースティシャル広告をプリロードします。

private void RegisterReloadHandler(RewardedInterstitialAd ad)
{
    // Raised when the ad closed full screen content.
    ad.OnAdFullScreenContentClosed += ()
    {
        Debug.Log("Rewarded interstitial ad full screen content closed.");

        // Reload the ad so that we can show another as soon as possible.
        LoadRewardedInterstitialAd();
    };
    // Raised when the ad failed to open full screen content.
    ad.OnAdFullScreenContentFailed += (AdError error) =>
    {
        Debug.LogError("Rewarded interstitial ad failed to open " +
                       "full screen content with error : " + error);

        // Reload the ad so that we can show another as soon as possible.
        LoadRewardedInterstitialAd();
    };
}

補足資料

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