İş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 |
string | Yerleşimin türü. Değerler:
|
name |
string | (İSTEĞE BAĞLI) oyununuzdaki bu reklam yerleşiminin adı. Dahili bir tanımlayıcıdır ve oynatıcıya gösterilmez. Gelecekteki sürümlerde bu tanımlayıcı, ek raporlama ve optimizasyon özelliklerini etkinleştirmek için kullanılabilir. Tüm yerleşimlerinizi adlandırmanızı öneririz. |
beforeAd |
fonksiyon | (İSTEĞE BAĞLI) Reklam gösterilmeden önce çağrılır. Oyunun sesi duraklatmalı ve sesi kapatmalıdır. Bu işlemler eşzamanlı olarak yapılmalıdır. Reklam, bu geri çağırma bittikten hemen sonra gösterilecektir. |
afterAd |
fonksiyon | (İSTEĞE BAĞLI) Reklam bittikten sonra çağrılır (herhangi bir nedenle). Ödüllü reklamlarda oyuncu işlemlerine bağlı olarak, adDismissed veya adViewed sonra çağrılır. Bu işlev, oyun akışını devam ettirmek için kullanılmalıdır. Örneğin, sesi açmak ve sonraki düzeyi başlatmak için kullanın. |
adBreakDone |
fonksiyon | (İSTEĞE BAĞLI) Reklam gösterilmemiş olsa bile her zaman adBreak() içindeki son adım olarak çağrılır. İşlev, bağımsız değişken olarak bir placementInfo nesnesinin şu şekilde tanımlandığını varsayar:
Yerleşim bilgileri nesnesinin ayrıntılı bir açıklaması için adBreakDone ve placementInfo() özelliklerine bakın. |
Yalnızca ödüllü yerleşimler... | ||
beforeReward |
fonksiyon | Ödüllü reklam varsa çağrılır. İşlev, ödüllü reklamı görüntülemek için çağrılması gereken tek bir bağımsız değişken (showAdFn() ) almalıdır. |
adDismissed |
fonksiyon | Ödüllü reklamlar için yalnızca oynatıcı reklamı kapattığında çağrılır. Yalnızca oynatıcı reklamı tamamlamadan önce kapatırsa çağrılır. Bu durumda ödül verilmemelidir. |
adViewed |
fonksiyon | Ödüllü reklamlar için yalnızca oynatıcı reklamı tamamladığında ve ödül verilmeli olduğunda çağrılır. |
adBreakDone()
and placementInfo
Reklam Yerleşimi API'sinde gösterilecek bir reklam yoksa, ilettiğiniz çeşitli önceki/sonraki geri çağırmaları çağırmaz. Ancak bir adBreakDone()
geri çağırması sağlarsanız, bir reklam gösterilmese bile her zaman çağrılır. Bu, yerleşimle ilgili yapmanız gereken ek işlemleri (ör. yerleşimle ilgili ek analizleri günlüğe kaydetme) yapmanızı sağlar.
adBreakDone()
işlevi, aşağıdaki gibi 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 nesnenin içindeki alanlar aşağıdaki anlamlara sahiptir:
breakType
,adBreak()
türüne iletilen tür bağımsız değişkenidirbreakName
,adBreak()
ürününe iletilen ad bağımsız değişkenibreakStatus
, bu yerleşimin durumudur ve aşağıdaki değerlerden biri olabilir:
breakStatus |
Neden |
---|---|
'notReady' |
Ad Placement API başlatılmadı |
'timeout' |
Reklam Yerleşimi API'sinin yanıt vermesi çok uzun sürdüğü için 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 tane videodan önce gösterilen reklam yerleşimi olmalıdır; sonraki videodan önce gösterilen reklamlar bu durumda başarısız olur |
'error' |
Geri çağırmada JavaScript hatası oluştu |
'noAdPreloaded' |
Reklam henüz yüklenmediği için bu yerleşim atlandı |
'frequencyCapped' |
Bu yerleşime sıklık sınırı uygulandığından reklam gösterilmiyor |
'ignored' |
Kullanıcı bir sonraki yerleşime ulaşmadan önce ödül istemini tıklamadı. Bu, bir sonraki adBreak() öncesinde showAdFn() için çağrılmadı. |
'other' |
Reklam başka bir nedenle gösterilmedi. (ör. Reklam hala getiriliyordu veya ekran yeniden boyutlandırıldığı/döndürüldüğü için daha önce önbelleğe alınmış bir reklam atıldı.) |
'dismissed' |
Kullanıcı, ödüllü bir reklamı sonuna kadar görüntülemeden kapattı |
'viewed' |
Reklam kullanıcı tarafından görüntülendi |
Not: adBreakDone()
her zaman adBreak()
tarafından yapılan son geri aramadır.
Reklam gösterildikten sonra oyununuzun duraklatmasını kaldırmak için afterAd()
kodunu kullanırsanız oyununuz yeniden başlatıldıktan sonra adBreakDone()
çağrılır. Günlük kaydı analizi gibi işlemler için bu durum uygun olabilir. Ancak, oyununuz yeniden başlatılmadan önce daha fazla işlem yapmak isterseniz mantığınızı afterAd()
adlı uygulamanızın adBreakDone()
modundan devam ettirebilirsiniz.