Modul @google/mobile-ads menyediakan antarmuka, class, dan fungsi tingkat teratas TypeScript inti untuk mengintegrasikan Google Mobile Ads ke dalam aplikasi React Native.
Ringkasan
-
Siklus Proses & Inisialisasi SDK: Gunakan
initializedenganInitializationConfiguntuk melakukan inisialisasi SDK, dan periksa status inisialisasi adaptor dengangetInitializationStatusdanInitializationStatus. -
User Messaging Platform (UMP): Mengelola izin pengguna dengan
requestConsentInfoUpdate,loadAndShowConsentFormIfRequired,showPrivacyOptionsForm, dan memeriksa status izin dengangetConsentStatusdancanRequestAds. -
Konfigurasi Permintaan: Tentukan penargetan global dan
setelan kebijakan dengan
setRequestConfigurationdanRequestConfiguration, mengonfigurasi opsi sepertiAgeRestrictedTreatment,MaxAdContentRating, danPublisherPrivacyPersonalizationState. -
Format Iklan: Memuat dan menampilkan iklan menggunakan class format
seperti
AppOpenAd,InterstitialAd,RewardedAd, danRewardedInterstitialAd. -
Alat Developer: Periksa penayangan iklan, status adaptor, dan konfigurasi SDK secara real-time menggunakan
openAdInspectoratauopenDebugMenu.
| Alias Jenis | |
|---|---|
Adapter
|
Menunjukkan kemungkinan status inisialisasi adaptor
mediasi.
|
Ad
|
Posisi ikon AdChoices di tampilan iklan. |
Ad
|
Format iklan yang diminta. |
Ad
|
Informasi error tentang alasan pemeriksa iklan gagal.
|
Ad
|
Error yang memengaruhi pembukaan atau pengoperasian pemeriksa iklan.
|
Ad
|
Opsi orientasi untuk iklan banner adaptif inline dan anchor adaptif besar.
|
Ad
|
Mewakili dimensi iklan. |
Age
|
Menentukan opsi perlakuan pembatasan usia untuk panggilan iklan.
|
Consent
|
Nilai status izin. |
Debug
|
Nilai debug untuk menguji geografi. |
Form
|
Menampilkan kode error untuk kegagalan operasi formulir User Messaging Platform (UMP).
|
Full
|
|
Load
|
Menampilkan kode error untuk kegagalan operasi pemuatan iklan.
|
Max
|
Menentukan rating konten iklan maksimum untuk aplikasi, mengklasifikasikan
jenis iklan yang dapat ditampilkan.
|
Native
|
Nama yang digunakan untuk mengidentifikasi aset iklan native standar.
|
Native
|
Mengidentifikasi format iklan native yang dimuat. |
Native
|
Preferensi untuk rasio aspek media iklan native yang ditampilkan.
|
On
|
Definisi antarmuka untuk callback yang akan dipanggil saat UI
pemeriksa iklan ditutup.
|
Precision
|
Presisi nilai iklan yang dilaporkan. |
Privacy
|
Status persyaratan opsi privasi. |
Publisher
|
Menunjukkan status personalisasi perlakuan privasi Penayang.
|
Resize
|
Opsi untuk menyesuaikan mode pengubahan ukuran konten gambar di
NativeAdMediaView.
|
Resolved
|
Menampilkan status akhir ukuran iklan setelah iklan dimuat.
|
Swipe
|
Petunjuk untuk gestur geser klik kustom. |
| Variabel | |
|---|---|
Ad
|
Ukuran iklan standar dan metode pembantu untuk membuat ukuran adaptif dan
kustom.
|
| Fungsi | |
|---|---|
can
|
Memeriksa apakah status izin saat ini mengizinkan Anda meminta
iklan.
|
get
|
Mendapatkan status izin pengguna saat ini. |
get
|
Mendapatkan status inisialisasi SDK. |
get
|
Memeriksa apakah titik entri opsi privasi diperlukan untuk
aplikasi Anda.
|
get
|
Mendapatkan konfigurasi permintaan global. |
initialize
|
Menginisialisasi Google Mobile Ads SDK. |
is
|
Memeriksa apakah formulir izin tersedia. |
load
|
Memuat formulir izin dan menampilkannya kepada pengguna jika
status izin saat ini memerlukannya (misalnya, statusnya adalah WAJIB).
|
open
|
Membuka overlay Pemeriksa Iklan Google Mobile Ads SDK.
|
open
|
Membuka menu debug. |
parse
|
Mengurai error native yang terjadi selama pemuatan iklan dan membungkusnya dalam
LoadAdError.
|
request
|
Meminta pembaruan informasi izin. |
reset
|
Menghapus semua status izin dari penyimpanan persisten.
|
set
|
Mengontrol apakah ID pihak pertama penayang diaktifkan.
|
set
|
Menetapkan konfigurasi permintaan global untuk kepatuhan dan
penargetan.
|
set
|
Menetapkan volume audio aplikasi yang dikontrol pengguna.
|
set
|
Menetapkan apakah aplikasi dibisukan. |
show
|
Menampilkan formulir opsi privasi. |
Alias Jenis
AdapterState
AdapterState: typeof AdapterState[keyof typeof AdapterState]
| Properti | |
|---|---|
NOT_
|
Menunjukkan bahwa adaptor mediasi belum
diinisialisasi atau gagal diinisialisasi.
|
READY
|
Menunjukkan bahwa adaptor mediasi berhasil
diinisialisasi dan siap menayangkan iklan.
|
AdChoicesPlacement
AdChoicesPlacement:
typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
| Properti | |
|---|---|
BOTTOM_
|
Pojok kiri bawah iklan. |
BOTTOM_
|
Pojok kanan bawah iklan. |
TOP_
|
Pojok kiri atas iklan. |
TOP_
|
Sudut kanan atas iklan. |
AdFormat
AdInspectorError
AdInspectorError:
BaseError<AdInspectorErrorCode>
AdInspectorErrorCode
AdInspectorErrorCode:
typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
AdOrientation
AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
| Properti | |
|---|---|
CURRENT
|
|
LANDSCAPE
|
|
PORTRAIT
|
|
AdSize
Mewakili dimensi iklan.
Dapat berupa salah satu dari kumpulan ukuran standar (misalnya, AdSize.LARGE_BANNER), atau ukuran adaptif.
Dapat berupa salah satu dari kumpulan ukuran standar (misalnya, AdSize.LARGE_BANNER), atau ukuran adaptif.
AgeRestrictedTreatment
AgeRestrictedTreatment:
typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
ConsentStatus
ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
DebugGeography
DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
FormErrorCode
FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
FullScreenContentErrorCode
FullScreenContentErrorCode:
typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
| Properti | |
|---|---|
AD_
|
Iklan sudah ditampilkan. |
AD_
|
Iklan belum siap ditampilkan. |
AD_
|
Iklan terlalu besar untuk adegan (khusus iOS). |
APP_
|
Aplikasi tidak berada di latar depan. |
INTERNAL_
|
Terjadi masalah internal; misalnya, pengecualian
terjadi saat bersiap untuk menampilkan konten iklan.
|
MEDIATION_
|
Adaptor mediasi gagal menampilkan iklan. Lihat
FullScreenContentError.mediationAdError
untuk mengetahui penyebab yang mendasarinya.
|
UNKNOWN
|
Kode error tidak dapat dipetakan ke kode error yang diketahui.
|
LoadAdErrorCode
LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
MaxAdContentRating
MaxAdContentRating:
typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
NativeAdAssetNames
NativeAdAssetNames:
typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
NativeAdType
NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
| Properti | |
|---|---|
BANNER
|
Iklan banner. |
CUSTOM_
|
Iklan format native kustom. |
NATIVE
|
Iklan native. |
NativeMediaAspectRatio
NativeMediaAspectRatio:
typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
OnAdInspectorClosedListener
OnAdInspectorClosedListener:
((error?) => void)
PrecisionType
PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
PrivacyOptionsRequirementStatus
PrivacyOptionsRequirementStatus:
typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
| Properti | |
|---|---|
NOT_
|
Titik entri opsi privasi tidak diperlukan.
|
REQUIRED
|
Titik entri opsi privasi wajib diisi. |
UNKNOWN
|
Status persyaratan opsi privasi tidak diketahui.
|
PublisherPrivacyPersonalizationState
PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
ResizeMode
ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
ResolvedAdSize
ResolvedAdSize:
FixedAdSize | FluidAdSize
Untuk sebagian besar iklan, ini diselesaikan menjadi FixedAdSize dengan dimensi
width dan height yang tepat.
Untuk iklan banner berukuran dinamis, ini diselesaikan menjadi
FluidAdSize
dengan dimensi dikelola oleh hierarki tampilan.
SwipeGestureDirection
SwipeGestureDirection:
typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
| Properti | |
|---|---|
DOWN
|
Geser ke bawah. |
LEFT
|
Geser ke kiri. |
RIGHT
|
Geser ke kanan. |
UP
|
Geser ke atas. |
Variabel
AdSize
AdSize: {
BANNER: FixedAdSize;
custom: ((width,
height) => FixedAdSize);
FLUID: FluidAdSize;
FULL_BANNER: FixedAdSize;
getCurrentOrientationInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
getInlineAdaptiveBannerAdSize: ((width,
maxHeight) => InlineAdaptiveAdSize);
getLandscapeInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
getLargeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getLargeLandscapeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getLargePortraitAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getPortraitInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
LARGE_BANNER: FixedAdSize;
LEADERBOARD: FixedAdSize;
MEDIUM_RECTANGLE: FixedAdSize;
}
Fungsi
canRequestAds
canRequestAds(): boolean
Memeriksa apakah status izin saat ini mengizinkan Anda meminta
iklan.
| Hasil | |
|---|---|
boolean
|
true jika Anda dapat meminta iklan,
false jika tidak.
|
getConsentStatus
getConsentStatus(): ConsentStatus
Mendapatkan status izin pengguna saat ini.
| Hasil | |
|---|---|
ConsentStatus
|
Status izin saat ini. |
getInitializationStatus
getInitializationStatus(): InitializationStatus
Mendapatkan status inisialisasi SDK.
Gunakan metode ini untuk memeriksa apakah SDK telah selesai diinisialisasi dan untuk memeriksa status setiap adaptor mediasi.
Gunakan metode ini untuk memeriksa apakah SDK telah selesai diinisialisasi dan untuk memeriksa status setiap adaptor mediasi.
| Hasil | |
|---|---|
InitializationStatus
|
Status inisialisasi saat ini. |
getPrivacyOptionsRequirementStatus
getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Memeriksa apakah titik entri opsi privasi diperlukan untuk
aplikasi Anda.
Jika titik entri diperlukan, tambahkan elemen UI yang terlihat dan dapat berinteraksi ke aplikasi Anda yang memanggil showPrivacyOptionsForm untuk menampilkan formulir opsi privasi. Jika titik entri tidak diperlukan, konfigurasi elemen UI Anda agar tidak terlihat dan dapat berinteraksi.
Jika titik entri diperlukan, tambahkan elemen UI yang terlihat dan dapat berinteraksi ke aplikasi Anda yang memanggil showPrivacyOptionsForm untuk menampilkan formulir opsi privasi. Jika titik entri tidak diperlukan, konfigurasi elemen UI Anda agar tidak terlihat dan dapat berinteraksi.
| Hasil | |
|---|---|
PrivacyOptionsRequirementStatus
|
Status persyaratan opsi privasi. |
getRequestConfiguration
getRequestConfiguration(): RequestConfiguration
Mendapatkan konfigurasi permintaan global.
Gunakan metode ini untuk mengambil konfigurasi permintaan saat ini yang telah diterapkan secara global.
Gunakan metode ini untuk mengambil konfigurasi permintaan saat ini yang telah diterapkan secara global.
| Hasil | |
|---|---|
RequestConfiguration
|
Konfigurasi permintaan global saat ini. |
initialize
initialize(config,
onInitializationComplete?): void
Melakukan inisialisasi Google Mobile Ads SDK.
Panggil metode ini sebelum memuat iklan dan sebelum berinteraksi dengan bagian lain Google Mobile Ads SDK.
Panggil metode ini sebelum memuat iklan dan sebelum berinteraksi dengan bagian lain Google Mobile Ads SDK.
| Parameter | |
|---|---|
config:
InitializationConfig
|
Opsi untuk mengontrol inisialisasi SDK. |
|
Fungsi callback yang akan dijalankan saat SDK selesai melakukan inisialisasi. |
isConsentFormAvailable
isConsentFormAvailable(): boolean
Memeriksa apakah formulir izin tersedia.
| Hasil | |
|---|---|
boolean
|
true jika formulir izin tersedia,
false jika tidak.
|
loadAndShowConsentFormIfRequired
loadAndShowConsentFormIfRequired(onDismissed?): void
Memuat formulir izin dan menampilkannya kepada pengguna jika status izin saat ini memerlukannya (misalnya, statusnya adalah WAJIB).
| Parameter | |
|---|---|
|
Fungsi callback dipanggil saat formulir ditutup atau jika tidak ada formulir yang diperlukan, dengan FormError opsional jika presentasi gagal. |
openAdInspector
openAdInspector(_listener): void
Membuka overlay Pemeriksa Iklan Google Mobile Ads SDK.
Gunakan metode ini untuk men-debug penyiapan mediasi dan sumber iklan.
Gunakan metode ini untuk men-debug penyiapan mediasi dan sumber iklan.
| Parameter | |
|---|---|
_listener:
OnAdInspectorClosedListener
|
|
openDebugMenu
openDebugMenu(adUnitId): void
Membuka menu debug.
Gunakan metode ini untuk membuka menu debug untuk unit iklan tertentu guna membantu pengujian dan pemecahan masalah konfigurasi iklan.
Gunakan metode ini untuk membuka menu debug untuk unit iklan tertentu guna membantu pengujian dan pemecahan masalah konfigurasi iklan.
| Parameter | |
|---|---|
adUnitId: string
|
ID unit iklan untuk membuka menu debug. |
parseLoadAdError
parseLoadAdError(error): LoadAdError
Mengurai error native yang terjadi selama pemuatan iklan dan membungkusnya dalam
LoadAdError.
| Parameter | |
|---|---|
error: unknown
|
Objek error yang ditampilkan oleh modul native. |
| Hasil | |
|---|---|
LoadAdError
|
Objek LoadAdError yang diuraikan. |
requestConsentInfoUpdate
requestConsentInfoUpdate(params?, onComplete?): void
Meminta pembaruan informasi izin.
API ini harus dipanggil di setiap sesi aplikasi sebelum memanggil getConsentStatus.
Setelah API ini dipanggil, nilai return getConsentStatus diperbarui secara serentak untuk menyimpan status izin dari sesi aplikasi sebelumnya, jika ada.
getConsentStatus dapat diperbarui lagi ke status terbaru setelah callback
API ini harus dipanggil di setiap sesi aplikasi sebelum memanggil getConsentStatus.
Setelah API ini dipanggil, nilai return getConsentStatus diperbarui secara serentak untuk menyimpan status izin dari sesi aplikasi sebelumnya, jika ada.
getConsentStatus dapat diperbarui lagi ke status terbaru setelah callback
onComplete dipanggil.
| Parameter | |
|---|---|
|
Konfigurasi opsional untuk proses debug dan penargetan. |
|
Fungsi callback dipanggil saat informasi izin selesai diperbarui, dengan FormError opsional jika permintaan gagal. |
reset
reset(): void
Menghapus semua status izin dari penyimpanan persisten.
Gunakan hanya untuk tujuan proses debug.
Gunakan hanya untuk tujuan proses debug.
setPublisherFirstPartyIdEnabled
setPublisherFirstPartyIdEnabled(enabled): void
Mengontrol apakah ID pihak pertama penayang diaktifkan.
Mengaktifkan atau menonaktifkan ID pihak pertama penayang Google Mobile Ads SDK, yang sebelumnya dikenal sebagai kunci aplikasi sama.
Mengaktifkan atau menonaktifkan ID pihak pertama penayang Google Mobile Ads SDK, yang sebelumnya dikenal sebagai kunci aplikasi sama.
- Lihat juga
| Parameter | |
|---|---|
enabled: boolean
|
Benar untuk mengaktifkan ID pihak pertama penayang; salah untuk
menonaktifkan. Default-nya adalah true.
|
setRequestConfiguration
setRequestConfiguration(_config): void
Menetapkan konfigurasi permintaan global untuk kepatuhan dan
penargetan.
Gunakan metode ini untuk menentukan detail penargetan, seperti rating konten iklan maksimum, setelan kepatuhan, seperti tag perlakuan berdasarkan usia, dan ID perangkat pengujian.
Gunakan metode ini untuk menentukan detail penargetan, seperti rating konten iklan maksimum, setelan kepatuhan, seperti tag perlakuan berdasarkan usia, dan ID perangkat pengujian.
| Parameter | |
|---|---|
_config:
RequestConfiguration
|
|
setUserControlledAppVolume
setUserControlledAppVolume(volume): void
Menetapkan volume audio aplikasi yang dikontrol pengguna.
Gunakan metode ini untuk menyesuaikan volume audio semua iklan relatif terhadap output audio lain di perangkat.
Gunakan metode ini untuk menyesuaikan volume audio semua iklan relatif terhadap output audio lain di perangkat.
| Parameter | |
|---|---|
volume: number
|
Tingkat volume, antara 0,0 (senyap) dan 1,0 (maksimum). Nilai floating point apa pun dalam rentang ini valid (misalnya, 0,001 atau 0,33333). Nilai tidak dibatasi untuk kenaikan ukuran langkah tertentu, seperti 0,1. |
setUserMutedApp
setUserMutedApp(muted): void
Menetapkan apakah aplikasi dibisukan.
Gunakan metode ini untuk mengontrol status bisu audio awal pada iklan berikutnya.
Gunakan metode ini untuk mengontrol status bisu audio awal pada iklan berikutnya.
| Parameter | |
|---|---|
muted: boolean
|
Apakah audio aplikasi harus dibisukan. Nilai defaultnya adalah
false.
|
showPrivacyOptionsForm
showPrivacyOptionsForm(onDismissed?): void
Menampilkan formulir opsi privasi.
Menampilkan formulir opsi privasi jika getPrivacyOptionsRequirementStatus adalah
Metode ini hanya boleh dipanggil sebagai respons terhadap input pengguna untuk meminta formulir opsi privasi ditampilkan.
Formulir opsi privasi dimuat sebelumnya oleh SDK secara otomatis saat formulir tersedia. Jika tidak ada formulir yang telah dimuat sebelumnya, SDK akan mencoba memuatnya secara asinkron.
Callback
Menampilkan formulir opsi privasi jika getPrivacyOptionsRequirementStatus adalah
REQUIRED.Metode ini hanya boleh dipanggil sebagai respons terhadap input pengguna untuk meminta formulir opsi privasi ditampilkan.
Formulir opsi privasi dimuat sebelumnya oleh SDK secara otomatis saat formulir tersedia. Jika tidak ada formulir yang telah dimuat sebelumnya, SDK akan mencoba memuatnya secara asinkron.
Callback
onDismissed
dipanggil setelah pengguna melihat formulir, memilih
opsi, dan menutup formulir. API ini juga dapat ditampilkan dengan
FormError
jika:
- Formulir tidak tersedia.
- Formulir gagal ditampilkan.
- Formulir masih dimuat sebelumnya.
| Parameter | |
|---|---|
|
Fungsi callback yang dipanggil saat formulir ditutup, dengan FormError opsional jika presentasi gagal. |