Doğal reklamlar özel etkinlikleri

Platform seçin: Android iOS Android (Eski)

Ön koşullar

Özel etkinlik kurulumunu tamamlayın.

Doğal reklam isteğinde bulunma

Şelale uyumlulaştırma zincirinde özel etkinlik satır öğesine ulaşıldığında, loadNativeAd() yöntemi özel etkinlik oluştururken sağladığınız sınıf adında çağrılır. Bu durumda, söz konusu yöntem SampleCustomEvent içinde yer alır ve SampleNativeCustomEventLoader içindeki loadNativeAd() yöntemini çağırır.

Doğal reklam isteğinde bulunmak için Adapter sınıfını genişleten veya loadNativeAd() sınıfını uygulayan bir sınıf oluşturun ya da değiştirin. Adapter sınıfını genişleten bir sınıf zaten varsa loadNativeAd() sınıfını orada uygulayın. Ayrıca, UnifiedNativeAdMapper uygulamak için yeni bir sınıf oluşturun.

Özel etkinlik örneğimizde, SampleCustomEvent, Adapter sınıfını genişletir ve ardından SampleNativeCustomEventLoader'e devreder.

Java

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.MediationNativeAdCallback;
...
public class SampleCustomEvent extends Adapter {
  private SampleNativeCustomEventLoader nativeLoader;

  @Override
  public void loadNativeAd(
      @NonNull MediationNativeAdConfiguration adConfiguration,
      @NonNull MediationAdLoadCallback<UnifiedNativeAdMapper, MediationNativeAdCallback> callback) {
    nativeLoader = new SampleNativeCustomEventLoader(adConfiguration, callback);
    nativeLoader.loadAd();
  }
}

SampleNativeCustomEventLoader aşağıdaki görevlerden sorumludur:

  • Doğal reklam yükleniyor.

  • UnifiedNativeAdMapper sınıfını uygulama

  • Reklam etkinliği geri aramalarını Google Mobile Ads SDK (Legacy)'ya alma ve bildirme.

Ad Manager kullanıcı arayüzünde tanımlanan isteğe bağlı parametre, reklam yapılandırmasına dahil edilir. Parametreye adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD) üzerinden erişilebilir. Bu parametre genellikle bir reklam ağı SDK'sının bir reklam nesnesi oluştururken gerektirdiği bir reklam birimi tanımlayıcısıdır.

Java

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

import com.google.android.gms.ads.mediation.Adapter;
import com.google.android.gms.ads.mediation.MediationNativeAdConfiguration;
import com.google.android.gms.ads.mediation.MediationAdLoadCallback;
import com.google.android.gms.ads.mediation.MediationNativeAdCallback;
...

public class SampleNativeCustomEventLoader extends SampleNativeAdListener {
  /** Configuration for requesting the native ad from the third-party network. */
  private final MediationNativeAdConfiguration mediationNativeAdConfiguration;

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

  /** Callback for native ad events. */
  private MediationNativeAdCallback nativeAdCallback;

  /** Constructor */
  public SampleNativeCustomEventLoader(
      @NonNull MediationNativeAdConfiguration mediationNativeAdConfiguration,
      @NonNull MediationAdLoadCallback<MediationNativeAd, MediationNativeAdCallback>
              mediationAdLoadCallback) {
    this.mediationNativeAdConfiguration = mediationNativeAdConfiguration;
    this.mediationAdLoadCallback = mediationAdLoadCallback;
  }

  /** Loads the native ad from the third-party ad network. */
  public void loadAd() {
    // Create one of the Sample SDK's ad loaders to request ads.
    Log.i("NativeCustomEvent", "Begin loading native ad.");
    SampleNativeAdLoader loader =
        new SampleNativeAdLoader(mediationNativeAdConfiguration.getContext());

    // All custom events have a server parameter named "parameter" that returns
    // back the parameter entered into the UI when defining the custom event.
    String serverParameter = mediationNativeAdConfiguration
        .getServerParameters()
        .getString(MediationConfiguration
        .CUSTOM_EVENT_SERVER_PARAMETER_FIELD);
    Log.d("NativeCustomEvent", "Received server parameter.");

    loader.setAdUnit(serverParameter);

    // Create a native request to give to the SampleNativeAdLoader.
    SampleNativeAdRequest request = new SampleNativeAdRequest();
    NativeAdOptions options = mediationNativeAdConfiguration.getNativeAdOptions();
    if (options != null) {
      // If the NativeAdOptions' shouldReturnUrlsForImageAssets is true, the adapter should
      // send just the URLs for the images.
      request.setShouldDownloadImages(!options.shouldReturnUrlsForImageAssets());

      request.setShouldDownloadMultipleImages(options.shouldRequestMultipleImages());
      switch (options.getMediaAspectRatio()) {
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_LANDSCAPE:
          request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_LANDSCAPE);
          break;
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_PORTRAIT:
          request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_PORTRAIT);
          break;
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_SQUARE:
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_ANY:
        case NativeAdOptions.NATIVE_MEDIA_ASPECT_RATIO_UNKNOWN:
        default:
          request.setPreferredImageOrientation(SampleNativeAdRequest.IMAGE_ORIENTATION_ANY);
      }
    }

    loader.setNativeAdListener(this);

    // Begin a request.
    Log.i("NativeCustomEvent", "Start fetching native ad.");
    loader.fetchAd(request);
  }
}

Reklamın başarıyla getirilmesine veya bir hatayla karşılaşmasına bağlı olarak onSuccess() veya onFailure() çağrısını yaparsınız. onSuccess(), MediationNativeAd uygulayan sınıfın bir örneği iletilerek çağrılır.

Genellikle bu yöntemler, bağdaştırıcınızın uyguladığı üçüncü taraf SDK'sından gelen geri çağırmaların içinde uygulanır. Bu örnekte, Sample SDK'sında ilgili geri çağırmaların bulunduğu bir SampleAdListener var:

Java

@Override
public void onNativeAdFetched(SampleNativeAd ad) {
  SampleUnifiedNativeAdMapper mapper = new SampleUnifiedNativeAdMapper(ad);
  mediationNativeAdCallback = mediationAdLoadCallback.onSuccess(mapper);
}

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

Haritalar'daki doğal reklamlar

Farklı SDK'lar, doğal reklamlar için kendi benzersiz biçimlerine sahiptir. Birinde "title" alanı içeren nesneler döndürülürken diğerinde "headline" alanı olabilir. Ayrıca, gösterimleri izlemek ve tıklamaları işlemek için kullanılan yöntemler SDK'dan SDK'ya değişebilir.

UnifiedNativeAdMapper, bu farklılıkları uzlaştırmaktan ve aracılık edilen bir SDK'nın doğal reklam nesnesini UnifiedNativeAdMapper tarafından beklenen arayüze uyarlamaktan sorumludur.Google Mobile Ads SDK (Legacy) Özel etkinlikler, kendi aracı SDK'larına özel eşleyiciler oluşturmak için bu sınıfı genişletmelidir. Örnek özel etkinlik projemizden bir örnek reklam eşleyiciyi aşağıda görebilirsiniz:

Java

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

import com.google.android.gms.ads.mediation.UnifiedNativeAdMapper;
import com.google.android.gms.ads.nativead.NativeAd;
...

public class SampleUnifiedNativeAdMapper extends UnifiedNativeAdMapper {

  private final SampleNativeAd sampleAd;

  public SampleUnifiedNativeAdMapper(SampleNativeAd ad) {
    sampleAd = ad;
    setHeadline(sampleAd.getHeadline());
    setBody(sampleAd.getBody());
    setCallToAction(sampleAd.getCallToAction());
    setStarRating(sampleAd.getStarRating());
    setStore(sampleAd.getStoreName());
    setIcon(
        new SampleNativeMappedImage(
            ad.getIcon(), ad.getIconUri(), SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));
    setAdvertiser(ad.getAdvertiser());

    List<NativeAd.Image> imagesList = new ArrayList<NativeAd.Image>();
    imagesList.add(new SampleNativeMappedImage(ad.getImage(), ad.getImageUri(),
        SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));
    setImages(imagesList);

    if (sampleAd.getPrice() != null) {
      NumberFormat formatter = NumberFormat.getCurrencyInstance();
      String priceString = formatter.format(sampleAd.getPrice());
      setPrice(priceString);
    }

    Bundle extras = new Bundle();
    extras.putString(SampleCustomEvent.DEGREE_OF_AWESOMENESS, ad.getDegreeOfAwesomeness());
    this.setExtras(extras);

    setOverrideClickHandling(false);
    setOverrideImpressionRecording(false);

    setAdChoicesContent(sampleAd.getInformationIcon());
  }

  @Override
  public void recordImpression() {
    sampleAd.recordImpression();
  }

  @Override
  public void handleClick(View view) {
    sampleAd.handleClick(view);
  }

  // The Sample SDK doesn't do its own impression/click tracking, instead relies on its
  // publishers calling the recordImpression and handleClick methods on its native ad object. So
  // there's no need to pass a reference to the View being used to display the native ad. If
  // your mediated network does need a reference to the view, the following method can be used
  // to provide one.

  @Override
  public void trackViews(View containerView, Map<String, View> clickableAssetViews,
      Map<String, View> nonClickableAssetViews) {
    super.trackViews(containerView, clickableAssetViews, nonClickableAssetViews);
    // If your ad network SDK does its own impression tracking, here is where you can track the
    // top level native ad view and its individual asset views.
  }

  @Override
  public void untrackView(View view) {
    super.untrackView(view);
    // Here you would remove any trackers from the View added in trackView.
  }
}

Şimdi de oluşturucu koduna daha yakından bakalım.

Aracılık edilen doğal reklam nesnesine referans tutma

Oluşturucu, SampleNativeAd parametresini kabul eder. Bu parametre, Sample SDK'nın doğal reklamları için kullandığı doğal reklam sınıfıdır. Eşleyici, tıklama ve gösterim etkinliklerini iletebilmek için aracılı reklamın referansına ihtiyaç duyar. SampleNativeAd yerel değişken olarak saklanır.

Eşlenmiş öğe özelliklerini ayarlama

Oluşturucu, SampleNativeAd nesnesini kullanarak UnifiedNativeAdMapper içindeki öğeleri doldurur.

Bu snippet, aracılık edilen reklamın fiyat verilerini alır ve eşleyicinin fiyatını ayarlamak için kullanır:

Java

if (sampleAd.getPrice() != null) {
    NumberFormat formatter = NumberFormat.getCurrencyInstance();
    String priceString = formatter.format(sampleAd.getPrice());
    setPrice(priceString);
}

Bu örnekte, aracılık edilen reklam fiyatı double olarak saklarken Ad Manager aynı öğe için String kullanır. Bu tür dönüşümlerin işlenmesinden eşleyici sorumludur.

Harita resmi öğeleri

Resim öğelerini eşlemek, double veya String gibi veri türlerini eşlemekten daha karmaşıktır. Resimler otomatik olarak indirilebilir veya URL değerleri olarak döndürülebilir. Piksel-DPI ölçekleri de farklılık gösterebilir.

Bu ayrıntıları yönetmenize yardımcı olmak için Google Mobile Ads SDK (Legacy), NativeAd.Image sınıfını sağlar. Aracılı bir doğal reklamı eşlemek için UnifiedNativeAdMapper öğesinin bir alt sınıfını oluşturmanız gerektiği gibi, resim öğelerini eşlerken de NativeAd.Image öğesinin bir alt sınıfını oluşturmanız gerekir.

Özel etkinliğin SampleNativeMappedImage sınıfı için bir örnek aşağıda verilmiştir:

Java

public class SampleNativeMappedImage extends NativeAd.Image {

  private Drawable drawable;
  private Uri imageUri;
  private double scale;

  public SampleNativeMappedImage(Drawable drawable, Uri imageUri, double scale) {
    this.drawable = drawable;
    this.imageUri = imageUri;
    this.scale = scale;
  }

  @Override
  public Drawable getDrawable() {
    return drawable;
  }

  @Override
  public Uri getUri() {
    return imageUri;
  }

  @Override
  public double getScale() {
    return scale;
  }
}

SampleNativeAdMapper, bu satırda eşlenmiş resim sınıfını kullanarak eşleyicinin simge resmi öğesini ayarlar:

Java

setIcon(new SampleNativeMappedImage(ad.getAppIcon(), ad.getAppIconUri(),
    SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));

Ekstralar paketine alan ekleme

Bazı uyumlulaştırılmış SDK'lar, Ad Manager doğal reklam biçimindekilerin dışında ek öğeler sağlar. UnifiedNativeAdMapper sınıfı, bu öğeleri yayıncılara iletmek için kullanılan bir setExtras() yöntemi içerir. SampleNativeAdMapper, örnek SDK'nın "mükemmellik derecesi" öğesi için bunu kullanır:

Java

Bundle extras = new Bundle();
extras.putString(SampleCustomEvent.DEGREE_OF_AWESOMENESS, ad.getDegreeOfAwesomeness());
this.setExtras(extras);

Yayıncılar, NativeAd sınıfının getExtras() yöntemini kullanarak verileri alabilir.

Reklam Seçenekleri

Özel etkinliğiniz, UnifiedNativeAdMapper üzerinde setAdChoicesContent() yöntemini kullanarak bir Reklam Seçenekleri simgesi sağlamaktan sorumludur. SampleNativeAdMapper'dan alınan aşağıdaki snippet'te, Reklam Seçenekleri simgesinin nasıl sağlanacağı gösterilmektedir:

Java

public SampleNativeAdMapper(SampleNativeAd ad) {
    ...
    setAdChoicesContent(sampleAd.getInformationIcon());
}

Gösterim ve tıklama etkinlikleri

Hem Google Mobile Ads SDK (Legacy) hem de uyumlulaştırılmış SDK'nın bir gösterim veya tıklama gerçekleştiğinde bunu bilmesi gerekir ancak bu etkinlikleri yalnızca bir SDK'nın izlemesi gerekir. Aracılık edilen SDK'nın gösterimleri ve tıklamaları kendi başına izlemeyi destekleyip desteklemediğine bağlı olarak özel etkinliklerin kullanabileceği iki farklı yaklaşım vardır.

Tıklamaları ve gösterimleri Google Mobile Ads SDK (Legacy) ile izleme

Uyumlulaştırılmış SDK kendi gösterim ve tıklama izlemesini yapmıyorsa ancak tıklamaları ve gösterimleri kaydetmek için yöntemler sağlıyorsa Google Mobile Ads SDK (Legacy) bu etkinlikleri izleyebilir ve bağdaştırıcıyı bilgilendirebilir. UnifiedNativeAdMapper sınıfı iki yöntem içerir: recordImpression() ve handleClick(). Özel etkinlikler, aracılık edilen yerel reklam nesnesinde ilgili yöntemi çağırmak için bu yöntemleri uygulayabilir:

Java

@Override
public void recordImpression() {
  sampleAd.recordImpression();
}

@Override
public void handleClick(View view) {
  sampleAd.handleClick(view);
}

SampleNativeAdMapper, örnek SDK'nın yerel reklam nesnesine referans içerdiğinden tıklama veya gösterim bildirmek için bu nesnede uygun yöntemi çağırabilir. handleClick() yönteminin tek bir parametre aldığını unutmayın: tıklamayı alan doğal reklam öğesine karşılık gelen View nesnesi.

Aracılık edilen SDK ile tıklamaları ve gösterimleri izleme

Bazı aracılık edilen SDK'lar, tıklamaları ve gösterimleri kendi başlarına izlemeyi tercih edebilir. Bu durumda, UnifiedNativeAdMapper oluşturucusunda aşağıdaki iki çağrıyı yaparak varsayılan tıklama ve gösterim izlemeyi geçersiz kılmanız gerekir:

Java

setOverrideClickHandling(true);
setOverrideImpressionRecording(true);

Tıklama ve gösterim izlemeyi geçersiz kılan özel etkinliklerin, onAdClicked() ve onAdImpression() etkinliklerini Google Mobile Ads SDK'sına bildirmesi gerekir.

Gösterimleri ve tıklamaları izlemek için uyumlulaştırılmış SDK'nın izlemeyi etkinleştirmek üzere görünümlere erişmesi gerekir. Özel etkinlik, trackViews() yöntemini geçersiz kılmalı ve yerel reklamın görünümünü izlenecek uyumlulaştırılmış SDK'ya iletmek için bu yöntemi kullanmalıdır. Özel etkinlik örnek projemizdeki (bu kılavuzdaki kod snippet'lerinin alındığı) örnek SDK bu yaklaşımı kullanmaz. Ancak bu yaklaşımı kullansaydı özel etkinlik kodu şu şekilde görünürdü:

Java

@Override
public void trackViews(View containerView,
    Map<String, View> clickableAssetViews,
    Map<String, View> nonClickableAssetViews) {
  sampleAd.setNativeAdViewForTracking(containerView);
}

Aracılık edilen SDK, tek tek öğelerin izlenmesini destekliyorsa hangi görünümlerin tıklanabilir hale getirilmesi gerektiğini görmek için clickableAssetViews içine bakabilir. Bu harita, NativeAdAssetNames içindeki bir öğe adına göre anahtarlanır. UnifiedNativeAdMapper, özel etkinliklerin görünümle ilgili referansları serbest bırakmak ve görünümü doğal reklam nesnesinden ayırmak için geçersiz kılabileceği karşılık gelen bir untrackView() yöntemi sunar.

Uyumlulaştırma etkinliklerini Google Mobile Ads SDK (Legacy) adresine yönlendirme

Uyumlulaştırmanın desteklediği tüm geri çağırmaları MediationNativeAdCallback dokümanlarında bulabilirsiniz.

Uygulamanızın Google Mobile Ads SDK (Legacy)'dan bu eşdeğer etkinlikleri alabilmesi için özel etkinliğinizin bu geri çağırmaların mümkün olduğunca çoğunu iletmesi önemlidir. Geri çağırmaları kullanma örneğini aşağıda bulabilirsiniz:

Böylece, yerel reklamlar için özel etkinlik uygulama işlemi tamamlanır. Örnek kodun tamamına GitHub'dan ulaşabilirsiniz.