Prasyarat
Selesaikan penyiapan peristiwa kustom.
Meminta iklan native
Saat item baris peristiwa kustom tercapai dalam rantai mediasi waterfall,
metode loadNativeAd() akan dipanggil pada nama class yang Anda berikan saat
membuat peristiwa
kustom. Dalam hal ini,
metode tersebut ada di SampleCustomEvent, yang kemudian memanggil
metode loadNativeAd() di SampleNativeCustomEventLoader.
Untuk meminta iklan native, buat atau ubah class yang memperluas Adapter untuk
mengimplementasikan loadNativeAd(). Jika class yang memperluas Adapter sudah ada,
terapkan loadNativeAd() di sana. Selain itu, buat class baru untuk mengimplementasikan
UnifiedNativeAdMapper.
Dalam contoh peristiwa kustom,
SampleCustomEvent memperluas class Adapter, lalu mendelegasikan ke
SampleNativeCustomEventLoader.
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 bertanggung jawab atas tugas-tugas berikut:
Memuat iklan native.
Mengimplementasikan class
UnifiedNativeAdMapper.Menerima dan melaporkan callback peristiwa iklan ke GMA Next-Gen SDK.
Parameter opsional yang ditentukan di UI AdMob disertakan dalam konfigurasi iklan. Parameter ini dapat diakses melalui
adConfiguration.getServerParameters().getString(MediationConfiguration.CUSTOM_EVENT_SERVER_PARAMETER_FIELD).
Parameter ini biasanya merupakan ID unit iklan yang diperlukan SDK jaringan iklan saat membuat instance objek iklan.
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); } }
Bergantung pada apakah iklan berhasil diambil atau mengalami error, Anda
akan memanggil
onSuccess()
atau
onFailure().
onSuccess() dipanggil dengan meneruskan instance class yang mengimplementasikan
MediationNativeAd.
Biasanya, metode ini diterapkan di dalam callback dari SDK pihak ketiga yang diterapkan adaptor Anda. Untuk contoh ini, SDK Contoh
memiliki SampleAdListener dengan callback yang relevan:
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)); }
Iklan native peta
SDK yang berbeda memiliki format uniknya sendiri untuk iklan native. Misalnya, satu fungsi mungkin menampilkan objek yang berisi kolom "title", sedangkan fungsi lain mungkin memiliki "headline". Selain itu, metode yang digunakan untuk melacak tayangan iklan dan memproses klik dapat bervariasi dari satu SDK ke SDK lainnya.
UnifiedNativeAdMapper bertanggung jawab untuk merekonsiliasi perbedaan ini dan
menyesuaikan objek iklan native SDK yang dimediasi agar sesuai dengan antarmuka yang diharapkan oleh
GMA Next-Gen SDK. Peristiwa kustom harus memperluas class ini untuk membuat
pemeta sendiri yang spesifik untuk SDK yang dimediasi. Berikut adalah contoh pemeta iklan dari
contoh project peristiwa kustom kami:
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. } }
Sekarang, mari kita pelajari kode konstruktor lebih lanjut.
Menyimpan referensi ke objek iklan native yang dimediasi
Konstruktor menerima parameter SampleNativeAd, class iklan native yang digunakan
oleh Sample SDK untuk iklan native-nya. Pemeta memerlukan referensi ke iklan yang dimediasi agar dapat meneruskan peristiwa klik dan tayangan iklan. SampleNativeAd disimpan sebagai variabel lokal.
Menetapkan properti aset yang dipetakan
Konstruktor menggunakan objek SampleNativeAd untuk mengisi aset di
UnifiedNativeAdMapper.
Cuplikan ini mendapatkan data harga iklan yang dimediasi dan menggunakannya untuk menetapkan harga pemeta:
Java
if (sampleAd.getPrice() != null) { NumberFormat formatter = NumberFormat.getCurrencyInstance(); String priceString = formatter.format(sampleAd.getPrice()); setPrice(priceString); }
Dalam contoh ini, iklan yang dimediasi menyimpan harga sebagai double, sedangkan
AdMob menggunakan String untuk aset yang sama. Pemeta bertanggung jawab untuk menangani jenis konversi ini.
Aset gambar peta
Memetakan aset gambar lebih rumit daripada memetakan jenis data seperti
double atau String. Gambar mungkin didownload secara otomatis atau
ditampilkan sebagai nilai URL. Skala piksel ke dpi juga dapat bervariasi.
Untuk membantu Anda mengelola detail ini, GMA Next-Gen SDK menyediakan class
NativeAd.Image. Sama seperti Anda perlu membuat subclass
UnifiedNativeAdMapper untuk memetakan iklan native yang dimediasi, Anda juga harus membuat
subclass NativeAd.Image saat memetakan aset gambar.
Berikut contoh class SampleNativeMappedImage peristiwa kustom:
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 menggunakan class gambar yang dipetakan di baris ini untuk menetapkan
aset gambar ikon pemeta:
Java
setIcon(new SampleNativeMappedImage(ad.getAppIcon(), ad.getAppIconUri(), SampleCustomEvent.SAMPLE_SDK_IMAGE_SCALE));
Menambahkan kolom ke Bundle tambahan
Beberapa SDK yang dimediasi menyediakan aset tambahan selain yang ada dalam
format iklan native AdMob. Class UnifiedNativeAdMapper
menyertakan metode setExtras() yang digunakan untuk meneruskan aset ini ke
penayang. SampleNativeAdMapper menggunakan ini untuk aset "tingkat kehebatan" Sample SDK:
Java
Bundle extras = new Bundle(); extras.putString(SampleCustomEvent.DEGREE_OF_AWESOMENESS, ad.getDegreeOfAwesomeness()); this.setExtras(extras);
Penayang dapat mengambil data menggunakan metode getExtras()
class NativeAd.
AdChoices
Peristiwa kustom Anda bertanggung jawab untuk menyediakan ikon AdChoices menggunakan metode setAdChoicesContent() di UnifiedNativeAdMapper. Berikut adalah cuplikan dari
SampleNativeAdMapper yang menunjukkan cara menyediakan ikon AdChoices:
Java
public SampleNativeAdMapper(SampleNativeAd ad) { ... setAdChoicesContent(sampleAd.getInformationIcon()); }
Peristiwa tayangan dan klik
GMA Next-Gen SDK dan SDK yang dimediasi perlu mengetahui kapan tayangan iklan atau klik terjadi, tetapi hanya satu SDK yang perlu melacak peristiwa ini. Ada dua pendekatan berbeda yang dapat digunakan peristiwa kustom, bergantung pada apakah SDK yang dimediasi mendukung pelacakan tayangan iklan dan klik sendiri.
Melacak klik dan tayangan iklan dengan GMA Next-Gen SDK
Jika SDK yang dimediasi tidak melakukan pelacakan tayangan iklan dan kliknya sendiri, tetapi
menyediakan metode untuk mencatat klik dan tayangan iklan, GMA Next-Gen SDK dapat
melacak peristiwa ini dan memberi tahu adaptor. Class
UnifiedNativeAdMapper menyertakan dua metode:
recordImpression() dan handleClick() yang
dapat diterapkan peristiwa kustom untuk memanggil metode yang sesuai pada objek iklan native
yang dimediasi:
Java
@Override public void recordImpression() { sampleAd.recordImpression(); } @Override public void handleClick(View view) { sampleAd.handleClick(view); }
Karena SampleNativeAdMapper menyimpan referensi ke objek iklan native Sample SDK, objek tersebut dapat memanggil metode yang sesuai pada objek tersebut untuk melaporkan klik
atau tayangan iklan. Perhatikan bahwa metode handleClick() menggunakan satu parameter: objek View yang sesuai dengan aset iklan native yang menerima klik.
Melacak klik dan tayangan iklan dengan SDK yang dimediasi
Beberapa SDK yang dimediasi mungkin lebih memilih untuk melacak klik dan tayangan iklan sendiri. Dalam hal ini, Anda harus mengganti pelacakan klik dan pelacak tayangan iklan default dengan melakukan dua panggilan berikut di konstruktor UnifiedNativeAdMapper:
Java
setOverrideClickHandling(true); setOverrideImpressionRecording(true);
Peristiwa kustom yang menggantikan pelacakan klik dan tayangan iklan diperlukan untuk
melaporkan peristiwa onAdClicked() dan onAdImpression() ke Google Mobile
Ads SDK.
Untuk melacak tayangan iklan dan klik, SDK yang dimediasi mungkin memerlukan akses ke
tampilan untuk mengaktifkan pelacakan. Peristiwa kustom harus mengganti
metode trackViews() dan menggunakannya untuk meneruskan tampilan iklan native ke SDK
yang dimediasi untuk dilacak. SDK contoh dari project contoh peristiwa kustom kami (yang menjadi sumber cuplikan kode panduan ini) tidak menggunakan pendekatan ini; tetapi jika menggunakannya, kode peristiwa kustom akan terlihat seperti ini:
Java
@Override public void trackViews(View containerView, Map<String, View> clickableAssetViews, Map<String, View> nonClickableAssetViews) { sampleAd.setNativeAdViewForTracking(containerView); }
Jika SDK yang dimediasi mendukung pelacakan aset individual, SDK tersebut dapat melihat ke dalam
clickableAssetViews untuk melihat tampilan mana yang harus dapat diklik. Peta ini
dikunci oleh nama aset di NativeAdAssetNames. UnifiedNativeAdMapper
menawarkan metode untrackView() yang sesuai, yang dapat diganti oleh peristiwa kustom
untuk merilis referensi apa pun ke tampilan dan memisahkannya dari objek iklan
native.
Meneruskan peristiwa mediasi ke GMA Next-Gen SDK
Anda dapat menemukan semua callback yang didukung mediasi di
dokumen MediationNativeAdCallback.
Peristiwa kustom Anda harus meneruskan sebanyak mungkin callback ini, sehingga aplikasi Anda menerima peristiwa yang setara ini dari GMA Next-Gen SDK. Berikut contoh penggunaan callback:
Dengan demikian, penerapan peristiwa kustom untuk iklan native telah selesai. Contoh lengkapnya tersedia di GitHub.