W tym dokumencie do opisywania typów używa się notacji TypeScript. W tabeli poniżej znajdziesz krótkie wyjaśnienie na przykładzie.
Wyrażenie typu | |
---|---|
string |
Pierwotny typ ciągu znaków. |
string[] |
Typ tablicy, w którym wartości mogą być tylko ciągami znaków. |
number | string |
Typ zjednoczenia, którego wartością może być liczba lub ciąg znaków. |
Array<number | string> |
Typ tablicy, w którym wartości są typem złożonym (złożonym). |
[number, string] |
Typ tuple, którego wartość jest tablicą o 2 elementach, która musi zawierać liczbę i ciąg w tej kolejności. |
Slot |
Typ obiektu, którego wartość jest wystąpieniem typu googletag.Slot . |
() => void |
Typ funkcji bez zdefiniowanych argumentów i wartości zwrotnej. |
Więcej informacji o obsługiwanych typach i wyrażeniach typów znajdziesz w podręczniku TypeScript .
Adnotacje typu
Dwukropek po zmiennej, nazwie parametru, nazwie właściwości lub podpisie 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 typów, które mogą się pojawić w tym dokumencie.
Adnotacja typu | |
---|---|
param: string |
Wskazuje, że param może przyjmować lub zwracać wartość ciągu znaków. Ta składnia jest używana w przypadku zmiennych, parametrów, właściwości i typów zwracanych.
|
param?: number | string |
Wskazuje, że parametr param jest opcjonalny, ale akceptuje liczbę lub ciąg 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
rest
, który akceptuje funkcje. Parametry REST mogą przyjmować nieograniczoną liczbę wartości danego typu.
|
googletag
Przestrzenie nazw | |
---|---|
config | Główny interfejs konfiguracji ustawień na poziomie strony. |
enums | Jest to przestrzeń nazw używana przez GPT do typów enum. |
events | Jest to przestrzeń nazw, której GPT używa do zdarzeń. |
secure | To przestrzeń nazw, której GPT używa do zarządzania bezpiecznymi sygnałami. |
Interfejsy | |
---|---|
Command | Tablica poleceń akceptuje sekwencję funkcji i wywołuje je po kolei. |
Companion | Usługa Reklam towarzyszących. |
Privacy | Obiekt konfiguracji ustawień prywatności. |
Pub | Usługa reklam wydawcy. |
Response | Obiekt reprezentujący pojedynczą odpowiedź reklamy. |
Rewarded | Obiekt reprezentujący nagrodę powiązaną z reklamą z nagrodą. |
Safe | Obiekt konfiguracji kontenerów SafeFrame. |
Service | Podstawowa klasa usługi zawierająca metody wspólne dla wszystkich usług. |
Size | Kreator obiektów specyfikacji mapowania rozmiarów. |
Slot | Slot to obiekt reprezentujący pojedynczy boks reklamowy na stronie. |
Aliasy typu | |
---|---|
General | Prawidłowa konfiguracja rozmiarów boksu reklamowego, która może zawierać jeden lub wiele rozmiarów. |
Multi | Lista pojedynczych prawidłowych rozmiarów. |
Named | Nazwy rozmiarów, które może mieć boks. |
Single | Jeden prawidłowy rozmiar dla boksu. |
Single | Tablica dwóch liczb reprezentujących szerokość, wysokość. |
Size | Mapowanie rozmiaru widocznego obszaru na rozmiary reklam. |
Size | Lista mapowania rozmiarów. |
Zmienne | |
---|---|
api | Flaga wskazująca, że interfejs GPT API został załadowany i gotowy do wywołania. |
cmd | Odwołania do globalnej kolejki poleceń na potrzeby asynchronicznego wykonywania wywołań związanych z GPT. |
pubads | Flaga wskazująca, że usługa PubAdsService jest włączona, załadowana i w pełni funkcjonalna. |
secure | Odwołanie do tablicy dostawców bezpiecznych sygnałów. |
Funkcje | |
---|---|
companion | Zwraca odwołanie do CompanionAdsService. |
define | Tworzy boks reklamowy poza stroną o podanej ścieżce jednostki reklamowej. |
define | Tworzy boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej i powiązuje go z identyfikatorem elementu div na stronie, który będzie zawierać reklamę. |
destroy | Niszczy podane boksy reklamowe, usuwając z GPT wszystkie powiązane z nimi obiekty i odniesienia. |
disable | Wyłącza Konsolę Google dla wydawcy. |
display | Instruuje usługi slotów, aby renderowały slot. |
enable | Włącza wszystkie usługi GPT zdefiniowane dla boksów reklamowych na stronie. |
get | Zwraca bieżącą wersję GPT. |
open | Otwiera Konsolę Google dla wydawcy. |
pubads | Zwraca odwołanie do usługi PubAdsService. |
set | Od tego momentu ustawia tytuł wszystkich elementów iframe kontenera reklam utworzonych przez PubAdsService. |
set | Ustawia ogólne opcje konfiguracji strony. |
size | Tworzy nowy obiekt SizeMappingBuilder. |
Aliasy typu
GeneralSize
GeneralSize: SingleSize | MultiSize
Prawidłowa konfiguracja rozmiarów boksu reklamowego, która może zawierać jeden lub wiele rozmiarów.
MultiSize
MultiSize: SingleSize[]
Lista pojedynczych prawidłowych rozmiarów.
NamedSize
- elastyczny: kontener reklamy zajmuje 100% szerokości kontenera nadrzędnego, a następnie dostosowuje wysokość do treści kreacji. Podobnie jak zwykłe elementy blokowe na stronie. Używany w przypadku reklam natywnych (zobacz powiązany artykuł). Pamiętaj, że do deklarowania rozmiaru boksu jako elastycznej można używać zarówno
fluid
, jak i['fluid']
.
NamedSize: "fluid" | ["fluid"]
Nazwy rozmiarów, które może mieć boks. W większości przypadków rozmiar to prostokąt o stałym rozmiarze, ale w niektórych przypadkach potrzebujemy innych specyfikacji rozmiaru. Dopuszczalne są tylko te nazwane rozmiary:
SingleSize
SingleSize: SingleSizeArray | NamedSize
Pojedynczy prawidłowy rozmiar dla slotu.
SingleSizeArray
SingleSizeArray: [number, number]
Tablica dwóch liczb reprezentujących szerokość, wysokość.
SizeMapping
SizeMapping: [SingleSizeArray, GeneralSize]
Mapowanie rozmiaru widocznego obszaru na rozmiary reklam. Kolumna używana w przypadku reklam elastycznych.
SizeMappingArray
SizeMappingArray: SizeMapping[]
Lista mapowania rozmiarów.
Zmienne
Const
apiReady
apiReady: boolean | undefined
Flaga wskazująca, że interfejs GPT API został załadowany i gotowy do wywołania. Ta właściwość będzie po prostu undefined
, dopóki interfejs API nie będzie gotowy.
Pamiętaj, że zalecany sposób obsługi asynchronicznego to użycie tagu googletag.cmd do kolejkowania wywołań zwrotnych na czas, gdy GPT będzie gotowy. Te funkcje zwracania wartości nie muszą sprawdzać, czy interfejs API jest gotowy do użycia (googletag.apiReady), ponieważ po skonfigurowaniu interfejsu API są one zawsze wykonywane.
Const
cmd
- 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()); });
cmd: ((this: typeof globalThis) => void)[] | CommandArray
Odwołuje się do globalnej kolejki poleceń służącej do asynchronicznego wykonywania wywołań związanych z GPT.
Zmienna googletag.cmd
jest inicjowana jako pusty tablica JavaScriptu przez składnię tagu GPT na stronie, a cmd.push
to standardowa metoda Array.push
, która dodaje element na końcu tablicy. Gdy wczytany jest kod JavaScriptu GPT, sprawdza on tablicę i wykonuje wszystkie funkcje po kolei. Następnie skrypt zastępuje cmd
obiektem CommandArray, którego metoda push jest zdefiniowana w celu wykonania przekazanego do niej argumentu funkcji. Ten mechanizm pozwala GPT zmniejszyć odczuwalne opóźnienie, pobierając kod JavaScript asynchronicznie, a zarazem umożliwiając przeglądarce dalsze renderowanie strony.
Const
pubadsReady
pubadsReady: boolean | undefined
Flaga z informacją, że usługa PubAdsService jest włączona, wczytana i w pełni funkcjonalna. Ta właściwość będzie po prostu undefined
do czasu wywołania i zainicjowania funkcji enableServices oraz załadowania i zainicjowania usługi PubAdsService.
secureSignalProviders
- 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"); }, });
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
Odwołania do tablicy dostawców bezpiecznych sygnałów.
Tablica dostawców bezpiecznych sygnałów przyjmuje sekwencję funkcji generujących sygnały i wywołuje je kolejno. Ma on zastąpić standardową tablicę, która służy do kolejkowania funkcji generujących sygnały, aby wywołać je po załadowaniu tagu GPT.
Funkcje
companionAds
companionAds(): CompanionAdsService
Zwraca odwołanie do CompanionAdsService.
Zwroty | |
---|---|
CompanionAdsService | Usługa reklam towarzyszących. |
defineOutOfPageSlot
- 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ż
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
Tworzy boks reklamowy poza stroną (reklamę pełnoekranową) 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 o kreacjach poza stroną.
W przypadku reklam poza stroną zarządzanych przez GPT div
jest obsługiwanym OutOfPageFormat.
Parametry | |
---|---|
adUnitPath: string | Pełna ścieżka jednostki reklamowej z kodem sieci i kodem jednostki reklamowej. |
| Identyfikator elementu div, który będzie zawierać tę jednostkę reklamową lub format OutOfPageFormat. |
Zwroty | |
---|---|
Slot | null | Nowo utworzony przedział lub null , jeśli nie można utworzyć przedziału. |
defineSlot
- 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ż
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
Tworzy boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej i powiązuje go z identyfikatorem elementu div na stronie, który będzie zawierać reklamę.
Parametry | |
---|---|
adUnitPath: string | Pełna ścieżka jednostki reklamowej z kodem sieci i kodem jednostki. |
size: GeneralSize | Szerokość i wysokość dodanego boksu. Ten rozmiar jest używany w żądaniu reklamy, jeśli nie ma mapowania rozmiaru elastycznego lub rozmiar widocznego obszaru jest mniejszy niż najmniejszy rozmiar podany w mapowaniu. |
| Identyfikator div, który będzie zawierać tę jednostkę reklamową. |
Zwroty | |
---|---|
Slot | null | Nowo utworzony przedział lub null , jeśli nie można utworzyć przedziału. |
destroySlots
- 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();
destroySlots(slots?: Slot[]): boolean
Niszczy podane boksy reklamowe, usuwając z GPT wszystkie powiązane z nimi obiekty i odniesienia. Ten interfejs API nie obsługuje slotów przekazywania i slotów towarzyszących.
Wywołanie tego interfejsu API w przypadku slotu powoduje wyczyszczenie reklamy i usunięcie obiektu slotu z wewnętrznego stanu obsługiwanego przez GPT. Wywołanie kolejnych funkcji w obiekcie boksu spowoduje nieoczekiwane zachowanie. Pamiętaj, że przeglądarka może nie zwolnić pamięci powiązanej z tym miejscem, jeśli strona wydawcy nadal do niego odwołuje. Wywołanie tego interfejsu API powoduje, że element div powiązany z tym boksem jest dostępny do ponownego użycia.
W szczególności zlikwidowanie boksu powoduje usunięcie reklamy z długotrwałego wyświetlenia strony w GPT, dzięki czemu przyszłe żądania nie będą już podlegać blokadom ani wykluczeniom konkurencji dotyczącym tej reklamy. Niewywołanie tej funkcji przed usunięciem elementu div slotu z strony spowoduje nieokreślone działanie.
Parametry | |
---|---|
| Tablica przedziałów do zniszczenia. Tablica jest opcjonalna. Jeśli nie zostanie określona, wszystkie gniazda zostaną zniszczone. |
Zwroty | |
---|---|
boolean | true , jeśli sloty zostały zniszczone, lub false w przeciwnym razie. |
disablePublisherConsole
Wyświetlacz
- Zobacz też
display(divOrSlot: string | Element | Slot): void
Instruuje usługi slotów, aby renderowały slot. Każdy boks reklamowy powinien być wyświetlany na stronie tylko raz. Zanim sloty zostaną wyświetlone, muszą być zdefiniowane i powiązane z usługą. Wywołanie wyświetlania nie może nastąpić, dopóki element nie pojawi się w DOM. Częstym sposobem na osiągnięcie tego celu jest umieszczenie go w bloku skryptu w elemencie div o nazwie w wywołaniu metody.
Jeśli używana jest architektura z pojedynczym żądaniem (SRA), wszystkie niepobrane boksy reklamowe w momencie wywołania tej metody zostaną pobrane jednocześnie. Aby wymusić brak wyświetlania boksu reklamowego, musisz usunąć cały element div.
Parametry | |
---|---|
divOrSlot: string | Element | Slot | Identyfikator elementu div zawierającego miejsce na reklamę lub element div lub obiekt miejsca na reklamę. Jeśli podany jest element div, musi on mieć atrybut „id” zgodny z identyfikatorem przekazywanym do defineSlot. |
enableServices
getVersion
openConsole
- 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ż
openConsole(div?: string): void
Otwiera Konsolę Google dla wydawcy.
Parametry | |
---|---|
| Identyfikator elementu div boksu reklamowego. Ta wartość jest opcjonalna. Jeśli podasz slot reklamowy, Konsola wydawcy spróbuje otworzyć go z wyświetlonymi szczegółami. |
pubads
pubads(): PubAdsService
Zwraca odwołanie do PubAdsService.
Zwroty | |
---|---|
PubAdsService | Usługa Reklamy wydawcy. |
setAdIframeTitle
- Przykład
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (starsza wersja)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
setAdIframeTitle(title: string): void
Ustawia tytuł wszystkich elementów iframe kontenerów reklam utworzonych od tego momentu przez PubAdsService.
Parametry | |
---|---|
title: string | Nowy tytuł wszystkich ramek iframe kontenera reklamy. |
setConfig
setConfig(config: PageSettingsConfig): void
Ustawia ogólne opcje konfiguracji strony.
Parametry | |
---|---|
config: PageSettingsConfig |
sizeMapping
- Zobacz też
sizeMapping(): SizeMappingBuilder
Tworzy nowy obiekt SizeMappingBuilder.
Zwroty | |
---|---|
SizeMappingBuilder | Nowy kreator. |
googletag.CommandArray
Metody | |
---|---|
push | Wykonuje sekwencję funkcji określonych w argumentach w odpowiedniej kolejności. |
Metody
push
- 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()); });
push(...f: ((this: typeof globalThis) => void)[]): number
Wykonuje sekwencję funkcji określonych w argumentach w kolejności.
Parametry | |
---|---|
| Funkcja JavaScriptu do wykonania. Wiązanie w czasie działania będzie zawsze globalThis . Rozważ przekazanie funkcji strzałki, aby zachować wartość this otaczającego kontekstu leksykalnego. |
Zwroty | |
---|---|
number | Liczba przetworzonych do tej pory poleceń. Jest to zgodne z wartością zwracaną przez funkcję Array.push (bieżąca długość tablicy). |
googletag.CompanionAdsService
PrzedłużaMetody | |
---|---|
add | Rejestruje detektor, który umożliwia konfigurowanie i wywoływanie funkcji JavaScript po wystąpieniu na stronie konkretnego zdarzenia GPT. Odziedziczone z |
get | Wyświetl listę slotów powiązanych z tą usługą. Odziedziczone z |
remove | usuwa wcześniej zarejestrowanego słuchacza. Odziedziczone z |
set | Określa, czy boksy towarzyszące, które nie zostały wypełnione, mają być automatycznie wypełniane reklamami zapasowymi. |
Metody
setRefreshUnfilledSlots
- Przykład
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (starsza wersja)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
setRefreshUnfilledSlots(value: boolean): void
Określa, czy niewypełnione boksy towarzyszące mają być automatycznie wypełniane reklamami zapasowymi.
Metodę tę można wywoływać wielokrotnie w trakcie istnienia strony, aby włączać i wyłączać wypełnianie. Wypełnianie będzie dotyczyć tylko boksów, które są zarejestrowane w usłudze PubAdsService. Ze względu na ograniczenia związane z zasadami ta metoda nie jest przeznaczona do wypełniania pustych miejsc na reklamy towarzyszące podczas wyświetlania reklamy wideo z Ad Exchange.
Parametry | |
---|---|
value: boolean | true , aby automatycznie wypełnić niewypełnione sloty, lub false , aby pozostawić je bez zmian. |
googletag.PrivacySettingsConfig
Właściwości | |
---|---|
child | Wskazuje, czy stronę należy traktować jako skierowaną do dzieci. |
limited | Umożliwia wyświetlanie reklam w trybie ograniczonego wyświetlania reklam, aby pomóc wydawcom w zapewnieniu zgodności z wymaganiami prawnymi. |
non | Umożliwia wyświetlanie reklam w trybie reklam niespersonalizowanych, aby pomóc wydawcom w spełnianiu wymagań regulacyjnych. |
restrict | Umożliwia wyświetlanie reklam w trybie przetwarzania ograniczonego, aby pomóc wydawcom w spełnianiu wymagań regulacyjnych. |
traffic | Wskazuje, czy żądania pochodzą z ruchu kupionego czy bezpłatnego. |
under | 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ż
Właściwości
Optional
childDirectedTreatment
childDirectedTreatment?: null | boolean
Wskazuje, czy stronę należy traktować jako skierowaną do dzieci. Ustaw wartość na null
, aby wyczyścić konfigurację.
Optional
limitedAds
- automatycznie, za pomocą sygnału z platformy do zarządzania zgodą użytkowników zgodnie z Zasadami IAB dotyczącymi przejrzystości i uzyskiwania zgody na przetwarzanie danych w wersji 2.0.
- Ręcznie, ustawiając wartość tego pola na
true
. - Przykład
JavaScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
JavaScript (starsza wersja)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
limitedAds?: boolean
Umożliwia wyświetlanie reklam w trybie ograniczonego wyświetlania reklam, aby pomóc wydawcom w spełnianiu wymagań regulacyjnych.
Możesz zlecić GPT żądanie reklam w ramach ograniczonego wyświetlania na 2 sposoby:
Pamiętaj, że nie musisz ręcznie włączać ograniczonego wyświetlania reklam, gdy używasz platformy CMP.
Optional
nonPersonalizedAds
nonPersonalizedAds?: boolean
Umożliwia wyświetlanie reklam w trybie reklam niespersonalizowanych, aby pomóc wydawcom w spełnianiu wymagań regulacyjnych.
Optional
restrictDataProcessing
restrictDataProcessing?: boolean
Umożliwia wyświetlanie reklam w trybie przetwarzania ograniczonego, aby pomóc wydawcom w spełnianiu wymagań regulacyjnych.
Optional
trafficSource
- 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, });
trafficSource?: TrafficSource
Wskazuje, czy żądania pochodzą z ruchu kupionego czy bezpłatnego. Ta wartość wypełnia wymiar Źródło wizyty w raportach Ad Managera. Jeśli nie jest ustawiony, w raportach źródło wizyty przyjmuje domyślnie wartość undefined
.
Optional
underAgeOfConsent
underAgeOfConsent?: null | boolean
Wskazuje, czy chcesz oznaczać żądania reklamy jako pochodzące od użytkowników, którzy nie osiągnęli wieku świadomego wyrażenia zgody. Ustaw wartość na null
, aby wyczyścić konfigurację.
googletag.PubAdsService
PrzedłużaMetody | |
---|---|
add | Rejestruje detektor, który umożliwia konfigurowanie i wywoływanie funkcji JavaScript po wystąpieniu na stronie konkretnego zdarzenia GPT. Odziedziczone z |
clear | Usuwa reklamy z podanych miejsc i zastępuje je pustymi treściami. |
clear | Czyści wszystkie etykiety wykluczenia kategorii reklam na poziomie strony. |
clear | Czyści parametry kierowania niestandardowego w przypadku określonego klucza lub wszystkich kluczy. |
collapse | Umożliwia zwijanie elementów div boksu, aby nie zajmowały miejsca na stronie, gdy nie ma treści reklamy do wyświetlenia. |
disable | Wyłącza żądania reklam podczas wczytywania strony, ale umożliwia wysyłanie żądań reklam za pomocą wywołania PubAdsService.refresh. |
display | Tworzy i wyświetla boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej. |
enable | Umożliwia opóźnione wczytywanie w GPT zgodnie z definicją obiektu konfiguracji. |
enable | Włącza tryb pojedynczego żądania do pobierania wielu reklam jednocześnie. |
enable | Informuje tag GPT, że na stronie będą znajdować się reklamy wideo. |
get | Zwraca wartość atrybutu AdSense powiązanego z podanym kluczem. |
get | Zwraca klucze atrybutów ustawione w tej usłudze. |
get | Wyświetl listę slotów powiązanych z tą usługą. Odziedziczone z jednostki organizacyjnej |
get | Zwraca określony niestandardowy parametr kierowania na poziomie usługi. |
get | Zwraca listę wszystkich ustawionych kluczy kierowania na poziomie usługi. |
is | Zwraca informację, czy w ramach poprzedniego wywołania PubAdsService.disableInitialLoad udało się wyłączyć początkowe żądania reklam. |
refresh | Pobiera i wyświetla nowe reklamy dla określonych lub wszystkich boksów na stronie. |
remove | usuwa wcześniej zarejestrowanego słuchacza. Odziedziczone z |
set | Ustawia wartości atrybutów AdSense, które mają zastosowanie do wszystkich boksów reklamowych w ramach usługi Reklamy wydawcy. |
set | Ustawia wykluczenie kategorii reklam na poziomie strony dla danej nazwy etykiety. |
set | Włącza i wyłącza poziome wyśrodkowanie reklam. |
set | Określa, czy wszystkie reklamy na stronie mają być wymuszone do renderowania przy użyciu kontenera SafeFrame. |
set | Przekazuje informacje o lokalizacji z witryn, dzięki czemu możesz kierować elementy zamówienia na określone lokalizacje. |
set | Umożliwia konfigurowanie wszystkich ustawień prywatności z pojedynczego interfejsu API za pomocą obiektu konfiguracji. |
set | Ustawia wartość identyfikatora podanego przez wydawcę. |
set | Ustawia preferencje na poziomie strony dla konfiguracji SafeFrame. |
set | Ustawia parametry kierowania niestandardowego dla danego klucza, które mają zastosowanie do wszystkich miejsc reklamowych usługi Publisher Ads. |
set | Określa informacje o treściach wideo, które mają być wysyłane wraz z żądaniami reklamy na potrzeby kierowania i wykluczania treści. |
update | Zmienia korelator wysyłany z żądaniami reklam, co powoduje rozpoczęcie nowego wyświetlenia strony. |
Metody
clear
- 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();
clear(slots?: Slot[]): boolean
Usuwa reklamy z podanych miejsc i zastępuje je pustymi treściami. Miejsca docelowe zostaną oznaczone jako niewybierane.
Usunięcie miejsca docelowego powoduje usunięcie reklamy z długotrwałego wyświetlenia strony w tagu wydawcy Google, dzięki czemu przyszłe żądania nie będą już podlegać blokadom ani wykluczeniom konkurencji dotyczącym tej reklamy.
Parametry | |
---|---|
| Tablica przedziałów do wyczyszczenia. Tablica jest opcjonalna. Jeśli nie zostanie określona, wszystkie gniazda zostaną wyczyszczone. |
Zwroty | |
---|---|
boolean | Zwraca wartość true , jeśli sloty zostały usunięte, a w przeciwnym razie – wartość false . |
clearCategoryExclusions
- 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ż
clearCategoryExclusions(): PubAdsService
Czyści wszystkie etykiety wykluczenia kategorii reklam na poziomie strony. Jest to przydatne, jeśli chcesz odświeżyć slot.
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano metodę. |
clearTargeting
- 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ż
clearTargeting(key?: string): PubAdsService
Czyści parametry kierowania niestandardowego w przypadku określonego klucza lub wszystkich kluczy.
Parametry | |
---|---|
| Klucz parametru kierowania. Klucz jest opcjonalny. Jeśli nie zostanie podany, wszystkie parametry kierowania zostaną wyczyszczone. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano metodę. |
collapseEmptyDivs
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
Umożliwia zwijanie elementów div boksu, aby nie zajmowały miejsca na stronie, gdy nie ma treści reklamy do wyświetlenia. Ten tryb musi być ustawiony przed włączeniem usługi.
Parametry | |
---|---|
| Określa, czy sloty mają być zwijać jeszcze przed pobraniem reklam. Ten parametr jest opcjonalny. Jeśli nie zostanie podany, domyślną wartością będzie false . |
Zwroty | |
---|---|
boolean | Zwraca true , jeśli włączono tryb zwijania div, oraz false , jeśli nie można włączyć trybu zwijania, ponieważ metoda została wywołana po włączeniu usługi. |
disableInitialLoad
disableInitialLoad(): void
Wyłącza żądania reklam podczas wczytywania strony, ale umożliwia żądania reklam za pomocą wywołania PubAdsService.refresh. Należy to ustawić przed włączeniem usługi. Musisz użyć trybu asynchronicznego, ponieważ w przeciwnym razie nie będzie można wysyłać żądań reklam za pomocą metody refresh
.
wyświetlacz
- 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");
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
Tworzy i wyświetla boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej. Ta metoda nie działa w trybie pojedynczego żądania.
Uwaga: po jej wywołaniu tworzony jest zrzut stanu boksu i strony, co zapewnia spójność przy wysyłaniu żądania reklamy i renderowaniu odpowiedzi. Wszelkie zmiany wprowadzone w stanie slotu lub strony po wywołaniu tej metody (w tym dotyczące kierowania, ustawień prywatności czy wymuszania SafeFrame) będą miały zastosowanie tylko do kolejnych żądań display()
lub refresh()
.
Parametry | |
---|---|
adUnitPath: string | Ścieżka jednostki reklamowej boksu do wyrenderowania. |
size: GeneralSize | Szerokość i wysokość boksu. |
| Identyfikator elementu div zawierającego slot lub sam element div. |
| Adres URL kliknięcia, który ma być używany w tym slocie. |
enableLazyLoad
- 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ż
fetchMarginPercent
Minimalna odległość boksu od bieżącego widocznego obszaru, zanim pobieramy reklamę, wyrażona jako odsetek rozmiaru widocznego obszaru. Wartość 0 oznacza „gdy boks znajdzie się w widocznym obszarze”, 100 oznacza „gdy reklama jest w 1 widocznym obszarze”, itd.renderMarginPercent
Minimalna odległość boksu reklamowego od bieżącego widocznego obszaru przed wyrenderowaniem reklamy. Umożliwia to wstępny odczyt reklamy, ale z opóźnieniem w przypadku renderowania i pobierania innych zasobów podrzędnych. Ta wartość działa tak samo jakfetchMarginPercent
jako odsetek widoku.mobileScaling
Współczynnik stosowany do marży na urządzeniach mobilnych. Dzięki temu możesz stosować różne marże na urządzeniach mobilnych i komputerach. Na przykład wartość 2, 0 powoduje pomnożenie wszystkich marż przez 2 na urządzeniach mobilnych, co zwiększa minimalną odległość boksu przed pobraniem i renderowaniem.
enableLazyLoad(config?: {
fetchMarginPercent?: number;
mobileScaling?: number;
renderMarginPercent?: number;
}): void
Umożliwia opóźnione wczytywanie w GPT zgodnie z definicją obiektu konfiguracji. Bardziej szczegółowe przykłady znajdziesz w artykule Leniwe ładowanie.
Uwaga: leniwe pobieranie w ramach SRA działa tylko wtedy, gdy wszystkie sloty znajdują się poza marginesem pobierania.
Parametry | |
---|---|
| Obiekt konfiguracji umożliwia dostosowanie działania funkcji lazy. W przypadku pominiętej konfiguracji zostanie użyty domyślny zestaw ustawień określony przez Google, który będzie dostosowywany z upływem czasu. Aby wyłączyć określone ustawienie, np. margines pobierania, ustaw wartość na -1 . |
enableSingleRequest
- Zobacz też
enableSingleRequest(): boolean
Włącza tryb pojedynczego żądania do pobierania wielu reklam jednocześnie. Wymaga to zdefiniowania i dodania wszystkich boksów reklam wydawcy do usługi PubAdsService przed jej włączeniem. Przed włączeniem usługi należy ustawić tryb pojedynczej prośby.
Zwroty | |
---|---|
boolean | Zwraca true , jeśli tryb pojedynczego żądania był włączony, oraz false , jeśli nie można włączyć trybu pojedynczego żądania, 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. Umożliwia to zastosowanie ograniczeń wykluczeń konkurencji w przypadku reklam displayowych i wideo. Jeśli treść filmu jest znana, wywołaj metodę PubAdsService.setVideoContent, aby móc używać wykluczania treści w przypadku reklam displayowych.
pobierz
- 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ż
get(key: string): null | string
Zwraca wartość atrybutu AdSense powiązanego z danym kluczem.
Parametry | |
---|---|
key: string | Nazwa atrybutu, którego szukasz. |
Zwroty | |
---|---|
null | string | Bieżąca wartość klucza atrybutu lub null , jeśli klucz nie jest obecny. |
getAttributeKeys
- 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'].
getAttributeKeys(): string[]
Zwraca klucze atrybutów ustawione w tej usłudze.
Zwroty | |
---|---|
string[] | Tablica kluczy atrybutów ustawionych w tej usłudze. kolejność nie jest zdefiniowana; |
getTargeting
- 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).
getTargeting(key: string): string[]
Zwraca określony niestandardowy parametr kierowania na poziomie usługi, który został ustawiony.
Parametry | |
---|---|
key: string | Klucz kierowania, którego szukasz. |
Zwroty | |
---|---|
string[] | Wartości powiązane z tym kluczem lub pusta tablica, jeśli nie ma takiego klucza. |
getTargetingKeys
- 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'].
getTargetingKeys(): string[]
Zwraca listę wszystkich ustawionych kluczy kierowania na poziomie usługi.
Zwroty | |
---|---|
string[] | Tablica kluczy kierowania. kolejność nie jest zdefiniowana; |
isInitialLoadDisabled
isInitialLoadDisabled(): boolean
Zwraca informację, czy w ramach poprzedniego wywołania PubAdsService.disableInitialLoad udało się wyłączyć początkowe żądania reklam.
Zwroty | |
---|---|
boolean | Zwraca true , jeśli poprzednie wywołanie PubAdsService.disableInitialLoad zakończyło się powodzeniem. W przeciwnym razie false . |
odśwież
- 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 });
changeCorrelator
Określa, czy nowy korelator ma być generowany do pobierania reklam. Nasze serwery reklam przechowują tę wartość przez krótki czas (obecnie przez 30 sekund, ale może się to zmienić), dzięki czemu żądania z tą samą wartością korelatora odebrane w niewielkim odstępie czasu są uznawane za pojedyncze wyświetlenie strony. Domyślnie nowy korelator jest generowany przy każdym odświeżeniu.
Uwaga: ta opcja nie ma wpływu na długotrwały widok strony w GPT, który automatycznie odzwierciedla reklamy wyświetlane obecnie na stronie i nie ma daty wygaśnięcia.
refresh(slots?: null | Slot[], options?: {
changeCorrelator: boolean;
}): void
Pobiera i wyświetla nowe reklamy w przypadku określonych lub wszystkich boksów reklamowych na stronie. Działa tylko w trybie renderowania asynchronicznego.
Aby zapewnić prawidłowe działanie we wszystkich przeglądarkach, wywołanie funkcji refresh
musi być poprzedzone wywołaniem display
miejsca na reklamę. Jeśli wywołanie funkcji display
zostanie pominięte, odświeżanie może działać nieoczekiwanie. W razie potrzeby można użyć metody PubAdsService.disableInitialLoad, by zatrzymać pobieranie reklamy przez display
.
Odświeżenie boksu spowoduje usunięcie starej reklamy z długotrwałej odsłony GPT, dzięki czemu na przyszłe żądania nie będą miały wpływu reklamy na wyłączność ani wykluczenia konkurencji.
Parametry | |
---|---|
| Slots to refresh (miejsca do odświeżenia). Tablica jest opcjonalna. Jeśli nie zostanie określona, wszystkie sloty zostaną odświeżone. |
| Opcje konfiguracji powiązane z tym wywołaniem odświeżania. |
set
- 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ż
set(key: string, value: string): PubAdsService
Ustawia wartości atrybutów AdSense, które mają zastosowanie do wszystkich boksów reklamowych w usłudze Reklamy wydawcy.
Wywołanie tej funkcji więcej niż raz w przypadku tego samego klucza spowoduje zastąpienie wcześniej ustawionych wartości. Wszystkie wartości muszą być ustawione przed wywołaniem funkcji display
lub refresh
.
Parametry | |
---|---|
key: string | Nazwa atrybutu. |
value: string | Wartość atrybutu. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano metodę. |
setCategoryExclusion
- 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ż
setCategoryExclusion(categoryExclusion: string): PubAdsService
Ustawia wykluczenie kategorii reklam na poziomie strony dla danej nazwy etykiety.
Parametry | |
---|---|
categoryExclusion: string | Etykieta wykluczenia kategorii reklam do dodania. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano metodę. |
setCentering
- 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);
setCentering(centerAds: boolean): void
Włącza i wyłącza poziome wyśrodkowanie reklam. Domyślnie wyśrodkowywanie jest wyłączone. W starszej wersji pliku gpt_mobile.js wyśrodkowanie jest domyślnie włączone.
Metodę tę należy wywołać przed wywołaniem metody display
lub refresh
, ponieważ tylko reklamy, które zostaną zażądane po wywołaniu tej metody, będą wyśrodkowane.
Parametry | |
---|---|
centerAds: boolean | true , aby wyśrodkować reklamy, false , aby wyrównać je do lewej. |
setForceSafeFrame
- To ustawienie będzie obowiązywać tylko w przypadku kolejnych żądań reklamy wysyłanych do odpowiednich boksów.
- Ustawienie na poziomie boksu, jeśli zostanie określone, zawsze zastąpi ustawienie na poziomie strony.
- Jeśli ustawisz wartość
true
(na poziomie boksu reklamowego lub strony), reklama będzie zawsze renderowana przy użyciu kontenera SafeFrame niezależnie od wyboru dokonanego w interfejsie Google Ad Manager. - Jeśli jednak ustawisz wartość
false
lub nie określisz tego ustawienia, reklama będzie renderowana z użyciem kontenera SafeFrame w zależności od typu kreacji i ustawień wybranych w interfejsie Google Ad Managera. - Z tego interfejsu API należy korzystać ostrożnie, ponieważ może on wpływać na działanie kreacji, które próbują wyjść poza element iframe lub które wymagają renderowania 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ż
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
Określa, czy wszystkie reklamy na stronie powinny być wymuszone do renderowania przy użyciu kontenera SafeFrame.
Podczas korzystania z tego interfejsu API pamiętaj o tych kwestiach:
Parametry | |
---|---|
forceSafeFrame: boolean | true , aby wymusić renderowanie wszystkich reklam na stronie w SafeFrame, i false , aby zmienić poprzednie ustawienie na „fałsz”. Ustawienie tej wartości na false , jeśli wcześniej nie było określone, nie spowoduje żadnych zmian. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano funkcję. |
setLocation
- 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");
setLocation(address: string): PubAdsService
Przekazuje informacje o lokalizacji z witryn, dzięki czemu możesz kierować elementy zamówienia na określone lokalizacje.
Parametry | |
---|---|
address: string | Adres w dowolnym formacie. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano metodę. |
setPrivacySettings
- 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, });
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
Umożliwia konfigurowanie wszystkich ustawień prywatności z pojedynczego interfejsu API za pomocą obiektu konfiguracji.
Parametry | |
---|---|
privacySettings: PrivacySettingsConfig | Obiekt zawierający konfigurację ustawień prywatności. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano funkcję. |
setPublisherProvidedId
- Przykład
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (starsza wersja)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
setPublisherProvidedId(ppid: string): PubAdsService
Określa wartość identyfikatora podanego przez wydawcę.
Parametry | |
---|---|
ppid: string | Identyfikator alfanumeryczny podany przez wydawcę. Musi mieć od 32 do 150 znaków. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, dla którego wywołano metodę. |
setSafeFrameConfig
- 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ż
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
Ustawia preferencje na poziomie strony dla konfiguracji SafeFrame. Wszystkie nierozpoznane klucze w obiekcie konfiguracji zostaną zignorowane. Jeśli dla rozpoznawanego klucza zostanie podana nieprawidłowa wartość, cała konfiguracja zostanie zignorowana.
Te ustawienia na poziomie strony zostaną zastąpione przez ustawienia na poziomie boksu reklamowego, jeśli zostały określone.
Parametry | |
---|---|
config: SafeFrameConfig | Obiekt konfiguracji. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano metodę. |
setTargeting
- 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ż
setTargeting(key: string, value: string | string[]): PubAdsService
Ustawia parametry kierowania niestandardowego dla danego klucza, które mają zastosowanie do wszystkich miejsc reklamowych usługi Publisher Ads. Wywołanie tej metody kilka razy z jednym kluczem spowoduje zastąpienie starych wartości. Klucze te są zdefiniowane na koncie Google Ad Managera.
Parametry | |
---|---|
key: string | Klucz parametru kierowania. |
value: string | string[] | Wartość parametru kierowania lub tablica wartości. |
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, dla którego wywołano metodę. |
setVideoContent
- Zobacz też
setVideoContent(videoContentId: string, videoCmsId: string): void
Określa informacje o treściach wideo, które mają być wysyłane wraz z żądaniami reklamy na potrzeby kierowania i wykluczania treści. Po wywołaniu tej metody reklamy wideo zostaną automatycznie włączone. W przypadku parametrów videoContentId
i videoCmsId
użyj wartości przekazanych do usługi przetwarzania treści Google Ad Managera.
Parametry | |
---|---|
videoContentId: string | Identyfikator treści filmu. |
videoCmsId: string | Identyfikator CMS filmu. |
updateCorrelator
- 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.
updateCorrelator(): PubAdsService
Zmienia korelator wysyłany z żądaniami reklam, co powoduje rozpoczęcie nowego wyświetlenia strony. Korelator jest taki sam dla wszystkich żądań reklamy pochodzących z 1 wyświetlenia strony i wyjątkowy dla poszczególnych wyświetleń strony. Dotyczy tylko trybu asynchronicznego.
Uwaga: nie ma to wpływu na długotrwały widok strony tagu GPT, który automatycznie odzwierciedla reklamy znajdujące się na stronie i nie ma daty wygaśnięcia.
Zwroty | |
---|---|
PubAdsService | Obiekt usługi, w którym wywołano funkcję. |
googletag.ResponseInformation
Właściwości | |
---|---|
advertiser | Identyfikator reklamodawcy. |
campaign | Identyfikator kampanii. |
creative | Identyfikator kreacji. |
creative | Identyfikator szablonu reklamy. |
line | Identyfikator elementu zamówienia. |
- Zobacz też
Właściwości
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
Właściwości | |
---|---|
amount | Liczba produktów w nagrodzie. |
type | Typ elementu zawartego w nagrodzie (np. „coin”, czyli „moneta”). |
- Zobacz też
Właściwości
amount
amount: number
Liczba elementów zawartych w nagrodzie.
type
type: string
Typ elementu zawartego w nagrodzie (np. „coin”, czyli „moneta”).
googletag.SafeFrameConfig
Właściwości | |
---|---|
allow | Określa, czy SafeFrame ma zezwalać na powiększanie treści reklamy przez nakładanie jej na zawartość strony. |
allow | Określa, czy SafeFrame ma zezwalać na powiększanie treści reklamy przez przesuwanie zawartości strony. |
sandbox | Określa, czy SafeFrame ma używać atrybutu piaskownicy HTML5, aby zapobiec nawigacji na najwyższym poziomie bez interakcji użytkownika. |
use | Wycofane. Określ, czy w przypadku kreacji z rezerwacji SafeFrame ma używać losowych subdomen. |
- Zobacz też
Właściwości
Optional
allowOverlayExpansion
allowOverlayExpansion?: boolean
Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez nakładanie się zawartości strony.
Optional
allowPushExpansion
allowPushExpansion?: boolean
Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez przepychanie treści strony.
Optional
sandbox
sandbox?: boolean
Określa, czy SafeFrame ma używać atrybutu piaskownicy HTML5, aby zapobiec nawigacji na najwyższym poziomie bez interakcji użytkownika. Jedyną prawidłową wartością jest true
(nie można wymusić wartości false
). Pamiętaj, że atrybut piaskownicy wyłącza wtyczki (np. Flash).
Optional
useUniqueDomain
- Zobacz też
useUniqueDomain?: null | boolean
Określa, czy SafeFrame ma używać losowych subdomen w przypadku kreacji z rezerwacji. Przekaż wartość null
, aby wyczyścić zapisaną wartość.
Uwaga: ta funkcja jest domyślnie włączona.
googletag.Service
Metody | |
---|---|
add | Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT. |
get | Wyświetl listę slotów powiązanych z tą usługą. |
remove | usuwa wcześniej zarejestrowanego słuchacza. |
Metody
addEventListener
- events.GameManualInterstitialSlotClosedEvent
- events.GameManualInterstitialSlotReadyEvent
- events.ImpressionViewableEvent
- events.RewardedSlotClosedEvent
- events.RewardedSlotGrantedEvent
- events.RewardedSlotReadyEvent
- events.SlotOnloadEvent
- events.SlotRenderEndedEvent
- events.SlotRequestedEvent
- events.SlotResponseReceived
- events.SlotVisibilityChangedEvent
- 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ż
addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service
Rejestruje detektor, który umożliwia konfigurowanie i wywoływanie funkcji JavaScript po wystąpieniu na stronie konkretnego zdarzenia GPT. Obsługiwane są te zdarzenia:
Parametry | |
---|---|
eventType: K | Ciąg tekstowy reprezentujący typ zdarzenia wygenerowanego przez GPT. W typach zdarzeń jest rozróżniana wielkość liter. |
listener: ((arg: EventTypeMap[K]) => void) | Funkcja, która przyjmuje pojedynczy argument obiektu zdarzenia. |
Zwroty | |
---|---|
Service | Obiekt usługi, w którym wywołano metodę. |
getSlots
removeEventListener
- 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(); });
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
usuwa wcześniej zarejestrowanego słuchacza.
Parametry | |
---|---|
eventType: K | Ciąg tekstowy reprezentujący typ zdarzenia wygenerowanego przez GPT. W typach zdarzeń jest rozróżniana wielkość liter. |
listener: ((event: EventTypeMap[K]) => void) | Funkcja, która przyjmuje pojedynczy argument obiektu zdarzenia. |
googletag.SizeMappingBuilder
Metody | |
---|---|
add | Dodaje mapowanie z tablicy o pojedynczym rozmiarze (przedstawiającej widoczny obszar) do tablicy o pojedynczym lub wielu rozmiarach, która reprezentuje boks. |
build | Tworzy specyfikację mapy rozmiarów na podstawie mapowań dodanych do tego kreatora. |
- Zobacz też
Metody
addSize
- 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]
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.
Parametry | |
---|---|
viewportSize: SingleSizeArray | Rozmiar widocznego obszaru dla tego wpisu mapowania. |
slotSize: GeneralSize | Rozmiary boksu dla tego wpisu mapowania. |
Zwroty | |
---|---|
SizeMappingBuilder | Odwołanie do tego kreatora. |
build
build(): null | SizeMappingArray
Tworzy specyfikację mapy rozmiarów na podstawie mapowań dodanych do tego konstruktora.
Jeśli podano nieprawidłowe mapowania, ta metoda zwróci null
. W przeciwnym razie zwraca specyfikację w prawidłowym formacie, która zostanie przekazana do metody Slot.defineSizeMapping.
Uwaga: działanie kreatora po wywołaniu tej metody jest niezdefiniowane.
Zwroty | |
---|---|
null | SizeMappingArray | Wynik utworzony przez ten kreator. Może mieć wartość null, jeśli podano nieprawidłowe mapowania rozmiaru. |
googletag.Slot
Metody | |
---|---|
add | Dodaje do tego boksu usługę. |
clear | Czyści wszystkie etykiety wykluczenia kategorii reklam na poziomie boksu reklamowego w tym boksie. |
clear | Czyści określone lub wszystkie parametry kierowania na poziomie boksu reklamowego w danym boksie. |
define | Ustawia tablicę mapowań od minimalnego rozmiaru widocznego obszaru do rozmiaru boksu dla tego boksu. |
get | Zwraca wartość atrybutu AdSense powiązanego z podanym kluczem dla tego boksu. |
get | Zwraca pełną ścieżkę jednostki reklamowej wraz z kodem sieci i ścieżką jednostki reklamowej. |
get | Zwraca listę kluczy atrybutów ustawionych w tym slocie. |
get | Zwraca etykiety wykluczenia kategorii reklam dla tego boksu. |
get | Zwraca informacje o odpowiedzi na reklamę. |
get | Zwraca identyfikator slotu div podany podczas definiowania slotu. |
get | Zwraca określony parametr niestandardowego kierowania ustawiony na tym slocie. |
get | Zwraca listę wszystkich kluczy kierowania niestandardowego ustawionych w tym slocie. |
set | Ustawia wartość atrybutu AdSense w tym boksie reklamowym. |
set | Ustawia w tym boksie etykietę wykluczenia kategorii reklamy na poziomie boksu. |
set | Ustawia adres URL kliknięcia, do którego użytkownicy będą przekierowywani po kliknięciu reklamy. |
set | Określa, czy boks div ma być ukryty, gdy nie ma w nim reklamy. |
set | Ustawia ogólne opcje konfiguracji tego przedziału. |
set | Określa, czy reklamy w tym boksie powinny być wymuszane do renderowania za pomocą kontenera SafeFrame. |
set | Określa ustawienia na poziomie boksu w przypadku konfiguracji SafeFrame. |
set | Ustawia parametr kierowania niestandardowego dla tego miejsca docelowego. |
update | Ustawia niestandardowe parametry kierowania dla tego boksu z mapy klucz:wartość w obiekcie JSON. |
Metody
addService
- 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());
addService(service: Service): Slot
Dodaje do tego boksu usługę.
Parametry | |
---|---|
service: Service | Usługa do dodania. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
clearCategoryExclusions
- 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.
clearCategoryExclusions(): Slot
Czyści wszystkie etykiety wykluczenia kategorii reklam na poziomie boksu reklamowego w tym boksie.
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
clearTargeting
- 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ż
clearTargeting(key?: string): Slot
Czyści określone lub wszystkie parametry kierowania na poziomie boksu reklamowego w danym boksie.
Parametry | |
---|---|
| Klucz parametru kierowania. Klucz jest opcjonalny. Jeśli nie zostanie podany, wszystkie parametry kierowania zostaną wyczyszczone. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
defineSizeMapping
- 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ż
defineSizeMapping(sizeMapping: SizeMappingArray): Slot
Określa tablicę mapowania od minimalnego rozmiaru widocznego obszaru do rozmiaru slotu.
Parametry | |
---|---|
sizeMapping: SizeMappingArray | Tablica mapowań rozmiarów. Aby go utworzyć, możesz użyć narzędzia SizeMappingBuilder. Każde mapowanie rozmiaru to tablica zawierająca 2 elementy: SingleSizeArray i GeneralSize. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
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ż
get(key: string): null | string
Zwraca wartość atrybutu AdSense powiązanego z danym kluczem w tym boksie. Aby wyświetlić atrybuty na poziomie usługi odziedziczone przez ten boks, użyj metody PubAdsService.get.
Parametry | |
---|---|
key: string | Nazwa atrybutu, którego szukasz. |
Zwroty | |
---|---|
null | string | Bieżąca wartość klucza atrybutu lub null , jeśli klucz nie jest obecny. |
getAdUnitPath
- 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'.
getAdUnitPath(): string
Zwraca pełną ścieżkę jednostki reklamowej, w tym kod sieci i ścieżkę jednostki reklamowej.
Zwroty | |
---|---|
string | Ścieżka jednostki reklamowej. |
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'].
getAttributeKeys(): string[]
Zwraca listę kluczy atrybutów ustawionych w tym slocie. Aby wyświetlić klucze atrybutów na poziomie usługi odziedziczonych przez ten przedział, użyj PubAdsService.getAttributeKeys.
Zwroty | |
---|---|
string[] | Tablica kluczy atrybutów. Kolejność nie jest zdefiniowana. |
getCategoryExclusions
- 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'].
getCategoryExclusions(): string[]
Zwraca etykiety wykluczenia kategorii reklam dla tego boksu.
Zwroty | |
---|---|
string[] | Etykiety wykluczenia kategorii reklam w tym boksie lub pusty tablicowy, jeśli nie ma żadnych ustawień. |
getResponseInformation
getResponseInformation(): null | ResponseInformation
Zwraca informacje o odpowiedzi na reklamę. Jest ona określana na podstawie ostatniej odpowiedzi reklamy w tym miejscu. Jeśli ta metoda zostanie wywołana, gdy boks nie zawiera reklamy, zwrócona zostanie wartość null
.
Zwroty | |
---|---|
null | ResponseInformation | Najnowsze informacje o odpowiedzi na reklamę lub null , jeśli w boksie nie ma reklamy. |
getSlotElementId
- Przykład
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (starsza wersja)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
getSlotElementId(): string
Zwraca identyfikator slotu div
podany podczas definiowania slotu.
Zwroty | |
---|---|
string | Identyfikator miejsca div . |
getTargeting
- 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).
getTargeting(key: string): string[]
Zwraca określony parametr niestandardowego kierowania ustawiony na tym slocie. Nie uwzględnia ona parametrów kierowania na poziomie usługi.
Parametry | |
---|---|
key: string | Klucz kierowania, którego szukasz. |
Zwroty | |
---|---|
string[] | Wartości powiązane z tym kluczem lub pusty tablicowy, jeśli takiego klucza nie ma. |
getTargetingKeys
- 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'].
getTargetingKeys(): string[]
Zwraca listę wszystkich kluczy kierowania niestandardowego ustawionych w tym slocie. Nie uwzględnia się kluczy kierowania na poziomie usługi.
Zwroty | |
---|---|
string[] | Tablica kluczy kierowania. kolejność nie jest zdefiniowana; |
set
- 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ż
set(key: string, value: string): Slot
Ustawia wartość atrybutu AdSense w tym boksie reklamowym. Zastąpi to wszystkie wartości ustawione na poziomie usługi dla tego klucza.
Wywołanie tej metody więcej niż raz w przypadku tego samego klucza spowoduje zastąpienie wcześniej ustawionych wartości. Przed wywołaniem funkcji display
lub refresh
należy ustawić wszystkie wartości.
Parametry | |
---|---|
key: string | Nazwa atrybutu. |
value: string | Wartość atrybutu. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
setCategoryExclusion
- 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ż
setCategoryExclusion(categoryExclusion: string): Slot
Ustawia w tym boksie etykietę wykluczenia kategorii reklamy na poziomie boksu.
Parametry | |
---|---|
categoryExclusion: string | Etykieta wykluczenia kategorii reklam do dodania. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
setClickUrl
- 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());
setClickUrl(value: string): Slot
Ustawia docelowy URL, na który użytkownicy zostaną przekierowani po kliknięciu reklamy.
Serwery Google Ad Managera nadal rejestrują kliknięcia, nawet jeśli docelowy URL zostanie zastąpiony. Do podanej wartości dołączany jest dowolny adres URL strony docelowej powiązany z wyświetlaną kreacją. Kolejne wywołania zastępują wartość. Ta opcja działa tylko w przypadku żądań innych niż żądania dotyczące usług RMA.
Parametry | |
---|---|
value: string | Klikany URL do ustawienia. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
setCollapseEmptyDiv
- 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.
setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
Określa, czy boks div
powinien być ukryty, gdy nie ma w nim reklamy. Spowoduje to zastąpienie ustawień na poziomie usługi.
Parametry | |
---|---|
collapse: boolean | Określa, czy boks ma się zwinąć, jeśli nie zostanie zwrócona żadna reklama. |
| Określa, czy boks ma być zwinięty jeszcze przed pobraniem reklamy. Zignorowana, jeśli wartość collapse nie jest true . |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
setConfig
setConfig(slotConfig: SlotSettingsConfig): void
Ustawia ogólne opcje konfiguracji dla tego slotu.
Parametry | |
---|---|
slotConfig: SlotSettingsConfig | Obiekt konfiguracji. |
setForceSafeFrame
- To ustawienie zacznie obowiązywać dopiero w przypadku kolejnych żądań reklamy wysłanych do odpowiednich slotów.
- Ustawienie na poziomie boksu, jeśli zostanie określone, zawsze zastąpi ustawienie na poziomie strony.
- Jeśli ustawisz wartość
true
(na poziomie boksu reklamowego lub strony), reklama będzie zawsze renderowana przy użyciu kontenera SafeFrame niezależnie od wyboru dokonanego w interfejsie Google Ad Manager. - Jeśli jednak ustawisz wartość
false
lub nie określisz tego ustawienia, reklama będzie renderowana z użyciem kontenera SafeFrame w zależności od typu kreacji i ustawień wybranych w interfejsie Google Ad Managera. - Z tego interfejsu API należy korzystać ostrożnie, ponieważ może on wpływać na działanie kreacji, które próbują wyjść poza element iframe lub które wymagają renderowania 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ż
setForceSafeFrame(forceSafeFrame: boolean): Slot
Określa, czy reklamy w tym boksie powinny być wymuszane do renderowania przy użyciu kontenera SafeFrame.
Podczas korzystania z tego interfejsu API pamiętaj o tych kwestiach:
Parametry | |
---|---|
forceSafeFrame: boolean | true , aby wymusić renderowanie wszystkich reklam w tym boksie w kontenerze SafeFrame, oraz false , aby zrezygnować z ustawienia na poziomie strony (jeśli występuje). Ustawienie wartości false , gdy nie jest określone na poziomie strony, nie spowoduje żadnych zmian. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
setSafeFrameConfig
- 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ż
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
Ustawia ustawienia na poziomie slotu dla konfiguracji SafeFrame. Wszystkie nierozpoznane klucze w obiekcie konfiguracji będą ignorowane. Jeśli dla rozpoznawanego klucza zostanie podana nieprawidłowa wartość, cała konfiguracja zostanie zignorowana.
Wszelkie preferencje na poziomie boksu, jeśli zostaną określone, zastąpią preferencje na poziomie strony.
Parametry | |
---|---|
config: null | SafeFrameConfig | Obiekt konfiguracji. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
setTargeting
- 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ż
setTargeting(key: string, value: string | string[]): Slot
Ustawia parametr kierowania niestandardowego dla tego boksu. Wywołanie tej metody kilka razy dla tego samego klucza spowoduje zastąpienie starych wartości. Wartości ustawione tutaj zastępują parametry kierowania ustawione na poziomie usługi. Klucze te są zdefiniowane na koncie Google Ad Managera.
Parametry | |
---|---|
key: string | Klucz parametru kierowania. |
value: string | string[] | Wartość parametru kierowania lub tablica wartości. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
updateTargetingFromMap
- W przypadku zastąpienia zostanie zachowana tylko ostatnia wartość.
- Jeśli wartością jest tablica, poprzednia 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"], });
updateTargetingFromMap(map: {
[adUnitPath: string]: string | string[];
}): Slot
Ustawia niestandardowe parametry kierowania dla tego boksu z mapy klucz:wartość w obiekcie JSON. Jest to tożsame z wywołaniem metody Slot.setTargeting dla wszystkich wartości kluczy obiektu. Klucze te są zdefiniowane na koncie Google Ad Managera.
Uwagi:
Parametry | |
---|---|
map: { | Mapa klucz:wartość parametru kierowania. |
Zwroty | |
---|---|
Slot | Obiekt slotu, w którym wywołano metodę. |
googletag.config
Interfejsy | |
---|---|
Ad | Ustawienia umożliwiające kontrolowanie rozszerzania reklam. |
Component | Obiekt reprezentujący aukcję z jednym komponentem w aukcji reklam na urządzeniu. |
Interstitial | Obiekt, który określa działanie pojedynczego pełnoekranowego boksu reklamowego. |
Page | Główny interfejs konfiguracji ustawień na poziomie strony. |
Privacy | Ustawienia umożliwiające kontrolowanie sposobów ochrony prywatności przez wydawcę. |
Publisher | Obiekt konfiguracji sygnałów dostarczanych przez wydawcę (PPS). |
Slot | Główny interfejs konfiguracji ustawień na poziomie slotu. |
Taxonomy | Obiekt zawierający wartości dotyczące jednej mapy kategorii. |
Aliasy typu | |
---|---|
Interstitial | Obsługiwane reguły reklam pełnoekranowych. |
Privacy | Obsługiwane metody ochrony prywatności wydawcy. |
Taxonomy | Obsługiwane taksonomie w przypadku sygnałów dostarczanych przez wydawcę. |
Aliasy typu
InterstitialTrigger
InterstitialTrigger: "unhideWindow" | "navBar"
Obsługiwane reguły reklam pełnoekranowych.
PrivacyTreatment
PrivacyTreatment: "disablePersonalization"
Obsługiwane metody ochrony prywatności wydawców
Taksonomia
Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
Obsługiwane taksonomie w przypadku sygnałów dostarczanych przez wydawcę.
googletag.config.AdExpansionConfig
Właściwości | |
---|---|
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 }, });
Właściwości
Optional
włączono
enabled?: boolean
Określa, czy rozszerzanie reklam jest włączone czy wyłączone.
Ustawienie tej wartości zastępuje ustawienie domyślne skonfigurowane w Google Ad Manager.
googletag.config.ComponentAuctionConfig
Właściwości | |
---|---|
auction | Obiekt konfiguracji aukcji dla tej aukcji komponentu. |
config | Klucz konfiguracji powiązany z tą aukcją komponentu. |
Właściwości
auctionConfig
- 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, }, ], });
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 komponentów.
Jeśli ta wartość jest ustawiona na null
, istniejąca konfiguracja określonego zasobu (configKey
) zostanie usunięta.
configKey
configKey: string
Klucz konfiguracji powiązany z tą aukcją komponentu.
Ta wartość nie może być pusta i powinna być niepowtarzalna. Jeśli 2 obiekty ComponentAuctionConfig
mają tę samą wartość configKey, ostatnio ustawiony obiekt ComponentAuctionConfig
nadpisze poprzednie konfiguracje.
googletag.config.InterstitialConfig
Właściwości | |
---|---|
triggers | Konfiguracja reguły aktywacji reklamy pełnoekranowej. |
Właściwości
Optional
reguł
- 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, }, }, });
triggers?: Partial<Record<InterstitialTrigger, boolean>>
Konfiguracja interfejsu dla tej reklamy wyskakującej.
Ustawienie wartości interfejsu na true
spowoduje jego włączenie, a ustawienie na false
– wyłączenie. Zastąpi to wartości domyślne skonfigurowane w usłudze Google Ad Manager.
googletag.config.PageSettingsConfig
Pozwala na konfigurowanie wielu funkcji za pomocą jednego wywołania interfejsu API.
Wszystkie wymienione poniżej właściwości to przykłady i nie odzwierciedlają rzeczywistych funkcji, które korzystają z setConfig. Aby uzyskać informacje o zestawie funkcji, sprawdź pola w typie PageSettingsConfig poniżej.
Przykłady:
- Zmodyfikowane są tylko funkcje określone w wywołaniu googletag.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 googletag.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 usunąć, przekazując wartość
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, });
Właściwości | |
---|---|
ad | Ustawienia umożliwiające kontrolowanie rozszerzania reklam. |
ad | Wycofane. |
pps | Ustawienia umożliwiające kontrolowanie sygnałów dostarczanych przez wydawcę. |
privacy | Ustawienia umożliwiające kontrolowanie sposobów ochrony prywatności przez wydawcę. |
thread | Ustawienie określające, czy GPT ma zwracać wątek JS podczas renderowania kreacji. |
Właściwości
Optional
adExpansion
adExpansion?: null | AdExpansionConfig
Ustawienia umożliwiające kontrolowanie rozszerzania reklam.
Optional
adYield
adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Optional
pps
pps?: null | PublisherProvidedSignalsConfig
Ustawienia umożliwiające kontrolowanie sygnałów dostarczanych przez wydawcę.
Optional
privacyTreatments
privacyTreatments?: null | PrivacyTreatmentsConfig
Ustawienia umożliwiające kontrolowanie sposobów ochrony prywatności przez wydawcę.
Optional
threadYield
null
(domyślnie): w przypadku boksów spoza widocznego obszaru GPT zwraca ona wątek JS.ENABLED_ALL_SLOTS
: GPT będzie generować wątek JS dla wszystkich boksów niezależnie od tego, czy boks znajduje się w widocznym obszarze.DISABLED
: GPT nie zwróci wątku JS.- Przykład
JavaScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
JavaScript (starsza wersja)
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ threadYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ threadYield: null });
- Zobacz też
threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"
Ustawienie określające, czy GPT ma generować wątek JS podczas renderowania kreacji.
GPT będzie wyświetlać reklamy tylko w przeglądarkach, które obsługują interfejs API Scheduler.postTask lub Scheduler.yield.
Obsługiwane wartości:
googletag.config.PrivacyTreatmentsConfig
Właściwości | |
---|---|
treatments | Szereg metod ochrony prywatności wydawcy, które można włączyć. |
Właściwości
treatments
- 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"] }, });
treatments: "disablePersonalization"[]
szereg funkcji ochrony prywatności wydawcy do włączenia.
googletag.config.PublisherProvidedSignalsConfig
Właściwości | |
---|---|
taxonomies | Obiekt zawierający mapowania taksonomii. |
- Przykład
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 30-34' // '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 | 30-34' // '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 | 30-34' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
Właściwości
taksonomie
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
Obiekt zawierający mapowania taksonomii.
googletag.config.SlotSettingsConfig
Pozwala na ustawienie wielu funkcji za pomocą jednego wywołania interfejsu API dla jednego slotu.
Wszystkie wymienione poniżej właściwości są przykładami i nie odzwierciedlają rzeczywistych funkcji, które korzystają z setConfig. Aby uzyskać informacje o zbiorze funkcji, sprawdź pola w typie SlotSettingsConfig poniżej.
Przykłady:
- Modyfikowane 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 z każdym wywołaniem 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 usunąć, przekazując wartość
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, });
Właściwości | |
---|---|
ad | Ustawienia umożliwiające kontrolowanie rozszerzania reklam. |
component | Tablica aukcji komponentów, które mają być uwzględnione w aukcji reklam na urządzeniu. |
interstitial | Ustawienia, które kontrolują działanie pełnoekranowych boksów reklamowych. |
Właściwości
Optional
adExpansion
adExpansion?: AdExpansionConfig
Ustawienia umożliwiające kontrolowanie rozszerzania reklam.
Optional
componentAuction
componentAuction?: ComponentAuctionConfig[]
Tablica aukcji komponentów, które mają być uwzględnione w aukcji reklam na urządzeniu.
Optional
Reklama pełnoekranowa
interstitial?: InterstitialConfig
Ustawienia, które kontrolują działanie boksu reklamy pełnoekranowej.
googletag.config.TaxonomyData
Właściwości | |
---|---|
values | Lista wartości Taxonomy. |
Właściwości
values
values: string[]
Lista wartości z taksonomii.
googletag.enums
Wyliczenia | |
---|---|
Out | Formaty poza stroną obsługiwane przez GPT. |
Traffic | Źródła wizyt obsługiwane przez GPT. |
Wyliczenia
OutOfPageFormat
- Zobacz też
OutOfPageFormat
Formaty reklam poza stroną obsługiwane przez GPT.
Wyliczenie członków | |
---|---|
BOTTOM_ | Format kotwiczy, w którym boks reklamowy jest przytwierdzony u dołu widocznego obszaru. |
GAME_ | Format ręcznej reklamy pełnoekranowej w instrukcji do gry. Uwaga: ręczna reklama pełnoekranowa w instrukcji do gry to format z ograniczonym dostępem. |
INTERSTITIAL | Format kreacji pełnoekranowej w internecie. |
LEFT_ | Format lewej kolumny bocznej. |
REWARDED | Format reklamy z nagrodą. |
RIGHT_ | Format reklamy w prawej kolumnie bocznej. |
TOP_ | Format kotwicy, w którym boks reklamowy jest przytwierdzony u góry widocznego obszaru. |
TrafficSource
- Zobacz też
TrafficSource
Źródła wizyt obsługiwane przez GPT.
googletag.events
Interfejsy | |
---|---|
Event | Podstawowy interfejs dla wszystkich zdarzeń GPT. |
Event | Jest to pseudotyp, który mapuje nazwę zdarzenia na odpowiadający mu typ obiektu zdarzenia w przypadku metod Service.addEventListener i Service.removeEventListener. |
Game | To zdarzenie jest wywoływane, gdy użytkownik zamknie reklamę pełnoekranową w wersji na potrzeby ręcznego wyświetlania w grze. |
Game | To zdarzenie jest wywoływane, gdy boks reklamy pełnoekranowej konfigurowanej ręcznie do wyświetlenia w grze jest gotowy do wyświetlenia użytkownikowi. |
Impression | To zdarzenie jest wywoływane, gdy wyświetlenie staje się widoczne zgodnie z kryteriami Widoku aktywnego. |
Rewarded | To zdarzenie jest wywoływane, gdy użytkownik zamknie boks reklamowy z nagrodą. |
Rewarded | To zdarzenie jest wywoływane, gdy przyznasz nagrodę za obejrzenie reklamy z nagrodą. |
Rewarded | To zdarzenie jest wywoływane, gdy reklama z nagrodą jest gotowa do wyświetlenia. |
Slot | To zdarzenie jest wywoływane, gdy iframe kreacji wywoła zdarzenie wczytywania. |
Slot | To zdarzenie jest wywoływane, gdy kod kreacji zostanie wstrzyknięty do slotu. |
Slot | To zdarzenie jest wywoływane po wysłaniu żądania reklamy dla określonego boksu. |
Slot | To zdarzenie jest wywoływane po otrzymaniu odpowiedzi na reklamę w danym boksie. |
Slot | To zdarzenie jest wywoływane za każdym razem, gdy zmienia się procentowy udział boksu reklamowego na ekranie. |
googletag.events.Event
Właściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. |
slot | Gniazdko, które wywołało zdarzenie. |
- Zobacz też
Właściwości
serviceName
serviceName: string
Nazwa usługi, która wywołała zdarzenie.
slot
slot: Slot
Przedział, który wywołał zdarzenie.
googletag.events.EventTypeMap
Właściwości | |
---|---|
game | Alias dla zdarzenia events.GameManualInterstitialSlotClosedEvent. |
game | Alias dla events.GameManualInterstitialSlotReadyEvent. |
impression | |
rewarded | |
rewarded | Alias dla events.RewardedSlotGrantedEvent. |
rewarded | Alias dla events.RewardedSlotReadyEvent. |
slot | Alias dla zdarzenia events.SlotOnloadEvent. |
slot | Alias dla events.SlotRenderEndedEvent. |
slot | Alias dla zdarzenia events.SlotRequestedEvent. |
slot | Alias dla events.SlotResponseReceived. |
slot | Alias dla zdarzenia events.SlotVisibilityChangedEvent. |
Właściwości
gameManualInterstitialSlotClosed
gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
Alias dla zdarzenia events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady
gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
Alias dla events.GameManualInterstitialSlotReadyEvent.
impressionViewable
impressionViewable: ImpressionViewableEvent
rewardedSlotClosed
rewardedSlotClosed: RewardedSlotClosedEvent
rewardedSlotGranted
rewardedSlotGranted: RewardedSlotGrantedEvent
Alias dla events.RewardedSlotGrantedEvent.
rewardedSlotReady
rewardedSlotReady: RewardedSlotReadyEvent
Alias dla events.RewardedSlotReadyEvent.
slotOnload
slotOnload: SlotOnloadEvent
Alias dla zdarzenia events.SlotOnloadEvent.
slotRenderEnded
slotRenderEnded: SlotRenderEndedEvent
Alias dla events.SlotRenderEndedEvent.
slotRequested
slotRequested: SlotRequestedEvent
Alias dla zdarzenia events.SlotRequestedEvent.
slotResponseReceived
slotResponseReceived: SlotResponseReceived
Alias events.SlotResponseReceived.
slotVisibilityChanged
slotVisibilityChanged: SlotVisibilityChangedEvent
Alias dla zdarzenia events.SlotVisibilityChangedEvent.
googletag.events.GameManualInterstitialSlotClosedEvent
PrzedłużaUwaga: ręczna reklama pełnoekranowa w grze to format o ograniczonym dostępie.
Właściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z jednostki organizacyjnej |
slot | Przedział, który wywołał zdarzenie. Odziedziczone z jednostki organizacyjnej |
- Przykład
JavaScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when a game manual interstial slot is closed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstial slot is closed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed."); if (slot === targetSlot) { // Slot specific logic. } });
googletag.events.GameManualInterstitialSlotReadyEvent
PrzedłużaUwaga: reklama pełnoekranowa z ręczną konfiguracją w grze jest formatem o ograniczonym dostępie.
Właściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Gniazdko, które wywołało zdarzenie. Odziedziczone z |
Metody | |
---|---|
make | Wyświetla użytkownikowi reklamę pełnoekranową z ręczną konfiguracją w grze. |
- Przykład
JavaScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (starsza wersja)
// This listener is called when a game manual interstitial slot is ready to // be displayed. var targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) { var slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. var displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a game manual interstitial slot is ready to // be displayed. const targetSlot = googletag.defineOutOfPageSlot( "/1234567/example", googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL, ); googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => { const slot = event.slot; console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed."); //Replace with custom logic. const displayGmiAd = true; if (displayGmiAd) { event.makeGameManualInterstitialVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
Metody
makeGameManualInterstitialVisible
googletag.events.ImpressionViewableEvent
PrzedłużaWłaściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Przedział, który wywołał zdarzenie. Odziedziczone z |
- 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żaWłaściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Gniazdko, które wywołało zdarzenie. Odziedziczone z |
- 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. } });
googletag.events.RewardedSlotGrantedEvent
PrzedłużaWłaściwości | |
---|---|
payload | Obiekt zawierający informacje o przyznanej nagrodzie. |
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Gniazdko, które wywołało zdarzenie. Odziedziczone z |
- 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. } });
Właściwości
payload
payload: null | RewardedPayload
Obiekt zawierający informacje o przyznanej nagrodzie.
googletag.events.RewardedSlotReadyEvent
PrzedłużaWłaściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Gniazdko, które wywołało zdarzenie. Odziedziczone z |
Metody | |
---|---|
make | 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. } });
Metody
makeRewardedVisible
googletag.events.SlotOnloadEvent
PrzedłużaSlotOnloadEvent
.Właściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Przedział, który wywołał zdarzenie. Odziedziczone z jednostki organizacyjnej |
- 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żaWłaściwości | |
---|---|
advertiser | Identyfikator reklamodawcy renderowanej reklamy. |
campaign | Identyfikator kampanii renderowanej reklamy. |
company | Identyfikatory firm, które licytowały renderowaną reklamę zapasową. |
creative | Identyfikator kreacji wyrenderowanej reklamy z rezerwacją. |
creative | Identyfikator szablonu kreacji renderowanej reklamy rezerwacyjnej. |
is | Wskazuje, czy reklama była reklamą zapasową. |
is | Czy dla boksu reklamowego zwrócono reklamę. |
label | Wycofane. |
line | Identyfikator elementu zamówienia wyświetlanej reklamy rezerwacyjnej. |
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
size | Wskazuje rozmiar renderowanej kreacji w pikselach. |
slot | Gniazdko, które wywołało zdarzenie. Odziedziczone z jednostki organizacyjnej |
slot | Czy treść boksu reklamowego została zmieniona w wyrenderowanej reklamie. |
source | Identyfikator kreacji w rezerwacji lub reklamy zapasowej. |
source | Identyfikator elementu zamówienia z wyrenderowaną rezerwacją lub reklamą zapasową. |
yield | Identyfikatory grup zysku dla wyrenderowanej reklamy backfill. |
- 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("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("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("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ż
Właściwości
advertiserId
advertiserId: null | number
Identyfikator reklamodawcy renderowanej reklamy. Wartość null
to pusty boks, reklamy backfill i kreacje renderowane przez usługi inne niż PubAdsService.
campaignId
campaignId: null | number
Identyfikator kampanii renderowanej reklamy. Wartość null
to pusty boks, reklamy backfill i kreacje renderowane 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 rezerwacją i kreacji renderowanych przez usługi inne niż PubAdsService.
creativeId
creativeId: null | number
Identyfikator kreacji renderowanej reklamy rezerwacyjnej. Wartość null
to pusty boks, reklamy backfill i kreacje renderowane przez usługi inne niż PubAdsService.
creativeTemplateId
creativeTemplateId: null | number
Identyfikator szablonu kreacji renderowanej reklamy rezerwacyjnej. Wartość null
to pusty boks, reklamy backfill i kreacje renderowane 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ą, a w przeciwnym razie – false
.
isEmpty
isEmpty: boolean
Czy dla boksu reklamowego zwrócono reklamę. Wartość to true
, jeśli nie zwrócono reklamy, a w przeciwnym razie – false
.
labelIds
labelIds: null | number[]
lineItemId
lineItemId: null | number
Identyfikator elementu zamówienia wyświetlanej reklamy rezerwacyjnej. Wartość null
to pusty boks, reklamy backfill i kreacje renderowane przez usługi inne niż PubAdsService.
rozmiar
size: null | string | number[]
Wskazuje rozmiar renderowanej kreacji w pikselach. Przykład: [728, 90]
. Wartość to null
(puste boksy reklamowe).
slotContentChanged
slotContentChanged: boolean
Określa, czy treść boksu została zmieniona z wyrenderowaną reklamą. Wartość to true
, jeśli treść została zmieniona, a w przeciwnym razie false
.
sourceAgnosticCreativeId
sourceAgnosticCreativeId: null | number
Identyfikator kreacji renderowanej reklamy z rezerwacją lub zapasowej. Wartość to null
, jeśli reklama nie jest rezerwacją ani zapasowego elementu zamówienia lub kreacja jest renderowana przez usługi inne niż PubAdsService.
sourceAgnosticLineItemId
sourceAgnosticLineItemId: null | number
Identyfikator elementu zamówienia z wyrenderowaną rezerwacją lub reklamą zapasową. Wartość to null
, jeśli reklama nie jest rezerwacją ani elementem zamówienia z zapasu lub jeśli kreacja jest renderowana przez usługi inne niż PubAdsService.
yieldGroupIds
yieldGroupIds: null | number[]
Identyfikatory grup zysku dla wyrenderowanej reklamy backfill. Wartość null
dotyczy pustych boksów, reklam z rezerwacją i kreacji renderowanych przez usługi inne niż PubAdsService.
googletag.events.SlotRequestedEvent
PrzedłużaWłaściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Gniazdko, które wywołało zdarzenie. Odziedziczone z |
- 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żaWłaściwości | |
---|---|
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Gniazdko, które wywołało zdarzenie. Odziedziczone z jednostki organizacyjnej |
- 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żaWłaściwości | |
---|---|
in | Odsetek obszaru reklamy, który jest widoczny. |
service | Nazwa usługi, która wywołała zdarzenie. Odziedziczone z |
slot | Gniazdko, które wywołało zdarzenie. Odziedziczone z jednostki organizacyjnej |
- 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ż
Właściwości
inViewPercentage
inViewPercentage: number
Odsetek obszaru reklamy, który jest widoczny. Wartość musi być liczbą od 0 do 100.
googletag.secureSignals
Interfejsy | |
---|---|
Bidder | Zwraca bezpieczny sygnał dla konkretnego licytującego. |
Publisher | Zwraca bezpieczny sygnał dotyczący konkretnego wydawcy. |
Secure | interfejs do zarządzania bezpiecznymi sygnałami. |
Aliasy typu | |
---|---|
Secure | Interfejs do zwracania bezpiecznego sygnału dla konkretnego licytującego lub dostawcy. |
Aliasy typu
SecureSignalProvider
SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider
Interfejs do zwracania bezpiecznego sygnału dla konkretnego licytującego lub dostawcy. Należy podać kolumnę id
lub networkCode
(ale nie obie).
googletag.secureSignals.BidderSignalProvider
Dostawca bezpiecznych sygnałów licytującego składa się z 2 części:
- Funkcja kolektora, która zwraca pole
Promise
kierujące do bezpiecznego sygnału. id
, który identyfikuje licytującego powiązanego z sygnałem.
Właściwości | |
---|---|
collector | Funkcja zwracająca Promise , która przekształca się w bezpieczny sygnał. |
id | Unikalny identyfikator sprzedawcy powiązany 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"); }, });
Właściwości
collectorFunction
collectorFunction: (() => Promise<string>)
Funkcja zwracająca Promise
, która przekształca się w bezpieczny sygnał.
id
id: string
Unikalny identyfikator kolektora powiązanego z tym bezpiecznym sygnałem, zarejestrowany w usłudze Google Ad Manager.
googletag.secureSignals.PublisherSignalProvider
Dostawca sygnału wydawcy składa się z 2 części:
- Funkcja kolekcjonera, która zwraca
Promise
, która przekształca się w bezpieczny sygnał. networkCode
, który identyfikuje wydawcę powiązanego z sygnałem.
Właściwości | |
---|---|
collector | Funkcja, która zwraca adres Promise odwołujący się do bezpiecznego sygnału. |
network | Kod sieci (widoczny 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"); }, });
Właściwości
collectorFunction
collectorFunction: (() => Promise<string>)
Funkcja zwracająca Promise
, która przekształca się w bezpieczny sygnał.
networkCode
networkCode: string
Kod sieci (widoczny w ścieżce jednostki reklamowej) wydawcy powiązanego z tym bezpiecznym sygnałem.
googletag.secureSignals.SecureSignalProvidersArray
Metody | |
---|---|
clear | Usuwa z pamięci podręcznej wszystkie sygnały wszystkich kolektorów. |
push | Dodaje do tablicy dostawcy sygnału nowy obiekt secureSignals.SecureSignalProvider i rozpoczyna proces generowania sygnału. |
Metody
clearAllCache
clearAllCache(): void
Czyści z pamięci podręcznej wszystkie sygnały dla wszystkich odbiorników.
Wywołanie tej metody może zmniejszyć prawdopodobieństwo uwzględnienia sygnałów w żądaniach reklamy w przypadku bieżących i potencjalnie późniejszych wyświetleń strony. Z tego powodu należy go wywoływać tylko wtedy, gdy występują istotne zmiany stanu, takie jak zdarzenia wskazujące na nowego użytkownika (logowanie się, wylogowywanie się, rejestrowanie się itp.).
push
push(provider: SecureSignalProvider): void
Dodaje do tablicy dostawcy sygnału nowy obiekt secureSignals.SecureSignalProvider i rozpoczyna proces generowania sygnału.
Parametry | |
---|---|
provider: SecureSignalProvider | Obiekt secureSignals.SecureSignalProvider do dodania do tablicy. |