מודעות מתגמלות

מודעות מתגמלות מאפשרות לכם לתת למשתמשים פריטים באפליקציה כתגמול על אינטראקציה עם מודעות וידאו, מודעות התנסות באפליקציה וסקרים.

לפני שמתחילים

לפני שממשיכים, צריך לבצע את הפעולות הבאות:

  • מגדירים את Google Mobile Ads SDK (Legacy).
  • משתמשים במזהה של יחידת המודעות המתגמלות לבדיקה ca-app-pub-3940256099942544/5224354917.
    • כשאתם מפתחים ובודקים את האפליקציות, חשוב להשתמש במודעות בדיקה ולא במודעות פעילות בשלב ההפקה. אם לא תשתמשו במזהה יחידת המודעות הייעודית לבדיקה, Google עלולה להשעות את החשבון שלכם.
    • לפני שמפרסמים את האפליקציה, צריך להחליף את המזהה הזה במזהה של יחידת המודעות.
    • פרטים על מודעות בדיקה ב-Google Mobile Ads SDK (Legacy) זמינים במאמר הפעלת מודעות בדיקה.

טעינה של אובייקט מודעה מתגמלת

כדי לטעון מודעות מתגמלות, מפעילים את השיטה הסטטית load במחלקה RewardedAd ומעבירים RewardedAdLoadCallback. בדרך כלל עושים את זה ב-method‏ onCreate של Activity. שימו לב שכמו קריאות חוזרות (callbacks) אחרות של טעינת פורמט, RewardedAdLoadCallback משתמש ב-LoadAdError כדי לספק פרטי שגיאה מדויקים יותר.

Java

RewardedAd.load(
    this,
    "AD_UNIT_ID",
    new AdRequest.Builder().build(),
    new RewardedAdLoadCallback() {
      @Override
      public void onAdLoaded(@NonNull RewardedAd rewardedAd) {
        Log.d(TAG, "Ad was loaded.");
        MainActivity.this.rewardedAd = rewardedAd;
      }

      @Override
      public void onAdFailedToLoad(@NonNull LoadAdError loadAdError) {
        Log.d(TAG, loadAdError.getMessage());
        rewardedAd = null;
      }
    });

Kotlin

RewardedAd.load(
  this,
  "AD_UNIT_ID",
  AdRequest.Builder().build(),
  object : RewardedAdLoadCallback() {
    override fun onAdLoaded(ad: RewardedAd) {
      Log.d(TAG, "Ad was loaded.")
      rewardedAd = ad
    }

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

מחליפים את AD_UNIT_ID במזהה יחידת המודעות.

הגדרת FullScreenContentCallback

ה-FullScreenContentCallback מטפל באירועים שקשורים להצגת ה-RewardedAd. לפני שמציגים את RewardedAd, צריך להגדיר את הקריאה החוזרת (callback) באופן הבא:

Java

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

      @Override
      public void onAdFailedToShowFullScreenContent(AdError adError) {
        // Called when fullscreen content failed to show.
        Log.d(TAG, "Ad failed to show.");
        // Don't forget to set the ad reference to null so you
        // don't show the ad a second time.
        rewardedAd = null;
      }

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

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

      @Override
      public void onAdClicked() {
        // Called when an ad is clicked.
        Log.d(TAG, "Ad was clicked.");
      }
    });

Kotlin

rewardedAd?.fullScreenContentCallback =
  object : FullScreenContentCallback() {
    override fun onAdDismissedFullScreenContent() {
      // Called when fullscreen content is dismissed.
      Log.d(TAG, "Ad was dismissed.")
      // Don't forget to set the ad reference to null so you
      // don't show the ad a second time.
      rewardedAd = null
    }

    override fun onAdFailedToShowFullScreenContent(adError: AdError) {
      // Called when fullscreen content failed to show.
      Log.d(TAG, "Ad failed to show.")
      // Don't forget to set the ad reference to null so you
      // don't show the ad a second time.
      rewardedAd = null
    }

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

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

    override fun onAdClicked() {
      // Called when an ad is clicked.
      Log.d(TAG, "Ad was clicked.")
    }
  }

הצגת המודעה

כשמציגים מודעה מתגמלת, משתמשים באובייקט OnUserEarnedRewardListener כדי לטפל באירועים מתגמלים.

Java

rewardedAd.show(
    MainActivity.this,
    new OnUserEarnedRewardListener() {
      @Override
      public void onUserEarnedReward(@NonNull RewardItem rewardItem) {
        Log.d(TAG, "User earned the reward.");
        // Handle the reward.
      }
    });

Kotlin

rewardedAd?.show(
  this,
  OnUserEarnedRewardListener { rewardItem ->
    Log.d(TAG, "User earned the reward.")
    // Handle the reward.
    val rewardAmount = rewardItem.amount
    val rewardType = rewardItem.type
  },
)

במודעות שמוצגות על ידי Google, ‏Google Mobile Ads SDK (Legacy) מפעיל את ה-method ‏onUserEarnedReward לפני ה-method ‏onAdDismissedFullScreenContent. במודעות שמוצגות באמצעות תהליך בחירת הרשת (Mediation) ב-AdMob, מקור המודעות של הצד השלישי קובע את סדר הקריאות החוזרות. במקורות של מודעות שמספקים קריאה חוזרת (callback) אחת לסגירה עם מידע על התגמול, המתאם של מנגנון בחירת הרשת קורא ל-method‏ onUserEarnedReward לפני ה-method‏ onAdDismissedFullScreenContent. פרטים נוספים זמינים במאמר הגדרת תהליך בחירת הרשת (Mediation) ב-AdMob.

אופציונלי: אימות קריאות חוזרות (callback) של אימות בצד השרת (SSV)

באפליקציות שנדרשים בהן נתונים נוספים בקריאות חוזרות (callback) של אימות בצד השרת (SSV), צריך להשתמש בתכונה "נתונים מותאמים אישית" של מודעות מתגמלות. כל ערך מחרוזת שמוגדר באובייקט של מודעה מתגמלת מועבר לפרמטר השאילתה custom_data של הקריאה החוזרת ל-SSV. אם לא מוגדר ערך של נתונים מותאמים אישית, הערך של פרמטר השאילתה custom_data לא יופיע בקריאה החוזרת ל-SSV.

בדוגמת הקוד הבאה אפשר לראות איך מגדירים נתונים בהתאמה אישית באובייקט של מודעה מתגמלת לפני ששולחים בקשה להצגת מודעה.

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

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)
    }
  },
)

מחליפים את SAMPLE_CUSTOM_DATA_STRING בנתונים בהתאמה אישית.

אם רוצים להגדיר מחרוזת תגמול בהתאמה אישית, צריך לעשות את זה לפני שמציגים את המודעה.

דוגמאות ב-GitHub

  • דוגמה למודעות מתגמלות: Java | Kotlin

השלבים הבאים

הנושאים הבאים: