google. ima. Reklam
Farklı reklam türlerini temsil eden sınıflar tarafından genişletilen bir reklam sınıfı.
Yöntemler
reklam kimliği
getAdId() dize döndürür
Reklam kimliği, ana reklam ve tamamlayıcı reklamları senkronize etmek için kullanılır.
- İadeler
-
string
Reklamın kimliği veya bu bilgi yoksa boş dize
ReklamAdıAdı
getAdPodInfo() , AdPodInfo işlevini döndürür
Reklamın kapsül bilgilerini döndürür.
- İadeler
-
non-null AdPodInfo
Reklamın kapsül bilgileri.
reklamReklamSistemi
getAdSystem() dizeyi döndürür
Reklam yanıtında yer alan kaynak reklam sunucusu bilgileri.
- İadeler
-
string
Reklamın kaynak reklam sunucusu veya bu bilgi yoksa boş dize.
Reklamveren Reklamvereni
getReklamverenName() dize dizesi
Reklam yayınlayan tarafın tanımladığı reklamveren adı.
- İadeler
-
string
Reklamveren adı veya bu bilgiler kullanılamıyorsa boş dize.
getApiFramework
getApiFramework() dize döndürür
Reklamı yürütmek için gereken API'yi tanımlar. Bu, vast'ta belirtilen apiFramework'ne karşılık gelir.
- İadeler
-
nullable string
Reklam çerçevesinin reklamı yürütmesi veya bu bilgi kullanılamıyorsa boş olması gerekir.
getCompanionAds
getCompanionAds(adSlotWidth, adSlotHeight, settings) boş olmayan CompanionAd dizisini döndürür
Tamamlayıcı reklam alanı boyutuna göre bu reklamın tamamlayıcı reklamlarını alır. İsteğe bağlı olarak, gelişmiş seçim ayarları kabul edilir. Bu yöntemin yalnızcaSTARTED etkinliğinde veya sonrasında edinilen reklam örnekleri için boş olmayan dizi döndüreceğini unutmayın. Özellikle, YÜKLENDİ etkinliğinden gelen reklamlar boş bir dizi döndürür.
Parametre |
|
---|---|
reklam alanı genişliği |
sayı Tamamlayıcı reklam alanının genişliği. |
reklam alanı yüksekliği |
sayı Tamamlayıcı reklam alanının yüksekliği. |
ayarlar |
İsteğe bağlı Tamamlayıcı Reklam Seçimi Ayarları Tamamlayıcı reklamlar için seçim ayarları. Değer boş olamaz. |
- İadeler
-
non-null Array of non-null CompanionAd
Ayarlarla ve alan boyutuyla eşleşen tamamlayıcı reklamlar dizisi.
getContentType
getContentType() dizeyi döndürür
Seçili reklam öğesinin içerik türünü veya reklam öğesi seçilmezse ya da içerik türü kullanılamıyorsa boş dize döndürür. Doğrusal reklamlar için içerik türü yalnızca medya dosyası seçiliyken START etkinliğinden sonra kullanılabilir.
- İadeler
-
string
İçerik türü (mevcut değilse boş dize).
reklam öğesi kimliği
getCreativeAdId() dize döndürür
Bir reklama ait ISCI (Industry Standard Commercial Identifier) kodunu veya kod mevcut değilse boş dize döndürür. Bu, VAST yanıtındaki reklam öğesinin Reklam Kimliğidir.
- İadeler
-
string
getCreativeId
getCreativeId() dize döndürür
Reklam için seçilen reklam öğesinin kimliğini alır.
- İadeler
-
string
Reklam için seçilen reklam öğesinin kimliği veya bu bilgi mevcut değilse boş dize.
GetDealId
getDealId() dize dizesi
Yukarıdan başlayarak geçerli reklam için sarmalayıcı zincirinde bulunan ilk anlaşma kimliğini döndürür. Uygun değilse boş dizeyi döndürür.
- İadeler
-
string
GetDescription
getDescription() dize döndürür
VAST yanıtından bu reklamın açıklamasını döndürür.
- İadeler
-
string
Belirtilmezse boş olan açıklama.
getDuration
getDuration() dönüş sayısı
Seçilen reklam öğesinin süresini veya doğrusal olmayan reklam öğeleri için -1 değerini döndürür.
- İadeler
-
number
Saniye cinsinden seçilen reklam öğesi süresi (doğrusal değilse -1).
Yükseklik
getHeight() dönüş sayısı
Seçilen doğrusal olmayan reklam öğesinin yüksekliğini döndürür.
- İadeler
-
number
Seçilen doğrusal olmayan reklam öğesinin yüksekliği veya bir doğrusal reklam öğesi için 0.
getMediaUrl
getMediaUrl() dize döndürür
Şu anda kullanımda olan medya seçim ayarlarına göre reklamdan seçilen medya dosyasının URL'sini döndürür. Bu bilgi mevcut değilse boş değer döndürür. BAŞLANGIÇLI etkinlikte kullanılabilir.
- İadeler
-
nullable string
dk.ÖnerilenSüre
getMinSuggestedDuration(), dönüş sayısı
Doğrusal olmayan reklam öğesinin görüntüleneceği saniye cinsinden minimum önerilen süreyi döndürür. Önerilen minimum süre bilinmiyorsa -2 değerini döndürür. Doğrusal reklam öğesi için reklamın tüm süresini döndürür.
- İadeler
-
number
Reklam öğesinin gösterilmesi gereken saniye cinsinden minimum süre.
getSkipTimeOffset'i
getSkipTimeOffset() dönüş sayısı
Reklam atlanabilir hale gelmeden önce oynatılan saniye sayısı. Atlanamayan reklamlar için veya bu özellik kullanılamıyorsa -1 döndürülür.
- İadeler
-
number
ofset (saniye cinsinden veya -1).
Anket URL'si
getSurveyUrl() dize döndürür
Söz konusu reklam için anketle ilişkilendirilen URL'yi döndürür. Uygun değilse boş değer döndürür.
- İadeler
-
nullable string
Başlık
getTitle() dizeyi döndürür
VAST yanıtındaki bu reklamın başlığını döndürür.
- İadeler
-
string
Belirtilmezse başlık boş olur.
getTraffickingParameters
getTraffickingParameters(), dize özelliklerine sahip Nesneyi döndürür
Reklam trafik işlemleri sırasında reklamla ilişkilendirilen özel parametreler alır.
- İadeler
-
non-null Object with string properties
Trafik işlemleri anahtarlarının değerleriyle eşlemeleri veya bilgi yoksa boş Nesne.
getTraffickingParametersDizesi
getTraffickingParametersString() dizeyi döndürür
Reklam trafik işlemleri sırasında reklamla ilişkilendirilen özel parametreler alır. getTraffickingParameters parametresinden ayrıştırılan parametrelerin ham dize sürümünü döndürür.
- İadeler
-
string
Trafik işlemleri parametreleri veya bu bilgi yoksa boş dize.
getUiElements
getUiElements() dize dizisini döndürür
Bu reklam oynatıldığında gösterilen kullanıcı arayüzü öğelerini döndürür.
Döndürülen dizinin olası öğeleri için UiElements
öğesine bakın.
- İadeler
-
non-null Array of string
Görüntülenen kullanıcı arayüzü öğeleri.
getUniversalAdIdRegistry
getUniversalAdIdRegistry() dize döndürür
Reklam için seçilen reklam öğesinin UniversalAdId'sinin kataloğuyla ilişkili kayıt otoritesi.
- Kullanımdan kaldırıldı
- Bunun yerine ad.getUniversalAdIds() işlevini kullanma
- İadeler
-
string
Kayıt defteri değerini veya yoksa "unknown" (bilinmiyor) değerini döndürür.
evrenselreklamkimliği
getUniversalAdIdValue() dize döndürür
Reklam için seçilen reklam öğesinin UniversalAdId'si.
- Kullanımdan kaldırıldı
- Bunun yerine ad.getUniversalAdIds() işlevini kullanma
- İadeler
-
string
Kimlik değerini veya (varsa) "bilinmiyor" değerini döndürür.
getUniversalAdId'leri
getUniversalAdIds(), boş olmayan UniversalAdIdInfo dizisi döndürür
Reklam için seçilen reklam öğesinin UniversalAdId'lerinin listesi.
- İadeler
-
non-null Array of non-null UniversalAdIdInfo
Bu reklam için geçerli olan evrensel reklam kimliği bilgilerinin listesini döndürür.
getVastMediaBitrate
getVastMediaBitrate() dönüş sayısı
Hem reklam öğesi hem de medya dosyası SDK tarafından seçildiğinde bu, medya dosyasının bit hızını geniş yanıtta listelendiği şekilde döndürür.
- İadeler
-
number
Seçilen medya dosyasının bit hızı veya 0.
getVastMediaHeight
getVastMediaHeight() dönüş sayısı
Seçilen reklam öğesinin VAST medya yüksekliğini döndürür.
- İadeler
-
number
Seçilen reklam öğesinin VAST medya yüksekliği veya hiçbiri seçilmezse 0.
getVastMediaGenişliği
getVastMediaWidth() sayı döndürür
Seçilen reklam öğesinin VAST medya genişliğini döndürür.
- İadeler
-
number
Seçilen reklam öğesinin VAST medya genişliği veya hiçbiri seçilmezse 0.
getGenişliği
getWidth() dönüş sayısı
Seçilen reklam öğesinin genişliğini döndürür.
- İadeler
-
number
Seçilen doğrusal olmayan reklam öğesinin genişliği veya bir doğrusal reklam öğesi için 0.
getWrapperAdId'leri
getWrapperAdIds() dize dizisini döndürür
Sarmalayıcı reklamlar için kullanılan reklam kimlikleri. Döndürülen kimlikler satır içi reklamdan (en içte) başlar ve en dıştaki sarmalayıcıya geçer. Sarmalayıcı reklam yoksa boş dizi döndürülür.
- İadeler
-
non-null Array of string
Satır içi reklamdan başlayan reklamların veya sarmalayıcı reklam yoksa boş dizinin kimlikleri.
GetWrapperReklam Sistemleri
getWrapperAdSystems() dize dizisini döndürür
Sarmalayıcı reklamlar için kullanılan reklam sistemleri. Döndürülen reklam sistemleri, satır içi reklamdan başlar ve en dıştaki sarmalayıcıya geçer. Sarmalayıcı reklam yoksa boş dizi döndürülür.
- İadeler
-
non-null Array of string
Satır içi reklamla başlayan reklamların reklam sistemleri veya sarmalayıcı reklam yoksa boş dizi.
getWrapperCreativeId'ler
getWrapperCreativeIds() dize dizisini döndürür
Sarmalayıcı reklamlar için kullanılan seçili reklam öğesi kimlikleri. Döndürülen reklam öğesi kimlikleri, satır içi reklamdan başlar ve en dıştaki sarmalayıcıya geçer. Sarmalayıcı reklam yoksa boş dizi döndürülür.
- İadeler
-
non-null Array of string
Satır içi reklamla başlayan reklam sarmalayıcıların kimlikleri veya sarmalayıcı reklam yoksa boş dizi.
isDoğrusal
isLinear() boole döndürür
Reklamın geçerli çalışma şeklinin doğrusal mı yoksa doğrusal olmayan mı olduğunu belirtir. Değer true ise reklamın doğrusal oynatma modunda olduğunu gösterir. Yanlış ise doğrusal olmayan modu belirtir. Oynatıcı, doğrusal özelliği kontrol eder ve durumunu reklam yerleşiminin ayrıntılarına göre günceller. Reklam doğrusal moddayken oynatıcı içerik videosunu duraklatır. Doğrusal olan ve başlangıçta reklam videodan önce gösterilen reklamsa (harici olarak tanımlanır) oynatıcı, içerik videosunun yüklenmesini reklam sonuna kadar geciktirmeyi seçebilir.
- İadeler
-
boolean
Reklam doğrusalysa evet, aksi takdirde yanlış değerini alır.