RewardedAd

Kotlin |Java

abstract class RewardedAd

---

這個類別用於請求及顯示獎勵廣告。

public class MainActivity extends AppCompatActivity {

    private RewardedAd rewardedAd;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        FullScreenContentCallback fullScreenContentCallback =
            new FullScreenContentCallback() {
                @Override
                public void onAdShowedFullScreenContent() {
                    // Code to be invoked when the ad showed full screen content.
                }

                @Override
                public void onAdDismissedFullScreenContent() {
                    rewardedAd = null;
                    // Code to be invoked when the ad dismissed full screen content.
                }
            };

        RewardedAd.load(
            this,
            "adUnitId",
            new AdRequest.Builder().build(),
            new RewardedAdLoadCallback() {
                @Override
                public void onAdLoaded(RewardedAd ad) {
                    findViewById(R.id.display_button).setVisibility(View.VISIBLE);
                    rewardedAd = ad;
                    rewardedAd.setFullScreenContentCallback(fullScreenContentCallback);
                }
            });
    }

    public void onDisplayButtonClicked(View view) {
        if (rewardedAd != null) {
            rewardedAd.show(
                this,
                new OnUserEarnedRewardListener() {
                    @Override
                    public void onUserEarnedReward(@NonNull RewardItem rewardItem) {
                        Toast.makeText(
                            MainActivity.this,
                            "onRewarded! currency: "
                                + rewardItem.getType() + "    amount: "
                                + rewardItem.getAmount(), Toast.LENGTH_SHORT).show();
                    }
                });
        }
    }
}

摘要

公用建構函式
RewardedAd()

公開函式
abstract Bundle!	getAdMetadata() 取得這個 RewardedAd 的所有可用廣告中繼資料。
abstract String	getAdUnitId() 傳回廣告單元 ID。
abstract FullScreenContentCallback?	getFullScreenContentCallback() 取得這個 RewardedAd 的 FullScreenContentCallback。
abstract OnAdMetadataChangedListener?	getOnAdMetadataChangedListener() 取得這個 RewardedAd 的 OnAdMetadataChangedListener。
abstract OnPaidEventListener?	getOnPaidEventListener() 取得這個 RewardedAd 的 OnPaidEventListener。
abstract Long	getPlacementId() 取得這個 RewardedAd 的刊登位置 ID。
abstract ResponseInfo	getResponseInfo() 傳回已載入廣告的 ResponseInfo 物件。
abstract RewardItem	getRewardItem() 取得已載入獎勵廣告的獎勵項目。
java-static Boolean	isAdAvailable(context: Context, adUnitId: String) 此函式已淘汰。 請改用 isAdAvailable。
java-static Unit	load(     context: Context,     adUnitId: String,     adManagerAdRequest: AdManagerAdRequest,     loadCallback: RewardedAdLoadCallback ) 載入 RewardedAd。
java-static Unit	load(     context: Context,     adUnitId: String,     adRequest: AdRequest,     loadCallback: RewardedAdLoadCallback ) 載入 RewardedAd。
java-static RewardedAd?	pollAd(context: Context, adUnitId: String) 此函式已淘汰。 請改用 pollAd。
abstract Unit	setFullScreenContentCallback(     fullScreenContentCallback: FullScreenContentCallback? ) 註冊回呼，在廣告顯示及關閉全螢幕內容時叫用。
abstract Unit	setImmersiveMode(immersiveModeEnabled: Boolean) 設定旗標，控制是否要在沉浸模式中顯示這個獎勵廣告物件。
abstract Unit	setOnAdMetadataChangedListener(listener: OnAdMetadataChangedListener?) 為這個 RewardedAd 設定 OnAdMetadataChangedListener。
abstract Unit	setOnPaidEventListener(listener: OnPaidEventListener?) 註冊回呼，在預估這則廣告已賺取收益時叫用。
abstract Unit	setPlacementId(placementId: Long) 設定獎勵廣告的刊登位置 ID。
abstract Unit	setServerSideVerificationOptions(     options: ServerSideVerificationOptions? ) 為這個 RewardedAd 設定 ServerSideVerificationOptions。
abstract Unit	show(     activity: Activity,     onUserEarnedRewardListener: OnUserEarnedRewardListener ) 顯示獎勵廣告。

公用建構函式

RewardedAd

RewardedAd()

公開函式

getAdMetadata

abstract fun getAdMetadata(): Bundle!

取得這個 RewardedAd 的所有可用廣告中繼資料。如果載入的廣告沒有中繼資料，廣告中繼資料就會空白。廣告中繼資料可能會在載入後更新。使用 onAdMetadataChanged 監聽變更。

getAdUnitId

abstract fun getAdUnitId(): String

傳回廣告單元 ID。

getFullScreenContentCallback

abstract fun getFullScreenContentCallback(): FullScreenContentCallback?

取得這個 RewardedAd 的 FullScreenContentCallback。

getOnAdMetadataChangedListener

abstract fun getOnAdMetadataChangedListener(): OnAdMetadataChangedListener?

取得這個 RewardedAd 的 OnAdMetadataChangedListener。

getOnPaidEventListener

abstract fun getOnPaidEventListener(): OnPaidEventListener?

取得這個 RewardedAd 的 OnPaidEventListener。

getPlacementId

abstract fun getPlacementId(): Long

取得這個 RewardedAd 的刊登位置 ID。

getResponseInfo

abstract fun getResponseInfo(): ResponseInfo

傳回已載入廣告的 ResponseInfo 物件。

getRewardItem

abstract fun getRewardItem(): RewardItem

取得已載入獎勵廣告的獎勵項目。

isAdAvailable

java-static fun isAdAvailable(context: Context, adUnitId: String): Boolean

此函式已淘汰。

請改用 isAdAvailable。

如果從 startPreload 載入可用的獎勵廣告，就會傳回 true。

load

java-static fun load(
    context: Context,
    adUnitId: String,
    adManagerAdRequest: AdManagerAdRequest,
    loadCallback: RewardedAdLoadCallback
): Unit

載入 RewardedAd。

參數
context: Context	背景資訊。
adUnitId: String	廣告單元 ID。
adManagerAdRequest: AdManagerAdRequest	包含指定目標資訊的 Google Ad Manager 廣告請求。
loadCallback: RewardedAdLoadCallback	獎勵廣告載入完成時要叫用的回呼。

load

java-static fun load(
    context: Context,
    adUnitId: String,
    adRequest: AdRequest,
    loadCallback: RewardedAdLoadCallback
): Unit

載入 RewardedAd。

參數
context: Context	背景資訊。
adUnitId: String	廣告單元 ID。
adRequest: AdRequest	含有指定目標資訊的廣告請求。
loadCallback: RewardedAdLoadCallback	獎勵廣告載入完成時要叫用的回呼。

pollAd

java-static fun pollAd(context: Context, adUnitId: String): RewardedAd?

此函式已淘汰。

請改用 pollAd。

從 startPreload 擷取下一個載入的獎勵廣告，如果沒有廣告，則擷取 null。

setFullScreenContentCallback

abstract fun setFullScreenContentCallback(
    fullScreenContentCallback: FullScreenContentCallback?
): Unit

註冊回呼，在廣告顯示及關閉全螢幕內容時叫用。

setImmersiveMode

abstract fun setImmersiveMode(immersiveModeEnabled: Boolean): Unit

設定旗標，控制是否要在沉浸模式中顯示這個獎勵廣告物件。請在 show 之前呼叫這個方法。在 show 期間，如果這個旗標已開啟且支援沉浸模式，系統會為有獎廣告開啟 SYSTEM_UI_FLAG_IMMERSIVE_STICKY 和 SYSTEM_UI_FLAG_HIDE_NAVIGATION。

setOnAdMetadataChangedListener

abstract fun setOnAdMetadataChangedListener(listener: OnAdMetadataChangedListener?): Unit

為這個 RewardedAd 設定 OnAdMetadataChangedListener。

setOnPaidEventListener

abstract fun setOnPaidEventListener(listener: OnPaidEventListener?): Unit

註冊回呼，在預估這則廣告已賺取收益時叫用。

setPlacementId

abstract fun setPlacementId(placementId: Long): Unit

設定獎勵廣告的刊登位置 ID。

為確保報表會納入這個刊登位置 ID，請在顯示廣告前呼叫這個方法。

參數
placementId: Long	AdMob 使用者介面為已設定的刊登位置提供的長整數。

setServerSideVerificationOptions

abstract fun setServerSideVerificationOptions(
    options: ServerSideVerificationOptions?
): Unit

為這個 RewardedAd 設定 ServerSideVerificationOptions。

顯示

abstract fun show(
    activity: Activity,
    onUserEarnedRewardListener: OnUserEarnedRewardListener
): Unit

顯示獎勵廣告。

參數
activity: Activity	顯示獎勵廣告的活動。
onUserEarnedRewardListener: OnUserEarnedRewardListener	使用者獲得獎勵時，系統會通知這個監聽器。