رویدادهای سفارشی آگهی‌های برنمایی

انتخاب پلاتفرم: Android iOS Android (قدیمی)

پیش‌نیازها

راه‌اندازی رویدادهای سفارشی را تکمیل کنید.

درخواست آگهی برنمایی

وقتی ردیف رویداد سفارشی در زنجیره واسطه‌گری آبشاری فراخوانی می‌شود، متد loadBannerAd() در نام کلاسی که هنگام ایجاد رویداد سفارشی ارائه کرده‌اید فراخوانی می‌شود. در این مورد، این روش در SampleCustomEvent است که سپس روش loadBannerAd() را در SampleBannerCustomEventLoader فرا می‌خواند.

برای درخواست آگهی برنمایی، کلاسی ایجاد یا اصلاح کنید که Adapter را گسترش دهد تا loadBannerAd() را پیاده‌سازی کند. علاوه‌براین، کلاس جدیدی برای پیاده‌سازی MediationBannerAd ایجاد کنید.

در مثال رویداد سفارشی ما، SampleCustomEvent کلاس Adapter را گسترش می‌دهد و سپس به SampleBannerCustomEventLoader واگذار می‌کند.

جاوا

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

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationBannerAd;
import com.google.android.gms.ads.mediation.MediationBannerAdCallback;
...

public class SampleCustomEvent extends Adapter {
  private SampleBannerCustomEventLoader bannerLoader;
  @Override
  public void loadBannerAd(
      @NonNull MediationBannerAdConfiguration adConfiguration,
      @NonNull MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback> callback) {
    bannerLoader = new SampleBannerCustomEventLoader(adConfiguration, callback);
    bannerLoader.loadAd();
  }
}

‫SampleBannerCustomEventLoader مسئول انجام تکالیف زیر است:

  • بار کردن آگهی برنمایی و فراخوانی MediationAdLoadCallback روش پس‌از تکمیل بار کردن.

  • درحال پیاده‌سازی میانای MediationBannerAd.

  • درحال دریافت و گزارش کردن برگشتی‌های رویداد آگهی به GMA Next-Gen SDK.

پارامتر اختیاری تعریف‌شده در واسط کاربر در پیکربندی آگهی گنجانده شده است. ازطریق adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD) می‌توان به این پارامتر دسترسی پیدا کرد. این پارامتر معمولاً شناسه واحد آگهی است که کیت توسعه نرم‌افزار شبکه آگهی هنگام نمونه‌سازی شیء آگهی به آن نیاز دارد.

جاوا

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

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationBannerAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationBannerAd;
import com.google.android.gms.ads.mediation.MediationBannerAdCallback;
...

public class SampleBannerCustomEventLoader extends SampleAdListener implements MediationBannerAd {

  /** View to contain the sample banner ad. */
  private SampleAdView sampleAdView;

  /** Configuration for requesting the banner ad from the third-party network. */
  private final MediationBannerAdConfiguration mediationBannerAdConfiguration;

  /** Callback that fires on loading success or failure. */
  private final MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback>
      mediationAdLoadCallback;

  /** Callback for banner ad events. */
  private MediationBannerAdCallback bannerAdCallback;

  /** Constructor. */
  public SampleBannerCustomEventLoader(
      @NonNull MediationBannerAdConfiguration mediationBannerAdConfiguration,
      @NonNull MediationAdLoadCallback<MediationBannerAd, MediationBannerAdCallback>
              mediationAdLoadCallback) {
    this.mediationBannerAdConfiguration = mediationBannerAdConfiguration;
    this.mediationAdLoadCallback = mediationAdLoadCallback;
  }

  /** Loads a banner 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 UI when defining the custom event.
    Log.i("BannerCustomEvent", "Begin loading banner ad.");
    String serverParameter =
        mediationBannerAdConfiguration.getServerParameters().getString(
        MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD);

    Log.d("BannerCustomEvent", "Received server parameter.");

    Context context = mediationBannerAdConfiguration.getContext();
    sampleAdView = new SampleAdView(context);

    // Assumes that the serverParameter is the ad unit of the Sample Network.
    sampleAdView.setAdUnit(serverParameter);
    AdSize size = mediationBannerAdConfiguration.getAdSize();

    // Internally, smart banners use constants to represent their ad size, which
    // means a call to AdSize.getHeight could return a negative value. You can
    // accommodate this by using AdSize.getHeightInPixels and
    // AdSize.getWidthInPixels instead, and then adjusting to match the device's
    // display metrics.
    int widthInPixels = size.getWidthInPixels(context);
    int heightInPixels = size.getHeightInPixels(context);
    DisplayMetrics displayMetrics = Resources.getSystem().getDisplayMetrics();
    int widthInDp = Math.round(widthInPixels / displayMetrics.density);
    int heightInDp = Math.round(heightInPixels / displayMetrics.density);

    sampleAdView.setSize(new SampleAdSize(widthInDp, heightInDp));
    sampleAdView.setAdListener(this);

    SampleAdRequest request = createSampleRequest(mediationBannerAdConfiguration);
    Log.i("BannerCustomEvent", "Start fetching banner ad.");
    sampleAdView.fetchAd(request);
  }

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

بسته به اینکه آگهی باموفقیت واکشی شود یا با خطا مواجه شود، یا onSuccess() یا onFailure() را فراخوانی می‌کنید. ‫onSuccess() با ارسال نمونه‌ای از کلاسی که MediationBannerAd را پیاده‌سازی می‌کند فراخوانده می‌شود.

معمولاً این روش‌ها در داخل برگشت تماس از کیت توسعه نرم‌افزار طرف سوم که آداپتور شما پیاده‌سازی می‌کند، پیاده‌سازی می‌شوند. برای این مثال، «کیت توسعه نرم‌افزار نمونه» دارای SampleAdListener با برگشتی‌های مربوطه است:

جاوا

@Override
public void onAdFetchSucceeded() {
  bannerAdCallback = mediationAdLoadCallback.onSuccess(this);
}

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

‫MediationBannerAd به پیاده‌سازی روش دریافت‌کننده View نیاز دارد:

جاوا

@Override
@NonNull
public View getView() {
  return sampleAdView;
}

رویدادهای واسطه‌گری را به GMA Next-Gen SDK بازارسال کنید

پس‌از فراخوانی onSuccess()، از شیء MediationBannerAdCallback برگشتی می‌تواند توسط آداپتور برای بازارسال رویدادهای ارائه از کیت توسعه نرم‌افزار طرف سوم به GMA Next-Gen SDK استفاده شود. کلاس SampleBannerCustomEventLoader رابط SampleAdListener را برای بازارسال کردن برگشتی‌های تماس از شبکه آگهی نمونه به GMA Next-Gen SDK گسترش می‌دهد.

مهم است که رویداد سفارشی شما تا حد امکان این برگشتی‌ها را بازارسال کند تا برنامه شما این رویدادهای معادل را از «کیت توسعه نرم‌افزار تبلیغات تلفن همراه Google» دریافت کند. در اینجا نمونه‌ای از استفاده از «بازخوان‌ها» آورده شده است:

جاوا

@Override
public void onAdFullScreen() {
  bannerAdCallback.onAdOpened();
  bannerAdCallback.reportAdClicked();
}

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

این کار پیاده‌سازی رویدادهای سفارشی را برای آگهی‌های برنمایی تکمیل می‌کند. مثال کامل در GitHub دردسترس است. می‌توانید از آن با شبکه آگهی که ازقبل پشتیبانی می‌شود استفاده کنید یا آن را برای نمایش آگهی‌های برنمای رویداد سفارشی اصلاح کنید.