API Referansı

Adsgram Metotları

init

Reklamı göstermek, yüklemek ve yok etmek için kullanılan AdController oluşturur.
Bir blockId için yalnızca bir kez başlatmak yeterlidir.
Aynı blockId ile init fonksiyonunu birden fazla kez çağırırsanız, bu blockId için aynı AdController'ı alırsınız.

Syntax

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

Parametreler

blockId

Rakamlardan oluşan string, örneğin "123".
Yayıncı hesabında aldığınız reklam bloğunun benzersiz tanımlayıcısı.
blockId nasıl alınacağına dair detaylı talimatları blockId alma bölümünde bulabilirsiniz.

debug Optional

Boolean değeri, true olarak ayarlandığında sunucudan test reklamıyla yanıt alırsınız ve entegrasyon hata ayıklaması için ADSGRAM DEBUG LOG önekli detaylı loglar tarayıcı konsoluna yazdırılır.

DANGER

Production'a release ederken kaldırmayı veya false olarak ayarlamayı unutmayın.
Test reklamı gösterimlerini istatistiklere eklemediğimiz için, platform ve blok sayfasında gösterim, gösteri, tıklama vb. istatistiklerini göremezsiniz.
Reward Url'e istek gönderilmez.

debugConsole Optional

Boolean değeri. Varsayılan true. Yalnızca debug parametresi true olduğunda çalışır.
true ise, ADSGRAM DEBUG LOG önekli detaylı loglar tarayıcı konsoluna yazdırılır. false ise, loglar hata ayıklama modunda bile konsola yazdırılmaz.

debugBannerType Optional

Olası değerler "FullscreenMedia" ve "RewardedVideo".
Tam olarak test banner tipini almak istediğinizde bu değeri kullanın. Yalnızca debug parametresi true olduğunda çalışır.

Dönüş Değeri

AdController

AdController Metotları

show

Reklamı yükler ve gösterir.

Syntax

javascript

AdController.show();

typescript

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

Dönüş Değeri

Kullanıcı reklamı sonuna kadar izlerse çözülür, aksi halde reddedilen Promise.
Promise sonucu aşağıdaki türlere sahiptir:

interface ShowPromiseResult {
  done: boolean; // kullanıcı sonuna kadar izlerse true, aksi halde false
  description: string; // olay açıklaması
  state: 'load' | 'render' | 'playing' | 'destroy'; // banner durumu
  error: boolean; // olay hata nedeniyle yayımlandıysa true, aksi halde false
}

Örnekler

Promises API kullanımı:

javascript

AdController.show().then((result) => {
  // kullanıcı reklamı sonuna kadar izler
  // kullanıcıyı ödüllendirme kodunuz
}).catch((result) => {
  // kullanıcı reklam oynatma sırasında hata alır veya reklamı atlar
  // hiçbir şey yapmayın veya istediğinizi yapın
})

typescript

AdController.show().then((result: ShowPromiseResult) => {
  // kullanıcı reklamı sonuna kadar izler
  // kullanıcıyı ödüllendirme kodunuz
}).catch((result: ShowPromiseResult) => {
  // kullanıcı reklam oynatma sırasında hata alır veya reklamı atlar
  // hiçbir şey yapmayın veya istediğinizi yapın
})

Aynı davranışı await kullanarak da elde edebilirsiniz

javascript

try {
  const showPromiseResult = await AdController.show();
  // kullanıcı reklamı sonuna kadar izler
  // kullanıcıyı ödüllendirme kodunuz
} catch (showPromiseResult) {
  // kullanıcı reklam oynatma sırasında hata alır veya reklamı atlar
  // hiçbir şey yapmayın veya istediğinizi yapın
}

typescript

try {
  const showPromiseResult: ShowPromiseResult = await AdController.show();
  // kullanıcı reklamı sonuna kadar izler
  // kullanıcıyı ödüllendirme kodunuz
} catch (showPromiseResult: ShowPromiseResult) {
  // kullanıcı reklam oynatma sırasında hata alır veya reklamı atlar
  // hiçbir şey yapmayın veya istediğinizi yapın
}

TIP

Reklam oynatmayı bitirdikten, atlandıktan veya hata aldıktan sonra herhangi bir ek eylem eklemeniz gerekiyorsa promise'i finally ile zincirleyin.

destroy

Reklamı göstermeyi durdurur ve yüklenen banner verilerini kaldırır.

Syntax

AdController.destroy();

Dönüş Değeri

Yok(undefined)

INFO

Genellikle bunu manuel olarak çağırmanız gerekmez, hata durumunda, atlama veya reklam tamamen izlendiğinde reklam otomatik olarak yok edilecektir.

addEventListener

event'e abone olur ve event tetiklendiğinde callback fonksiyonunu çağırır.
Reklam gösterimi üzerinde daha fazla kontrole ihtiyacınız varsa kullanılır.

Syntax

AdController.addEventListener('onReward', () => {
    // kullanıcıyı ödüllendirme kodunuz
});

Parametreler

event

Olay Türleri:

Event	Ne Zaman Gerçekleşir
onStart	ilk banner karesi gösterildiğinde
onSkip	kullanıcı reklamı kapattığında
onReward	kullanıcı rewarded banner'ı sonuna kadar izlediğinde
onComplete	kullanıcı interstitial banner'ı sonuna kadar izlediğinde veya kapattığında
onError	kullanıcı banner render edilirken veya oynatılırken hata aldığında
onBannerNotFound	gösterilecek banner olmadığında
onNonStopShow	kullanıcı arka arkaya birkaç reklam izlemeye çalıştığında
onTooLongSession	oturum çok uzun olduğunda, reklam almak için uygulamanın yeniden başlatılması gerekir

TIP

Özel uyarınızı göstermek istiyorsanız, onBannerNotFound, onNonStopShow veya onTooLongSession olaylarına abone olabilirsiniz.
Aksi halde varsayılan uyarıyı göstereceğiz.
Uyarı, kullanıcının dilinde veya İngilizce görüntülenir
ve şu şekilde görünür 👇

callback

Belirtilen türde bir olay gerçekleştiğinde çağrılacak fonksiyon.

Dönüş Değeri

Yok(undefined)

removeEventListener

Belirlenen callback ile event'e aboneliği kaldırır

Syntax

AdController.removeEventListener('onReward', rewardFunction);

Parametreler

addEventListener ile aynı

Dönüş Değeri

Yok(undefined)