אירועים בהתאמה אישית של מודעות מתגמלות

דרישות מוקדמות

משלימים את הגדרת האירועים בהתאמה אישית.

שליחת בקשה להצגת מודעה מתגמלת

כשמגיעים לפריט האירוע המותאם אישית בשרשרת בחירת הרשת ב-Waterfall, מתבצעת קריאה ל-method‏ loadRewardedAd() עם שם המחלקה שסיפקתם בזמן יצירת האירוע המותאם אישית. במקרה הזה, ה-method נמצא ב-SampleCustomEvent, שמפעיל את ה-method loadRewardedAd() ב-SampleRewardedCustomEventLoader.

כדי לבקש מודעת פרסום עם תגמול, יוצרים או משנים סוג (class) שמרחיב את Adapter כדי להטמיע את loadRewardedAd(). בנוסף, יוצרים כיתה חדשה כדי להטמיע את MediationRewardedAd.

בדוגמה לאירוע מותאם אישית, המחלקה SampleCustomEvent מרחיבה את המחלקה Adapter ולאחר מכן מעבירה את הגישה למחלקה SampleRewardedCustomEventLoader.

Java

package com.google.ads.mediation.sample.customevent;

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationRewardedAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationRewardedAd;
import com.google.android.gms.ads.mediation.MediationRewardedAdCallback;
...

public class SampleCustomEvent extends Adapter {

  private SampleNativeCustomEventLoader nativeLoader;

  @Override
  public void loadRewardedAd(
      @NonNull MediationRewardedAdConfiguration mediationRewardedAdConfiguration,
      @NonNull
          MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>
              mediationAdLoadCallback) {
    rewardedLoader =
        new SampleRewardedCustomEventLoader(
            mediationRewardedAdConfiguration, mediationAdLoadCallback);
    rewardedLoader.loadAd();
  }
}

SampleRewardedCustomEventLoader אחראי על המשימות הבאות:

  • טעינת המודעה המתגמלת

  • הטמעת הממשק MediationRewardedAd.

  • קבלת קריאות חזרה (callbacks) של אירועי מודעות ב-Google Mobile Ads SDK ודיווח עליהן

הפרמטר האופציונלי שמוגדר בממשק המשתמש של Ad Manager נכלל בהגדרת המודעה. אפשר לגשת לפרמטר דרך adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD). הפרמטר הזה הוא בדרך כלל מזהה של יחידת מודעות שנדרש ל-SDK של רשת המודעות כשיוצרים מופע של אובייקט מודעה.

Java

package com.google.ads.mediation.sample.customevent;

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationRewardedAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationRewardedAd;
import com.google.android.gms.ads.mediation.MediationRewardedAdCallback;
...

public class SampleRewardedCustomEventLoader extends SampleRewardedAdListener
    implements MediationRewardedAd {

  /** Configuration for requesting the rewarded ad from the third-party network. */
  private final MediationRewardedAdConfiguration mediationRewardedAdConfiguration;

  /**
   * A {@link MediationAdLoadCallback} that handles any callback when a Sample
   * rewarded ad finishes loading.
   */
  private final MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>
      mediationAdLoadCallback;

  /** Callback for rewarded ad events. */
  private MediationRewardedAdCallback rewardedAdCallback;

  /** Constructor. */
  public SampleRewardedCustomEventLoader(
      @NonNull MediationRewardedAdConfiguration mediationRewardedAdConfiguration,
      @NonNull MediationAdLoadCallback<MediationRewardedAd, MediationRewardedAdCallback>
              mediationAdLoadCallback) {
    this.mediationRewardedAdConfiguration = mediationRewardedAdConfiguration;
    this.mediationAdLoadCallback = mediationAdLoadCallback;
  }

  /** Loads the rewarded ad from the third-party ad network. */
  public void loadAd() {
    // All custom events have a server parameter named "parameter" that returns
    // back the parameter entered into the AdMob UI when defining the custom event.
    Log.i("RewardedCustomEvent", "Begin loading rewarded ad.");
    String serverParameter = mediationRewardedAdConfiguration
        .getServerParameters()
        .getString(MediationConfiguration
        .CUSTOM_EVENT_SERVER_PARAMETER_FIELD);
    Log.d("RewardedCustomEvent", "Received server parameter.");
    SampleAdRequest request = createSampleRequest(mediationRewardedAdConfiguration);
    sampleRewardedAd = new SampleRewardedAd(serverParameter);
    sampleRewardedAd.setListener(this);
    Log.i("RewardedCustomEvent", "Start fetching rewarded ad.");
    sampleRewardedAd.loadAd(request);
  }

  public SampleAdRequest createSampleRequest(
      MediationAdConfiguration mediationAdConfiguration) {
    SampleAdRequest request = new SampleAdRequest();
    request.setTestMode(mediationAdConfiguration.isTestRequest());
    request.setKeywords(mediationAdConfiguration.getMediationExtras().keySet());
    return request;
  }
}

בהתאם לכך שהמודעה אוחזר בהצלחה או שנתקלה בשגיאה, צריך להפעיל את onSuccess() או את onFailure(). כדי לקרוא ל-onSuccess(), מעבירים מופע של המחלקה שמטמיעה את MediationRewardedAd.

בדרך כלל, השיטות האלה מיושמות בתוך קריאות חזרה (callbacks) מ-SDK של צד שלישי שהמתאם מטמיע. בדוגמה הזו, ל-SDK לדוגמה יש SampleAdListener עם קריאות חוזרות רלוונטיות:

Java

@Override
public void onRewardedAdLoaded() {
  rewardedAdCallback = mediationAdLoadCallback.onSuccess(this);
}

@Override
public void onRewardedAdFailedToLoad(SampleErrorCode errorCode) {
    mediationAdLoadCallback.onFailure(SampleCustomEventError.createSampleSdkError(errorCode));
}

MediationRewardedAd מחייב הטמעה של שיטת showAd() כדי להציג את המודעה:

Java

@Override
public void showAd(Context context) {
  if (!(context instanceof Activity)) {
    rewardedAdCallback.onAdFailedToShow(
        SampleCustomEventError.createCustomEventNoActivityContextError());
    return;
  }
  Activity activity = (Activity) context;

  if (!sampleRewardedAd.isAdAvailable()) {
    rewardedAdCallback.onAdFailedToShow(
        SampleCustomEventError.createCustomEventAdNotAvailableError());
    return;
  }
  sampleRewardedAd.showAd(activity);
}

העברה של אירועי בחירת רשת מודעות אל Google Mobile Ads SDK

אחרי הקריאה ל-onSuccess(), האובייקט MediationRewardedAdCallback שמוחזר יכול לשמש את המתאם כדי להעביר אירועי הצגה מ-SDK של צד שלישי אל Google Mobile Ads SDK. הכיתה SampleRewardedCustomEventLoader מרחיבה את הממשק SampleAdListener כדי להעביר קריאות חזרה (callbacks) מרשת המודעות לדוגמה אל Google Mobile Ads SDK.

חשוב שהאירוע המותאם אישית יעביר כמה שיותר קריאות חוזרות (callbacks) כאלה, כדי שהאפליקציה תקבל את האירועים המקבילים האלה מ-Google Mobile Ads SDK. דוגמה לשימוש בקריאות חזרה (callbacks):

Java

@Override
public void onAdRewarded(final String rewardType, final int amount) {
  RewardItem rewardItem =
      new RewardItem() {
        @Override
        public String getType() {
          return rewardType;
        }

        @Override
        public int getAmount() {
          return amount;
        }
      };
  rewardedAdCallback.onUserEarnedReward(rewardItem);
}

@Override
public void onAdClicked() {
  rewardedAdCallback.reportAdClicked();
}

@Override
public void onAdFullScreen() {
  rewardedAdCallback.onAdOpened();
  rewardedAdCallback.onVideoStart();
  rewardedAdCallback.reportAdImpression();
}

@Override
public void onAdClosed() {
  rewardedAdCallback.onAdClosed();
}

@Override
public void onAdCompleted() {
  rewardedAdCallback.onVideoComplete();
}

זהו השלב האחרון בהטמעת האירועים בהתאמה אישית למודעות בתשלום. הדוגמה המלאה זמינה ב-GitHub. אפשר להשתמש בו עם רשת מודעות שכבר נתמכת, או לשנות אותו כדי להציג מודעות פרסום עם תגמול על אירועים בהתאמה אישית.