设置激励广告

请选择平台： Android iOS Unity Flutter Android（旧版）

激励广告助您通过应用内商品，奖励与视频广告、试玩广告和调查问卷互动的用户。

本指南介绍了如何将激励广告植入到 Android 应用中。

准备工作

在继续操作之前，请先完成以下事项：

  • 设置 GMA Next-Gen SDK。
  • 使用测试激励广告单元 ID ca-app-pub-3940256099942544/5224354917。
    • 在构建和测试应用时，请确保使用的是测试广告，而不是实际投放的广告。如果您不使用测试广告单元 ID，Google 可能会暂停您的账号。
    • 在发布应用之前，请将此 ID 替换为您的广告单元 ID。
    • 如需详细了解 GMA Next-Gen SDK 测试广告，请参阅启用测试广告。

了解广告预加载（Beta 版）

GMA Next-Gen SDK 中的广告预加载功能（Beta 版）可自动执行广告加载和缓存操作。

广告预加载具有以下优势：

  • 引用管理：在展示广告之前，系统会保留引用。
  • 自动重新加载：从缓存中检索到广告后，系统会加载新广告。
  • 受管理的重试：在广告加载失败时加载新广告。
  • 过期处理：在广告过期之前刷新广告。
  • 缓存优化：优化缓存顺序，以投放优先级最高的广告。
注意：如需手动加载广告，请参阅加载单个激励广告。

开始预加载广告

如需开始预加载广告，请在应用启动时调用一次 startPreload() 方法。调用 startPreload() 方法后，GMA Next-Gen SDK 会自动预加载广告，并重试预加载配置的失败请求。

以下示例展示了如何开始预加载广告：

Kotlin

val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
RewardedAdPreloader.start(adUnitId, preloadConfig)

Java

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
RewardedAdPreloader.start(adUnitId, preloadConfig);

请将 AD_UNIT_ID 替换为您的广告单元 ID。

上例展示了如何使用广告单元 ID 作为预加载 ID。预加载 ID 是您创建的字符串标识符，用于标识广告预加载配置。如果您的应用需要为同一广告单元 ID 提供多个定位配置，请传递自定义字符串标识符。

获取并展示预加载的广告

当您想展示广告时，请调用 pollAd() 方法。GMA Next-Gen SDK 会检索可用的广告，并在后台自动预加载下一个广告。如果没有可展示的广告，GMA Next-Gen SDK 将不返回任何广告。

当您有可用的广告对象时，请调用 show 方法来展示广告。使用奖励监听器来处理奖励事件。以下示例展示了如何检索和展示预加载的广告：

Kotlin

private fun pollAndShowAd(activity: Activity, adUnitId: String) {
  // Polling returns the next available ad and loads another ad in the background.
  val ad = RewardedAdPreloader.pollAd(adUnitId)
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not available.")
    return
  }

  // Interact with the ad object as needed.
  Log.d(TAG, "Rewarded ad response info: ${ad.getResponseInfo()}")
  ad.adEventCallback =
    object : RewardedAdEventCallback {
      override fun onAdImpression() {
        Log.d(TAG, "Rewarded ad recorded an impression.")
      }
    }
  ad.show(activity) { rewardItem -> Log.d(TAG, "User earned reward: ${rewardItem.amount}") }
}

Java

private void pollAndShowAd(Activity activity, String adUnitId) {
  // Polling returns the next available ad and loads another ad in the background.
  final RewardedAd ad = RewardedAdPreloader.pollAd(adUnitId);

  // Interact with the ad object as needed.
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not available.");
    return;
  }

  Log.d(TAG, "Rewarded ad response info: " + ad.getResponseInfo());
  ad.setAdEventCallback(
      new RewardedAdEventCallback() {
        @Override
        public void onAdImpression() {
          Log.d(TAG, "Rewarded ad recorded an impression.");
        }
      });

  // Show the ad.
  ad.show(
      activity,
      rewardItem -> {
        Log.d(TAG, "User earned reward: " + rewardItem.getAmount());
      });
}

在准备好展示广告之前，请避免调用 pollAd() 方法。如需在不显示广告响应信息的情况下读取该信息，请参阅读取响应信息。

监听广告事件

在展示广告之前，请先监听广告事件。以下示例注册了广告事件的回调：

Kotlin

private fun listenToAdEvents() {
  // Listen for ad events.
  val ad = rewardedAd
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not ready yet.")
    return
  }

  ad.adEventCallback =
    object : RewardedAdEventCallback {
      override fun onAdShowedFullScreenContent() {
        // Rewarded ad did show.
      }

      override fun onAdDismissedFullScreenContent() {
        // Rewarded ad did dismiss.
        rewardedAd = null
      }

      override fun onAdFailedToShowFullScreenContent(
        fullScreenContentError: FullScreenContentError
      ) {
        // Rewarded ad failed to show.
        Log.e(TAG, "Rewarded ad failed to show: ${fullScreenContentError.message}")
      }

      override fun onAdImpression() {
        // Rewarded ad did record an impression.
      }

      override fun onAdClicked() {
        // Rewarded ad did record a click.
      }
    }
}

Java

private void listenToAdEvents() {
  // Listen for ad events.
  if (rewardedAd == null) {
    Log.e(TAG, "Rewarded ad is not ready yet.");
    return;
  }

  rewardedAd.setAdEventCallback(
      new RewardedAdEventCallback() {
        @Override
        public void onAdShowedFullScreenContent() {
          // Rewarded ad did show.
        }

        @Override
        public void onAdDismissedFullScreenContent() {
          // Rewarded ad did dismiss.
          rewardedAd = null;
        }

        @Override
        public void onAdFailedToShowFullScreenContent(
            FullScreenContentError fullScreenContentError) {
          // Rewarded ad failed to show.
          Log.e(TAG, "Rewarded ad failed to show: " + fullScreenContentError.getMessage());
        }

        @Override
        public void onAdImpression() {
          // Rewarded ad did record an impression.
        }

        @Override
        public void onAdClicked() {
          // Rewarded ad did record a click.
        }
      });
}

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

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

以下示例演示了如何在展示广告之前对广告对象设置自定义数据：

Kotlin

RewardedAd.load(
  context,
  AD_UNIT_ID,
  AdRequest.Builder().build(),
  object : RewardedAdLoadCallback() {
    override fun onAdLoaded(ad: RewardedAd) {
      rewardedAd = ad
      val options =
        ServerSideVerificationOptions.Builder().setCustomData("SAMPLE_CUSTOM_DATA_STRING").build()
      rewardedAd?.setServerSideVerificationOptions(options)
    }
  },
)

Java

RewardedAd.load(
    context,
    AD_UNIT_ID,
    new AdRequest.Builder().build(),
    new RewardedAdLoadCallback() {
      @Override
      public void onAdLoaded(RewardedAd ad) {
        rewardedAd = ad;
        ServerSideVerificationOptions options =
            new ServerSideVerificationOptions.Builder()
                .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
                .build();
        rewardedAd.setServerSideVerificationOptions(options);
      }
    });

将 SAMPLE_CUSTOM_DATA_STRING 替换为您的自定义数据。

可选：监听预加载事件

开始预加载广告时，请注册预加载事件，以便在广告预加载成功、预加载失败或广告缓存耗尽时收到通知。

以下示例展示了如何注册预加载广告事件：

Kotlin

val preloadCallback =
  object : PreloadCallback {
    override fun onAdFailedToPreload(preloadId: String, adError: LoadAdError) {
      Log.d(TAG, "Rewarded preload ad $preloadId failed to load with error: ${adError.message}")
    }

    override fun onAdsExhausted(preloadId: String) {
      Log.i(TAG, "Rewarded preload ad $preloadId is not available")
    }

    override fun onAdPreloaded(preloadId: String, responseInfo: ResponseInfo) {
      Log.i(TAG, "Rewarded preload ad $preloadId is available")
    }
  }
val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
RewardedAdPreloader.start(adUnitId, preloadConfig, preloadCallback)

Java

PreloadCallback preloadCallback =
    new PreloadCallback() {
      @Override
      public void onAdFailedToPreload(String preloadId, LoadAdError adError) {
        Log.d(
            TAG,
            String.format(
                "Rewarded preload ad %s failed to load with error: %s",
                preloadId, adError.getMessage()));
      }

      @Override
      public void onAdsExhausted(String preloadId) {
        Log.i(TAG, "Rewarded preload ad " + preloadId + " is not available");
      }

      @Override
      public void onAdPreloaded(String preloadId, ResponseInfo responseInfo) {
        Log.i(TAG, "Rewarded preload ad " + preloadId + " is available");
      }
    };

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
RewardedAdPreloader.start(adUnitId, preloadConfig, preloadCallback);

当广告加载失败时，GMA Next-Gen SDK 会自动预加载广告，并重试预加载配置的失败请求。

可选：检查广告是否可用

如果您需要了解广告是否可用，请检查广告可用性。以下示例用于检查预加载的广告是否可用：

Kotlin

private fun isAdAvailable(adUnitId: String): Boolean {
  return RewardedAdPreloader.isAdAvailable(adUnitId)
}

Java

private boolean isAdAvailable(String adUnitId) {
  return RewardedAdPreloader.isAdAvailable(adUnitId);
}

可选：设置缓冲区空间

缓冲区大小用于控制内存中预加载的广告数量。默认情况下，Google 会优化缓冲区大小，以平衡内存消耗和广告投放延迟时间。您可以设置自定义缓冲区空间，以增加内存中保留的广告数量。我们建议将缓冲区空间设置为两个预加载的广告。

以下示例展示了如何设置缓冲区空间：

Kotlin

val adRequest = AdRequest.Builder(adUnitId).build()
// Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
val preloadConfig = PreloadConfiguration(adRequest, bufferSize = 2)
RewardedAdPreloader.start(adUnitId, preloadConfig)

Java

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
// Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest, 2);
RewardedAdPreloader.start(adUnitId, preloadConfig);

预加载缓存限制

GMA Next-Gen SDK 会针对所有广告单元和预加载 ID 中的预加载广告总数强制执行应用级限制：

  • 默认限制：Google 最多在内存中保留六个预加载的广告。此限制适用于所有格式和预加载 ID。
  • 建议为每个预加载 ID 保留 2 的缓冲区空间。

可选：停止预加载广告

如果您不需要在会话中再次显示特定预加载 ID 的广告，可以停止预加载广告。如需停止加载具有特定预加载 ID 的广告，请使用预加载 ID 调用 destroy() 方法。调用 destroy() 方法会从缓存中移除与预加载 ID 关联的所有预加载广告。

以下示例展示了如何停止预加载广告：

Kotlin

private fun stopPreloading(adUnitId: String) {
  // Stops the preloading and destroy preloaded ads.
  RewardedAdPreloader.destroy(adUnitId)
}

Java

private void stopPreloading(String adUnitId) {
  // Stops the preloading and destroy preloaded ads.
  RewardedAdPreloader.destroy(adUnitId);
}

可选：读取响应信息

读取下一个预加载广告的响应信息，而不从缓存中移除该广告。

以下示例展示了如何读取下一个预加载的广告响应信息：

Kotlin

val responseInfo = RewardedAdPreloader.peekAdResponseInfo(preloadId)
if (responseInfo == null) {
  Log.e(TAG, "Failed to peek ad response info.")
  return
}

Log.d(TAG, "Peeked ad response ID: ${responseInfo.responseId}")

Java

ResponseInfo responseInfo = RewardedAdPreloader.peekAdResponseInfo(preloadId);
if (responseInfo == null) {
  Log.e(TAG, "Failed to peek ad response info.");
  return;
}

Log.d(TAG, "Peeked ad response ID: " + responseInfo.getResponseId());