google. ima. Ustawienia Imma
Te zajęcia zawierają ustawienia obejmujące cały pakiet SDK.
Wyliczenia
Tryb towarzyszący
tekst
Definiuje zestaw stałych dla ustawienia reklam towarzyszących. To ustawienie określa, czy elementy towarzyszące powinny być uzupełniane w różnych sytuacjach.
Jeśli wartość to ALWAYS
, reklamy towarzyszące będą próbowane we wszystkich sytuacjach, nawet gdy
nie zostanie zwrócona żadna reklama główna.
Jeśli wartość to ON_MASTER_AD
, próba wyświetlenia reklamy towarzyszącej zostanie podjęta wtedy, gdy reklama główna będzie miała mniej reklam towarzyszących od liczby boksów towarzyszących. Brakujące kreacje towarzyszące zostaną wypełnione.
Wartością domyślną jest ALWAYS
.
... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices();W przypadku filmów odtwarzanych automatycznie zalecamy wprowadzenie tej dodatkowej zmiany, która pozwoli uniknąć wstępnego wczytywania boksów towarzyszących i zastąpić je kreacjami towarzyszącymi.
googletag.pubads().disableInitialLoad(); ... googletag.enableServices();
Wartość |
|
---|---|
ZAWSZE |
|
WŁ_MASTER_AD |
Tryb VPAID
liczba
Zestaw stałych wartości umożliwiających włączenie funkcji VPAID.
Wartość |
|
---|---|
WYŁĄCZONA |
Reklamy VPAID nie będą odtwarzane i zostanie zwrócony błąd. |
AKTYWNA |
Reklamy VPAID można włączyć w międzydomenowym elemencie iframe. Reklama VPAID nie może uzyskać dostępu do witryny. Reklamy VPAID, które zależą od przyjaznego dostępu do elementów iframe, mogą powodować błędy. Jest to ustawienie domyślne. |
BEZPIECZEŃSTWO |
Reklamy VPAID są włączane za pomocą zaprzyjaźnionego elementu iframe. Umożliwi to reklamie dostęp do witryny za pomocą kodu JavaScript. |
Usługi
Tryb towarzyszący
tekst
Definiuje zestaw stałych dla ustawienia reklam towarzyszących. To ustawienie określa, czy elementy towarzyszące powinny być uzupełniane w różnych sytuacjach.
Jeśli wartość to ALWAYS
, reklamy towarzyszące będą próbowane we wszystkich sytuacjach, nawet gdy
nie zostanie zwrócona żadna reklama główna.
Jeśli wartość to ON_MASTER_AD
, próba wyświetlenia reklamy towarzyszącej zostanie podjęta wtedy, gdy reklama główna będzie miała mniej reklam towarzyszących od liczby boksów towarzyszących. Brakujące kreacje towarzyszące zostaną wypełnione.
Wartością domyślną jest ALWAYS
.
... let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div'); slot1.addService(googletag.companionAds()).addService(googletag.pubads()); ... googletag.companionAds().setRefreshUnfilledSlots(true); ... googletag.enableServices();W przypadku filmów odtwarzanych automatycznie zalecamy wprowadzenie tej dodatkowej zmiany, która pozwoli uniknąć wstępnego wczytywania boksów towarzyszących i zastąpić je kreacjami towarzyszącymi.
googletag.pubads().disableInitialLoad(); ... googletag.enableServices();
Wartość |
|
---|---|
ZAWSZE |
|
WŁ_MASTER_AD |
Tryb VPAID
liczba
Zestaw stałych wartości umożliwiających włączenie funkcji VPAID.
Wartość |
|
---|---|
WYŁĄCZONA |
Reklamy VPAID nie będą odtwarzane i zostanie zwrócony błąd. |
AKTYWNA |
Reklamy VPAID można włączyć w międzydomenowym elemencie iframe. Reklama VPAID nie może uzyskać dostępu do witryny. Reklamy VPAID, które zależą od przyjaznego dostępu do elementów iframe, mogą powodować błędy. Jest to ustawienie domyślne. |
BEZPIECZEŃSTWO |
Reklamy VPAID są włączane za pomocą zaprzyjaźnionego elementu iframe. Umożliwi to reklamie dostęp do witryny za pomocą kodu JavaScript. |
Metody
getCompanionBackfill
getCompanionBackfill() zwraca tryb towarzyszący
Zwraca bieżący tryb reklam towarzyszących.
- Zwraca
-
non-null CompanionBackfillMode
Obecna wartość.
getDisableCustomplayForIOS10Plus.
getDisableCustomplayForIOS10Plus() zwraca wartość logiczną
Określa, czy wyłączyć niestandardowe odtwarzanie w przeglądarkach na iOS 10 lub nowszych. Wartość domyślna to fałsz.
- Zwraca
-
boolean
getFlagFlags
getFeatureFlags() zwraca obiekt z właściwościami dowolnego typu
Zwraca obiekt z kluczami jako flagi funkcji, a wartości jako ich obecny stan.
- Zwraca
-
non-null Object with any type properties
getLocale
getLocale() zwraca ciąg znaków
Zwraca język określony przez wydawcę.
- Zwraca
-
string
Język określony przez wydawcę.
getNumRedirects
getNumRedirects() zwraca liczbę
Zwraca maksymalną liczbę przekierowań dla kolejnych przekierowań.
- Zwraca
-
Maksymalna liczba przekierowań:
number
.
getPlayerType
getPlayerType() zwraca ciąg znaków
Zwraca typ odtwarzacza podany przez partnera.
- Zwraca
-
string
Typ odtwarzacza partnera.
getPlayerVersion
getPlayerVersion() zwraca ciąg znaków
Zwraca wersję odtwarzacza dostarczaną przez partnera.
- Zwraca
-
string
Wersja odtwarzacza partnera.
getPpid
getPpid() zwraca (wartość null lub ciąg)
Zwraca identyfikator podany przez wydawcę.
- Zwraca
-
(null or string)
identyfikator podany przez wydawcę.
Pliki cookie są włączone
isCookiesEnabled() zwraca wartość logiczną
- Zwraca
-
boolean
Określa, czy wydawca zezwala na używanie plików cookie.
Ustaw automatyczne odtwarzanie reklam
setAutoPlayAdBreaks(autoPlayAdBreaks) zwraca nieważną wartość
Określa, czy przerwy na reklamy VMAP i reguły reklamowe mają być odtwarzane automatycznie
Parametr |
|
---|---|
Automatyczne miejsca przerw reklamowych |
wartość logiczna Określa, czy przerwy na reklamy mają być odtwarzane automatycznie. |
- Zwraca
-
void
Ustaw element towarzyszący
setCompanionBackfill(mode) zwraca nieważną wartość
Ustawia tryb uzupełniania towarzyszącego. Zobacz różne tryby dostępne w ImaSdkSettings.CompanionBackfillMode.
Domyślny tryb to ImaSdkSettings.CompanionBackfillMode.ALWAYS.
Parametr |
|
---|---|
tryb |
Tryb towarzyszący Wybrany tryb uzupełniania reklamy towarzyszącej. Wartość nie może być pusta. |
- Zwraca
-
void
Ustawione pliki cookie
setCookiesEnabled(cookiesEnabled) zwraca nieważne pliki
Określa, czy pakiet SDK powinien przechowywać plik cookie Google Ad Managera (GFP) w domenie wydawcy jako własny plik cookie. Umożliwia to trwałe przechowywanie wielu wizyt w tej samej domenie bez użycia plików cookie innych firm. Wartość domyślna to true (prawda).
To ustawienie nie ma wpływu na inne pliki cookie, które mogą być ustawiane przez inne osoby lub w innych celach. Zgoda użytkowników i rezygnacja mogą też uniemożliwić korzystanie z własnych plików cookie. Dane te będą gromadzone przez wydawcę korzystającego z systemu zarządzania zgodą użytkowników zgodnego ze standardami IAB, jeśli znajduje się on w tej samej ramce.
Parametr |
|
---|---|
pliki cookie włączone |
wartość logiczna |
- Zwraca
-
void
setDisableCustomplayForIOS10Plus.
setDisableCustomplayForIOS10Plus(disable) zwraca nie
Określa, czy ma być wyłączone niestandardowe odtwarzanie w przeglądarce iOS 10 lub nowszej. Jeśli ustawisz wartość prawda, reklamy będą odtwarzane w treści treści wideo. Spowoduje to włączenie reklam TrueView możliwych do pominięcia. Będzie ona jednak wbudowana i nie będzie obsługiwać natywnych reklam na iOS na pełnym ekranie. Jeśli ustawisz wartość fałsz, reklamy będą odtwarzane w tym samym odtwarzaczu co Twoje treści. Wartość ustawiona w tym miejscu podczas tworzenia kontenera reklamy displayowej jest używana przez cały czas trwania kontenera. Wartość domyślna to fałsz.
Parametr |
|
---|---|
wyłącz |
wartość logiczna Określa, czy wyłączyć odtwarzanie niestandardowe. |
- Zwraca
-
void
Flagi funkcji
setFeatureFlags(featureFlags) zwraca ważność
Ustaw wartość flag funkcji. Powinien on zostać ustawiony jak najszybciej przed wysłaniem żądania reklam. Ustawienia pozostaną niezmienione do czasu przesłania następnego żądania reklamy. Wywołanie tej metody spowoduje zresetowanie wszystkich flag funkcji dla następnego żądania reklamy.
Parametr |
|
---|---|
Flagi funkcji |
Obiekt o właściwościach dowolnego typu Wartość nie może być pusta. |
- Zwraca
-
void
Funkcja setLocale
setLocale(język) zwraca wartość nieważną
Określa język podany przez wydawcę. Musisz ją wywołać przed utworzeniem AdsLoader lub AdDisplayContainer. Region określa język, w którym mają być wyświetlane elementy UI. Obsługiwane kody znajdziesz w Lokalizacji dla języka i języka.
Parametr |
|
---|---|
język |
tekst Język określony przez wydawcę. |
- Zwraca
-
void
setNumRedirects
setNumRedirects(numRedirects) zwraca nieważną wartość
Określa maksymalną liczbę przekierowań przed odrzuceniem kolejnych przekierowań i przerwaniem wczytywania reklamy. Liczba przekierowań bezpośrednio wpływa na czas oczekiwania, a tym samym na wrażenia użytkowników. Dotyczy to wszystkich reklam towarzyszących kodu VAST.
Parametr |
|
---|---|
numRedirects |
liczba maksymalna liczba przekierowań. |
- Zwraca
-
void
TypSetPlayer
setPlayerType(playerType) zwraca nieważny
Umożliwia określenie typu odtwarzacza podanego przez partnera. To ustawienie powinno służyć do określenia nazwy odtwarzacza zintegrowanego z pakietem SDK. Typ odtwarzacza o długości większej niż 20 znaków zostanie skrócony. Podany typ odtwarzacza powinien być krótki i unikalny. To jest ustawienie opcjonalne, które poprawia wykorzystanie pakietu SDK na podstawie typów odtwarzaczy.
Przykład:
settings.setPlayerType('google/gmf-player');
Parametr |
|
---|---|
typ gracza |
tekst Typ odtwarzacza partnera. |
- Zwraca
-
void
WersjaSetPlayer
setPlayerVersion(playerVersion) zwraca nieważną wartość.
Określa wersję odtwarzacza dostarczaną przez partnera. To ustawienie powinno określać wersję odtwarzacza partnera zintegrowanego z pakietem SDK. Wersje odtwarzacza dłuższe niż 20 znaków zostaną skrócone. To jest ustawienie opcjonalne, które poprawia funkcje pakietu SDK według wersji odtwarzacza.
Przykład:
settings.setPlayerVersion('1.0.0');
Parametr |
|
---|---|
Wersja odtwarzacza |
tekst Wersja odtwarzacza partnera. |
- Zwraca
-
void
UstawPpid
setPpid(ppid) zwraca ważność
Określa identyfikator podany przez wydawcę.
Parametr |
|
---|---|
ppid, |
tekst podany przez wydawcę. |
- Zwraca
-
void
setSetId
setSessionId(sessionId) zwraca nieważny
Identyfikator sesji to tymczasowy identyfikator losowy. Służy wyłącznie do ograniczania liczby wyświetleń. Identyfikator sesji musi być identyfikatorem UUID.
Parametr |
|
---|---|
sessionId, |
tekst Tymczasowy identyfikator UUID używany do ograniczania liczby wyświetleń. |
- Zwraca
-
void
setVpaidAllowed.
setVpaidAllowed(allowVpaid) zwraca zwrot
Rola wycofana. Użyj funkcji setVpaidMode. Określa, czy dozwolone są kreacje VPAID.
Parametr |
|
---|---|
allowVpaid |
wartość logiczna Określa, czy zezwolić na kreacje VPAID. |
- Zwraca
-
void
setVpaidMode.
setVpaidMode(vpaidMode) zwraca nieważny
Ustawia tryb odtwarzania VPAID.
Parametr |
|
---|---|
tryb płatny |
Tryb VPAID Określa sposób odtwarzania reklam VPAID. Domyślnie jest to tryb bezpieczny. Wartość nie może być pusta. |
- Zwraca
-
void