此页面由 Cloud Translation API 翻译。

激励广告

所谓激励广告，指的是用户可以选择与之互动来换取的一种广告获取应用内奖励。本指南介绍了如何植入 AdMob 转换为 Unity 应用。

阅读一些客户成功案例：案例研究 1，案例研究 2。

本指南介绍了如何在 Unity 应用中植入激励广告。

前提条件

完成入门指南。

始终使用测试广告进行测试

以下示例代码包含一个广告单元 ID，可用于请求测试广告。该测试广告单元已经过专门配置会返回测试广告制作出来的广告，确保安全使用。

不过，当您在 AdMob 网页界面并创建您自己的广告单元要在您的应用中使用的 ID，请明确将设备配置为测试设备开发。

Android

ca-app-pub-3940256099942544/5224354917

iOS

ca-app-pub-3940256099942544/1712485313

初始化移动广告 SDK

加载广告之前，请先调用 MobileAds.Initialize()。此操作仅需执行一次，最好是在应用启动时执行。

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.
        });
    }
}

如果您使用的是中介功能，请等到回调发生后再按这样可确保初始化所有中介适配器

实现

植入激励广告的主要步骤如下所示：

加载激励广告
[可选] 验证服务器端验证 (SSV) 回调
通过奖励回调展示激励广告
监听激励广告事件
清理激励广告
预加载下一个激励广告

加载激励广告

激励广告的加载是通过在Load() RewardedAd 类。已加载的 RewardedAd 对象是作为参数。以下示例展示了如何加载 RewardedAd。


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

  private RewardedAd _rewardedAd;

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

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

      // create our request used to load the ad.
      var adRequest = new AdRequest();

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

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

              _rewardedAd = ad;
          });
  }

[可选] 验证服务器端验证 (SSV) 回调

在服务器端验证中需要额外数据的应用回调应使用激励广告的自定义数据功能。在激励广告对象上设置的任何字符串值都会传递给 custom_data 查询参数。如果未设置自定义数据值， custom_data 查询参数值不会出现在 SSV 回调中。

以下代码示例演示了如何在激励广告。

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

    // If the operation completed successfully, no error is returned.
    Debug.Log("Rewarded 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);

});

如果您要设置自定义奖励字符串，则必须在显示。

通过奖励回调展示激励广告

展示广告时，您必须提供一个回调来处理奖励用户。每次加载时，广告仅可展示一次。使用 CanShowAd() 方法确认广告已做好展示准备。

以下代码演示了展示激励广告的最佳方法。

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

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

监听激励广告事件

若要进一步自定义您广告的行为，您可以在广告生命周期内加入许多事件，如打开、关闭等等。监听注册 delegate 以控制这些事件，如下所示。

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

清理激励广告

创建完 RewardedAd 后，请确保在放弃对它的引用前调用 Destroy() 方法：

_rewardedAd.Destroy();

这会通知插件该对象已不再使用，以及可收回。此方法调用失败会导致内存泄漏。

预加载下一个激励广告

RewardedAd 是一次性对象。也就是说，在展示激励广告后无法再次使用该对象。若要再请求一个激励广告您需要创建一个新的 RewardedAd 对象。

若要为下一次展示机会准备好激励广告，请在 OnAdFullScreenContentClosed 或 OnAdFullScreenContentFailed 广告事件引发后预加载激励广告。

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

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

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

其他资源

HelloWorld 示例：所有广告格式的最少植入。