W tym dokumencie do opisywania typów użyto notacji TypeScript. W tabeli poniżej znajdziesz krótkie objaśnienie poszczególnych przykładów.
Wyrażenie typu | |
---|---|
string |
Typ podstawowego ciągu znaków. |
string[] |
Typ tablicy, w którym wartości mogą być tylko ciągami tekstowymi. |
number | string |
Typ sumy, w którym wartość może być liczbą lub ciągiem znaków. |
Array<number | string> |
Typ tablicy, w którym wartości są typem zespolonym (union). |
[number, string] |
Typ krotki, w którym wartość jest tablicą dwuelementową, która musi zawierać liczbę i ciąg znaków w tej kolejności. |
Slot |
Typ obiektu, gdzie wartość jest wystąpieniem obiektu googletag.Slot . |
() => void |
Typ funkcji bez zdefiniowanych argumentów i bez wartości zwracanej. |
Więcej informacji o obsługiwanych typach i wyrażeniach znajdziesz w podręczniku TypeScript .
Adnotacje typu
Dwukropek za zmienną, nazwą parametru, nazwą właściwości lub podpisem funkcji wskazuje adnotację typu. Adnotacje typu opisują typy, które element po lewej stronie dwukropka może akceptować lub zwracać. W tabeli poniżej znajdziesz przykłady adnotacji, które możesz zobaczyć w tym artykule.
Adnotacja typu | |
---|---|
param: string |
Wskazuje, że param akceptuje lub zwraca wartość ciągu znaków. Ta składnia jest używana w przypadku zmiennych, parametrów, właściwości i zwracanych typów.
|
param?: number | string |
Wskazuje, że właściwość param jest opcjonalna, ale może być podana w postaci liczby lub ciągu znaków. Ta składnia jest używana w przypadku parametrów i właściwości.
|
...params: Array<() => void> |
Wskazuje, że params to
parametr spoczynku
, który akceptuje funkcje. Parametry pozostałe przyjmują nieograniczoną liczbę wartości określonego typu.
|
Definicje typów
Typy | |
---|---|
|
SingleSize | MultiSize
|
Prawidłowa konfiguracja rozmiaru boksu, który może mieć jeden lub wiele rozmiarów. |
|
|
SingleSize[]
|
Lista pojedynczych prawidłowych rozmiarów. |
|
|
"fluid" | ["fluid"]
|
Nazwane rozmiary, jakie może mieć boks. W większości przypadków prostokąt o stałym rozmiarze ma stały rozmiar, ale w niektórych przypadkach możemy potrzebować innych specyfikacji dotyczących rozmiaru. Prawidłowe są tylko te rozmiary:
|
|
|
SingleSizeArray | NamedSize
|
Pojedynczy prawidłowy rozmiar boksu. |
|
|
[number, number]
|
Tablica 2 liczb reprezentujących szerokość, wysokość. |
|
|
[SingleSizeArray, GeneralSize]
|
Mapowanie rozmiaru widocznego obszaru na rozmiary reklam. Używane w przypadku reklam elastycznych. |
|
|
SizeMapping[]
|
Lista mapowań rozmiaru. |
|
|
"unhideWindow" | "navBar"
|
Obsługiwane reguły dotyczące reklam pełnoekranowych. |
|
|
"disablePersonalization"
|
Obsługiwane metody ochrony prywatności wydawców. |
|
|
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
|
Obsługiwane taksonomie sygnałów dostarczanych przez wydawcę. |
|
|
BidderSignalProvider | PublisherSignalProvider
|
Interfejs zwracania bezpiecznego sygnału w przypadku określonego licytującego lub dostawcy. Należy podać jedną z wartości |
Typy wyliczeń
Wartości w polu enum | |
---|---|
googletag.enums.OutOfPageFormat
|
Formaty poza stroną obsługiwane przez GPT.
|
googletag.enums.TrafficSource
|
Źródła wizyt obsługiwane przez GPT.
|
googletag.enums.OutOfPageFormat
-
Formaty poza stroną obsługiwane przez GPT.
-
- Zobacz też
googletag.enums.TrafficSource
-
Źródła wizyt obsługiwane przez GPT.
-
- Zobacz też
googletag
Globalna przestrzeń nazw interfejsu API tagu wydawcy Google.
Podsumowanie zmiennej | |
---|---|
apiReady
|
Flaga wskazująca, że interfejs GPT API został wczytany i gotowy do wywołania.
|
cmd
|
Odniesienie do globalnej kolejki poleceń służącej do asynchronicznego wykonywania wywołań związanych z GPT.
|
pubadsReady
|
Flaga z informacją, że usługa
PubAdsService jest włączona, załadowana i w pełni sprawna.
|
secureSignalProviders
|
Odwołanie do tablicy dostawców bezpiecznych sygnałów.
|
Podsumowanie funkcji | |
---|---|
companionAds
|
Zwraca odwołanie do obiektu
CompanionAdsService .
|
defineOutOfPageSlot
|
Konstruuje boks reklamowy poza stroną o podanej ścieżce jednostki reklamowej.
|
defineSlot
|
Konstruuje boks reklamowy o określonej ścieżce i rozmiarze jednostki reklamowej oraz wiąże go z identyfikatorem elementu div na stronie, który będzie zawierać reklamę.
|
destroySlots
|
Niszczy podane boksy, usuwając z GPT wszystkie powiązane obiekty i odwołania do tych boksów.
|
disablePublisherConsole
|
Wyłącza Konsolę Google dla wydawcy.
|
display
|
Instruuje usługi przedziałów, aby wyrenderowały boks.
|
enableServices
|
Włącza wszystkie usługi GPT zdefiniowane na potrzeby boksów reklamowych na stronie.
|
getVersion
|
Zwraca aktualną wersję GPT.
|
openConsole
|
Otwiera Konsolę Google dla wydawcy.
|
pubads
|
Zwraca odwołanie do obiektu
PubAdsService .
|
setAdIframeTitle
|
Ustawia tytuł wszystkich elementów iframe kontenera reklam utworzonych od tej chwili przez narzędzie
PubAdsService .
|
setConfig
|
Określa ogólne opcje konfiguracji strony.
|
sizeMapping
|
Tworzy nowy element
SizeMappingBuilder .
|
googletag.apiReady
-
apiReady: boolean | undefined
-
Flaga wskazująca, że interfejs GPT API został wczytany i gotowy do wywołania. Ta właściwość będzie mieć wartość
undefined
, dopóki interfejs API nie będzie gotowy.
Zalecaną metodą obsługi asynchronicznej jest korzystanie z googletag.cmd do kolejki wywołań zwrotnych, gdy tag GPT jest gotowy. Te wywołania zwrotne nie wymagają sprawdzania metody googletag.apiReady, ponieważ gwarantujemy ich wykonanie po skonfigurowaniu interfejsu API. -
- Przykład
-
JavaScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
JavaScript (starsza wersja)
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
TypeScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
googletag.cmd
-
cmd: Array<(this: typeof globalThis) => void> | CommandArray
-
Odniesienie do globalnej kolejki poleceń do asynchronicznego wykonywania wywołań związanych z GPT.
Zmiennagoogletag.cmd
jest inicjowana do pustej tablicy JavaScript przez składnię tagu GPT na stronie, acmd.push
to standardowa metodaArray.push
, która dodaje element na końcu tablicy. Po załadowaniu tagu JavaScript GPT sprawdza on tablicę i wykonuje wszystkie funkcje po kolei. Następnie skrypt zastępujecmd
obiektemCommandArray
, którego metoda push jest zdefiniowana w celu wykonania przekazanego do niej argumentu funkcji. Ten mechanizm umożliwia GPT zmniejszenie postrzeganego czasu oczekiwania przez asynchroniczne pobieranie kodu JavaScript przy jednoczesnym umożliwieniu przeglądarce kontynuowania renderowania strony. -
- Przykład
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (starsza wersja)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
googletag.pubadsReady
-
pubadsReady: boolean | undefined
-
Flaga z informacją, że usługa
PubAdsService
jest włączona, załadowana i w pełni sprawna. Ta właściwość będzie po prostuundefined
do czasu wywołaniaenableServices
iPubAdsService
wczytania i zainicjowania. -
googletag.secureSignalProviders
-
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
-
Odniesienie do tablicy dostawców bezpiecznych sygnałów.
Tablica dostawców bezpiecznych sygnałów akceptuje sekwencję funkcji generujących sygnały i wywołuje je w określonej kolejności. Ma ona zastąpić tablicę standardową służącą do umieszczania w kolejce funkcji generujących sygnały, które są wywoływane po załadowaniu tagu GPT. -
- Przykład
-
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (starsza wersja)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- Zobacz też
googletag.companionAds
-
companionAds(): CompanionAdsService
-
Zwraca odwołanie do obiektu
CompanionAdsService
. -
-
Akcje powrotne CompanionAdsService
Usługa reklam towarzyszących.
googletag.defineOutOfPageSlot
-
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
-
Tworzy boks reklamowy poza stroną o podanej ścieżce jednostki reklamowej.
W przypadku niestandardowych reklam poza stronądiv
to identyfikator elementu div, który będzie zawierać reklamę. Więcej informacji znajdziesz w artykule na temat kreacji poza stroną.
W przypadku reklam poza stroną zarządzanych przez GPTdiv
jest obsługiwany przez format OutOfPageFormat. -
- Przykład
-
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (starsza wersja)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- Zobacz też
-
Parametry adUnitPath: string
Pełna ścieżka jednostki reklamowej zawierająca kod sieci i kod jednostki reklamowej.div?: string | OutOfPageFormat
Identyfikator elementu div, który będzie zawierać tę jednostkę reklamową lub OutOfPageFormat. -
Akcje powrotne Slot | null
Nowo utworzony boks lubnull
, jeśli nie można go utworzyć.
googletag.defineSlot
-
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
-
Konstruuje boks reklamowy o określonej ścieżce i rozmiarze jednostki reklamowej oraz wiąże go z identyfikatorem elementu div na stronie, który będzie zawierać reklamę.
-
- Przykład
-
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (starsza wersja)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- Zobacz też
-
Parametry adUnitPath: string
Pełna ścieżka jednostki reklamowej zawierająca kod sieci i kod jednostki.size: GeneralSize
Szerokość i wysokość dodanego boksu. Jest to rozmiar używany w żądaniu reklamy, jeśli nie podano elastycznego mapowania rozmiaru lub rozmiar widocznego obszaru jest mniejszy niż najmniejszy podany w mapowaniu.div?: string
Identyfikator elementu div, który będzie zawierać tę jednostkę reklamową. -
Akcje powrotne Slot | null
Nowo utworzony boks lubnull
, jeśli nie można go utworzyć.
googletag.destroySlots
-
destroySlots(slots?: Slot[]): boolean
-
Niszczy podane boksy, usuwając z GPT wszystkie powiązane obiekty i odwołania do tych boksów. Ten interfejs API nie obsługuje przedziałów przebiegu zwrotnego ani boksów towarzyszących.
Wywołanie tego interfejsu API w boksie powoduje wyczyszczenie reklamy i usunięcie obiektu boksu ze stanu wewnętrznego utrzymywanego przez GPT. Wywołanie dodatkowych funkcji w obiekcie przedziału spowoduje niezdefiniowane zachowanie. Pamiętaj, że przeglądarka może nadal nie zwolnić pamięci powiązanej z tym boksem, jeśli odwołanie do niego jest utrzymywane przez stronę wydawcy. Wywołanie tego interfejsu API sprawia, że element div powiązany z tym boksem jest dostępny do ponownego użycia.
W szczególności zniszczenie boksu powoduje usunięcie reklamy z długotrwałej odsłony GPT, więc na przyszłe żądania nie będą wpływać reklamy na wyłączność ani wykluczenia konkurencji związane z tą reklamą. Jeśli nie wywołasz tej funkcji przed usunięciem elementu div boksu ze strony, nastąpi niezdefiniowane działanie. -
- Przykład
-
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (starsza wersja)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
-
Parametry slots?: Slot[]
Tablica przedziałów do zniszczenia. Tablica jest opcjonalna; wszystkie przedziały zostaną zniszczone, jeśli nie będzie określony. -
Akcje powrotne boolean
true
, jeśli przedziały zostały zniszczone,false
w przeciwnym razie.
googletag.disablePublisherConsole
-
disablePublisherConsole(): void
-
Wyłącza Konsolę Google dla wydawcy.
-
- Zobacz też
googletag.display
-
display(divOrSlot: string | Element | Slot): void
-
Instruuje usługi przedziałów, aby wyrenderowały boks. Każdy boks reklamowy powinien być wyświetlany na stronie tylko raz. Przed wyświetleniem każdy boks musi zostać zdefiniowany i mieć powiązaną usługę. Wywołanie wyświetlania nie może wystąpić, dopóki element nie znajduje się w elemencie DOM. Zazwyczaj jest to umieszczone w bloku skryptu wewnątrz elementu div wymienionego w wywołaniu metody.
Jeśli używana jest architektura pojedynczego żądania (SRA), wszystkie niepobrane boksy reklamowe podczas wywoływania tej metody zostaną pobrane jednocześnie. Aby zablokować wyświetlanie boksu reklamowego, należy usunąć cały element div. -
- Przykład
-
JavaScript
googletag.cmd.push(() => { googletag.display("div-1"); });
JavaScript (starsza wersja)
googletag.cmd.push(function () { googletag.display("div-1"); });
TypeScript
googletag.cmd.push(() => { googletag.display("div-1"); });
- Zobacz też
-
Parametry divOrSlot: string | Element | Slot
Identyfikator elementu div zawierającego boks reklamowy, element div lub obiekt boksu. Jeśli podany jest element div, musi mieć atrybut „id” zgodny z identyfikatorem przekazanym dodefineSlot
.
googletag.enableServices
-
enableServices(): void
-
Włącza wszystkie usługi GPT zdefiniowane na potrzeby boksów reklamowych na stronie.
-
googletag.getVersion
-
getVersion(): string
-
Zwraca aktualną wersję GPT.
-
- Zobacz też
-
Akcje powrotne string
Aktualnie wykonywany ciąg tekstowy wersji GPT.
googletag.openConsole
-
openConsole(div?: string): void
-
Otwiera Konsolę Google dla wydawcy.
-
- Przykład
-
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (starsza wersja)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- Zobacz też
-
Parametry div?: string
Identyfikator div boksu reklamowego. Ta wartość jest opcjonalna. Jeśli zostanie podany, Konsola wydawcy spróbuje otworzyć szczegóły określonego boksu reklamowego w widocznym miejscu.
googletag.pubads
-
pubads(): PubAdsService
-
Zwraca odwołanie do obiektu
PubAdsService
. -
-
Akcje powrotne PubAdsService
Usługa Reklamy wydawcy.
googletag.setAdIframeTitle
-
setAdIframeTitle(title: string): void
-
Ustawia tytuł wszystkich elementów iframe kontenera reklam utworzonych od tej chwili przez narzędzie
PubAdsService
. -
- Przykład
-
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (starsza wersja)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
-
Parametry title: string
Nowy tytuł wszystkich elementów iframe kontenera reklam.
googletag.setConfig
-
setConfig(config: PageSettingsConfig): void
-
Określa ogólne opcje konfiguracji strony.
-
-
Parametry config: PageSettingsConfig
googletag.sizeMapping
-
sizeMapping(): SizeMappingBuilder
-
Tworzy nowy element
SizeMappingBuilder
. -
- Zobacz też
-
Akcje powrotne SizeMappingBuilder
Nowy budowniczy.
googletag.CommandArray
Tablica poleceń akceptuje sekwencję funkcji i wywołuje je w kolejności. Ma ona zastąpić tablicę standardową, która służy do umieszczania w kolejce funkcji do wywołania po załadowaniu tagu GPT.
Podsumowanie metody | |
---|---|
push
|
Wykonuje w kolejności sekwencję funkcji określonych w argumentach.
|
push
-
push(...f: Array<(this: typeof globalThis) => void>): number
-
Wykonuje w kolejności sekwencję funkcji określonych w argumentach.
-
- Przykład
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (starsza wersja)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
-
Parametry ...f: Array<(this: typeof globalThis) => void>
Funkcja JavaScript do wykonania. Powiązanie w środowisku wykonawczym będzie zawsze miało wartośćglobalThis
. Rozważ przekazanie funkcji strzałki, aby zachować wartośćthis
kontekstu leksykalnego. -
Akcje powrotne number
Liczba przetworzonych poleceń do tej pory. Jest to zgodne z wartością zwrotną parametruArray.push
(bieżącą długością tablicy).
googletag.CompanionAdsService
Przedłuża
Usługa reklam towarzyszących. Ta usługa jest wykorzystywana w reklamach wideo do wyświetlania reklam towarzyszących.
Podsumowanie metody | |
---|---|
addEventListener
|
Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT.
Odziedziczone z grupy
|
getSlots
|
Pobierz listę przedziałów powiązanych z tą usługą.
Odziedziczone z grupy
|
removeEventListener
|
Usuwa wcześniej zarejestrowany detektor.
Odziedziczone z grupy
|
setRefreshUnfilledSlots
|
Określa, czy boksy towarzyszące, które nie zostały wypełnione, będą automatycznie wypełniane automatycznie.
|
setRefreshUnfilledSlots
-
setRefreshUnfilledSlots(value: boolean): void
-
Określa, czy boksy towarzyszące, które nie zostały wypełnione, będą automatycznie wypełniane automatycznie.
Ta metoda może być wywoływana kilka razy w czasie działania strony, aby włączać i wyłączać reklamy zapasowe. Tylko boksy zarejestrowane wPubAdsService
będą wyświetlane w reklamach zapasowych. Ze względu na ograniczenia wynikające z zasad ta metoda nie służy do wypełniania pustych boksów towarzyszących podczas wyświetlania reklam wideo z Ad Exchange. -
- Przykład
-
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (starsza wersja)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
-
Parametry value: boolean
true
, aby automatycznie uzupełniać niewypełnione boksy,false
, aby je pozostawić bez zmian.
googletag.PrivacySettingsConfig
Obiekt konfiguracji ustawień prywatności.
Podsumowanie usługi | |
---|---|
childDirectedTreatment
|
Wskazuje, czy strona ma być traktowana jako skierowana do dzieci.
|
limitedAds
|
Umożliwia wyświetlanie reklam w trybie ograniczonego wyświetlania reklam, by ułatwić wydawcom zachowanie zgodności z przepisami.
|
nonPersonalizedAds
|
Umożliwia wyświetlanie reklam w trybie reklam niespersonalizowanych, by ułatwić wydawcom zachowanie zgodności z przepisami.
|
restrictDataProcessing
|
Umożliwia wyświetlanie reklam w trybie ograniczonego przetwarzania, by ułatwić wydawcom zachowanie zgodności z przepisami.
|
trafficSource
|
Wskazuje, czy żądania dotyczą ruchu kupionego czy bezpłatnego.
|
underAgeOfConsent
|
Określa, czy żądania reklamy mają być oznaczane jako pochodzące od użytkowników, którzy nie osiągnęli wieku świadomego wyrażenia zgody.
|
- Zobacz też
childDirectedTreatment
-
childDirectedTreatment: null | boolean
-
Wskazuje, czy strona ma być traktowana jako skierowana do dzieci. Aby wyczyścić konfigurację, ustaw wartość
null
. -
limitedAds
-
limitedAds: boolean
-
Umożliwia wyświetlanie reklam w trybie ograniczonego wyświetlania reklam, by ułatwić wydawcom zachowanie zgodności z przepisami. Gdy ta opcja jest włączona, można opcjonalnie wysyłać żądania biblioteki GPT z adresu URL reklam niewymagającego plików cookie.
-
- Zobacz też
nonPersonalizedAds
-
nonPersonalizedAds: boolean
-
Umożliwia wyświetlanie reklam w trybie reklam niespersonalizowanych, by ułatwić wydawcom zachowanie zgodności z przepisami.
-
restrictDataProcessing
-
restrictDataProcessing: boolean
-
Umożliwia wyświetlanie reklam w trybie ograniczonego przetwarzania, by ułatwić wydawcom zachowanie zgodności z przepisami.
-
trafficSource
-
trafficSource: TrafficSource
-
Wskazuje, czy żądania dotyczą ruchu kupionego czy bezpłatnego. Ta wartość powoduje uzupełnienie wymiaru Źródło wizyt w raportach Ad Managera. Jeśli jej nie skonfigurujesz, domyślnym źródłem wizyt w raportach będzie
undefined
. -
- Przykład
-
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (starsza wersja)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
underAgeOfConsent
-
underAgeOfConsent: null | boolean
-
Określa, czy żądania reklamy mają być oznaczane jako pochodzące od użytkowników, którzy nie osiągnęli wieku świadomego wyrażenia zgody. Aby wyczyścić konfigurację, ustaw wartość
null
. -
googletag.PubAdsService
Przedłuża
Usługa Reklamy wydawcy. Ta usługa służy do pobierania i wyświetlania reklam z konta Google Ad Managera.
Podsumowanie metody | |
---|---|
addEventListener
|
Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT.
Odziedziczone z grupy
|
clear
|
Usuwa reklamy z podanych boksów i zastępuje je pustą treścią.
|
clearCategoryExclusions
|
Usuwa wszystkie etykiety wykluczeń kategorii reklam na poziomie strony.
|
clearTargeting
|
Usuwa parametry kierowania niestandardowego dla określonego klucza lub wszystkich kluczy.
|
collapseEmptyDivs
|
Włącza zwijanie elementów div boksów, aby nie zajmowały miejsca na stronie, gdy nie ma treści reklamy do wyświetlenia.
|
disableInitialLoad
|
Wyłącza żądania reklam podczas wczytywania strony, ale umożliwia wysyłanie żądań reklam za pomocą wywołania
PubAdsService.refresh .
|
display
|
Konstruuje i wyświetla boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej.
|
enableLazyLoad
|
Umożliwia leniwe ładowanie w GPT zgodnie z definicją w obiekcie konfiguracji.
|
enableSingleRequest
|
Włącza tryb pojedynczego żądania umożliwiający pobieranie wielu reklam naraz.
|
enableVideoAds
|
Informuje tag GPT, że na stronie będą znajdować się reklamy wideo.
|
get
|
Zwraca wartość atrybutu AdSense powiązanego z danym kluczem.
|
getAttributeKeys
|
Zwraca klucze atrybutów ustawione w tej usłudze.
|
getSlots
|
Pobierz listę przedziałów powiązanych z tą usługą.
Odziedziczone z grupy
|
getTargeting
|
Zwraca określony niestandardowy parametr kierowania na poziomie usługi.
|
getTargetingKeys
|
Zwraca listę wszystkich niestandardowych kluczy kierowania na poziomie usługi.
|
isInitialLoadDisabled
|
Wskazuje, czy wstępne żądania reklam zostały wyłączone przez poprzednie wywołanie funkcji
PubAdsService.disableInitialLoad .
|
refresh
|
Pobiera i wyświetla nowe reklamy dla określonych lub wszystkich boksów na stronie.
|
removeEventListener
|
Usuwa wcześniej zarejestrowany detektor.
Odziedziczone z grupy
|
set
|
Ustawia wartości atrybutów AdSense stosowane do wszystkich boksów reklamowych w ramach usługi Reklamy wydawcy.
|
setCategoryExclusion
|
Ustawia wykluczenie kategorii reklam na poziomie strony dla podanej nazwy etykiety.
|
setCentering
|
Włącza i wyłącza wyśrodkowanie reklam w poziomie.
|
setForceSafeFrame
|
Określa, czy wymuszanie renderowania wszystkich reklam na stronie ma być wymuszane za pomocą kontenera SafeFrame.
|
setLocation
|
Przekazuje z witryn informacje o lokalizacji, umożliwiając kierowanie geograficzne elementów zamówienia na określone lokalizacje.
|
setPrivacySettings
|
Umożliwia konfigurowanie wszystkich ustawień prywatności w pojedynczym interfejsie API za pomocą obiektu konfiguracji.
|
setPublisherProvidedId
|
Ustawia wartość identyfikatora podanego przez wydawcę.
|
setSafeFrameConfig
|
Określa ustawienia konfiguracji SafeFrame na poziomie strony.
|
setTargeting
|
Ustawia niestandardowe parametry kierowania dla danego klucza, które mają zastosowanie do wszystkich boksów reklamowych usługi reklam wydawcy.
|
setVideoContent
|
Określa informacje o treści wideo, które będą wysyłane razem z żądaniami reklamy na potrzeby kierowania i wykluczania treści.
|
updateCorrelator
|
Zmienia korelator wysyłany z żądaniami reklamy, co w efekcie rozpoczyna nowe wyświetlenie strony.
|
clear
-
clear(slots?: Slot[]): boolean
-
Usuwa reklamy z podanych boksów i zastępuje je pustą treścią. Boksy zostaną oznaczone jako niepobrane.
W szczególności wyczyszczenie boksu powoduje usunięcie reklamy z długotrwałej odsłony tagu GPT, więc reklamy na wyłączność i wykluczenia konkurencji związane z tą reklamą nie będą wpływać na przyszłe żądania. -
- Przykład
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (starsza wersja)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
-
Parametry slots?: Slot[]
Tablica przedziałów do wyczyszczenia. Tablica jest opcjonalna. Wszystkie boksy zostaną wyczyszczone, jeśli nie będzie określone. -
Akcje powrotne boolean
Zwraca wartośćtrue
, jeśli boksy zostały wyczyszczone. W przeciwnym razie zwraca wartośćfalse
.
clearCategoryExclusions
-
clearCategoryExclusions(): PubAdsService
-
Usuwa wszystkie etykiety wykluczeń kategorii reklam na poziomie strony. Jest to przydatne, jeśli chcesz odświeżyć boks.
-
- Przykład
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (starsza wersja)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- Zobacz też
-
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał metodę.
clearTargeting
-
clearTargeting(key?: string): PubAdsService
-
Usuwa parametry kierowania niestandardowego dla określonego klucza lub wszystkich kluczy.
-
- Przykład
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (starsza wersja)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- Zobacz też
-
Parametry key?: string
Klucz parametru kierowania. Ten klucz jest opcjonalny. Wszystkie parametry kierowania zostaną wyczyszczone, jeśli nie będą nieokreślone. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał metodę.
collapseEmptyDivs
-
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
-
Włącza zwijanie elementów div boksów, aby nie zajmowały miejsca na stronie, gdy nie ma treści reklamy do wyświetlenia. Ten tryb należy ustawić przed włączeniem usługi.
-
Parametry collapseBeforeAdFetch?: boolean
Określa, czy zwinąć boksy jeszcze przed pobraniem reklam. Ten parametr jest opcjonalny. Jeśli nie zostanie podany, domyślną wartością będziefalse
. -
Akcje powrotne boolean
Zwraca wartośćtrue
, jeśli włączony był tryb zwijania div, oraz wartośćfalse
, jeśli włączenie trybu zwijania jest niemożliwe, ponieważ metoda została wywołana po włączeniu usługi.
disableInitialLoad
-
disableInitialLoad(): void
-
Wyłącza żądania reklam podczas wczytywania strony, ale umożliwia wysyłanie żądań reklam za pomocą wywołania
PubAdsService.refresh
. To ustawienie należy ustawić przed włączeniem usługi. Należy użyć trybu asynchronicznego. W przeciwnym razie wysyłanie żądań reklam za pomocą funkcjirefresh
będzie niemożliwe.
display
-
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
-
Konstruuje i wyświetla boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej. Ta metoda nie działa z trybem pojedynczego żądania.
Uwaga: wywołanie tej metody powoduje utworzenie podsumowania stanu boksu i strony w celu zapewnienia spójności podczas wysyłania żądania reklamy i renderowania odpowiedzi. Wszelkie zmiany wprowadzone w boksie lub stanie strony po wywołaniu tej metody (w tym kierowania, ustawień prywatności, wymuszania SafeFrame itp.) zostaną zastosowane tylko do kolejnych żądańdisplay()
lubrefresh()
. -
- Przykład
-
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (starsza wersja)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- Zobacz też
-
Parametry adUnitPath: string
Ścieżka jednostki reklamowej boksu, który ma być renderowany.size: GeneralSize
Szerokość i wysokość boksu.div?: string | Element
Identyfikator elementu div zawierającego boks lub sam element div.clickUrl?: string
Klikalny adres URL do użycia w tym boksie.
enableLazyLoad
-
enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void
-
Umożliwia leniwe ładowanie w GPT zgodnie z definicją w obiekcie konfiguracji. Szczegółowe przykłady znajdziesz w przykładzie leniwego ładowania.
Uwaga: leniwe pobieranie w architekturze SRA działa tylko wtedy, gdy wszystkie boksy znajdują się poza marginesem pobierania. -
- Przykład
-
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (starsza wersja)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- Zobacz też
-
Parametry config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
Obiekt konfiguracji umożliwia dostosowanie leniwego działania. Pominięte konfiguracje będą używać wartości domyślnych ustawionych przez Google, które z czasem zostaną dostrojone. Aby wyłączyć określone ustawienie, na przykład marżę pobierania, ustaw wartość-1
.fetchMarginPercent
Minimalna odległość od bieżącego widocznego obszaru, jaką musi znajdować się boks, zanim pobierzemy reklamę jako procent jego rozmiaru. Wartość 0 oznacza „gdy boks wejdzie w widoczny obszar”, 100 oznacza „gdy reklama znajduje się w 1 widocznym obszarze” itd.renderMarginPercent
Minimalna odległość od bieżącego widocznego obszaru, jaką musi znajdować się boks, zanim zostanie wyrenderowana reklama. Umożliwia to wstępne pobieranie reklamy i oczekiwanie na wyrenderowanie i pobranie innych zasobów podrzędnych. Ta wartość działa tak samo jakfetchMarginPercent
jako procent widocznego obszaru.mobileScaling
Mnożnik stosowany do marż na urządzeniach mobilnych. Dzięki temu można stosować różne marże na urządzeniach mobilnych i na komputerach. Na przykład wartość 2, 0 spowoduje pomnożenie wszystkich marginesów przez 2 na urządzeniach mobilnych, co zwiększy minimalną odległość boksu przed pobraniem i zrenderowaniem.
enableSingleRequest
-
enableSingleRequest(): boolean
-
Włącza tryb pojedynczego żądania umożliwiający pobieranie wielu reklam naraz. Wymaga to określenia wszystkich boksów reklam wydawcy i dodania do usługi PubAdsService przed włączeniem tej usługi. Przed włączeniem usługi należy ustawić tryb pojedynczego żądania.
-
Akcje powrotne boolean
Zwracatrue
, jeśli włączony był tryb pojedynczego żądania, orazfalse
, jeśli włączenie trybu pojedynczego żądania jest niemożliwe, ponieważ metoda została wywołana po włączeniu usługi.
enableVideoAds
-
enableVideoAds(): void
-
Informuje tag GPT, że na stronie będą znajdować się reklamy wideo. Dzięki temu można wprowadzić ograniczenia dotyczące wykluczeń konkurencji w przypadku reklam displayowych i wideo. Jeśli treść wideo jest znana, wywołaj
PubAdsService.setVideoContent
, aby móc korzystać z wykluczeń treści w przypadku reklam displayowych. -
get
-
get(key: string): null | string
-
Zwraca wartość atrybutu AdSense powiązanego z danym kluczem.
-
- Przykład
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (starsza wersja)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- Zobacz też
-
Parametry key: string
Nazwa atrybutu do wyszukania. -
Akcje powrotne null | string
Bieżąca wartość klucza atrybutu lubnull
, jeśli klucz nie jest dostępny.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Zwraca klucze atrybutów ustawione w tej usłudze.
-
- Przykład
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (starsza wersja)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Akcje powrotne string[]
Tablica kluczy atrybutów ustawionych w tej usłudze. Kolejność jest nieokreślona.
getTargeting
-
getTargeting(key: string): string[]
-
Zwraca określony niestandardowy parametr kierowania na poziomie usługi.
-
- Przykład
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (starsza wersja)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
-
Parametry key: string
Klucz kierowania, którego należy szukać. -
Akcje powrotne string[]
Wartości powiązane z tym kluczem lub pusta tablica, jeśli nie ma takiego klucza.
getTargetingKeys
-
getTargetingKeys(): string[]
-
Zwraca listę wszystkich niestandardowych kluczy kierowania na poziomie usługi.
-
- Przykład
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (starsza wersja)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
-
Akcje powrotne string[]
Tablica kluczy kierowania. Kolejność jest nieokreślona.
isInitialLoadDisabled
-
isInitialLoadDisabled(): boolean
-
Wskazuje, czy wstępne żądania reklam zostały wyłączone przez poprzednie wywołanie funkcji
PubAdsService.disableInitialLoad
. -
-
Akcje powrotne boolean
Zwraca wartośćtrue
, jeśli poprzednie wywołanie funkcjiPubAdsService.disableInitialLoad
zakończyło się powodzeniem. W przeciwnym razie zwraca wartośćfalse
.
refresh
-
refresh(slots?: null | Slot[], options?: { changeCorrelator: boolean }): void
-
Pobiera i wyświetla nowe reklamy dla określonych lub wszystkich boksów na stronie. Działa tylko w trybie renderowania asynchronicznego.
Aby zapewnić prawidłowe działanie przeglądarek we wszystkich przeglądarkach, wywołanierefresh
musi być poprzedzone wywołaniemdisplay
boksu reklamowego. Jeśli wywołaniedisplay
zostanie pominięte, odświeżanie może działać w nieoczekiwany sposób. W razie potrzeby można użyć metodyPubAdsService.disableInitialLoad
, aby zatrzymać pobieranie reklamy przezdisplay
.
Odświeżenie boksu spowoduje usunięcie starej reklamy z długotrwałej odsłony GPT, więc na przyszłe żądania nie będą wpływać reklamy na wyłączność ani wykluczenia konkurencji związane z tą reklamą. -
- Przykład
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (starsza wersja)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- Zobacz też
-
Parametry slots?: null | Slot[]
Boksy do odświeżenia. Tablica jest opcjonalna. Wszystkie przedziały zostaną odświeżone, jeśli nie jest określona.options?: { changeCorrelator: boolean }
Opcje konfiguracji powiązane z tym wywołaniem odświeżania.changeCorrelator
Określa, czy na potrzeby pobierania reklam ma być generowany nowy korelator. Nasze serwery reklam utrzymują tę wartość przez krótki czas (obecnie wynosi ona 30 sekund i może ulec zmianie), więc żądania z tym samym korelatorem odebrane blisko siebie, będą uznawane za jedno wyświetlenie strony. Domyślnie przy każdym odświeżeniu generowany jest nowy korelator.
Uwaga: ta opcja nie ma wpływu na długotrwałe odsłony tagów GPT, które automatycznie odzwierciedlają reklamy aktualnie widoczne na stronie i nie mają wyznaczonego okresu ważności.
set
-
set(key: string, value: string): PubAdsService
-
Ustawia wartości atrybutów AdSense, które mają zastosowanie do wszystkich boksów reklamowych w ramach usługi Reklamy wydawcy.
Wywołanie tej metody więcej niż raz dla tego samego klucza spowoduje zastąpienie poprzednio ustawionych dla niego wartości. Wszystkie wartości należy ustawić przed wywołaniem funkcjidisplay
lubrefresh
. -
- Przykład
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (starsza wersja)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- Zobacz też
-
Parametry key: string
Nazwa atrybutu.value: string
Wartość atrybutu. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał metodę.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): PubAdsService
-
Ustawia wykluczenie kategorii reklam na poziomie strony dla podanej nazwy etykiety.
-
- Przykład
-
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (starsza wersja)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- Zobacz też
-
Parametry categoryExclusion: string
Etykieta wykluczenia kategorii reklam, którą chcesz dodać. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał metodę.
setCentering
-
setCentering(centerAds: boolean): void
-
Włącza i wyłącza wyśrodkowanie reklam w poziomie. Centrum jest domyślnie wyłączone. W starszej wersji pliku gpt_mobile.js środkowanie jest domyślnie włączone.
Ta metoda należy wywołać przed wywołaniem metodydisplay
lubrefresh
, ponieważ wyśrodkowane zostaną tylko reklamy żądane po wywołaniu tej metody. -
- Przykład
-
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (starsza wersja)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
-
Parametry centerAds: boolean
true
, aby wyśrodkować reklamy,false
, aby je wyrównać do lewej.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
-
Określa, czy renderowanie wszystkich reklam na stronie powinno być wymuszane za pomocą kontenera SafeFrame.
Podczas korzystania z tego interfejsu API pamiętaj o tych kwestiach:- To ustawienie będzie działać tylko w przypadku kolejnych żądań reklamy wysyłanych w przypadku danych boksów reklamowych.
- Ustawienie na poziomie boksu (jeśli zostało określone) zawsze zastępuje ustawienie na poziomie strony.
- Jeśli ustawisz wartość
true
(na poziomie boksu lub strony), reklama będzie zawsze renderowana za pomocą kontenera SafeFrame niezależnie od opcji wybranej w interfejsie Google Ad Managera. - Jeśli jednak ustawisz wartość
false
lub pozostanie nieokreślona, reklama zostanie wyrenderowana za pomocą kontenera SafeFrame w zależności od typu kreacji i wyboru dokonanego w interfejsie Google Ad Managera. - Podczas używania tego interfejsu API należy zachować ostrożność, ponieważ może on wpłynąć na zachowanie kreacji, które próbują wydobyć się poza elementy iframe, lub polegają na tym, że będą renderowane bezpośrednio na stronie wydawcy.
-
- Przykład
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (starsza wersja)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Zobacz też
-
Parametry forceSafeFrame: boolean
true
, aby wymuszać renderowanie wszystkich reklam na stronie w SafeFrame, lubfalse
, aby zmienić poprzednie ustawienie na Fałsz. Ustawienie wartościfalse
, jeśli nie zostało wcześniej określone, niczego nie zmieni. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał funkcję.
setLocation
-
setLocation(address: string): PubAdsService
-
Przekazuje z witryn informacje o lokalizacji, umożliwiając kierowanie geograficzne elementów zamówienia na określone lokalizacje.
-
- Przykład
-
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (starsza wersja)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
-
Parametry address: string
Adres w dowolnym formacie. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał metodę.
setPrivacySettings
-
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
-
Umożliwia konfigurowanie wszystkich ustawień prywatności w pojedynczym interfejsie API za pomocą obiektu konfiguracji.
-
- Przykład
-
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (starsza wersja)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- Zobacz też
-
Parametry privacySettings: PrivacySettingsConfig
Obiekt zawierający konfigurację ustawień prywatności. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał funkcję.
setPublisherProvidedId
-
setPublisherProvidedId(ppid: string): PubAdsService
-
Ustawia wartość identyfikatora podanego przez wydawcę.
-
- Przykład
-
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (starsza wersja)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- Zobacz też
-
Parametry ppid: string
Identyfikator alfanumeryczny podany przez wydawcę. Musi mieć od 32 do 150 znaków. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał metodę.
setSafeFrameConfig
-
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
-
Określa ustawienia konfiguracji SafeFrame na poziomie strony. Wszystkie nierozpoznane klucze w obiekcie konfiguracji będą ignorowane. Jeśli podana zostanie nieprawidłowa wartość dla rozpoznanego klucza, cała konfiguracja zostanie zignorowana.
Te preferencje na poziomie strony zostaną zastąpione przez preferencje na poziomie boksu, jeśli zostaną określone. -
- Przykład
-
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (starsza wersja)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Zobacz też
-
Parametry config: SafeFrameConfig
Obiekt konfiguracji. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał metodę.
setTargeting
-
setTargeting(key: string, value: string | string[]): PubAdsService
-
Ustawia niestandardowe parametry kierowania dla danego klucza, które mają zastosowanie do wszystkich boksów reklamowych usługi reklam wydawcy. Wywołanie tej metody wielokrotnie dla tego samego klucza spowoduje zastąpienie starych wartości. Klucze są zdefiniowane na Twoim koncie Google Ad Managera.
-
- Przykład
-
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (starsza wersja)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- Zobacz też
-
Parametry key: string
Klucz parametru kierowania.value: string | string[]
Wartość parametru kierowania lub tablica wartości. -
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał metodę.
setVideoContent
-
setVideoContent(videoContentId: string, videoCmsId: string): void
-
Określa informacje o treści wideo, które będą wysyłane razem z żądaniami reklamy na potrzeby kierowania i wykluczania treści. Po wywołaniu tej metody reklamy wideo będą automatycznie włączane. W przypadku
videoContentId
ivideoCmsId
używane są wartości podane w usłudze przetwarzania treści Google Ad Managera. -
- Zobacz też
-
Parametry videoContentId: string
Identyfikator treści wideo.videoCmsId: string
Identyfikator CMS filmu.
updateCorrelator
-
updateCorrelator(): PubAdsService
-
Zmienia korelator wysyłany z żądaniami reklamy, co w efekcie rozpoczyna nowe wyświetlenie strony. Korelator jest taki sam w przypadku wszystkich żądań reklamy pochodzących z jednego wyświetlenia strony i unikalny dla wszystkich wyświetleń strony. Działa tylko w trybie asynchronicznym.
Uwaga: nie ma to wpływu na długotrwałe odsłony tagów GPT, które automatycznie pokazują reklamy na stronie i nie mają wyznaczonego okresu ważności. -
- Przykład
-
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (starsza wersja)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
-
Akcje powrotne PubAdsService
Obiekt usługi, który wywołał funkcję.
googletag.ResponseInformation
Obiekt reprezentujący pojedynczą odpowiedź na żądanie reklamy.
Podsumowanie usługi | |
---|---|
advertiserId
|
Identyfikator reklamodawcy.
|
campaignId
|
Identyfikator kampanii.
|
creativeId
|
Identyfikator kreacji.
|
creativeTemplateId
|
Identyfikator szablonu reklamy.
|
lineItemId
|
Identyfikator elementu zamówienia.
|
- Zobacz też
advertiserId
-
advertiserId: null | number
-
Identyfikator reklamodawcy.
-
campaignId
-
campaignId: null | number
-
Identyfikator kampanii.
-
creativeId
-
creativeId: null | number
-
Identyfikator kreacji.
-
creativeTemplateId
-
creativeTemplateId: null | number
-
Identyfikator szablonu reklamy.
-
lineItemId
-
lineItemId: null | number
-
Identyfikator elementu zamówienia.
-
googletag.RewardedPayload
Obiekt reprezentujący nagrodę powiązaną z reklamą z nagrodą
Podsumowanie usługi | |
---|---|
amount
|
Liczba produktów uwzględnionych w nagrodzie.
|
type
|
Typ produktu objętego nagrodą (np. „moneta”).
|
- Zobacz też
amount
-
amount: number
-
Liczba produktów uwzględnionych w nagrodzie.
-
type
-
type: string
-
Typ produktu objętego nagrodą (np. „moneta”).
-
googletag.SafeFrameConfig
Obiekt konfiguracji kontenerów SafeFrame.
Podsumowanie usługi | |
---|---|
allowOverlayExpansion
|
Określa, czy element SafeFrame ma zezwalać na rozwijanie treści reklamy przez nakładanie się treści strony.
|
allowPushExpansion
|
Określa, czy SafeFrame ma zezwalać na rozwinięcie treści reklamy przez przekazywanie zawartości strony.
|
sandbox
|
Określa, czy SafeFrame ma używać atrybutu piaskownicy HTML5, by uniemożliwić nawigację na najwyższym poziomie bez interakcji użytkownika.
|
useUniqueDomain
|
Wycofano.
Określa, czy w przypadku kreacji z rezerwacji element SafeFrame ma używać losowych subdomen.
|
- Zobacz też
allowOverlayExpansion
-
allowOverlayExpansion: boolean
-
Określa, czy element SafeFrame ma zezwalać na rozwijanie treści reklamy przez nakładanie się treści strony.
-
allowPushExpansion
-
allowPushExpansion: boolean
-
Określa, czy SafeFrame ma zezwalać na rozwinięcie treści reklamy przez przekazywanie zawartości strony.
-
sandbox
-
sandbox: boolean
-
Określa, czy SafeFrame ma używać atrybutu piaskownicy HTML5, by uniemożliwić nawigację na najwyższym poziomie bez interakcji użytkownika. Jedyną prawidłową wartością jest
true
(nie można wymusić wartościfalse
). Pamiętaj, że atrybut piaskownicy wyłącza wtyczki (np. Flash). -
useUniqueDomain
-
useUniqueDomain: null | boolean
-
Określa, czy w przypadku kreacji z rezerwacji element SafeFrame ma używać losowych subdomen. Przekaż
null
, aby wyczyścić zapisaną wartość.
Uwaga: ta funkcja jest domyślnie włączona. -
- Zobacz też
googletag.Service
Klasa usługi podstawowej, która zawiera metody wspólne dla wszystkich usług.
Podsumowanie metody | |
---|---|
addEventListener
|
Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT.
|
getSlots
|
Pobierz listę przedziałów powiązanych z tą usługą.
|
removeEventListener
|
Usuwa wcześniej zarejestrowany detektor.
|
addEventListener
-
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (arg: EventTypeMap[K]) => void): Service
-
Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT. Obsługiwane są te zdarzenia:
Obiekt odpowiedniego typu zdarzenia jest przekazywany do odbiornika w chwili jego wywołania. -
- Przykład
-
JavaScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
-
Parametry eventType: K
Ciąg znaków reprezentujący typ zdarzenia generowanego przez tag GPT. W typach zdarzeń wielkość liter ma znaczenie.listener: (arg: EventTypeMap[K]) => void
Funkcja, która przyjmuje pojedynczy argument obiektu zdarzenia. -
Akcje powrotne Service
Obiekt usługi, który wywołał metodę.
getSlots
removeEventListener
-
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (event: EventTypeMap[K]) => void): void
-
Usuwa wcześniej zarejestrowany detektor.
-
- Przykład
-
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (starsza wersja)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
-
Parametry eventType: K
Ciąg znaków reprezentujący typ zdarzenia generowanego przez tag GPT. W typach zdarzeń wielkość liter ma znaczenie.listener: (event: EventTypeMap[K]) => void
Funkcja, która przyjmuje pojedynczy argument obiektu zdarzenia.
googletag.SizeMappingBuilder
Kreator obiektów specyfikacji mapowania rozmiaru. Narzędzie to ułatwia tworzenie specyfikacji rozmiarów.
Podsumowanie metody | |
---|---|
addSize
|
Dodaje mapowanie z tablicy o jednym rozmiarze (reprezentującej widoczny obszar) do tablicy o jednym lub wielu rozmiarach reprezentującej boks.
|
build
|
Kompiluje specyfikację rozmiaru mapy na podstawie mapowań dodanych do tego konstruktora.
|
- Zobacz też
addSize
-
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
-
Dodaje mapowanie z tablicy o jednym rozmiarze (reprezentującej widoczny obszar) do tablicy o jednym lub wielu rozmiarach reprezentującej boks.
-
- Przykład
-
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (starsza wersja)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
TypeScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
-
Parametry viewportSize: SingleSizeArray
Rozmiar widocznego obszaru dla tego wpisu mapowania.slotSize: GeneralSize
Rozmiary przedziału dla tego wpisu mapowania. -
Akcje powrotne SizeMappingBuilder
Odwołanie do tego konstruktora.
build
-
build(): null | SizeMappingArray
-
Kompiluje specyfikację mapy rozmiaru na podstawie mapowań dodanych do tego konstruktora.
Jeśli podano nieprawidłowe mapowania, ta metoda zwróci wartośćnull
. W przeciwnym razie zwraca specyfikację w prawidłowym formacie, która jest potrzebna do przekazania doSlot.defineSizeMapping
.
Uwaga: zachowanie kreatora po wywołaniu tej metody jest niezdefiniowane. -
-
Akcje powrotne null | SizeMappingArray
Wynik utworzony przez ten konstruktor. Może mieć wartość null, jeśli podano nieprawidłowe mapowania rozmiaru.
googletag.Slot
Boks to obiekt reprezentujący pojedynczy boks reklamowy na stronie.
Podsumowanie metody | |
---|---|
addService
|
Dodaje element
Service do tego boksu.
|
clearCategoryExclusions
|
Usuwa wszystkie etykiety wykluczeń kategorii reklam na poziomie boksu dla tego boksu.
|
clearTargeting
|
Usuwa określone lub wszystkie niestandardowe parametry kierowania na poziomie boksu dla tego boksu.
|
defineSizeMapping
|
Ustawia tablicę mapowania z minimalnego rozmiaru widocznego obszaru na rozmiar boksu dla tego boksu.
|
get
|
Zwraca wartość atrybutu AdSense powiązanego z danym kluczem dla tego boksu.
|
getAdUnitPath
|
Zwraca pełną ścieżkę jednostki reklamowej wraz z kodem sieci i ścieżką do jednostki reklamowej.
|
getAttributeKeys
|
Zwraca listę kluczy atrybutów ustawionych w tym przedziale.
|
getCategoryExclusions
|
Zwraca etykiety wykluczenia kategorii reklam dla tego boksu.
|
getResponseInformation
|
Zwraca informacje o odpowiedzi na reklamę.
|
getSlotElementId
|
Zwraca identyfikator przedziału
div podanego podczas definiowania boksu.
|
getTargeting
|
Zwraca określony niestandardowy parametr kierowania ustawiony w tym boksie.
|
getTargetingKeys
|
Zwraca listę wszystkich kluczy kierowania niestandardowego ustawionych w tym boksie.
|
set
|
Ustawia wartość atrybutu AdSense dla tego boksu reklamowego.
|
setCategoryExclusion
|
Ustawia etykietę wykluczenia kategorii reklamy na poziomie boksu dla tego boksu.
|
setClickUrl
|
Ustawia klikany URL, do którego użytkownicy będą przekierowywani po kliknięciu reklamy.
|
setCollapseEmptyDiv
|
Określa, czy boks
div ma być ukryty, jeśli w boksie nie ma reklam.
|
setConfig
|
Ustawia ogólne opcje konfiguracji tego przedziału.
|
setForceSafeFrame
|
Określa, czy reklamy w tym boksie mają być wymuszane przy użyciu kontenera SafeFrame.
|
setSafeFrameConfig
|
Ustawia preferencje na poziomie boksu dla konfiguracji SafeFrame.
|
setTargeting
|
Ustawia niestandardowy parametr kierowania dla tego boksu.
|
updateTargetingFromMap
|
Ustawia niestandardowe parametry kierowania dla tego boksu z mapy klucz-wartość w obiekcie JSON.
|
addService
-
Dodaje element
Service
do tego boksu. -
- Przykład
-
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (starsza wersja)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- Zobacz też
-
Parametry service: Service
Usługa do dodania. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
clearCategoryExclusions
-
clearCategoryExclusions(): Slot
-
Usuwa wszystkie etykiety wykluczeń kategorii reklam na poziomie boksu dla tego boksu.
-
- Przykład
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (starsza wersja)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
-
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
clearTargeting
-
clearTargeting(key?: string): Slot
-
Usuwa określone lub wszystkie niestandardowe parametry kierowania na poziomie boksu dla tego boksu.
-
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- Zobacz też
-
Parametry key?: string
Klucz parametru kierowania. Ten klucz jest opcjonalny. Wszystkie parametry kierowania zostaną wyczyszczone, jeśli nie będą nieokreślone. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
defineSizeMapping
-
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
-
Ustawia tablicę mapowania z minimalnego rozmiaru widocznego obszaru na rozmiar boksu dla tego boksu.
-
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping!);
- Zobacz też
-
Parametry sizeMapping: SizeMappingArray
Tablica mapowania rozmiaru. Możesz go utworzyć za pomocą narzędziaSizeMappingBuilder
. Każde mapowanie rozmiaru to tablica z 2 elementami:SingleSizeArray
iGeneralSize
. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
get
-
get(key: string): null | string
-
Zwraca wartość atrybutu AdSense powiązanego z danym kluczem dla tego boksu. Aby zobaczyć atrybuty na poziomie usługi odziedziczone przez ten boks, użyj funkcji
PubAdsService.get
. -
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- Zobacz też
-
Parametry key: string
Nazwa atrybutu do wyszukania. -
Akcje powrotne null | string
Bieżąca wartość klucza atrybutu lubnull
, jeśli klucz nie jest dostępny.
getAdUnitPath
-
getAdUnitPath(): string
-
Zwraca pełną ścieżkę jednostki reklamowej wraz z kodem sieci i ścieżką do jednostki reklamowej.
-
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
-
Akcje powrotne string
Ścieżka jednostki reklamowej.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Zwraca listę kluczy atrybutów ustawionych w tym przedziale. Aby zobaczyć klucze atrybutów na poziomie usługi odziedziczonych przez ten boks, użyj kodu
PubAdsService.getAttributeKeys
. -
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Akcje powrotne string[]
Tablica kluczy atrybutów. Kolejność jest nieokreślona.
getCategoryExclusions
-
getCategoryExclusions(): string[]
-
Zwraca etykiety wykluczenia kategorii reklam dla tego boksu.
-
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
-
Akcje powrotne string[]
Etykiety wykluczenia kategorii reklam dla tego boksu lub pusta tablica, jeśli nie została ustawiona.
getResponseInformation
-
getResponseInformation(): null | ResponseInformation
-
Zwraca informacje o odpowiedzi na reklamę. Są one oparte na ostatniej odpowiedzi reklamy dla tego boksu. Jeśli ta funkcja zostanie wywołana, gdy boks nie ma reklam, zwracana jest wartość
null
. -
-
Akcje powrotne null | ResponseInformation
Najnowsza odpowiedź na reklamę lubnull
, jeśli w boksie nie ma reklam.
getSlotElementId
-
getSlotElementId(): string
-
Zwraca identyfikator przedziału
div
podanego podczas definiowania boksu. -
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div-1'.
-
Akcje powrotne string
Identyfikator boksudiv
.
getTargeting
-
getTargeting(key: string): string[]
-
Zwraca określony niestandardowy parametr kierowania ustawiony w tym boksie. Parametry kierowania na poziomie usługi nie są uwzględniane.
-
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
-
Parametry key: string
Klucz kierowania, którego należy szukać. -
Akcje powrotne string[]
Wartości powiązane z tym kluczem lub pusta tablica, jeśli nie ma takiego klucza.
getTargetingKeys
-
getTargetingKeys(): string[]
-
Zwraca listę wszystkich kluczy kierowania niestandardowego ustawionych w tym boksie. Klucze kierowania na poziomie usługi nie są uwzględniane.
-
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
-
Akcje powrotne string[]
Tablica kluczy kierowania. Kolejność jest nieokreślona.
set
-
set(key: string, value: string): Slot
-
Ustawia wartość atrybutu AdSense dla tego boksu reklamowego. Spowoduje to zastąpienie wszystkich wartości ustawionych dla tego klucza na poziomie usługi.
Wywołanie tej metody więcej niż raz dla tego samego klucza spowoduje zastąpienie poprzednio ustawionych dla niego wartości. Wszystkie wartości należy ustawić przed wywołaniem funkcjidisplay
lubrefresh
. -
- Przykład
-
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (starsza wersja)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- Zobacz też
-
Parametry key: string
Nazwa atrybutu.value: string
Wartość atrybutu. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
setCategoryExclusion
-
setCategoryExclusion(categoryExclusion: string): Slot
-
Ustawia etykietę wykluczenia kategorii reklamy na poziomie boksu dla tego boksu.
-
- Przykład
-
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (starsza wersja)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- Zobacz też
-
Parametry categoryExclusion: string
Etykieta wykluczenia kategorii reklam, którą chcesz dodać. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
setClickUrl
-
setClickUrl(value: string): Slot
-
Ustawia klikany URL, na który będą przekierowywani użytkownicy po kliknięciu reklamy.
Serwery Google Ad Managera nadal rejestrują kliknięcie, nawet jeśli zastąpimy klikany URL. Każdy adres URL strony docelowej powiązany z wyświetlaną kreacją jest dołączany do podanej wartości. Kolejne wywołania zastępują tę wartość. Działa to tylko w przypadku żądań w trybie SRA. -
- Przykład
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (starsza wersja)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
-
Parametry value: string
Klikalny URL do ustawienia. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
setCollapseEmptyDiv
-
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
-
Określa, czy boks
div
ma być ukryty, jeśli w boksie nie ma reklam. Spowoduje to zastąpienie ustawień na poziomie usługi. -
- Przykład
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (starsza wersja)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- Zobacz też
-
Parametry collapse: boolean
Określa, czy zwinąć boks, jeśli nie zostanie zwrócona żadna reklama.collapseBeforeAdFetch?: boolean
Określa, czy zwinąć boks jeszcze przed pobraniem reklamy. Ta wartość jest ignorowana, jeśli zwijanie nie jest wartościątrue
. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
setConfig
-
setConfig(slotConfig: SlotSettingsConfig): void
-
Ustawia ogólne opcje konfiguracji tego przedziału.
-
-
Parametry slotConfig: SlotSettingsConfig
Obiekt konfiguracji.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): Slot
-
Określa, czy reklamy w tym boksie powinny być wymuszane przy użyciu kontenera SafeFrame.
Podczas korzystania z tego interfejsu API pamiętaj o tych kwestiach:- To ustawienie będzie działać tylko w przypadku kolejnych żądań reklamy wysyłanych w przypadku danych boksów reklamowych.
- Ustawienie na poziomie boksu (jeśli zostało określone) zawsze zastępuje ustawienie na poziomie strony.
- Jeśli ustawisz wartość
true
(na poziomie boksu lub strony), reklama będzie zawsze renderowana za pomocą kontenera SafeFrame niezależnie od opcji wybranej w interfejsie Google Ad Managera. - Jeśli jednak ustawisz wartość
false
lub pozostanie nieokreślona, reklama zostanie wyrenderowana za pomocą kontenera SafeFrame w zależności od typu kreacji i wyboru dokonanego w interfejsie Google Ad Managera. - Podczas używania tego interfejsu API należy zachować ostrożność, ponieważ może on wpłynąć na zachowanie kreacji, które próbują wydobyć się poza elementy iframe, lub polegają na tym, że będą renderowane bezpośrednio na stronie wydawcy.
-
- Przykład
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (starsza wersja)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- Zobacz też
-
Parametry forceSafeFrame: boolean
true
, aby wymuszać renderowanie wszystkich reklam w tym boksie w SafeFrame, orazfalse
, aby zrezygnować z ustawienia na poziomie strony (jeśli jest dostępne). Ustawienie wartościfalse
na poziomie strony, gdy nie jest określone na poziomie strony, niczego nie zmieni. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
setSafeFrameConfig
-
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
-
Ustawia preferencje na poziomie boksu dla konfiguracji SafeFrame. Wszystkie nierozpoznane klucze w obiekcie konfiguracji będą ignorowane. Jeśli podana zostanie nieprawidłowa wartość dla rozpoznanego klucza, cała konfiguracja zostanie zignorowana.
Te preferencje na poziomie boksu (jeśli zostaną określone) zastąpią wszelkie preferencje na poziomie strony. -
- Przykład
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (starsza wersja)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Zobacz też
-
Parametry config: null | SafeFrameConfig
Obiekt konfiguracji. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
setTargeting
-
setTargeting(key: string, value: string | string[]): Slot
-
Ustawia niestandardowy parametr kierowania dla tego boksu. Wywołanie tej metody wielokrotnie dla tego samego klucza spowoduje zastąpienie starych wartości. Wartości ustawione tutaj zastąpią parametry kierowania ustawione na poziomie usługi. Klucze są zdefiniowane na Twoim koncie Google Ad Managera.
-
- Przykład
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- Zobacz też
-
Parametry key: string
Klucz parametru kierowania.value: string | string[]
Wartość parametru kierowania lub tablica wartości. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
updateTargetingFromMap
-
updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot
-
Ustawia niestandardowe parametry kierowania dla tego boksu z mapy klucz-wartość w obiekcie JSON. Działa to tak samo jak wywoływanie funkcji
Slot.setTargeting
w przypadku wszystkich par klucz-wartość obiektu. Te klucze są zdefiniowane na Twoim koncie Google Ad Managera.
Uwagi:- W przypadku zastąpienia zostanie zachowana tylko ostatnia wartość.
- Jeśli wartość jest tablicą, jakakolwiek wcześniejsza wartość zostanie zastąpiona, a nie scalona.
- Wartości ustawione tutaj zastąpią parametry kierowania ustawione na poziomie usługi.
-
- Przykład
-
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (starsza wersja)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
-
Parametry map: { [adUnitPath: string]: string | string[] }
Mapa klucz:wartość parametru kierowania. -
Akcje powrotne Slot
Obiekt przedziału, w którym została wywołana metoda.
googletag.config.AdExpansionConfig
Ustawienia sterujące rozwijaniem reklam.
Podsumowanie usługi | |
---|---|
enabled
|
Określa, czy rozwijanie reklam jest włączone czy wyłączone.
|
- Przykład
-
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (starsza wersja)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
enabled
-
enabled: boolean
-
Określa, czy rozwijanie reklam jest włączone czy wyłączone.
Ustawienie tej wartości zastępuje wartość domyślną skonfigurowaną w usłudze Google Ad Manager.
googletag.config.ComponentAuctionConfig
Obiekt reprezentujący aukcję z jednym elementem w aukcji reklam na urządzeniu.
Podsumowanie usługi | |
---|---|
auctionConfig
|
Obiekt konfiguracji aukcji na potrzeby aukcji tego komponentu.
|
configKey
|
Klucz konfiguracji powiązany z aukcją komponentu.
|
auctionConfig
-
auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: { [buyer: string]: number }, perBuyerGroupLimits: { [buyer: string]: number }, perBuyerSignals: { [buyer: string]: unknown }, perBuyerTimeouts: { [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }
-
Obiekt konfiguracji aukcji dla tej aukcji składowej.
Jeśli ta wartość jest ustawiona nanull
, wszelkie dotychczasowe konfiguracje dla określonego elementuconfigKey
zostaną usunięte. -
- Przykład
-
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (starsza wersja)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- Zobacz też
configKey
-
configKey: string
-
Klucz konfiguracji powiązany z aukcją tego komponentu.
Ta wartość nie może być pusta i nie może się powtarzać. Jeśli 2 obiektyComponentAuctionConfig
mają tę samą wartość configKey, ustawiony ostatni obiekt zastąpi wcześniejsze konfiguracje. -
googletag.config.InterstitialConfig
Obiekt określający działanie pojedynczego pełnoekranowego boksu reklamowego.
Podsumowanie usługi | |
---|---|
triggers
|
Konfiguracja reguły kreacji pełnoekranowej dla tej reklamy pełnoekranowej.
|
triggers
-
triggers: Partial<Record<InterstitialTrigger, boolean>>
-
Konfiguracja reguły reklamy pełnoekranowej dla tej reklamy pełnoekranowej.
Jeśli ustawisz wartość reguły reklamy pełnoekranowej natrue
, zostanie ona włączona, afalse
– wyłączona. Spowoduje to zastąpienie wartości domyślnych skonfigurowanych w usłudze Google Ad Manager. -
- Przykład
-
JavaScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
JavaScript (starsza wersja)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- Zobacz też
googletag.config.PageSettingsConfig
Główny interfejs konfiguracyjny ustawień na poziomie strony.
Umożliwia skonfigurowanie wielu funkcji przy użyciu jednego wywołania interfejsu API.
Wszystkie właściwości wymienione poniżej są przykładami i nie odzwierciedlają rzeczywistych funkcji, które korzystają z funkcji setConfig. Zestaw funkcji znajdziesz w polach typu PageSettingsConfig poniżej.
Przykłady:
- Zmodyfikowane są tylko funkcje określone w wywołaniu
setConfig
.// Configure feature alpha. googletag.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. googletag.setConfig({ bravo: {...} });
- Wszystkie ustawienia danej funkcji są aktualizowane przy każdym wywołaniu funkcji
setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. googletag.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. googletag.setConfig({ charlie: { echo: 2 } });
- Wszystkie ustawienia funkcji można wyczyścić, przekazując
null
.// Configure features delta, golf, and hotel. googletag.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. googletag.setConfig({ delta: null, hotel: null, });
Podsumowanie usługi | |
---|---|
adExpansion
|
Ustawienia sterujące rozwijaniem reklam.
|
pps
|
Ustawienia do sterowania sygnałami dostarczanymi przez wydawcę.
|
privacyTreatments
|
Ustawienia kontroli prywatności wydawcy.
|
adExpansion
-
adExpansion: null | AdExpansionConfig
-
Ustawienia sterujące rozwijaniem reklam.
-
pps
-
pps: null | PublisherProvidedSignalsConfig
-
Ustawienia do sterowania sygnałami dostarczanymi przez wydawcę.
-
privacyTreatments
-
privacyTreatments: null | PrivacyTreatmentsConfig
-
Ustawienia kontroli prywatności wydawcy.
-
googletag.config.PrivacyTreatmentsConfig
Ustawienia kontroli prywatności wydawcy.
Podsumowanie usługi | |
---|---|
treatments
|
Różne sposoby ochrony prywatności wydawców, które możesz włączyć.
|
treatments
-
treatments: "disablePersonalization"[]
-
Różne sposoby ochrony prywatności wydawców, które możesz włączyć.
-
- Przykład
-
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (starsza wersja)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
googletag.config.PublisherProvidedSignalsConfig
Obiekt konfiguracji sygnałów dostarczanych przez wydawcę.
Podsumowanie usługi | |
---|---|
taxonomies
|
Obiekt zawierający mapowania taksonomii.
|
- Przykład
-
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (starsza wersja)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
- Zobacz też
taxonomies
-
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
-
Obiekt zawierający mapowania taksonomii.
-
googletag.config.SlotSettingsConfig
Główny interfejs konfiguracyjny ustawień na poziomie boksu.
Umożliwia skonfigurowanie wielu funkcji przy użyciu jednego wywołania interfejsu API dla jednego boksu.
Wszystkie właściwości wymienione poniżej są przykładami i nie odzwierciedlają rzeczywistych funkcji, które korzystają z setConfig. Zestaw funkcji znajdziesz w polach typu SlotSettingsConfig poniżej.
Przykłady:
- Zmodyfikowane są tylko funkcje określone w wywołaniu
Slot.setConfig
.const slot = googletag.defineSlot("/1234567/example", [160, 600]); // Configure feature alpha. slot.setConfig({ alpha: {...} }); // Configure feature bravo. Feature alpha is unchanged. slot.setConfig({ bravo: {...} });
- Wszystkie ustawienia danej funkcji są aktualizowane przy każdym wywołaniu funkcji
Slot.setConfig
.// Configure feature charlie to echo = 1, foxtrot = true. slot.setConfig({ charlie: { echo: 1, foxtrot: true, } }); // Update feature charlie to echo = 2. Since foxtrot was not specified, // the value is cleared. slot.setConfig({ charlie: { echo: 2 } });
- Wszystkie ustawienia funkcji można wyczyścić, przekazując
null
.// Configure features delta, golf, and hotel. slot.setConfig({ delta: {...}, golf: {...}, hotel: {...}, }); // Feature delta and hotel are cleared, but feature golf remains set. slot.setConfig({ delta: null, hotel: null, });
Podsumowanie usługi | |
---|---|
adExpansion
|
Ustawienia sterujące rozwijaniem reklam.
|
componentAuction
|
Tablica aukcji składowych w aukcji reklam na urządzeniu.
|
interstitial
|
Ustawienia kontrolujące działanie pełnoekranowego boksu reklamowego.
|
adExpansion
-
adExpansion: AdExpansionConfig
-
Ustawienia sterujące rozwijaniem reklam.
-
componentAuction
-
componentAuction: ComponentAuctionConfig[]
-
Tablica aukcji składowych w aukcji reklam na urządzeniu.
-
interstitial
-
interstitial: InterstitialConfig
-
Ustawienia kontrolujące działanie pełnoekranowego boksu reklamowego.
-
googletag.config.TaxonomyData
Obiekt zawierający wartości pojedynczej taksonomii.
Podsumowanie usługi | |
---|---|
values
|
Lista wartości taksonomii.
|
values
-
values: string[]
-
Lista wartości taksonomii.
-
googletag.events.Event
Podstawowy interfejs do wszystkich zdarzeń GPT. Wszystkie poniższe zdarzenia GPT będą miały te pola.
Podsumowanie usługi | |
---|---|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
|
slot
|
Przedział, który wywołał zdarzenie.
|
- Zobacz też
serviceName
-
serviceName: string
-
Nazwa usługi, która wywołała zdarzenie.
-
slot
-
slot: Slot
-
Przedział, który wywołał zdarzenie.
-
googletag.events.EventTypeMap
To pseudotyp, który mapuje nazwę zdarzenia na odpowiadający mu typ obiektu zdarzenia dla Service.addEventListener
i Service.removeEventListener
. Jest ona udokumentowana tylko w celach referencyjnych i bezpieczeństwa wpisywania.
Podsumowanie usługi | |
---|---|
impressionViewable
|
Alias domeny
events.ImpressionViewableEvent .
|
rewardedSlotClosed
|
Alias domeny
events.RewardedSlotClosedEvent .
|
rewardedSlotGranted
|
Alias domeny
events.RewardedSlotGrantedEvent .
|
rewardedSlotReady
|
Alias domeny
events.RewardedSlotReadyEvent .
|
slotOnload
|
Alias domeny
events.SlotOnloadEvent .
|
slotRenderEnded
|
Alias domeny
events.SlotRenderEndedEvent .
|
slotRequested
|
Alias domeny
events.SlotRequestedEvent .
|
slotResponseReceived
|
Alias domeny
events.SlotResponseReceived .
|
slotVisibilityChanged
|
Alias domeny
events.SlotVisibilityChangedEvent .
|
impressionViewable
-
impressionViewable: ImpressionViewableEvent
-
Alias domeny
events.ImpressionViewableEvent
. -
rewardedSlotClosed
-
rewardedSlotClosed: RewardedSlotClosedEvent
-
Alias domeny
events.RewardedSlotClosedEvent
. -
rewardedSlotGranted
-
rewardedSlotGranted: RewardedSlotGrantedEvent
-
Alias domeny
events.RewardedSlotGrantedEvent
. -
rewardedSlotReady
-
rewardedSlotReady: RewardedSlotReadyEvent
-
Alias domeny
events.RewardedSlotReadyEvent
. -
slotOnload
-
slotOnload: SlotOnloadEvent
-
Alias domeny
events.SlotOnloadEvent
. -
slotRenderEnded
-
slotRenderEnded: SlotRenderEndedEvent
-
Alias domeny
events.SlotRenderEndedEvent
. -
slotRequested
-
slotRequested: SlotRequestedEvent
-
Alias domeny
events.SlotRequestedEvent
. -
slotResponseReceived
-
slotResponseReceived: SlotResponseReceived
-
Alias domeny
events.SlotResponseReceived
. -
slotVisibilityChanged
-
slotVisibilityChanged: SlotVisibilityChangedEvent
-
Alias domeny
events.SlotVisibilityChangedEvent
. -
googletag.events.ImpressionViewableEvent
Przedłuża
Zdarzenie to jest wywoływane, gdy wyświetlenie staje się widoczne zgodnie z kryteriami Widoku aktywnego.
Podsumowanie usługi | |
---|---|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
- Przykład
-
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
googletag.events.RewardedSlotClosedEvent
Przedłuża
Zdarzenie jest wywoływane, gdy użytkownik zamknie boks reklamowy z nagrodą. Może się uruchomić przed przyznaniem nagrody lub po jej przyznaniu. Aby sprawdzić, czy nagroda została przyznana, użyj narzędzia events.RewardedSlotGrantedEvent
.
Podsumowanie usługi | |
---|---|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
- Przykład
-
JavaScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when the user closes a rewarded ad slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
googletag.events.RewardedSlotGrantedEvent
Przedłuża
Zdarzenie jest uruchamiane, gdy zostanie przyznana nagroda za obejrzenie reklamy z nagrodą. Jeśli reklama zostanie zamknięta, zanim zostaną spełnione kryteria przyznawania nagrody, zdarzenie nie zostanie uruchomione.
Podsumowanie usługi | |
---|---|
payload
|
Obiekt zawierający informacje o przyznanej nagrodzie.
|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
- Przykład
-
JavaScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called whenever a reward is granted for a // rewarded ad. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
payload
-
payload: null | RewardedPayload
-
Obiekt zawierający informacje o przyznanej nagrodzie.
-
googletag.events.RewardedSlotReadyEvent
Przedłuża
Zdarzenie to jest wywoływane, gdy reklama z nagrodą jest gotowa do wyświetlenia. Wydawca odpowiada za umożliwienie użytkownikom obejrzenia reklamy przed jej wyświetleniem.
Podsumowanie usługi | |
---|---|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
Podsumowanie metody | |
---|---|
makeRewardedVisible
|
Wyświetla reklamę z nagrodą.
|
- Przykład
-
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
makeRewardedVisible
-
makeRewardedVisible(): void
-
Wyświetla reklamę z nagrodą. Metodę tę nie należy wywoływać, dopóki użytkownik nie wyrazi zgody na wyświetlenie reklamy.
-
googletag.events.SlotOnloadEvent
Przedłuża
To zdarzenie jest wywoływane, gdy element iframe kreacji uruchomi zdarzenie wczytywania. Podczas renderowania reklam multimedialnych w trybie renderowania synchronicznego nie są używane żadne elementy iframe, więc element SlotOnloadEvent
nie będzie uruchamiany.
Podsumowanie usługi | |
---|---|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
- Przykład
-
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
googletag.events.SlotRenderEndedEvent
Przedłuża
To zdarzenie jest wywoływane po wstrzyknięciu kodu kreacji do boksu. Zdarzenie to nastąpi przed pobraniem zasobów kreacji, więc może ona być jeszcze niewidoczna. Jeśli chcesz wiedzieć, kiedy wszystkie zasoby kreacji w danym boksie zostały wczytane, skorzystaj z tabeli events.SlotOnloadEvent
.
Podsumowanie usługi | |
---|---|
advertiserId
|
Identyfikator reklamodawcy renderowanej reklamy.
|
campaignId
|
Identyfikator kampanii renderowanej reklamy.
|
companyIds
|
Identyfikatory firm, które ustalały stawki za wyrenderowaną reklamę zapasową.
|
creativeId
|
Identyfikator kreacji renderowanej reklamy z rezerwacji.
|
creativeTemplateId
|
Identyfikator szablonu kreacji renderowanej reklamy z rezerwacji.
|
isBackfill
|
Wskazuje, czy reklama była reklamą zapasową.
|
isEmpty
|
Wskazuje, czy reklama została zwrócona dla tego boksu.
|
labelIds
|
Identyfikatory etykiet renderowanej reklamy.
|
lineItemId
|
Identyfikator elementu zamówienia renderowanej reklamy z rezerwacji.
|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
size
|
Wskazuje rozmiar renderowanej kreacji w pikselach.
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
slotContentChanged
|
Wskazuje, czy treść boksu została zmieniona wraz z wyrenderowaną reklamą.
|
sourceAgnosticCreativeId
|
Identyfikator kreacji renderowanej reklamy z rezerwacji lub reklamy zapasowej.
|
sourceAgnosticLineItemId
|
Identyfikator elementu zamówienia renderowanej reklamy z rezerwacji lub reklamy zapasowej.
|
yieldGroupIds
|
Identyfikatory grup zysku wyrenderowanej reklamy zapasowej.
|
- Przykład
-
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
advertiserId
-
advertiserId: null | number
-
Identyfikator reklamodawcy renderowanej reklamy. Wartość to
null
dla pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niżPubAdsService
. -
campaignId
-
campaignId: null | number
-
Identyfikator kampanii renderowanej reklamy. Wartość to
null
dla pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niżPubAdsService
. -
companyIds
-
companyIds: null | number[]
-
Identyfikatory firm, które ustalały stawki za wyrenderowaną reklamę zapasową. Wartość to
null
w przypadku pustych boksów, reklam z rezerwacji i kreacji renderowanych przez usługi inne niżPubAdsService
. -
creativeId
-
creativeId: null | number
-
Identyfikator kreacji renderowanej reklamy z rezerwacji. Wartość to
null
dla pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niżPubAdsService
. -
creativeTemplateId
-
creativeTemplateId: null | number
-
Identyfikator szablonu kreacji renderowanej reklamy z rezerwacji. Wartość to
null
dla pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niżPubAdsService
. -
isBackfill
-
isBackfill: boolean
-
Wskazuje, czy reklama była reklamą zapasową. Wartość to
true
, jeśli reklama była reklamą zapasową,false
w przeciwnym razie. -
isEmpty
-
isEmpty: boolean
-
Wskazuje, czy reklama została zwrócona dla tego boksu. Wartość to
true
, jeśli nie została zwrócona żadna reklama. W przeciwnym razie wartość tofalse
. -
labelIds
-
labelIds: null | number[]
-
Identyfikatory etykiet renderowanej reklamy. Wartość to
null
dla pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niżPubAdsService
. -
lineItemId
-
lineItemId: null | number
-
Identyfikator elementu zamówienia renderowanej reklamy z rezerwacji. Wartość to
null
dla pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niżPubAdsService
. -
size
-
size: null | string | number[]
-
Wskazuje rozmiar renderowanej kreacji w pikselach. Przykład:
[728, 90]
. Wartość w przypadku pustych boksów reklamowych tonull
. -
slotContentChanged
-
slotContentChanged: boolean
-
Wskazuje, czy treść boksu została zmieniona wraz z wyrenderowaną reklamą. Wartość to
true
, jeśli treść została zmieniona. W przeciwnym razie wartość tofalse
. -
sourceAgnosticCreativeId
-
sourceAgnosticCreativeId: null | number
-
Identyfikator kreacji renderowanej reklamy z rezerwacji lub reklamy zapasowej. Wartość to
null
, jeśli reklama nie jest rezerwacją ani zapasową elementem zamówienia lub kreacja jest renderowana przez usługi inne niżPubAdsService
. -
sourceAgnosticLineItemId
-
sourceAgnosticLineItemId: null | number
-
Identyfikator elementu zamówienia renderowanej reklamy z rezerwacji lub reklamy zapasowej. Wartość to
null
, jeśli reklama nie jest rezerwacją ani zapasową elementem zamówienia lub kreacja jest renderowana przez usługi inne niżPubAdsService
. -
yieldGroupIds
-
yieldGroupIds: null | number[]
-
Identyfikatory grup zysku wyrenderowanej reklamy zapasowej. Wartość to
null
w przypadku pustych boksów, reklam z rezerwacji i kreacji renderowanych przez usługi inne niżPubAdsService
. -
googletag.events.SlotRequestedEvent
Przedłuża
Zdarzenie to jest wywoływane po wysłaniu żądania reklamy dla określonego boksu.
Podsumowanie usługi | |
---|---|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
- Przykład
-
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
googletag.events.SlotResponseReceived
Przedłuża
Zdarzenie to jest wywoływane po otrzymaniu odpowiedzi na reklamę w przypadku określonego boksu.
Podsumowanie usługi | |
---|---|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
- Przykład
-
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
googletag.events.SlotVisibilityChangedEvent
Przedłuża
Zdarzenie jest wywoływane zawsze, gdy zmienia się odsetek obszaru boksu reklamowego na ekranie. Zdarzenie jest ograniczane i będzie uruchamiane nie częściej niż raz na 200 ms.
Podsumowanie usługi | |
---|---|
inViewPercentage
|
Procent obszaru reklamy, który jest widoczny.
|
serviceName
|
Nazwa usługi, która wywołała zdarzenie.
Odziedziczone z grupy
|
slot
|
Przedział, który wywołał zdarzenie.
Odziedziczone z grupy
|
- Przykład
-
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Zobacz też
inViewPercentage
-
inViewPercentage: number
-
Procent obszaru reklamy, który jest widoczny. Wartość musi być liczbą od 0 do 100.
-
googletag.secureSignals.BidderSignalProvider
Zwraca bezpieczny sygnał dla określonego licytującego.
Dostawca bezpiecznych sygnałów dla licytującego składa się z 2 części:
- Funkcja kolektora, która zwraca wartość
Promise
, która zmienia się w bezpieczny sygnał. - Element
id
, który identyfikuje licytującego powiązanego z sygnałem.
secureSignals.PublisherSignalProvider
.
Podsumowanie usługi | |
---|---|
collectorFunction
|
.
|
id
|
Unikalny identyfikator dostawcy powiązanego z tym bezpiecznym sygnałem zarejestrowany w usłudze Google Ad Manager.
|
- Przykład
-
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (starsza wersja)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Zobacz też
collectorFunction
-
collectorFunction: () => Promise<string>
-
id
-
id: string
-
Unikalny identyfikator dostawcy powiązanego z tym bezpiecznym sygnałem zarejestrowany w usłudze Google Ad Manager.
-
googletag.secureSignals.PublisherSignalProvider
Zwraca bezpieczny sygnał dla określonego wydawcy.
Dostawca sygnału dla wydawcy składa się z 2 części:
- Funkcja kolektora, która zwraca wartość
Promise
, która zmienia się w bezpieczny sygnał. - Identyfikator
networkCode
, który identyfikuje wydawcę powiązanego z sygnałem.
secureSignals.BidderSignalProvider
.
Podsumowanie usługi | |
---|---|
collectorFunction
|
.
|
networkCode
|
Kod sieci (w takiej postaci, w jakiej występuje w ścieżce jednostki reklamowej) wydawcy powiązanego z tym bezpiecznym sygnałem.
|
- Przykład
-
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (starsza wersja)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Zobacz też
collectorFunction
-
collectorFunction: () => Promise<string>
-
networkCode
-
networkCode: string
-
Kod sieci (w takiej postaci, w jakiej występuje w ścieżce jednostki reklamowej) wydawcy powiązanego z tym bezpiecznym sygnałem.
-
googletag.secureSignals.SecureSignalProvidersArray
Interfejs do zarządzania bezpiecznymi sygnałami.
Podsumowanie metody | |
---|---|
clearAllCache
|
Usuwa wszystkie sygnały z pamięci podręcznej w pamięci lokalnej.
|
push
|
Dodaje nowy element
secureSignals.SecureSignalProvider do tablicy dostawcy sygnału i rozpoczyna proces generowania sygnału.
|
clearAllCache
-
clearAllCache(): void
-
Usuwa wszystkie sygnały z pamięci podręcznej w pamięci lokalnej.
-
push
-
push(provider: SecureSignalProvider): void
-
Dodaje nowy element
secureSignals.SecureSignalProvider
do tablicy dostawcy sygnału i rozpoczyna proces generowania sygnału. -
-
Parametry provider: SecureSignalProvider
ObiektsecureSignals.SecureSignalProvider
, który ma zostać dodany do tablicy.