獎勵廣告

獎勵廣告 可讓您以應用程式內商品獎勵與影片廣告、可試玩廣告及問卷調查互動的使用者。

必要條件

• Google Mobile Ads SDK 19.7.0 以上版本。
• 完成入門指南。

請務必使用測試廣告進行測試

建構及測試應用程式時，請務必使用測試廣告，而非實際的正式版廣告。否則可能導致帳戶停權。

如要載入測試廣告，最簡單的方法是使用 Android 獎勵廣告專用的測試廣告單元 ID：

ca-app-pub-3940256099942544/5224354917

這項廣告單元已特別設定為針對每項要求傳回測試廣告，您可以在編寫程式碼、測試及偵錯時，在自己的應用程式中自由使用這項廣告單元。只要在發布應用程式前，將其替換為自己的廣告單元 ID 即可。

如要進一步瞭解 Mobile Ads SDK 的測試廣告運作方式，請參閱「測試廣告」。

載入獎勵廣告物件

注意： 請在主執行緒上發出所有 Mobile Ads SDK 呼叫。

如要載入獎勵廣告，請在 RewardedAd 類別上呼叫靜態 load() 方法，並傳入 RewardedAdLoadCallback。這通常是在 Activity 的 onCreate() 方法中執行。請注意，與其他格式載入回呼一樣，RewardedAdLoadCallback 會利用 LoadAdError 提供更精確的錯誤詳細資料。

Java

import com.google.android.gms.ads.rewarded.RewardedAd;

public class MainActivity extends Activity {
  private RewardedAd rewardedAd;
  private final String TAG = "MainActivity";

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    AdRequest adRequest = new AdRequest.Builder().build();
    RewardedAd.load(this, "ca-app-pub-3940256099942544/5224354917",
      adRequest, new RewardedAdLoadCallback() {
        @Override
        public void onAdFailedToLoad(@NonNull LoadAdError loadAdError) {
          // Handle the error.
          Log.d(TAG, loadAdError.toString());
          rewardedAd = null;
        }

        @Override
        public void onAdLoaded(@NonNull RewardedAd ad) {
          rewardedAd = ad;
          Log.d(TAG, "Ad was loaded.");
        }
    });
  }
}

Kotlin

class MainActivity : AppCompatActivity() {

  private var rewardedAd: RewardedAd? = null
  private final var TAG = "MainActivity"

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
    var adRequest = AdRequest.Builder().build()
    RewardedAd.load(this,"ca-app-pub-3940256099942544/5224354917", adRequest, object : RewardedAdLoadCallback() {
      override fun onAdFailedToLoad(adError: LoadAdError) {
        Log.d(TAG, adError?.toString())
        rewardedAd = null
      }

      override fun onAdLoaded(ad: RewardedAd) {
        Log.d(TAG, "Ad was loaded.")
        rewardedAd = ad
       }
    })
  }
}

提示：您可以在要顯示預先載入的廣告之前，使用廣告載入呼叫建立快取，這樣一來，在需要時就能立即顯示廣告。由於廣告會在一小時後到期，因此您應每小時清除快取，並重新載入新的廣告。

設定 FullScreenContentCallback

FullScreenContentCallback 會處理與顯示 RewardedAd 相關的事件。顯示 RewardedAd 前，請務必設定回呼，如下所示：

Java

rewardedAd.setFullScreenContentCallback(new FullScreenContentCallback() {
  @Override
  public void onAdClicked() {
    // Called when a click is recorded for an ad.
    Log.d(TAG, "Ad was clicked.");
  }

   @Override
  public void onAdDismissedFullScreenContent() {
    // Called when ad is dismissed.
    // Set the ad reference to null so you don't show the ad a second time.
    Log.d(TAG, "Ad dismissed fullscreen content.");
    rewardedAd = null;
  }

  @Override
  public void onAdFailedToShowFullScreenContent(AdError adError) {
    // Called when ad fails to show.
    Log.e(TAG, "Ad failed to show fullscreen content.");
    rewardedAd = null;
  }

  @Override
  public void onAdImpression() {
    // Called when an impression is recorded for an ad.
    Log.d(TAG, "Ad recorded an impression.");
  }

  @Override
  public void onAdShowedFullScreenContent() {
    // Called when ad is shown.
    Log.d(TAG, "Ad showed fullscreen content.");
  }
});

Kotlin

rewardedAd?.fullScreenContentCallback = object: FullScreenContentCallback() {
  override fun onAdClicked() {
    // Called when a click is recorded for an ad.
    Log.d(TAG, "Ad was clicked.")
  }

  override fun onAdDismissedFullScreenContent() {
    // Called when ad is dismissed.
    // Set the ad reference to null so you don't show the ad a second time.
    Log.d(TAG, "Ad dismissed fullscreen content.")
    rewardedAd = null
  }

  override fun onAdFailedToShowFullScreenContent(adError: AdError?) {
    // Called when ad fails to show.
    Log.e(TAG, "Ad failed to show fullscreen content.")
    rewardedAd = null
  }

  override fun onAdImpression() {
    // Called when an impression is recorded for an ad.
    Log.d(TAG, "Ad recorded an impression.")
  }

  override fun onAdShowedFullScreenContent() {
    // Called when ad is shown.
    Log.d(TAG, "Ad showed fullscreen content.")
  }
}

顯示廣告

顯示獎勵廣告時，您會使用 OnUserEarnedRewardListener 物件處理獎勵事件。

Java

if (rewardedAd != null) {
  Activity activityContext = MainActivity.this;
  rewardedAd.show(activityContext, new OnUserEarnedRewardListener() {
    @Override
    public void onUserEarnedReward(@NonNull RewardItem rewardItem) {
      // Handle the reward.
      Log.d(TAG, "The user earned the reward.");
      int rewardAmount = rewardItem.getAmount();
      String rewardType = rewardItem.getType();
    }
  });
} else {
  Log.d(TAG, "The rewarded ad wasn't ready yet.");
}

Kotlin

rewardedAd?.let { ad ->
  ad.show(this, OnUserEarnedRewardListener { rewardItem ->
    // Handle the reward.
    val rewardAmount = rewardItem.amount
    val rewardType = rewardItem.type
    Log.d(TAG, "User earned the reward.")
  })
} ?: run {
  Log.d(TAG, "The rewarded ad wasn't ready yet.")
}

[選用] 驗證伺服器端驗證 (SSV) 回呼

如果應用程式需要在伺服器端驗證回呼中使用額外資料，則應使用獎勵廣告的客製資料功能。獎勵廣告物件上設定的任何字串值，都會傳遞至 SSV 回呼的 custom_data 查詢參數。如果未設定自訂資料值，SSV 回呼中就不會顯示 custom_data 查詢參數值。

以下程式碼範例示範如何在要求廣告前，在獎勵廣告物件上設定自訂資料。

Java

RewardedAd.load(MainActivity.this, "ca-app-pub-3940256099942544/5354046379",
    new AdRequest.Builder().build(),  new RewardedAdLoadCallback() {
  @Override
  public void onAdLoaded(RewardedAd ad) {
    Log.d(TAG, "Ad was loaded.");
    rewardedAd = ad;
    ServerSideVerificationOptions options = new ServerSideVerificationOptions
        .Builder()
        .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
        .build();
    rewardedAd.setServerSideVerificationOptions(options);
  }
  @Override
  public void onAdFailedToLoad(LoadAdError loadAdError) {
      Log.d(TAG, loadAdError.toString());
      rewardedAd = null;
  }
});

Kotlin

RewardedAd.load(this, "ca-app-pub-3940256099942544/5354046379",
    AdRequest.Builder().build(), object : RewardedAdLoadCallback() {
  override fun onAdLoaded(ad: RewardedAd) {
    Log.d(TAG, "Ad was loaded.")
    rewardedInterstitialAd = ad
    val options = ServerSideVerificationOptions.Builder()
        .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
        .build()
    rewardedAd.setServerSideVerificationOptions(options)
  }

  override fun onAdFailedToLoad(adError: LoadAdError) {
      Log.d(TAG, adError?.toString())
      rewardedAd = null
  }
})

如要設定自訂獎勵字串，請務必在顯示廣告前設定。

重點： 自訂獎勵字串會以百分比轉義，因此在從 SSV 回呼中剖析時，可能需要解碼。

常見問題

初始化呼叫是否有逾時限制？

10 秒後，即使中介服務聯播網仍未完成初始化，Google Mobile Ads SDK 也會叫用 OnInitializationCompleteListener。

如果在收到初始化回呼時，部分中介服務聯播網尚未就緒，該怎麼辦？

建議您在 OnInitializationCompleteListener 的回呼中載入廣告。即使中介服務聯播網尚未就緒，Google Mobile Ads SDK 仍會向該聯播網要求廣告。因此，如果中介服務聯播網在逾時後完成初始化，仍可在該工作階段中供應日後的廣告請求。

您可以呼叫 MobileAds.getInitializationStatus()，繼續在應用程式工作階段中輪詢所有轉接程式的初始化狀態。

如何找出特定中介服務聯播網未就緒的原因？

AdapterStatus.getDescription() 說明轉接程式為何無法處理廣告請求。

系統是否一律會先呼叫 onUserEarnedReward() 回呼，再呼叫 onAdDismissedFullScreenContent() 回呼？

對於 Google 廣告，所有 onUserEarnedReward() 呼叫都會在 onAdDismissedFullScreenContent() 之前發生。對於透過中介服務放送的廣告，第三方廣告聯播網 SDK 的導入方式會決定回呼順序。如果廣告聯播網 SDK 提供單一關閉回呼，且含有獎勵資訊，則中介服務適配器會在 onAdDismissedFullScreenContent() 之前叫用 onUserEarnedReward()。

GitHub 上的範例

• 獎勵廣告範例： Java | Kotlin

後續步驟

請參閱下列主題：

• 使用者隱私權
• 最佳化 SDK 初始化和廣告載入 (Beta 版)