Referensi API

Metode Adsgram

init

Membuat AdController yang digunakan untuk menampilkan, memuat, dan menghancurkan iklan.
Cukup melakukan inisialisasi satu kali untuk satu blockId.
Jika Anda memanggil fungsi init dengan blockId yang sama lebih dari satu kali, Anda akan mendapatkan AdController yang sama untuk blockId tersebut.

Sintaks

const AdController = window.Adsgram.init({
  blockId: "your-block-id",
  debug: true,
  debugConsole: true,
  debugBannerType: "FullscreenMedia"
});

Parameter

blockId

String dengan angka, misalnya "123".
Pengenal unik dari block iklan yang Anda terima di akun publisher.
Instruksi lengkap tentang cara mendapatkan blockId dapat Anda temukan di Bagian mendapatkan blockId

debug Optional

Nilai boolean jika diatur ke true Anda akan mendapatkan respons dari server dengan iklan test dan log terperinci dengan awalan ADSGRAM DEBUG LOG akan ditampilkan di konsol browser untuk debugging integrasi.

DANGER

Jangan lupa untuk menghapus atau mengatur ke false saat merilis ke produksi.
Kami tidak menambahkan tayangan iklan test ke statistik, sehingga Anda tidak akan melihat statistik tayangan, tampilan, klik, dll. di halaman platform dan block.
Permintaan ke Reward Url tidak akan dikirim.

debugConsole Optional

Nilai boolean. Default adalah true. Hanya berfungsi jika parameter debug bernilai true.
Jika true, log terperinci dengan awalan ADSGRAM DEBUG LOG akan ditampilkan di konsol browser. Jika false, log tidak ditampilkan di konsol, bahkan dalam mode debug.

debugBannerType Optional

Nilai yang mungkin adalah "FullscreenMedia" dan "RewardedVideo".
Gunakan nilai ini ketika Anda ingin mendapatkan tipe banner test yang tepat. Hanya berfungsi jika parameter debug bernilai true.

Nilai kembalian

AdController

Metode AdController

show

Memuat dan menampilkan iklan.

Sintaks

javascript

AdController.show();

typescript

const showPromise: Promise<ShowPromiseResult> = AdController.show();

Nilai kembalian

Promise yang menjadi resolved jika pengguna menonton iklan hingga selesai, jika tidak rejected.
Hasil promise memiliki tipe sebagai berikut:

interface ShowPromiseResult {
  done: boolean; // true jika pengguna menonton hingga selesai, jika tidak false
  description: string; // deskripsi event
  state: 'load' | 'render' | 'playing' | 'destroy'; // status banner
  error: boolean; // true jika event dipancarkan karena error, jika tidak false
}

Contoh

Menggunakan API promises:

javascript

AdController.show().then((result) => {
  // pengguna menonton iklan hingga selesai
  // kode Anda untuk memberikan hadiah kepada pengguna
}).catch((result) => {
  // pengguna mendapatkan error saat memutar iklan atau melewatkan iklan
  // tidak melakukan apa-apa atau sesuaikan keinginan Anda
})

typescript

AdController.show().then((result: ShowPromiseResult) => {
  // pengguna menonton iklan hingga selesai
  // kode Anda untuk memberikan hadiah kepada pengguna
}).catch((result: ShowPromiseResult) => {
  // pengguna mendapatkan error saat memutar iklan atau melewatkan iklan
  // tidak melakukan apa-apa atau sesuaikan keinginan Anda
})

Anda juga dapat mencapai perilaku yang sama menggunakan await

javascript

try {
  const showPromiseResult = await AdController.show();
  // pengguna menonton iklan hingga selesai
  // kode Anda untuk memberikan hadiah kepada pengguna
} catch (showPromiseResult) {
  // pengguna mendapatkan error saat memutar iklan atau melewatkan iklan
  // tidak melakukan apa-apa atau sesuaikan keinginan Anda
}

typescript

try {
  const showPromiseResult: ShowPromiseResult = await AdController.show();
  // pengguna menonton iklan hingga selesai
  // kode Anda untuk memberikan hadiah kepada pengguna
} catch (showPromiseResult: ShowPromiseResult) {
  // pengguna mendapatkan error saat memutar iklan atau melewatkan iklan
  // tidak melakukan apa-apa atau sesuaikan keinginan Anda
}

TIPS

Rantai promise dengan finally jika Anda perlu menambahkan tindakan tambahan setelah iklan selesai diputar, dilewati, atau mendapatkan error.

destroy

Untuk menghentikan penampilan iklan dan menghapus data banner yang telah dimuat.

Sintaks

AdController.destroy();

Nilai kembalian

None(undefined)

INFO

Biasanya Anda tidak perlu memanggilnya secara manual, dalam kasus error, dilewati, atau iklan ditonton sepenuhnya, iklan akan otomatis dihancurkan.

addEventListener

Berlangganan event dan memanggil fungsi callback jika event dipicu.
Digunakan jika Anda memerlukan kontrol lebih lanjut atas tampilan iklan.

Sintaks

AdController.addEventListener('onReward', () => {
    // kode Anda untuk memberikan hadiah kepada pengguna
});

Parameter

event

Jenis event:

Event	Terjadi
onStart	saat frame pertama banner ditampilkan
onSkip	saat pengguna menutup iklan
onReward	saat pengguna menonton banner reward hingga selesai
onComplete	saat pengguna menonton banner interstitial hingga selesai atau menutupnya
onError	saat pengguna mendapatkan error selama rendering atau memutar banner
onBannerNotFound	saat tidak ada banner untuk ditampilkan
onNonStopShow	saat pengguna mencoba menonton beberapa iklan secara berurutan
onTooLongSession	saat sesi terlalu lama, pengguna perlu memulai ulang aplikasi untuk mendapatkan iklan

TIP

Jika Anda ingin menampilkan alert kustom, Anda dapat berlangganan ke onBannerNotFound, onNonStopShow, atau onTooLongSession.
Jika tidak, kami akan menampilkan alert default.
Alert ditampilkan dalam bahasa pengguna atau dalam bahasa Inggris
dan terlihat seperti ini 👇

callback

Fungsi yang akan dipanggil saat event dengan tipe yang ditentukan terjadi.

Nilai kembalian

None(undefined)

removeEventListener

Berhenti berlangganan event dengan callback yang telah ditentukan

Sintaks

AdController.removeEventListener('onReward', rewardFunction);

Parameter

Sama seperti pada addEventListener

Nilai kembalian

None(undefined)