adBreak()

İşlev imzası:

adBreak(
   type: '<type>',                     // The type of this placement
   name: '<name>',                     // A descriptive name for this placement
   beforeAd: () => {},                 // Prepare for the ad. Mute and pause the game flow
   afterAd: () => {},                  // Resume the game and re-enable sound
   beforeReward: (showAdFn) => {},     // Show reward prompt (call showAdFn() if clicked)
   adDismissed: () => {},              // Player dismissed the ad before completion
   adViewed: () => {},                 // Ad was viewed and closed
   adBreakDone: (placementInfo) => {}, // Always called (if provided) even if an ad didn't show
);

adBreak() parametreleri

Ad Tür Açıklama
Tüm yerleşim türleri
type dize

Yerleşimin türü. Değerler:

  • Oyun yüklenmeden önce (kullanıcı arayüzü oluşturulmadan önce) 'preroll'
  • Oyun başlamadan 'start' önce (kullanıcı arayüzü oluşturulduktan sonra)
  • 'pause' Oyuncu oyunu duraklattığında
  • 'next' oyuncu bir sonraki seviyeye geçer
  • 'browse' Oyuncu, oynanış dışındaki seçenekleri keşfederse
  • 'reward' ödüllü reklam
name dize (İSTEĞE BAĞLI) Oyununuzdaki bu reklam yerleşimi için bir ad. Bu, dahili bir tanımlayıcıdır ve oyuncuya gösterilmez. Bu tanımlayıcı, gelecekteki sürümlerde ek raporlama ve optimizasyon özelliklerini etkinleştirmek için kullanılabilir.

Tüm yerleşimlerinizi adlandırmanızı öneririz.
beforeAd işlev (İSTEĞE BAĞLI) Reklam gösterilmeden önce çağrılır. Oyun duraklatılmalı ve ses kapatılmalıdır. Bu işlemler senkron olarak yapılmalıdır. Reklam, bu geri çağırma işlemi tamamlandıktan hemen sonra gösterilir.
afterAd işlev (İSTEĞE BAĞLI) Reklam tamamlandıktan sonra (herhangi bir nedenle) çağrılır. Ödüllü reklamlarda, oynatıcı işlemlerine bağlı olarak adDismissed veya adViewed sonrası olarak adlandırılır. Bu işlev, oyun akışına devam etmek için kullanılmalıdır. Örneğin, sesi açmak ve bir sonraki seviyeye başlamak için kullanın.
adBreakDone işlev (İSTEĞE BAĞLI) Reklam gösterilmemiş olsa bile her zaman bir adBreak() içindeki son adım olarak çağrılır. İşlev, bağımsız değişken olarak aşağıdaki şekilde tanımlanan bir placementInfo nesnesi alır:
{
    breakType: '<type>',
    breakName: '<name>',
    breakFormat: 'interstitial|reward',
    breakStatus:  'error|noAdPreloaded|...|viewed',
}
Yerleşim bilgileri nesnesiyle ilgili ayrıntılı açıklama için adBreakDone ve placementInfo() bölümlerine bakın.
Yalnızca ödüllü yerleşimler...
beforeReward işlev Ödüllü reklam varsa çağrılır. İşlev, ödüllü reklamı göstermek için çağrılması gereken tek bir bağımsız değişken (showAdFn()) almalıdır.
adDismissed işlev Yalnızca oyuncu reklamı kapattığında ödüllü reklamlar için çağrılır. Yalnızca oynatıcı reklamı tamamlanmadan önce kapatırsa çağrılır. Bu durumda ödül verilmemelidir.
adViewed işlev Yalnızca ödüllü reklamlar için, oynatıcı reklamı tamamladığında ve ödül verilmesi gerektiğinde çağrılır.

adBreakDone() and placementInfo

Reklam Yerleşimi API'sinde gösterilecek bir reklam yoksa ilettiğiniz çeşitli before/after geri çağırmaları çağrılmaz. Ancak bir adBreakDone() geri çağırma işlevi sağlarsanız reklam gösterilmese bile bu işlev her zaman çağrılır. Bu sayede, yerleşimle ilgili yapmanız gereken ek işlemleri (ör. yerleşimle ilgili ek analizler kaydetme) gerçekleştirebilirsiniz.

adBreakDone() işlevi, aşağıdaki şekilde tanımlanan bir placementInfo nesnesini bağımsız değişken olarak alır:

{
  breakType: '<type>',
  breakName: '<name>',
  breakFormat: 'interstitial|reward',
  breakStatus: 'notReady|timeout|error|noAdPreloaded|frequencyCapped|ignored|other|dismissed|viewed',
}

Bu nesnedeki alanlar aşağıdaki anlambilimlere sahiptir:

  • breakType, adBreak()'ye iletilen tür bağımsız değişkenidir.
  • breakName, adBreak() işlevine iletilen ad bağımsız değişkenidir.
  • breakStatus, bu yerleşimin durumudur ve aşağıdaki değerlerden biri olabilir:
breakStatus Neden
'notReady' Reklam Yerleşimi API'si başlatılmamış
'timeout' Reklam Yerleşimi API'sinin yanıt vermesi çok uzun sürdüğünden bir yerleşim zaman aşımına uğradı
'invalid' Yerleşim geçersizdi ve yoksayıldı. Örneğin, sayfa yükleme başına yalnızca bir ön rulo yerleşimi olmalıdır. Sonraki ön rulo yerleşimleri bu durumla başarısız olur.
'error' Geri çağırmada bir JavaScript hatası oluştu
'noAdPreloaded' Henüz önceden yüklenmiş bir reklam olmadığından bu yerleşim atlandı
'frequencyCapped' Sıklık sınırı bu yerleşime uygulandığı için bir reklam gösterilmedi
'ignored' Kullanıcı, bir sonraki yerleşime ulaşmadan önce ödül istemini tıklamadı. Yani bir sonraki adBreak()'den önce showAdFn() çağrılmadı.
'other' Reklam başka bir nedenle gösterilmedi. (ör. Reklam henüz getirilmemiş veya ekranın boyutu değiştirildiği/döndürüldüğü için önceden önbelleğe alınmış bir reklam silinmiş olabilir.)
'dismissed' Kullanıcı, ödüllü bir reklamı tamamlanana kadar görüntülemeden kapattı
'viewed' Reklam, kullanıcı tarafından görüntülendi

Not: adBreakDone(), adBreak()'ün her zaman son geri çağırma işlemidir.

Bir reklam gösterildikten sonra oyununuzu devam ettirmek için afterAd() kullanırsanız oyununuz yeniden başlatıldıktan sonra adBreakDone() çağrılır. Analytics'i kaydetme gibi işlemler için bu uygun olabilir ancak oyununuz yeniden başlamadan önce ek işlemler yapmak istiyorsanız oyununuzu duraklatma mantığını afterAd() konumundan adBreakDone() konumuna taşıyın.