google. ima. ImaSdkSettings
Bu sınıfta SDK genelinde ayarlar bulunur.
Numaralandırmalar
Tamamlayıcı Dolgu Modu
string
Tamamlayıcı dolgu ayarı için bir sabit değer kümesi tanımlar. Bu ayar, çeşitli senaryolarda tamamlayıcıların doldurulmasının gerekip gerekmediğini gösterir.
Değer ALWAYS
ise ana reklam döndürülmese bile her durumda tamamlayıcı dolgu denenir.
Değer ON_MASTER_AD
ise ve tamamlayıcı
alandan daha az tamamlayıcı içeren bir ana reklam varsa tamamlayıcı dolgu denenir. Eksik tamamlayıcılar doldurulacaktır.
Varsayılan değer: ALWAYS
... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices();Otomatik oynatma videoları için tamamlayıcı alanların önceden yüklenmesini ve ardından hemen tamamlayıcılarla değiştirilmesini önlemek için aşağıdaki ek değişiklik önerilir.
googletag.pubads().disableInitialLoad(); ... googletag.enableServices();
Değer |
|
---|---|
HER ZAMAN |
|
ON_MASTER_AD - |
VpaidMode
number (sayı)
VPAID işlevini etkinleştirmek için bir sabit değer grubu.
Değer |
|
---|---|
DEVRE DIŞI |
VPAID reklamları oynatılmaz ve hata döndürülür. |
ETKİN |
VPAID reklamları, alanlar arası iFrame kullanılarak etkinleştirilir. VPAID reklamı siteye erişemez. Uygun iframe erişimine bağlı VPAID reklamları hatalı olabilir. Bu, varsayılan seçenektir. |
GİZLİ |
VPAID reklamları, uygun bir iframe kullanılarak etkinleştirilir. Bu, JavaScript'in reklama siteye erişmesini sağlar. |
Özellikler
Tamamlayıcı Dolgu Modu
string
Tamamlayıcı dolgu ayarı için bir sabit değer kümesi tanımlar. Bu ayar, çeşitli senaryolarda tamamlayıcıların doldurulmasının gerekip gerekmediğini gösterir.
Değer ALWAYS
ise ana reklam döndürülmese bile her durumda tamamlayıcı dolgu denenir.
Değer ON_MASTER_AD
ise ve tamamlayıcı
alandan daha az tamamlayıcı içeren bir ana reklam varsa tamamlayıcı dolgu denenir. Eksik tamamlayıcılar doldurulacaktır.
Varsayılan değer: ALWAYS
... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices();Otomatik oynatma videoları için tamamlayıcı alanların önceden yüklenmesini ve ardından hemen tamamlayıcılarla değiştirilmesini önlemek için aşağıdaki ek değişiklik önerilir.
googletag.pubads().disableInitialLoad(); ... googletag.enableServices();
Değer |
|
---|---|
HER ZAMAN |
|
ON_MASTER_AD - |
VpaidMode
number (sayı)
VPAID işlevini etkinleştirmek için bir sabit değer grubu.
Değer |
|
---|---|
DEVRE DIŞI |
VPAID reklamları oynatılmaz ve hata döndürülür. |
ETKİN |
VPAID reklamları, alanlar arası iFrame kullanılarak etkinleştirilir. VPAID reklamı siteye erişemez. Uygun iframe erişimine bağlı VPAID reklamları hatalı olabilir. Bu, varsayılan seçenektir. |
GİZLİ |
VPAID reklamları, uygun bir iframe kullanılarak etkinleştirilir. Bu, JavaScript'in reklama siteye erişmesini sağlar. |
Yöntemler
getCompanionBackfill
getCompanionBackfill() CompanionBackfillMode değerini döndürür
Mevcut tamamlayıcı dolgu modunu döndürür.
- İadeler
-
non-null CompanionBackfillMode
Geçerli değer.
iOS Devre Dışı
getDisableCustomplayForIOS10Plus() Boole değerini döndürür
iOS 10 ve üzeri tarayıcılarda özel oynatmanın devre dışı bırakılıp bırakılmayacağını belirler. Varsayılan değer, false (yanlış) değeridir.
- İadeler
-
boolean
getFeatureİşaretleri
getFeatureFlags() herhangi bir tür özelliğine sahip Nesneyi döndürür
Nesneleri özellik işareti olarak, değerleri ise geçerli durum olarak döndürür.
- İadeler
-
non-null Object with any type properties
yerel ayar
getLocale() dönüş dizesi
Yayıncı tarafından sağlanan yerel ayarı döndürür.
- İadeler
-
string
Yayıncı tarafından sağlanan yerel ayar.
getNumRedirects
getNumRedirects() dönüştürülen sayı
Sonraki yönlendirmeler için reddedilecek maksimum yönlendirme sayısını döndürür.
- İadeler
-
number
maksimum yönlendirme sayısı.
getPlayerTürü
getPlayerType() dizesini döndürür
İş ortağı tarafından sağlanan oyuncu türünü döndürür.
- İadeler
-
string
İş ortağı oyuncu türü.
getPlayerSürümü
getPlayerVersion() dizesini döndürür
İş ortağı tarafından sağlanan oynatıcı sürümünü döndürür.
- İadeler
-
string
İş ortağı oyuncu sürümü.
getPpid
getPpid() dönüşleri (null veya dize)
Yayıncı tarafından sağlanan kimliği döndürür.
- İadeler
-
Yayıncı tarafından sağlanan
(null or string)
kimliği.
isCookiesEtkin
isCookiesEnabled() Boole değerini döndürür
- İadeler
-
boolean
Yayıncının çerezlerin kullanılmasına izin verip vermediği.
otomatik oynatmareklam_araları
setAutoPlayAdBreaks(autoPlayAdBreaks) durum döndürür
VMAP ve reklam kuralları reklam aralarının otomatik olarak oynatılıp oynatılmayacağını ayarlar
Parametre |
|
---|---|
otomatik_ReklamAraları |
boolean Reklam aralarının otomatik olarak oynatılıp oynatılmayacağı. |
- İadeler
-
void
setCompanionBackfill
setCompanionBackfill(mode) geçersiz değeri döndürür
Tamamlayıcı dolgu modunu ayarlar. ImaSdkSettings.CompanionBackfillMode'da bulunan çeşitli modlara göz atın.
Varsayılan mod ImaSdkSettings.CompanionBackfillMode.ALWAYS şeklindedir.
Parametre |
|
---|---|
mod |
Tamamlayıcı Dolgu Modu Seçilen tamamlayıcı dolgu modu. Değer boş olmamalıdır. |
- İadeler
-
void
setCookiesEnabled
setCookiesEnabled(cookiesEnabled) geçersiz değer döndürür
SDK'nın, birinci taraf çerezi olarak yayıncının alan adında bir Google Ad Manager çerezini (GFP Çerezi) depolayıp depolamayacağı. Bu, üçüncü taraf çerezlerini kullanmadan aynı alana yapılan birden fazla ziyarette kalıcılık sağlar. Varsayılan olarak true değerine ayarlanır.
Bu ayar, diğer tarafların ayarlayabileceği veya başka amaçlarla kullanabileceği diğer çerezleri etkilemez. Kullanıcı rızası ve devre dışı bırakma işlemleri birinci taraf çerezlerinin kullanımını da devre dışı bırakabilir. Bunlar, aynı çerçevede olan, IAB uyumlu bir Kullanıcı Rızası Yönetim Sağlayıcısı tarafından kullanılır.
Parametre |
|
---|---|
Çerezler Etkin |
boolean |
- İadeler
-
void
IOS10Plus için Devre Dışı BırakmaÖzel Oynatma
setDisableCustomplayForIOS10Plus(devre dışı bırak) geçersiz değer döndürür
iOS 10 ve üzeri tarayıcılarda özel oynatmanın devre dışı bırakılıp bırakılmayacağını belirler. Doğruysa, içerik videosu satır içiyse reklamlar satır içinde oynatılır. Bu, TrueView atlanabilir reklamlarını etkinleştirir. Ancak reklam satır içi olarak kalır ve iOS'un yerel tam ekran özelliğini desteklemez. Yanlış değerine ayarlandığında reklamlar, içeriğinizle aynı oynatıcıda oynatılır. AdDisplayKapsayıcı oluşturulduğunda burada ayarlanan değer, kapsayıcının kullanım ömrü boyunca kullanılır. Varsayılan değer, false (yanlış) değeridir.
Parametre |
|
---|---|
disable |
boolean Özel oynatmanın devre dışı bırakılıp bırakılmayacağı. |
- İadeler
-
void
setÖzellik İşaretleri
setFeatureFlags(featureFlags) return geçersiz
Özellik işaretlerinin değerini ayarlayın. Bu işlem, reklam istenmeden önce mümkün olduğunca erken ayarlanmalıdır. Ayarlar bir sonraki reklam isteğine kadar sabit kalır. Bu yöntemin tekrar çağrılması, sonraki reklam isteği için tüm özellik işaretlerini sıfırlar.
Parametre |
|
---|---|
özellik İşaretleri |
Herhangi bir tür özelliğine sahip nesne Değer boş olmamalıdır. |
- İadeler
-
void
setLocale
setLocale(locale) return (geçersiz)
Yayıncı tarafından sağlanan yerel ayarı belirtir. AdsLoader veya AdDisplayKapsayıcı oluşturulmadan önce çağrılmalıdır. Yerel ayar, kullanıcı arayüzü öğelerinin hangi dilde gösterileceğini belirtir. Desteklenen kodları Dil ve Yerel Ayar için Yerelleştirme bölümünde bulabilirsiniz.
Parametre |
|
---|---|
locale |
string Yayıncı tarafından sağlanan yerel ayar. |
- İadeler
-
void
setNumRedirects
setNumRedirects(numRedirects) return geçersiz
Sonraki yönlendirmeler reddedilmeden ve reklam yükü iptal edilmeden önce en fazla yönlendirme sayısını belirtir. Yönlendirme sayısı, gecikmeyi ve dolayısıyla kullanıcı deneyimini doğrudan etkiler. Bu, tüm VAST sarmalayıcı reklamları için geçerlidir.
Parametre |
|
---|---|
numRedirect'ler |
number (sayı) Maksimum yönlendirme sayısı. |
- İadeler
-
void
SetPlayerTürü
setPlayerType(playerType) return geçersiz kılar
İş ortağı tarafından sağlanan oynatıcı türünü ayarlar. Bu ayar, SDK ile entegre edilen oynatıcının adını belirtmek için kullanılmalıdır. 20 karakterden uzun oyuncu türü kısaltılır. Belirtilen oynatıcı türü kısa ve benzersiz olmalıdır. Bu, oynatıcı türlerini izleyerek SDK'nın kullanılabilirliğini iyileştirmek için kullanılan isteğe bağlı bir ayardır.
Örnek:
settings.setPlayerType('google/gmf-player');
Parametre |
|
---|---|
playerType |
string İş ortağının oynatıcısının türü. |
- İadeler
-
void
setPlayerSürümü
setPlayerVersion(playerVersion) geçersiz değer döndürür
İş ortağı tarafından sağlanan oynatıcı sürümünü ayarlar. Bu ayar, SDK ile entegre edilen iş ortağı oynatıcının sürümünü belirtmek için kullanılmalıdır. 20 karakterden uzun oyuncu sürümleri kısaltılır. Bu, oynatıcı sürümünü izleyerek SDK'nın kullanılabilirliğini iyileştirmek için kullanılan isteğe bağlı bir ayardır.
Örnek:
settings.setPlayerVersion('1.0.0');
Parametre |
|
---|---|
oynatıcıSürümü |
string İş ortağının oynatıcısının sürümü. |
- İadeler
-
void
setPid
setPpid(ppid) geçersiz değeri döndürür
Yayıncı tarafından sağlanan kimliği belirler.
Parametre |
|
---|---|
yöresel |
string yayıncı tarafından sağlanan kimlik. |
- İadeler
-
void
oturum kimliği
setSessionId(sessionId) geçersiz değeri döndürüyor
Oturum kimliği geçici bir rastgele kimliktir. Yalnızca sıklık sınırı için kullanılır. Oturum kimliği UUID olmalıdır.
Parametre |
|
---|---|
oturum kimliği |
string Sıklık sınırı için kullanılan geçici bir UUID. |
- İadeler
-
void
setVpaidAllowed
setVpaidAllowed(allowVpaid) geçersiz değerini döndürür
Kullanımdan kaldırıldı. setVpaidMode kullanın. VPAID reklam öğelerine izin verilip verilmeyeceğini ayarlar.
Parametre |
|
---|---|
allowVpaid |
boolean VPAID reklam öğelerine izin verilip verilmeyeceğini belirler. |
- İadeler
-
void
Ödenmiş Mod
setVpaidMode(vpaidMode) return
VPAID oynatma modunu ayarlar.
Parametre |
|
---|---|
vpaidMode |
VpaidMode VPAID reklamlarının nasıl oynatılacağını ayarlar. Varsayılan ayar güvenli moddur. Değer boş olmamalıdır. |
- İadeler
-
void