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

בחירת פלטפורמה: Android iOS Unity Flutter Android (Legacy)

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

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

לפני שממשיכים, צריך:

  • הגדרה של Google Mobile Ads SDK (Legacy)
  • משתמשים במזהה יחידת המודעות המתגמלות לבדיקה /21775744923/example/rewarded.
    • כשמפתחים ובודקים את האפליקציות, חשוב להשתמש במודעות בדיקה ולא במודעות פעילות לפרסום מוצרים. אם לא תשתמשו במזהה של יחידת המודעות לבדיקה, Google עשויה להשעות את החשבון שלכם.
    • לפני שמפרסמים את האפליקציה, מחליפים את המזהה הזה במזהה של יחידת המודעות.
    • פרטים על Google Mobile Ads SDK (Legacy) מודעות בדיקה זמינים במאמר הפעלת מודעות בדיקה.

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

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

Java

RewardedAd.load(
    this,
    "AD_UNIT_ID",
    new AdManagerAdRequest.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",
  AdManagerAdRequest.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, צריך להגדיר את הקריאה החוזרת באופן הבא:

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) קוראת לפונקציה onUserEarnedReward לפני הפונקציה onAdDismissedFullScreenContent. כשמדובר במודעות שמוצגות באמצעות תהליך בחירת הרשת, מקור המודעות של הצד השלישי קובע את סדר הקריאות החוזרות. במקורות מודעות שמספקים קריאה חוזרת (callback) יחידה לסגירה עם פרטי התגמול, מתאם ה-Mediation מפעיל את ה-method‏ onUserEarnedReward לפני ה-method‏ onAdDismissedFullScreenContent. פרטים נוספים זמינים במאמר בנושא הגדרת תהליך בחירת הרשת.

אופציונלי: אימות קריאות חוזרות של אימות בצד השרת (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

השלבים הבאים

כדאי לעיין בנושאים הבאים: