Dokumentacja GPT

W tym dokumencie do opisu typów użyto notacji TypeScript. W tabeli poniżej znajdziesz krótkie wyjaśnienie na przykładzie.

Wyrażenie typu
string	Typ podstawowy string.
string[]	Typ tablicy, w której wartości mogą być tylko ciągami znaków.
number | string	Typ unii, w którym wartość może być liczbą lub ciągiem znaków.
Array<number | string>	Typ tablicy, w której wartości są typem złożonym (unii).
[number, string]	Typ krotki, w którym wartość jest tablicą dwuelementową, która musi zawierać liczbę i ciąg znaków w tej kolejności.
Slot	Typ obiektu, którego wartość jest instancją googletag.Slot.
() => void	Typ funkcji bez zdefiniowanych argumentów i bez wartości zwracanej.

Więcej informacji o obsługiwanych typach i wyrażeniach typów znajdziesz w podręczniku TypeScript .

Adnotacje dotyczące typów

Dwukropek po zmiennej, nazwie parametru, nazwie właściwości lub podpisie funkcji oznacza 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 typu, które możesz zobaczyć w tym dokumencie.

Adnotacja typu
param: string	Wskazuje, że param akceptuje lub zwraca wartość ciągu tekstowego. Ta składnia jest używana w przypadku zmiennych, parametrów, właściwości i zwracanych typów.
param?: number | string	Wskazuje, że parametr param jest opcjonalny, ale jeśli jest określony, 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 reszty , który akceptuje funkcje. Parametry reszty akceptują nieograniczoną liczbę wartości określonego typu.

---

googletag

Globalna przestrzeń nazw, której tag wydawcy Google używa w swoim interfejsie API.

Przestrzenie nazw
config	Główny interfejs konfiguracji ustawień na poziomie strony.
enums	Jest to przestrzeń nazw, której GPT używa w przypadku typów wyliczeniowych.
events	Jest to przestrzeń nazw, której GPT używa do zdarzeń.
secureSignals	Jest to przestrzeń nazw, której GPT używa do zarządzania bezpiecznymi sygnałami.

Interfejsy
CommandArray	Tablica poleceń akceptuje sekwencję funkcji i wywołuje je w odpowiedniej kolejności.
CompanionAdsService	Usługa reklam towarzyszących.
PrivacySettingsConfig	Obiekt konfiguracji ustawień prywatności.
PubAdsService	Usługa reklam wydawcy.
RequestHook	Funkcja wywołania zwrotnego wywoływana przed każdym żądaniem reklamy, gdy jest zarejestrowana za pomocą PubAdsService.registerRequestHook.
ResponseInformation	Obiekt reprezentujący pojedynczą odpowiedź na reklamę.
RewardedPayload	Obiekt reprezentujący nagrodę powiązaną z reklamą z nagrodą.
Service	Podstawowa klasa usługi, która zawiera metody wspólne dla wszystkich usług.
SizeMappingBuilder	Kreator obiektów specyfikacji mapowania rozmiarów.
Slot	Boks to obiekt reprezentujący pojedynczy boks reklamowy na stronie.

Aliasy typu
FluidSize	Ciąg rozmiaru, w którym kontener reklamy zajmuje 100% szerokości nadrzędnego elementu div, a następnie zmienia wysokość, aby dopasować ją do zawartości kreacji.
GeneralSize	Prawidłowa konfiguracja rozmiaru boksu, która może obejmować jeden lub kilka rozmiarów.
MultiSize	Lista pojedynczych prawidłowych rozmiarów.
NamedSize	Nazwane rozmiary, które może mieć boks.
SingleSize	Pojedynczy prawidłowy rozmiar boksu.
SingleSizeArray	Tablica 2 liczb reprezentujących [szerokość, wysokość].
SizeMapping	Mapowanie rozmiaru widocznego obszaru na rozmiary reklam.
SizeMappingArray	Lista mapowań rozmiarów.

Zmienne
apiReady	Flaga wskazująca, że interfejs GPT API został wczytany i jest gotowy do wywołania.
cmd	Odwołanie do globalnej kolejki poleceń na potrzeby asynchronicznego wykonywania wywołań związanych z GPT.
pubadsReady	Flaga wskazująca, że usługa PubAdsService jest włączona, wczytana i w pełni funkcjonalna.
secureSignalProviders	Odniesienie do tablicy dostawców bezpiecznych sygnałów.

Funkcje
companionAds	Zwraca odwołanie do CompanionAdsService.
defineOutOfPageSlot	Tworzy boks reklamowy poza stroną o podanej ścieżce jednostki reklamowej.
defineSlot	Tworzy boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej oraz wiąże go z identyfikatorem elementu div na stronie, który będzie zawierał reklamę.
destroySlots	Niszczy podane boksy, usuwając z GPT wszystkie powiązane z nimi obiekty i odniesienia.
disablePublisherConsole	Wyłącza Konsolę Google dla wydawcy.
display	Instruuje usługi boksów, aby wyrenderowały boks.
enableServices	Włącza wszystkie usługi GPT zdefiniowane dla boksów reklamowych na stronie.
getConfig	Pobiera zamrożoną kopię ogólnych opcji konfiguracji strony ustawionych przez setConfig.
getVersion	Zwraca bieżącą wersję tagu GPT.
openConsole	Otwiera Konsolę Google dla wydawcy.
pubads	Zwraca odwołanie do PubAdsService.
setAdIframeTitle	Ustawia tytuł wszystkich elementów iframe kontenera reklam utworzonych przez PubAdsService od tego momentu.
setConfig	Ustawia ogólne opcje konfiguracji strony.
sizeMapping	Tworzy nowy obiekt SizeMappingBuilder.

Aliasy typu

---

FluidSize

FluidSize: "fluid"

Ciąg rozmiaru, w którym kontener reklamy zajmuje 100% szerokości nadrzędnego elementu div, a następnie zmienia wysokość, aby dopasować ją do zawartości kreacji. Podobnie jak zwykłe elementy blokowe na stronie. Służy do wyświetlania reklam natywnych i banerów reklamowych (zobacz powiązany artykuł).

---

GeneralSize

GeneralSize: SingleSize | MultiSize

Prawidłowa konfiguracja rozmiaru boksu, która może obejmować jeden lub kilka rozmiarów.

---

MultiSize

MultiSize: SingleSize[]

Lista pojedynczych prawidłowych rozmiarów.

---

NamedSize

NamedSize: FluidSize | [FluidSize]

Nazwane rozmiary, 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 rodzajów specyfikacji rozmiaru. Dozwolone są tylko te nazwy rozmiarów:

• fluid: kontener reklamy zajmuje 100% szerokości nadrzędnego elementu div, a następnie zmienia wysokość, aby dopasować się do treści kreacji. Podobnie jak zwykłe elementy blokowe na stronie. Służy do wyświetlania reklam natywnych i banerów reklamowych (zobacz powiązany artykuł). Pamiętaj, że zarówno fluid, jak i ['fluid'] to prawidłowe formy deklarowania elastycznego rozmiaru boksu.

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

Pojedynczy prawidłowy rozmiar boksu.

---

SingleSizeArray

SingleSizeArray: [number, number]

Tablica 2 liczb reprezentujących [szerokość, wysokość].

---

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Mapowanie rozmiaru widocznego obszaru na rozmiary reklam. Używane w reklamach elastycznych.

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

Lista mapowań rozmiarów.

Zmienne

---

Const apiReady

apiReady: boolean | undefined

Flaga wskazująca, że interfejs GPT API został wczytany i jest gotowy do wywołania. Do czasu przygotowania interfejsu API ta właściwość będzie miała wartość undefined.

Pamiętaj, że zalecanym sposobem obsługi trybu asynchronicznego jest użycie googletag.cmd do kolejkowania wywołań zwrotnych, gdy tag GPT będzie gotowy. Te wywołania zwrotne nie muszą sprawdzać googletag.apiReady, ponieważ ich wykonanie jest gwarantowane po skonfigurowaniu interfejsu API.

---

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray

Odwołanie do globalnej kolejki poleceń na potrzeby asynchronicznego wykonywania wywołań związanych z GPT.

Zmienna googletag.cmd jest inicjowana jako pusta 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. Po wczytaniu kodu JavaScript tagu GPT przegląda on tablicę i wykonuje wszystkie funkcje w odpowiedniej kolejności. Następnie skrypt zastępuje cmd obiektem CommandArray, którego metoda push jest zdefiniowana tak, aby wykonywać przekazany do niej argument funkcji. Ten mechanizm pozwala GPT zmniejszyć postrzegany czas oczekiwania przez asynchroniczne pobieranie kodu JavaScript, podczas gdy przeglądarka może kontynuować renderowanie strony.

Przykład

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

JavaScript (starsza wersja)

googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

---

Const pubadsReady

pubadsReady: boolean | undefined

Flaga wskazująca, że usługa PubAdsService jest włączona, wczytana i w pełni funkcjonalna. Ta właściwość będzie miała wartość undefined, dopóki nie zostanie wywołana metoda enableServices, a usługa PubAdsService nie zostanie wczytana i zainicjowana.

---

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

Odniesienie do tablicy dostawców bezpiecznych sygnałów.

Tablica dostawców bezpiecznych sygnałów akceptuje sekwencję funkcji generujących sygnały i wywołuje je w odpowiedniej kolejności. Ma ona zastąpić standardową tablicę, która służy do umieszczania w kolejce funkcji generujących sygnały, które mają być wywoływane po wczytaniu GPT.

Przykład

JavaScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

JavaScript (starsza wersja)

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    return Promise.resolve("signal");
  },
});

TypeScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

Zobacz też

• Udostępnianie bezpiecznych sygnałów licytującym

Funkcje

---

companionAds

companionAds(): CompanionAdsService

Zwraca odwołanie do CompanionAdsService.

Zwroty
CompanionAdsService	Usługa reklam towarzyszących.

---

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null

Tworzy boks reklamowy poza stroną o podanej ścieżce jednostki reklamowej.

W przypadku niestandardowych reklam poza stroną div to identyfikator elementu div, który będzie zawierać reklamę. Więcej informacji znajdziesz w artykule o kreacjach poza stroną.

W przypadku reklam poza stroną zarządzanych przez GPT div jest obsługiwanym formatem OutOfPageFormat.

Przykład

JavaScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

JavaScript (starsza wersja)

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

TypeScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

Zobacz też

• Wyświetlanie reklamy z nagrodą
• Wyświetlanie reklamy pełnoekranowej w przeglądarce
• Wyświetlanie reklamy zakotwiczonej
• Wyświetlanie reklamy poza stroną

Parametry
adUnitPath: string	Pełna ścieżka jednostki reklamowej z kodem sieci i kodem jednostki reklamowej.
Optional div: string | OutOfPageFormat	Identyfikator elementu div, który będzie zawierać tę jednostkę reklamową lub OutOfPageFormat.

Zwroty
Slot | null	Nowo utworzony boks lub null, jeśli nie można utworzyć boksu.

---

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null

Tworzy boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej oraz wiąże go z identyfikatorem elementu div na stronie, który będzie zawierał reklamę.

Przykład

JavaScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

JavaScript (starsza wersja)

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

Zobacz też

• Pierwsze kroki z tagami wydawcy Google

Parametry
adUnitPath: string	Pełna ścieżka jednostki reklamowej z kodem sieci i kodem jednostki.
size: GeneralSize	Szerokość i wysokość dodanego boksu reklamowego. Jest to rozmiar używany w żądaniu reklamy, jeśli nie podano mapowania rozmiaru elastycznego lub rozmiar widocznego obszaru jest mniejszy niż najmniejszy rozmiar podany w mapowaniu.
Optional div: string	Identyfikator elementu div, który będzie zawierać tę jednostkę reklamową.

Zwroty
Slot | null	Nowo utworzony boks lub null, jeśli nie można utworzyć boksu.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

Niszczy podane boksy, usuwając z GPT wszystkie powiązane z nimi obiekty i odniesienia. Ten interfejs API nie obsługuje boksów przebitki ani boksów towarzyszących.

Wywołanie tego interfejsu API w boksie powoduje wyczyszczenie reklamy i usunięcie obiektu boksu ze stanu wewnętrznego utrzymywanego przez GPT. Wywołanie kolejnych funkcji w obiekcie boksu spowoduje zachowanie niezgodne z oczekiwaniami. Pamiętaj, że przeglądarka może nie zwolnić pamięci powiązanej z tym boksem, jeśli odwołanie do niego jest utrzymywane przez stronę wydawcy. Wywołanie tego interfejsu API sprawia, że element div powiązany z tym boksem jest dostępny do ponownego użycia.

W szczególności zniszczenie boksu powoduje usunięcie reklamy z długotrwałego wyświetlenia strony GPT, dzięki czemu przyszłe żądania nie będą podlegać wpływowi reklam na wyłączność ani wykluczeń konkurencji związanych z tą reklamą. Jeśli nie wywołasz tej funkcji przed usunięciem elementu div boksu ze strony, może to spowodować nieoczekiwane działanie.

Przykład

JavaScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

JavaScript (starsza wersja)

// The calls to construct an ad and display contents.
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

TypeScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

Parametry
Optional slots: Slot[]	Tablica boksów do zniszczenia. Tablica jest opcjonalna. Jeśli nie zostanie określona, wszystkie boksy zostaną zniszczone.

Zwroty
boolean	true, jeśli boksy zostały zniszczone, lub false w przeciwnym razie.

---

disablePublisherConsole

disablePublisherConsole(): void

Wyłącza Konsolę Google dla wydawcy.

Zobacz też

• Konsola Google dla wydawcy

---

display

display(divOrSlot: string | Element | Slot): void

Instruuje usługi boksów, aby wyrenderowały boks. Każdy boks reklamowy powinien być wyświetlany tylko raz na stronie. Wszystkie boksy muszą być zdefiniowane i mieć przypisaną usługę, zanim zostaną wyświetlone. Wywołanie wyświetlenia nie może nastąpić, dopóki element nie znajdzie się w DOM. Zwykle można to osiągnąć, umieszczając go w bloku skryptu w elemencie div nazwanym 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ć niewyświetlanie boksu reklamowego, należy usunąć cały element div.

Zobacz też

• Pierwsze kroki z tagami wydawcy Google
• Wyświetlanie reklamy testowej
• Kontrolowanie wczytywania i odświeżania reklam

Parametry
divOrSlot: string | Element | Slot	Identyfikator elementu div zawierającego boks reklamowy lub element div albo obiekt boksu. Jeśli podano element div, musi on mieć atrybut „id” zgodny z identyfikatorem przekazanym do defineSlot.

---

enableServices

enableServices(): void

Włącza wszystkie usługi GPT zdefiniowane dla boksów reklamowych na stronie.

---

getConfig

getConfig(keys: string | string[]): Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>

Pobiera zamrożoną kopię ogólnych opcji konfiguracji strony ustawionych przez setConfig.

Ta metoda nie obsługuje wszystkich właściwości setConfig(). Obsługiwane właściwości:

• adsenseAttributes
• disableInitialLoad
• targeting

Przykład

JavaScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

JavaScript (starsza wersja)

// Get the value of the `targeting` setting.
var targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
var config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

TypeScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

Parametry
keys: string | string[]	Klucze opcji konfiguracji, które chcesz pobrać.

Zwroty
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>	Zablokowana kopia opcji konfiguracji strony.

---

getVersion

getVersion(): string

Zwraca bieżącą wersję tagu GPT.

Zobacz też

• Historia zmian GPT

Zwroty
string	Ciąg znaków aktualnie wykonywanej wersji GPT.

---

openConsole

openConsole(div?: string): void

Otwiera Konsolę Google dla wydawców.

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ż

• Konsola Google dla wydawcy

Parametry
Optional div: string	Identyfikator elementu div boksu reklamowego. Ta wartość jest opcjonalna. Jeśli podasz tę wartość, Konsola wydawcy spróbuje otworzyć się z widocznymi szczegółami określonego boksu reklamowego.

---

pubads

pubads(): PubAdsService

Zwraca odwołanie do PubAdsService.

Zwroty
PubAdsService	Usługa Publisher Ads.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

Ustawia tytuł wszystkich elementów iframe kontenera reklam utworzonych przez PubAdsService od tego momentu.

Przykład

JavaScript

googletag.setAdIframeTitle("title");

JavaScript (starsza wersja)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Parametry
title: string	Nowy tytuł wszystkich elementów iframe kontenera reklam.

---

setConfig

setConfig(config: PageSettingsConfig): void

Ustawia ogólne opcje konfiguracji strony.

Parametry
config: PageSettingsConfig

---

sizeMapping

sizeMapping(): SizeMappingBuilder

Tworzy nowy obiekt SizeMappingBuilder.

Zobacz też

• Rozmiary reklam: reklamy elastyczne

Zwroty
SizeMappingBuilder	Nowy kreator.

---

googletag.CommandArray

Tablica poleceń akceptuje sekwencję funkcji i wywołuje je w odpowiedniej kolejności. Ma ona zastąpić standardową tablicę, która służy do umieszczania w kolejce funkcji do wywołania po wczytaniu GPT.

Metody
push	Wykonuje po kolei sekwencję funkcji określonych w argumentach.

Metody

---

push

push(...f: ((this: typeof globalThis) => void)[]): number

Wykonuje po kolei sekwencję funkcji określonych w argumentach.

Przykład

JavaScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

JavaScript (starsza wersja)

googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

Parametry
Rest ...f: ((this: typeof globalThis) => void)[]	Funkcja JavaScriptu, która ma zostać wykonana. Wiązanie środowiska wykonawczego będzie zawsze mieć wartość globalThis. Rozważ przekazanie funkcji strzałkowej, aby zachować wartość this otaczającego kontekstu leksykalnego.

Zwroty
number	Liczba poleceń przetworzonych do tej pory. Jest to zgodne z wartością zwracaną przez Array.push (bieżącą długością tablicy).

---

googletag.CompanionAdsService

Rozszerza Service

Usługa reklam towarzyszących. Ta usługa jest używana przez reklamy wideo do wyświetlania reklam towarzyszących.

Metody
addEventListener	Rejestruje detektor, który umożliwia skonfigurowanie i wywołanie funkcji JavaScriptu, gdy na stronie wystąpi określone zdarzenie GPT. Odziedziczone z metody Service.addEventListener
getSlots	Pobierz listę przedziałów czasowych powiązanych z tą usługą. Odziedziczone z metody Service.getSlots
removeEventListener	Usuwa wcześniej zarejestrowany detektor. Odziedziczone z metody Service.removeEventListener
setRefreshUnfilledSlots	Określa, czy puste boksy towarzyszące będą automatycznie wypełniane reklamami zapasowymi.

Zobacz też

• Reklamy towarzyszące w odtwarzaczach wideo i audio

Metody

---

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

Określa, czy niewypełnione boksy towarzyszące będą automatycznie wypełniane reklamami zapasowymi.

Tę metodę można wywoływać wielokrotnie podczas cyklu życia strony, aby włączać i wyłączać wypełnianie reklamami zapasowymi. Reklamami zapasowymi będą wypełniane tylko boksy zarejestrowane w usłudze PubAdsService. Ze względu na ograniczenia wynikające z zasad ta metoda nie jest przeznaczona do wypełniania pustych boksów towarzyszących, gdy wyświetlana jest reklama wideo Ad Exchange.

Przykład

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (starsza wersja)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Parametry
value: boolean	true, aby automatycznie wypełnić niewypełnione boksy, lub false, aby pozostawić je bez zmian.

---

googletag.PrivacySettingsConfig

Obiekt konfiguracji ustawień prywatności.

Właściwości
childDirectedTreatment?	Wskazuje, czy strona powinna być traktowana jako skierowana do dzieci.
limitedAds?	Umożliwia uruchomienie serwera w trybie ograniczonego wyświetlania reklam, aby pomóc wydawcom w spełnianiu wymagań dotyczących zgodności z przepisami.
nonPersonalizedAds?	Umożliwia wyświetlanie reklam w trybie reklam niespersonalizowanych, aby pomóc wydawcom w spełnianiu wymagań zgodności z przepisami.
restrictDataProcessing?	Umożliwia wyświetlanie reklam w trybie ograniczonego przetwarzania, aby pomóc wydawcom w spełnianiu wymagań prawnych.
tagForAgeTreatment?	Traktowanie ze względu na wiek, które wskazuje, czy żądanie reklamy powinno być traktowane jako skierowane do dzieci, nastolatków czy nieokreślone.
trafficSource?	Wskazuje, czy żądania reprezentują ruch kupiony czy bezpłatny.
underAgeOfConsent?	Wskazuje, 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ż

• Konfigurowanie ustawień prywatności

Właściwości

---

Optional childDirectedTreatment

childDirectedTreatment?: boolean

Wskazuje, czy strona powinna być traktowana jako skierowana do dzieci. Ustaw wartość null, aby wyczyścić konfigurację.

---

Optional limitedAds

limitedAds?: boolean

Umożliwia uruchamianie serwera w trybie ograniczonego wyświetlania reklam, aby pomóc wydawcom w spełnianiu wymagań dotyczących zgodności z przepisami.

Informacje o konieczności żądania reklam w ramach ograniczonego wyświetlania mogą być przesyłane do GPT na 2 sposoby:

• automatycznie, za pomocą sygnału z platformy do zarządzania zgodą użytkowników zgodnej 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;

Ręczne konfigurowanie ograniczonego wyświetlania reklam jest możliwe tylko wtedy, gdy tag GPT jest wczytywany z adresu URL ograniczonego wyświetlania reklam. Próba zmiany tego ustawienia, gdy tagi GPT zostały wczytane ze standardowego adresu URL, spowoduje wygenerowanie ostrzeżenia w Konsoli wydawcy.

Pamiętaj, że nie musisz ręcznie włączać ograniczonego wyświetlania reklam, gdy używasz platformy CMP.

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,
});

Zobacz też

• Wyświetlanie reklam w ramach ograniczonego wyświetlania reklam

---

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean

Umożliwia wyświetlanie reklam w trybie reklam niespersonalizowanych, aby pomóc wydawcom w spełnianiu wymagań zgodności z przepisami.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Umożliwia wyświetlanie reklam w trybie ograniczonego przetwarzania, aby pomóc wydawcom w spełnianiu wymagań prawnych.

---

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment

Traktowanie ze względu na wiek, które wskazuje, czy żądanie reklamy powinno być traktowane jako skierowane do dzieci, nastolatków czy nieokreślone.

Skonsultuj się z prawnikiem, aby określić ustawienia dotyczące traktowania użytkowników z uwzględnieniem wieku zgodnie z obowiązującymi Cię wymogami prawnymi i regulacyjnymi. Więcej informacji o tym ustawieniu znajdziesz w tym artykule w Centrum pomocy.

Ustawiając tę właściwość, potwierdzasz, że to powiadomienie jest prawidłowe i masz upoważnienie do działania w imieniu właściciela witryny. Rozumiesz, że nadużycie tego ustawienia może spowodować zamknięcie Twojego konta Google.

Przykład

JavaScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

JavaScript (starsza wersja)

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

TypeScript

// Enable teen privacy treatment.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.TEEN,
});

// Clear age treatment configuration.
googletag.pubads().setPrivacySettings({
  tagForAgeTreatment: googletag.enums.TagForAgeTreatment.UNSPECIFIED,
});

---

Optional trafficSource

trafficSource?: TrafficSource

Wskazuje, czy żądania reprezentują ruch kupiony czy bezpłatny. Ta wartość wypełnia wymiar Źródło wizyt w raportach Ad Managera. Jeśli nie jest ustawione, źródło wizyt w raportach jest domyślnie ustawione na undefined.

Przykład

JavaScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

JavaScript (starsza wersja)

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

TypeScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

---

Optional underAgeOfConsent

underAgeOfConsent?: boolean

Wskazuje, czy żądania reklam mają być oznaczane jako pochodzące od użytkowników, którzy nie osiągnęli wieku świadomego wyrażenia zgody. Ustaw wartość null, aby wyczyścić konfigurację.

---

googletag.PubAdsService

Rozszerza Service

Usługa reklam wydawcy. Ta usługa służy do pobierania i wyświetlania reklam z Twojego konta Google Ad Managera.

Metody
addEventListener	Rejestruje detektor, który umożliwia skonfigurowanie i wywołanie funkcji JavaScriptu, gdy na stronie wystąpi określone zdarzenie GPT. Odziedziczone z metody Service.addEventListener
clear	Usuwa reklamy z podanych boksów i zastępuje je pustą treścią.
clearCategoryExclusions	Wycofano. Usuwa wszystkie etykiety wykluczenia kategorii reklam na poziomie strony.
clearTargeting	Wycofano. Usuwa parametry kierowania niestandardowego dla określonego klucza lub wszystkich kluczy.
collapseEmptyDivs	Wycofano. Umożliwia zwijanie elementów div boksów, dzięki czemu nie zajmują one miejsca na stronie, gdy nie ma treści reklamy do wyświetlenia.
disableInitialLoad	Wycofano. 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.
enableLazyLoad	Wycofano. Włącza leniwe ładowanie w GPT zgodnie z definicją w obiekcie konfiguracji.
enableSingleRequest	Wycofano. Włącza tryb pojedynczego żądania, aby pobierać wiele reklam jednocześnie.
enableVideoAds	Wycofano. Sygnalizuje tagowi GPT, że na stronie będą wyświetlane reklamy wideo.
get	Wycofano. Zwraca wartość atrybutu AdSense powiązanego z danym kluczem.
getAttributeKeys	Wycofano. Zwraca klucze atrybutów ustawione w tej usłudze.
getSlots	Pobierz listę przedziałów czasowych powiązanych z tą usługą. Odziedziczone z metody Service.getSlots
getTargeting	Wycofano.  Zwraca określony niestandardowy parametr kierowania na poziomie usługi, który został ustawiony.
getTargetingKeys	Wycofano. Zwraca listę wszystkich ustawionych niestandardowych kluczy kierowania na poziomie usługi.
isInitialLoadDisabled	Wycofano. Zwraca informację, czy początkowe żądania reklam zostały pomyślnie wyłączone przez poprzednie wywołanie PubAdsService.disableInitialLoad.
refresh	Pobiera i wyświetla nowe reklamy w określonych lub wszystkich boksach na stronie.
registerRequestHook	Rejestruje hook, który ma być wykonywany równolegle z innymi zarejestrowanymi hookami przed każdym żądaniem reklamy na stronie w ramach globalnego limitu czasu.
removeEventListener	Usuwa wcześniej zarejestrowany detektor. Odziedziczone z metody Service.removeEventListener
set	Wycofano. Ustawia wartości atrybutów AdSense, które mają zastosowanie do wszystkich boksów reklamowych w usłudze Publisher Ads.
setCategoryExclusion	Wycofano. Ustawia wykluczenie kategorii reklam na poziomie strony dla danej nazwy etykiety.
setCentering	Wycofano. Włącza i wyłącza poziome wyśrodkowanie reklam.
setForceSafeFrame	Wycofano. Określa, czy wszystkie reklamy na stronie mają być renderowane przy użyciu kontenera SafeFrame.
setLocation	Wycofano. Przekazuje informacje o lokalizacji z witryn, dzięki czemu możesz kierować elementy zamówienia na określone lokalizacje.
setPrivacySettings	Umożliwia skonfigurowanie wszystkich ustawień prywatności z poziomu jednego interfejsu API za pomocą obiektu konfiguracji.
setPublisherProvidedId	Ustawia wartość identyfikatora podanego przez wydawcę.
setSafeFrameConfig	Wycofano. Ustawia preferencje na poziomie strony dotyczące konfiguracji SafeFrame.
setTargeting	Wycofano. Ustawia parametry kierowania niestandardowego dla danego klucza, które mają zastosowanie do wszystkich boksów reklamowych usługi reklamowej wydawcy.
setVideoContent	Wycofano. Ustawia informacje o treściach wideo, które mają być wysyłane wraz z żądaniami reklam na potrzeby kierowania i wykluczania treści.
updateCorrelator	Zmienia korelator wysyłany z żądaniami reklamy, co powoduje rozpoczęcie nowego wyświetlenia strony.

Metody

---

clear

clear(slots?: Slot[]): boolean

Usuwa reklamy z podanych boksów i zastępuje je pustą treścią. Boksy zostaną oznaczone jako niepobrane.

W szczególności wyczyszczenie boksu powoduje usunięcie reklamy z długotrwałego wyświetlenia strony w GPT, dzięki czemu przyszłe żądania nie będą podlegać wpływowi roadblocków ani wykluczeń konkurencji związanych z tą reklamą.

Przykład

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

JavaScript (starsza wersja)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

Parametry
Optional slots: Slot[]	Tablica boksów do wyczyszczenia. Tablica jest opcjonalna. Jeśli nie zostanie określona, wszystkie boksy zostaną wyczyszczone.

Zwroty
boolean	Zwraca true, jeśli boksy zostały wyczyszczone, lub false w przeciwnym razie.

---

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

Usuwa wszystkie etykiety wykluczenia kategorii reklam na poziomie strony. Jest to przydatne, jeśli chcesz odświeżyć boks.

Wycofane: zamiast tego użyj PageSettingsConfig.categoryExclusion.

Przykład

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

JavaScript (starsza wersja)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.setConfig({
  categoryExclusion: null,
});

// Make ad requests. Any ad can be returned.

Zobacz też

• Etykiety własne do blokowania reklam

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

clearTargeting

clearTargeting(key?: string): PubAdsService

Usuwa parametry kierowania niestandardowego dla określonego klucza lub wszystkich kluczy.

Wycofane: zamiast tego użyj PageSettingsConfig.targeting.

Przykład

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

JavaScript (starsza wersja)

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
    fruits: "apple",
  },
});

googletag.setConfig({
  targeting: {
    interests: null,
  },
});
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.setConfig({
  targeting: null,
});
// All targeting has been cleared.

Zobacz też

• Kierowanie na pary klucz-wartość

Parametry
Optional key: string	Klucz parametru kierowania. Klucz jest opcjonalny. Jeśli nie zostanie określony, wszystkie parametry kierowania zostaną wyczyszczone.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Włącza zwijanie elementów div boksów, dzięki czemu nie zajmują one miejsca na stronie, gdy nie ma treści reklamy do wyświetlenia. Ten tryb należy ustawić przed włączeniem usługi.

Wycofane: zamiast tego użyj PageSettingsConfig.collapseDiv.

Zobacz też

• Zwijanie pustych boksów reklamowych
• Minimalizowanie przesunięcia układu

Parametry
Optional collapseBeforeAdFetch: boolean	Określa, czy boks ma być zwijany jeszcze przed pobraniem reklam. Ten parametr jest opcjonalny. Jeśli nie zostanie podany, jako wartość domyślna zostanie użyta wartość false.

Zwroty
boolean	Zwraca true, jeśli tryb zwijania elementu div został włączony, lub 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 wysyłanie żądań reklam za pomocą wywołania PubAdsService.refresh. Należy to zrobić przed włączeniem usługi. Należy używać trybu asynchronicznego. W przeciwnym razie nie będzie można wysyłać żądań reklam za pomocą refresh.

Wycofane: zamiast tego użyj PageSettingsConfig.disableInitialLoad.

Zobacz też

• Kontrolowanie wczytywania i odświeżania reklam
• Kontrolowanie grupowania w architekturze SRA

---

display

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 jest skróconym odpowiednikiem wywołania funkcji googletag.defineSlot, po którym natychmiast następuje wywołanie funkcji googletag.display.

Działanie tej metody zależy od tego, czy włączona jest architektura z pojedynczym żądaniem (SRA):

• Architektura SRA włączona: wszystkie boksy reklamowe zdefiniowane do momentu tego wywołania zostaną zgrupowane i objęte jednym żądaniem.
• SRA wyłączone (domyślnie): boks reklamowy będzie żądany osobno.

Uwaga: gdy ta metoda jest wywoływana, tworzony jest zrzut stanu boksu i strony, aby zapewnić spójność podczas wysyłania żądania reklamy i renderowania odpowiedzi. Wszelkie zmiany wprowadzone w boksie lub stanie strony po wywołaniu tej metody (w tym kierowanie, ustawienia prywatności, wymuszanie SafeFrame itp.) będą miały zastosowanie tylko do kolejnych żądań display() lub refresh().

Przykład

JavaScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

JavaScript (starsza wersja)

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

Zobacz też

• Wyświetlanie reklamy testowej
• Kontrolowanie wczytywania i odświeżania reklam

Parametry
adUnitPath: string	Ścieżka jednostki reklamowej boksu, który ma zostać wyrenderowany.
size: GeneralSize	Szerokość i wysokość boksu.
Optional div: string | Element	Identyfikator elementu div zawierającego boks lub sam element div.
Optional clickUrl: string	Klikany URL, którego chcesz używać w tym boksie.

---

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void

Włącza leniwe ładowanie w GPT zgodnie z definicją w obiekcie konfiguracji. Bardziej szczegółowe przykłady znajdziesz w artykule o leniwym ładowaniu.

Uwaga: leniwe pobieranie w architekturze SRA działa tylko wtedy, gdy wszystkie boksy znajdują się poza marginesem pobierania.

Wycofane: zamiast tego użyj PageSettingsConfig.lazyLoad.

Przykład

JavaScript

googletag.setConfig({
  lazyLoad: {
    // 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.setConfig({
  lazyLoad: {
    // 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.setConfig({
  lazyLoad: {
    // 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ż

• Sprawdzone metody dotyczące reklam: nadawanie priorytetu „ważnym” boksom reklamowym
• Leniwe ładowanie

Parametry

Optional config: {   fetchMarginPercent?: number;   mobileScaling?: number;   renderMarginPercent?: number; }

Obiekt konfiguracji umożliwia dostosowanie działania leniwego. W przypadku pominiętych konfiguracji zostaną użyte ustawienia domyślne Google, które z czasem będą dostosowywane. Aby wyłączyć określone ustawienie, np. margines pobierania, ustaw wartość na -1. fetchMarginPercent Minimalna odległość boksu od bieżącego widocznego obszaru, jaką musi on osiągnąć, zanim pobierzemy reklamę, wyrażona jako odsetek rozmiaru widocznego obszaru. Wartość 0 oznacza „gdy boks znajdzie się w widocznym obszarze”, 100 – „gdy reklama jest oddalona o 1 widoczny obszar” itd. renderMarginPercent Minimalna odległość boksu od bieżącego widocznego obszaru, jaką musi on osiągnąć, zanim wyrenderujemy reklamę. Umożliwia to wstępne pobieranie reklamy, ale opóźnia renderowanie i pobieranie innych zasobów podrzędnych. Wartość działa tak samo jak fetchMarginPercent jako wartość procentowa widocznego obszaru. mobileScaling Mnożnik stosowany do marginesów na urządzeniach mobilnych. Dzięki temu marginesy mogą się różnić na urządzeniach mobilnych i komputerach. Na przykład wartość 2,0 spowoduje pomnożenie wszystkich marginesów przez 2 na urządzeniach mobilnych, co zwiększy minimalną odległość, w jakiej może znajdować się boks przed pobraniem i wyrenderowaniem.

---

enableSingleRequest

enableSingleRequest(): boolean

Włącza tryb pojedynczego żądania, aby pobierać wiele reklam jednocześnie. Wymaga to zdefiniowania wszystkich boksów reklamowych wydawcy i dodania ich do usługi PubAdsService przed jej włączeniem. Tryb pojedynczego żądania musi być ustawiony przed włączeniem usługi.

Wycofane: zamiast tego użyj PageSettingsConfig.singleRequest.

Zobacz też

• Sprawdzone metody dotyczące reklam: prawidłowe korzystanie z architektury z pojedynczym żądaniem
• Kontrolowanie grupowania w architekturze SRA

Zwroty
boolean	Zwraca true, jeśli tryb pojedynczego żądania został włączony, i 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

Sygnalizuje tagowi GPT, że na stronie będą wyświetlane reklamy wideo. Umożliwia to stosowanie ograniczeń wykluczeń konkurencji w przypadku reklam displayowych i reklam wideo. Jeśli treść wideo jest znana, wywołaj PubAdsService.setVideoContent, aby móc używać wykluczania treści w przypadku reklam displayowych.

Wycofane: zamiast tego użyj PageSettingsConfig.videoAds.

---

get

get(key: string): string

Zwraca wartość atrybutu AdSense powiązanego z danym kluczem.

Wycofane: zamiast tego użyj googletag.getConfig.

Przykład

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

JavaScript (starsza wersja)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
var pageUrl =
  (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null;
// Returns 'http://www.example.com'.

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

Zobacz też

• Atrybuty AdSense

Parametry
key: string	Nazwa atrybutu, którego szukasz.

Zwroty
string	Bieżąca wartość klucza atrybutu lub null, jeśli klucz nie istnieje.

---

getAttributeKeys

getAttributeKeys(): string[]

Zwraca klucze atrybutów ustawione w tej usłudze.

Wycofane: zamiast tego użyj googletag.getConfig.

Przykład

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

JavaScript (starsza wersja)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

var adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
var adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
    document_language: "en",
  },
});

const adsenseConfig = googletag.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

Zwroty
string[]	Tablica kluczy atrybutów ustawionych w tej usłudze. Kolejność jest nieokreślona.

---

getTargeting

getTargeting(key: string): string[]

Zwraca określony niestandardowy parametr kierowania na poziomie usługi, który został ustawiony.

Wycofane: zamiast tego użyj googletag.getConfig.

Przykład

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

JavaScript (starsza wersja)

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

var targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["interests"]) || [];
// Returns ['sports'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["interests"] || [];
// Returns ['sports'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

Parametry
key: string	Klucz kierowania do wyszukania.

Zwroty
string[]	Wartości powiązane z tym kluczem lub pusta tablica, jeśli nie ma takiego klucza.

---

getTargetingKeys

getTargetingKeys(): string[]

Zwraca listę wszystkich ustawionych niestandardowych kluczy kierowania na poziomie usługi.

Wycofane: zamiast tego użyj googletag.getConfig.

Przykład

JavaScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

JavaScript (starsza wersja)

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

var targetingConfig = googletag.getConfig("targeting").targeting;
var keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

TypeScript

googletag.setConfig({
  targeting: {
    interests: "sports",
    colors: "blue",
  },
});

const targetingConfig = googletag.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'colors'].

Zwroty
string[]	Tablica kluczy kierowania. Kolejność jest nieokreślona.

---

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Zwraca informację, czy początkowe żądania reklam zostały wyłączone przez poprzednie wywołanie PubAdsService.disableInitialLoad.

Wycofane: zamiast tego użyj googletag.getConfig.

Zwroty
boolean	Zwraca true, jeśli poprzednie wywołanie PubAdsService.disableInitialLoad się powiodło, lub false w przeciwnym razie.

---

refresh

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void

Pobiera i wyświetla nowe reklamy w określonych lub wszystkich boksach na stronie. Działa tylko w trybie renderowania asynchronicznego.

Aby zapewnić prawidłowe działanie we wszystkich przeglądarkach, przed wywołaniem refresh należy wywołać display boks reklamowy. Jeśli wywołanie funkcji display zostanie pominięte, odświeżanie może działać nieprawidłowo. W razie potrzeby możesz użyć metody PubAdsService.disableInitialLoad, aby uniemożliwić usłudze display pobranie reklamy.

Odświeżenie boksu powoduje usunięcie starej reklamy z długotrwałego wyświetlenia strony w GPT, dzięki czemu przyszłe żądania nie będą podlegać wpływowi roadblocków ani wykluczeń konkurencji związanych z tą reklamą.

Przykład

JavaScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

JavaScript (starsza wersja)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

Zobacz też

• Kontrolowanie wczytywania i odświeżania reklam
• Odświeżanie boksów reklamowych

Parametry
Optional slots: Slot[]	Boksy do odświeżenia. Tablica jest opcjonalna. Jeśli nie zostanie określona, wszystkie boksy zostaną odświeżone.
Optional options: {   changeCorrelator: boolean; }	Opcje konfiguracji powiązane z tym wywołaniem odświeżania. changeCorrelator Określa, czy do pobierania reklam ma być generowany nowy korelator. Nasze serwery reklam przechowują tę wartość korelatora przez krótki czas (obecnie przez 30 sekund, ale może to ulec zmianie), dzięki czemu żądania z tym samym korelatorem otrzymane w krótkich odstępach czasu będą traktowane jako jedno wyświetlenie strony. Domyślnie przy każdym odświeżeniu generowany jest nowy korelator. Uwaga: ta opcja nie ma wpływu na długotrwałe wyświetlenie strony w GPT, które automatycznie odzwierciedla reklamy aktualnie wyświetlane na stronie i nie ma daty ważności.

---

registerRequestHook

registerRequestHook(hook: RequestHook, hookId: string): (() => void)

Experimental Rejestruje hook, który ma być wykonywany równolegle z innymi zarejestrowanymi hookami przed każdym żądaniem reklamy na stronie w ramach globalnego limitu czasu.

Przykład

JavaScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

JavaScript (starsza wersja)

// Coming soon.

TypeScript

// Register a request hook.
const unregister = googletag.pubads().registerRequestHook(async ({ slots }) => {
  const someAsynchronousAction = Promise.resolve();
  await someAsynchronousAction;
  for (const slot of slots) {
    slot.setConfig({ targeting: { hookApplied: "true" } });
  }
}, "my-hook");

// Unregister the hook.
unregister();

Parametry
hook: RequestHook	Funkcja, która pobiera obiekt zawierający listę żądanych boksów i zwraca obietnicę, która jest spełniana po zakończeniu wszystkich działań asynchronicznych.
hookId: string	Identyfikator do oznaczenia punktu zaczepienia w celu ulepszenia diagnostyki.

Zwroty
(() => void)	Funkcja wyrejestrowująca punkt zaczepienia.

---

set

set(key: string, value: string): PubAdsService

Ustawia wartości atrybutów AdSense, które mają zastosowanie do wszystkich boksów reklamowych w usługach reklamowych Publisher Ads.

Wywołanie tej metody więcej niż raz dla tego samego klucza spowoduje zastąpienie wcześniej ustawionych wartości tego klucza. Wszystkie wartości muszą być ustawione przed wywołaniem display lub refresh.

Wycofane: zamiast tego użyj PageSettingsConfig.adsenseAttributes.

Przykład

JavaScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

JavaScript (starsza wersja)

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

TypeScript

googletag.setConfig({
  adsenseAttributes: {
    page_url: "http://www.example.com",
  },
});

Zobacz też

• Atrybuty AdSense

Parametry
key: string	Nazwa atrybutu.
value: string	Wartość atrybutu.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

Ustawia wykluczenie kategorii reklam na poziomie strony dla podanej nazwy etykiety.

Wycofane: zamiast tego użyj PageSettingsConfig.categoryExclusion.

Przykład

JavaScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

JavaScript (starsza wersja)

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

TypeScript

// Label = AirlineAd.
googletag.setConfig({
  categoryExclusion: ["AirlineAd"],
});

Zobacz też

• Etykiety własne do blokowania reklam

Parametry
categoryExclusion: string	Etykieta wykluczenia kategorii reklam, którą chcesz dodać.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

setCentering

setCentering(centerAds: boolean): void

Włącza i wyłącza wyśrodkowanie reklam w poziomie. Wyśrodkowanie jest domyślnie wyłączone. W starszej wersji gpt_mobile.js wyśrodkowanie jest domyślnie włączone.

Tę metodę należy wywołać przed wywołaniem display lub refresh, ponieważ wyśrodkowane zostaną tylko reklamy, o które poproszono po wywołaniu tej metody.

Wycofane: użyj zamiast tego PageSettingsConfig.centering.

Przykład

JavaScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});

JavaScript (starsza wersja)

// Make ads centered.
googletag.setConfig({
  centering: true,
});

TypeScript

// Make ads centered.
googletag.setConfig({
  centering: true,
});

Parametry
centerAds: boolean	true, aby wyśrodkować reklamy, lub false, aby wyrównać je do lewej.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Określa, czy wszystkie reklamy na stronie mają być renderowane przy użyciu kontenera SafeFrame.

Podczas korzystania z tego interfejsu API pamiętaj o tych kwestiach:

• To ustawienie będzie obowiązywać tylko w przypadku kolejnych żądań reklamy wysyłanych w odpowiednich boksach.
• Ustawienie na poziomie boksu, jeśli jest określone, zawsze zastępuje ustawienie na poziomie strony.
• Jeśli ustawisz wartość true (na poziomie boksu lub strony), reklama będzie zawsze renderowana przy użyciu kontenera SafeFrame niezależnie od wyboru dokonanego w interfejsie Google Ad Managera.
• Jeśli jednak ustawisz wartość false lub pozostawisz to pole puste, reklama będzie renderowana przy użyciu kontenera SafeFrame w zależności od typu kreacji i wyboru dokonanego w interfejsie Google Ad Managera.
• Z tego interfejsu API należy korzystać ostrożnie, ponieważ może on wpływać na zachowanie kreacji, które próbują wyjść poza elementy iframe lub polegają na renderowaniu bezpośrednio na stronie wydawcy.

Wycofane: zamiast tego użyj PageSettingsConfig.safeFrame.

Przykład

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
  },
});

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      forceSafeFrame: 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ż

• Renderowanie kreacji przy użyciu SafeFrame

Parametry
forceSafeFrame: boolean	true, aby wymusić renderowanie wszystkich reklam na stronie w ramkach SafeFrame, i false, aby zmienić poprzednie ustawienie na „false”. Jeśli wcześniej nie określono wartości, ustawienie jej na false niczego nie zmieni.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

setLocation

setLocation(address: string): PubAdsService

Przekazuje informacje o lokalizacji ze stron internetowych, dzięki czemu możesz kierować geograficznie elementy zamówienia na określone lokalizacje.

Wycofane: zamiast tego użyj PageSettingsConfig.location.

Przykład

JavaScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

JavaScript (starsza wersja)

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

TypeScript

// Postal code:
googletag.setConfig({
  location: "10001,US",
});

Parametry
address: string	Adres w formie dowolnej.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Umożliwia skonfigurowanie wszystkich ustawień prywatności z poziomu jednego interfejsu API za pomocą obiektu konfiguracji.

Przykład

JavaScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

JavaScript (starsza wersja)

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

TypeScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

Zobacz też

• Konfigurowanie ustawień prywatności
• Wyświetlanie reklam w ramach ograniczonego wyświetlania reklam

Parametry
privacySettings: PrivacySettingsConfig	Obiekt zawierający konfigurację ustawień prywatności.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano funkcję.

---

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

Ustawia wartość identyfikatora podawanego przez wydawcę.

Przykład

JavaScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

JavaScript (starsza wersja)

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

Zobacz też

• Informacje o identyfikatorach podawanych przez wydawców

Parametry
ppid: string	Identyfikator alfanumeryczny podany przez wydawcę. Musi mieć od 22 do 150 znaków.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

Ustawia preferencje na poziomie strony dotyczące konfiguracji SafeFrame. Wszystkie nierozpoznane klucze w obiekcie konfiguracji zostaną zignorowane. Jeśli dla rozpoznanego klucza zostanie przekazana nieprawidłowa wartość, cała konfiguracja zostanie zignorowana.

Te ustawienia na poziomie strony zostaną zastąpione ustawieniami na poziomie boksu, jeśli zostały określone.

Wycofane: zamiast tego użyj PageSettingsConfig.safeFrame.

Przykład

JavaScript

googletag.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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.setConfig({
  safeFrame: {
    forceSafeFrame: true,
    allowOverlayExpansion: true,
    allowPushExpansion: true,
    sandbox: true,
  },
});

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .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ż

• Renderowanie kreacji przy użyciu SafeFrame

Parametry
config: SafeFrameConfig	Obiekt konfiguracji.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

setTargeting

setTargeting(key: string, value: string | string[]): PubAdsService

Ustawia parametry kierowania niestandardowego dla danego klucza, które mają zastosowanie do wszystkich boksów reklamowych usługi Publisher Ads. Wielokrotne wywołanie tej metody dla tego samego klucza spowoduje zastąpienie starych wartości. Te klucze są zdefiniowane na Twoim koncie Google Ad Managera.

Wycofane: zamiast tego użyj PageSettingsConfig.targeting.

Przykład

JavaScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

JavaScript (starsza wersja)

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

// Example with a single value for a key.
googletag.setConfig({
  targeting: {
    interests: "sports",
  },
});

// Example with multiple values for a key inside in an array.
googletag.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

Zobacz też

• Kierowanie na pary klucz-wartość

Parametry
key: string	Klucz parametru kierowania.
value: string | string[]	Wartość parametru kierowania lub tablica wartości.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano metodę.

---

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void

Ustawia 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 podanych w usłudze przetwarzania treści Google Ad Managera.

Wycofane: zamiast tego użyj PageSettingsConfig.videoAds.

Zobacz też

• Parametry adresu URL tagu reklamy VAST

Parametry
videoContentId: string	Identyfikator treści wideo.
videoCmsId: string	Identyfikator CMS filmu.

---

updateCorrelator

updateCorrelator(): PubAdsService

Zmienia korelator wysyłany z żądaniami reklamy, co powoduje rozpoczęcie nowego wyświetlenia strony. Korelator jest taki sam dla wszystkich żądań reklamy pochodzących z jednego wyświetlenia strony i unikalny dla poszczególnych wyświetleń strony. Dotyczy tylko trybu asynchronicznego.

Uwaga: nie ma to wpływu na długotrwałe wyświetlenie strony w GPT, które automatycznie odzwierciedla reklamy faktycznie wyświetlane na stronie i nie ma daty ważności.

Przykład

JavaScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

JavaScript (starsza wersja)

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

TypeScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

Zwroty
PubAdsService	Obiekt usługi, na którym wywołano funkcję.

---

googletag.RequestHook

Funkcja wywołania zwrotnego wywoływana przed każdym żądaniem reklamy, gdy jest zarejestrowana za pomocą PubAdsService.registerRequestHook.

---

googletag.ResponseInformation

Obiekt reprezentujący pojedynczą odpowiedź na reklamę.

Właściwości
advertiserId	Identyfikator reklamodawcy.
campaignId	Identyfikator kampanii.
creativeId	Identyfikator kreacji.
creativeTemplateId	Identyfikator szablonu reklamy.
lineItemId	Identyfikator elementu zamówienia.

Zobacz też

• Slot.getResponseInformation

Właściwości

---

advertiserId

advertiserId: number

Identyfikator reklamodawcy.

---

campaignId

campaignId: number

Identyfikator kampanii.

---

creativeId

creativeId: number

Identyfikator kreacji.

---

creativeTemplateId

creativeTemplateId: number

Identyfikator szablonu reklamy.

---

lineItemId

lineItemId: number

Identyfikator elementu zamówienia.

---

googletag.RewardedPayload

Obiekt reprezentujący nagrodę powiązaną z reklamą z nagrodą.

Właściwości
amount	Liczba elementów uwzględnionych w nagrodzie.
type	Typ elementu uwzględnionego w nagrodzie (np. „moneta”).

Zobacz też

• Wyświetlanie reklamy z nagrodą

Właściwości

---

amount

amount: number

Liczba elementów uwzględnionych w nagrodzie.

---

type

type: string

Typ elementu uwzględnionego w nagrodzie (np. „moneta”).

---

googletag.Service

Podstawowa klasa usługi, która zawiera metody wspólne dla wszystkich usług.

Metody
addEventListener	Rejestruje detektor, który umożliwia skonfigurowanie i wywołanie funkcji JavaScriptu, gdy na stronie wystąpi określone zdarzenie GPT.
getSlots	Pobierz listę przedziałów czasowych powiązanych z tą usługą.
removeEventListener	Usuwa wcześniej zarejestrowany detektor.

Metody

---

addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service

Rejestruje detektor, który umożliwia skonfigurowanie i wywołanie funkcji JavaScriptu, gdy na stronie wystąpi określone zdarzenie GPT. Obsługiwane są te zdarzenia:

• events.GameManualInterstitialSlotClosedEvent
• events.GameManualInterstitialSlotReadyEvent
• events.ImpressionViewableEvent
• events.RewardedSlotClosedEvent
• events.RewardedSlotGrantedEvent
• events.RewardedSlotReadyEvent
• events.SlotOnloadEvent
• events.SlotRenderEndedEvent
• events.SlotRequestedEvent
• events.SlotResponseReceived
• events.SlotVisibilityChangedEvent

Obiekt odpowiedniego typu zdarzenia jest przekazywany do detektora, gdy jest on wywoływany.

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ż

• Detektory zdarzeń reklamowych

Parametry
eventType: K	Ciąg znaków reprezentujący typ zdarzenia wygenerowanego przez GPT. W typach zdarzeń jest rozróżniana wielkość liter.
listener: ((arg: EventTypeMap[K]) => void)	Funkcja, która przyjmuje jeden argument obiektu zdarzenia.

Zwroty
Service	Obiekt usługi, na którym wywołano metodę.

---

getSlots

getSlots(): Slot[]

Pobierz listę przedziałów czasowych powiązanych z tą usługą.

Zwroty
Slot[]	Miejsca w kolejności, w jakiej zostały dodane do usługi.

---

removeEventListener

removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void

Usuwa wcześniej zarejestrowany detektor.

Przykład

JavaScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

JavaScript (starsza wersja)

googletag.cmd.push(function () {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  var onViewableListener = function (event) {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(function () {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

TypeScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag
    .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
    .addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

Parametry
eventType: K	Ciąg znaków reprezentujący typ zdarzenia wygenerowanego przez GPT. W typach zdarzeń jest rozróżniana wielkość liter.
listener: ((event: EventTypeMap[K]) => void)	Funkcja, która przyjmuje jeden argument obiektu zdarzenia.

---

googletag.SizeMappingBuilder

Kreator obiektów specyfikacji mapowania rozmiarów. Ten kreator ułatwia tworzenie specyfikacji rozmiaru.

Metody
addSize	Dodaje mapowanie z tablicy o jednym rozmiarze (reprezentującej widoczny obszar) do tablicy o jednym lub wielu rozmiarach reprezentującej boks.
build	Tworzy specyfikację mapy rozmiarów na podstawie mapowań dodanych do tego kreatora.

Zobacz też

• Rozmiary reklam: reklamy elastyczne

Metody

---

addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder

Dodaje mapowanie z tablicy o jednym rozmiarze (reprezentującej widoczny obszar) do tablicy o jednym lub wielu rozmiarach (reprezentującej boks).

Przykład

JavaScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

JavaScript (starsza wersja)

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

TypeScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

Parametry
viewportSize: SingleSizeArray	Rozmiar widocznego obszaru dla tego wpisu mapowania.
slotSize: GeneralSize	Rozmiary boksu dla tego wpisu mapowania.

Zwroty
SizeMappingBuilder	Odwołanie do tego kreatora.

---

build

build(): SizeMappingArray

Tworzy specyfikację mapy rozmiarów na podstawie mapowań dodanych do tego kreatora.

Jeśli podano nieprawidłowe mapowania, ta metoda zwróci wartość null. W przeciwnym razie zwraca specyfikację w prawidłowym formacie, którą można przekazać do metody Slot.defineSizeMapping.

Uwaga: działanie kreatora po wywołaniu tej metody jest niezdefiniowane.

Zwroty
SizeMappingArray	Wynik utworzony przez ten kreator. Może być puste, jeśli podano nieprawidłowe mapowania rozmiaru.

---

googletag.Slot

Boks to obiekt reprezentujący pojedynczy boks reklamowy na stronie.

Metody
addService	Dodaje usługę do tego boksu.
clearCategoryExclusions	Wycofano. Usuwa wszystkie etykiety wykluczenia kategorii reklam na poziomie boksu dla tego boksu.
clearTargeting	Wycofano. Usuwa określone lub wszystkie parametry kierowania niestandardowego na poziomie boksu dla tego boksu.
defineSizeMapping	Ustawia tablicę mapowań od minimalnego rozmiaru widocznego obszaru do rozmiaru boksu dla tego boksu.
get	Wycofano. Zwraca wartość atrybutu AdSense powiązanego z danym kluczem dla tego boksu.
getAdUnitPath	Zwraca pełną ścieżkę jednostki reklamowej z kodem sieci i ścieżką jednostki reklamowej.
getAttributeKeys	Wycofano. Zwraca listę kluczy atrybutów ustawionych w tym boksie.
getCategoryExclusions	Wycofano. Zwraca etykiety wykluczenia kategorii reklam dla tego boksu.
getConfig	Pobiera niezmienną kopię ogólnych opcji konfiguracji boksu ustawionych przez setConfig.
getResponseInformation	Zwraca informacje o odpowiedzi na reklamę.
getSlotElementId	Zwraca identyfikator boksu div podany podczas definiowania boksu.
getTargeting	Wycofano. Zwraca konkretny parametr kierowania niestandardowego ustawiony w tym boksie.
getTargetingKeys	Wycofano. Zwraca listę wszystkich kluczy kierowania niestandardowego ustawionych w tym boksie.
set	Wycofano. Ustawia wartość atrybutu AdSense w tym boksie reklamowym.
setCategoryExclusion	Wycofano. Ustawia etykietę wykluczenia kategorii reklamy na poziomie boksu w tym boksie.
setClickUrl	Wycofano. Ustawia klikany URL, na który użytkownicy zostaną przekierowani po kliknięciu reklamy.
setCollapseEmptyDiv	Wycofano. Określa, czy boks div ma być ukryty, gdy nie ma w nim reklamy.
setConfig	Ustawia ogólne opcje konfiguracji tego boksu.
setForceSafeFrame	Wycofano. Określa, czy reklamy w tym boksie mają być renderowane przy użyciu kontenera SafeFrame.
setSafeFrameConfig	Wycofano. Ustawia preferencje na poziomie boksu dotyczące konfiguracji SafeFrame.
setTargeting	Wycofano. Ustawia parametr kierowania niestandardowego dla tego boksu.
updateTargetingFromMap	Wycofano. Ustawia parametry kierowania niestandardowego dla tego boksu na podstawie mapy klucz:wartość w obiekcie JSON.

Metody

---

addService

addService(service: Service): Slot

Dodaje usługę do tego boksu.

Przykład

JavaScript

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

JavaScript (starsza wersja)

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());

Zobacz też

• Pierwsze kroki z tagami wydawcy Google
• Wyświetlanie reklamy testowej

Parametry
service: Service	Usługa, która ma zostać dodana.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

clearCategoryExclusions

clearCategoryExclusions(): Slot

Usuwa wszystkie etykiety wykluczenia kategorii reklam na poziomie boksu dla tego boksu.

Wycofane: zamiast tego użyj SlotSettingsConfig.categoryExclusion.

Przykład

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// 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")
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// 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")!
  .setConfig({
    categoryExclusion: ["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.setConfig({
  categoryExclusion: null,
});

// Make an ad request. Any ad can be returned for the slot.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

clearTargeting

clearTargeting(key?: string): Slot

Usuwa określone lub wszystkie niestandardowe parametry kierowania na poziomie boksu dla tego boksu.

Wycofane: zamiast tego użyj SlotSettingsConfig.targeting.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
      color: "red",
    },
  })
  .addService(googletag.pubads());

slot.setConfig({
  targeting: {
    color: null,
  },
});
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.setConfig({
  targeting: null,
});
// All targeting has been cleared.

Zobacz też

• Kierowanie na pary klucz-wartość

Parametry
Optional key: string	Klucz parametru kierowania. Klucz jest opcjonalny. Jeśli nie zostanie określony, wszystkie parametry kierowania zostaną wyczyszczone.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Ustawia tablicę mapowań od minimalnego rozmiaru widocznego obszaru do rozmiaru boksu dla tego boksu.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

var mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping!);

Zobacz też

• Rozmiary reklam: reklamy elastyczne

Parametry
sizeMapping: SizeMappingArray	Tablica mapowań rozmiarów. Możesz go utworzyć za pomocą SizeMappingBuilder. Każde mapowanie rozmiaru to tablica składająca się z 2 elementów: SingleSizeArray i GeneralSize.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

get

get(key: string): string

Zwraca wartość atrybutu AdSense powiązanego z danym kluczem dla tego boksu. Aby wyświetlić atrybuty na poziomie usługi odziedziczone przez ten boks, użyj metody PubAdsService.get.

Wycofana: zamiast niej użyj metody googletag.Slot.getConfig.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
var pageUrl =
  (adsenseConfig === null || adsenseConfig === void 0 ? void 0 : adsenseConfig.page_url) || null;
// Returns 'http://www.example.com'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const pageUrl = adsenseConfig?.page_url || null;
// Returns 'http://www.example.com'.

Zobacz też

• Atrybuty AdSense

Parametry
key: string	Nazwa atrybutu, którego szukasz.

Zwroty
string	Bieżąca wartość klucza atrybutu lub null, jeśli klucz nie istnieje.

---

getAdUnitPath

getAdUnitPath(): string

Zwraca pełną ścieżkę jednostki reklamowej z kodem sieci i ścieżką jednostki reklamowej.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

Zwroty
string	Ścieżka jednostki reklamowej.

---

getAttributeKeys

getAttributeKeys(): string[]

Zwraca listę kluczy atrybutów ustawionych w tym boksie. Aby wyświetlić klucze atrybutów na poziomie usługi odziedziczone przez ten boks, użyj metody PubAdsService.getAttributeKeys.

Wycofana: zamiast niej użyj metody googletag.Slot.getConfig.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

var adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
var adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
      document_language: "en",
    },
  })
  .addService(googletag.pubads());

const adsenseConfig = slot.getConfig("adsenseAttributes").adsenseAttributes;
const adsenseAttributes = Object.keys(adsenseConfig || {});
// Returns ['page_url', 'document_language'].

Zwroty
string[]	Tablica kluczy atrybutów. Kolejność jest nieokreślona.

---

getCategoryExclusions

getCategoryExclusions(): string[]

Zwraca etykiety wykluczenia kategorii reklam dla tego boksu.

Wycofane: zamiast tego użyj googletag.Slot.getConfig.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

JavaScript (starsza wersja)

var _a;
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

var exclusions =
  ((_a = slot.getConfig("categoryExclusion")) === null || _a === void 0
    ? void 0
    : _a.categoryExclusion) || [];
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd", "TrainAd"],
  })
  .addService(googletag.pubads());

const exclusions = slot.getConfig("categoryExclusion")?.categoryExclusion || [];
// Returns ['AirlineAd', 'TrainAd'].

Zwroty
string[]	Etykiety wykluczenia kategorii reklam dla tego boksu lub pusta tablica, jeśli nie ustawiono żadnych etykiet.

---

getConfig

getConfig(keys: string | string[]): Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>

Pobiera niezmienną kopię ogólnych opcji konfiguracji boksu ustawionych przez funkcję setConfig.

Ta metoda nie obsługuje wszystkich właściwości setConfig(). Obsługiwane właściwości:

• adsenseAttributes
• categoryExclusion
• targeting

Przykład

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

JavaScript (starsza wersja)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
var targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
var config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

Parametry
keys: string | string[]	Klucze opcji konfiguracji, które chcesz pobrać.

Zwroty
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>	Zablokowana kopia opcji konfiguracji boksu.

---

getResponseInformation

getResponseInformation(): ResponseInformation

Zwraca informacje o odpowiedzi na reklamę. Jest to określane na podstawie ostatniej odpowiedzi na żądanie reklamy w danym boksie. Jeśli ta funkcja zostanie wywołana, gdy w boksie nie ma reklamy, zwrócona zostanie wartość null.

Zwroty
ResponseInformation	Najnowsze informacje o odpowiedzi na reklamę lub null, jeśli boks nie zawiera reklamy.

---

getSlotElementId

getSlotElementId(): string

Zwraca identyfikator boksu div podany podczas definiowania boksu.

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'.

Zwroty
string	Identyfikator boksu reklamowego div.

---

getTargeting

getTargeting(key: string): string[]

Zwraca konkretny parametr kierowania niestandardowego ustawiony w tym boksie. Parametry kierowania na poziomie usługi nie są uwzględniane.

Wycofane: zamiast tego użyj googletag.Slot.getConfig.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

var targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
var targeting =
  (targetingConfig === null || targetingConfig === void 0
    ? void 0
    : targetingConfig["allow_expandable"]) || [];
// Returns ['true'].

var ageTargeting =
  (targetingConfig === null || targetingConfig === void 0 ? void 0 : targetingConfig["age"]) || [];
// Returns [] (empty array).

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;

// Get targeting for a specific key.
const targeting = targetingConfig?.["allow_expandable"] || [];
// Returns ['true'].

const ageTargeting = targetingConfig?.["age"] || [];
// Returns [] (empty array).

Parametry
key: string	Klucz kierowania do wyszukania.

Zwroty
string[]	Wartości powiązane z tym kluczem lub pusta tablica, jeśli nie ma takiego klucza.

---

getTargetingKeys

getTargetingKeys(): string[]

Zwraca listę wszystkich kluczy kierowania niestandardowego ustawionych w tym boksie. Klucze kierowania na poziomie usługi nie są uwzględniane.

Wycofane: zamiast tego użyj googletag.Slot.getConfig.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

var targetingConfig = slot.getConfig("targeting").targeting;
var keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    targeting: {
      allow_expandable: "true",
      interests: ["sports", "music"],
    },
  })
  .addService(googletag.pubads());

const targetingConfig = slot.getConfig("targeting").targeting;
const keys = Object.keys(targetingConfig || {});
// Returns ['interests', 'allow_expandable'].

Zwroty
string[]	Tablica kluczy kierowania. Kolejność jest nieokreślona.

---

set

set(key: string, value: string): Slot

Ustawia wartość atrybutu AdSense w tym boksie reklamowym. Spowoduje to zastąpienie wszystkich wartości ustawionych dla tego klucza na poziomie usługi.

Wywołanie tej metody więcej niż raz dla tego samego klucza spowoduje zastąpienie wcześniej ustawionych wartości dla tego klucza. Wszystkie wartości muszą być ustawione przed wywołaniem display lub refresh.

Wycofane: zamiast tego użyj SlotSettingsConfig.adsenseAttributes.

Przykład

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

JavaScript (starsza wersja)

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    adsenseAttributes: {
      page_url: "http://www.example.com",
    },
  })
  .addService(googletag.pubads());

Zobacz też

• Atrybuty AdSense

Parametry
key: string	Nazwa atrybutu.
value: string	Wartość atrybutu.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

Ustawia etykietę wykluczenia kategorii reklamy na poziomie boksu w tym boksie.

Wycofane: zamiast tego użyj SlotSettingsConfig.categoryExclusion.

Przykład

JavaScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

JavaScript (starsza wersja)

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    categoryExclusion: ["AirlineAd"],
  })
  .addService(googletag.pubads());

Zobacz też

• Etykiety własne do blokowania reklam

Parametry
categoryExclusion: string	Etykieta wykluczenia kategorii reklam, którą chcesz dodać.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

setClickUrl

setClickUrl(value: string): Slot

Ustawia klikany URL, na który użytkownicy będą przekierowywani po kliknięciu reklamy.

Serwery Google Ad Managera nadal rejestrują kliknięcie, nawet jeśli klikany URL zostanie zastąpiony. Do podanej wartości dołączany jest adres URL strony docelowej powiązany z wyświetlaną kreacją. Kolejne wywołania zastępują tę wartość. Działa to tylko w przypadku żądań innych niż SRA.

Wycofane: zamiast tego użyj SlotSettingsConfig.clickUrl.

Przykład

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

JavaScript (starsza wersja)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setConfig({
    clickUrl: "http://www.example.com?original_click_url=",
  })
  .addService(googletag.pubads());

Parametry
value: string	Klikany URL, który chcesz ustawić.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot

Określa, czy boks div powinien być ukryty, gdy nie ma w nim reklamy. Zastępuje ustawienia na poziomie usługi.

Wycofane: zamiast tego użyj SlotSettingsConfig.collapseDiv.

Przykład

JavaScript

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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)

var slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

var slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .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

const slot1 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    collapseDiv: "BEFORE_FETCH",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

const slot2 = googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setConfig({
    collapseDiv: "ON_NO_FILL",
  })
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

Zobacz też

• Zwijanie pustych boksów reklamowych
• Minimalizowanie przesunięcia układu

Parametry
collapse: boolean	Określa, czy boks ma zostać zwinięty, jeśli nie zostanie zwrócona żadna reklama.
Optional collapseBeforeAdFetch: boolean	Określa, czy boks ma być zwijany, zanim reklama zostanie pobrana. Ignorowane, jeśli zwijanie nie jest ustawione na true.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot

Ustawia ogólne opcje konfiguracji tego boksu.

Parametry
slotConfig: SlotSettingsConfig	Obiekt konfiguracji.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Określa, czy reklamy w tym boksie mają być renderowane przy użyciu kontenera SafeFrame.

Podczas korzystania z tego interfejsu API pamiętaj o tych kwestiach:

• To ustawienie będzie obowiązywać tylko w przypadku kolejnych żądań reklamy wysyłanych w odpowiednich boksach.
• Ustawienie na poziomie boksu, jeśli jest określone, zawsze zastępuje ustawienie na poziomie strony.
• Jeśli ustawisz wartość true (na poziomie boksu lub strony), reklama będzie zawsze renderowana przy użyciu kontenera SafeFrame niezależnie od wyboru dokonanego w interfejsie Google Ad Managera.
• Jeśli jednak ustawisz wartość false lub pozostawisz to pole puste, reklama będzie renderowana przy użyciu kontenera SafeFrame w zależności od typu kreacji i wyboru dokonanego w interfejsie Google Ad Managera.
• Z tego interfejsu API należy korzystać ostrożnie, ponieważ może on wpływać na zachowanie kreacji, które próbują wyjść poza elementy iframe lub polegają na renderowaniu bezpośrednio na stronie wydawcy.

Wycofane: użyj zamiast tego SlotSettingsConfig.safeFrame.

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ż

• Renderowanie kreacji przy użyciu SafeFrame

Parametry
forceSafeFrame: boolean	true, aby wymusić renderowanie wszystkich reklam w tym boksie w ramkach SafeFrame, i false, aby zrezygnować z ustawienia na poziomie strony (jeśli jest obecne). Ustawienie wartości false, gdy nie jest ona określona na poziomie strony, niczego nie zmieni.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot

Ustawia preferencje na poziomie boksu dotyczące konfiguracji SafeFrame. Wszystkie nierozpoznane klucze w obiekcie konfiguracji zostaną zignorowane. Jeśli dla rozpoznanego klucza zostanie przekazana nieprawidłowa wartość, cała konfiguracja zostanie zignorowana.

Jeśli te ustawienia na poziomie boksu zostaną określone, zastąpią wszystkie ustawienia na poziomie strony.

Wycofane: zamiast tego użyj SlotSettingsConfig.safeFrame.

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ż

• Renderowanie kreacji przy użyciu SafeFrame

Parametry
config: SafeFrameConfig	Obiekt konfiguracji.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

setTargeting

setTargeting(key: string, value: string | string[]): Slot

Ustawia parametr kierowania niestandardowego dla tego boksu. Wielokrotne wywoływanie tej metody dla tego samego klucza spowoduje zastąpienie starych wartości. Wartości ustawione tutaj zastąpią parametry kierowania ustawione na poziomie usługi. Te klucze są zdefiniowane na Twoim koncie Google Ad Managera.

Wycofane: zamiast tego użyj SlotSettingsConfig.targeting.

Przykład

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

JavaScript (starsza wersja)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;
slot.addService(googletag.pubads());

// Example with a single value for a key.
slot.setConfig({
  targeting: {
    allow_expandable: "true",
  },
});

// Example with multiple values for a key inside in an array.
slot.setConfig({
  targeting: {
    interests: ["sports", "music"],
  },
});

Zobacz też

• Kierowanie na pary klucz-wartość

Parametry
key: string	Klucz parametru kierowania.
value: string | string[]	Wartość parametru kierowania lub tablica wartości.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot

Ustawia parametry kierowania niestandardowego dla tego boksu na podstawie mapy klucz:wartość w obiekcie JSON. Działa to tak samo jak wywołanie metody Slot.setTargeting dla wszystkich par klucz-wartość obiektu. Te klucze są zdefiniowane na Twoim koncie Google Ad Managera.

Uwagi:

• W przypadku zastąpienia zachowana zostanie tylko ostatnia wartość.
• Jeśli wartość jest tablicą, poprzednia wartość zostanie zastąpiona, a nie scalona.
• Wartości ustawione tutaj zastąpią parametry kierowania ustawione na poziomie usługi.

Wycofane: użyj zamiast tego SlotSettingsConfig.targeting.

Przykład

JavaScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

JavaScript (starsza wersja)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

Parametry
map: {   [adUnitPath: string]: string | string[]; }	Mapa klucz:wartość parametru kierowania.

Zwroty
Slot	Obiekt boksu, na którym wywołano metodę.

---

googletag.config

Główny interfejs konfiguracji ustawień na poziomie strony.

Interfejsy
AdExpansionConfig	Ustawienia umożliwiające kontrolowanie rozwijania reklam.
AdSenseAttributesConfig	Ustawienia umożliwiające kontrolowanie zachowania reklam AdSense.
AutoRefreshConfig	Ustawienia konfiguracji automatycznego odświeżania.
ContinueButtonConfig	Ustawienia umożliwiające skonfigurowanie działania przycisku Kontynuuj.
InterstitialConfig	Obiekt, który definiuje zachowanie pojedynczego boksu reklamy pełnoekranowej.
LazyLoadConfig	Ustawienia umożliwiające kontrolowanie korzystania z leniwego ładowania w GPT.
PageSettingsConfig	Główny interfejs konfiguracji ustawień na poziomie strony.
PrivacyTreatmentsConfig	Ustawienia umożliwiające kontrolowanie procedur wydawcy dotyczących prywatności.
PublisherProvidedSignalsConfig	Obiekt konfiguracji sygnałów dostarczanych przez wydawcę.
SafeFrameConfig	Ustawienia umożliwiające kontrolowanie SafeFrame w GPT.
SlotSettingsConfig	Główny interfejs konfiguracji ustawień na poziomie boksu.
TaxonomyData	Obiekt zawierający wartości dla pojedynczej mapy kategorii.
VideoAdsConfig	Ustawienia umożliwiające skonfigurowanie ustawień związanych z reklamami wideo.

Aliasy typu
CollapseDivBehavior	Obsługiwane wartości do kontrolowania zachowania boksów reklamowych podczas zwijania.
InterstitialTrigger	Obsługiwane aktywatory reklam pełnoekranowych.
PrivacyTreatment	Obsługiwane sposoby traktowania prywatności przez wydawcę.
Taxonomy	Obsługiwane taksonomie w przypadku sygnałów dostarczanych przez wydawcę.

Aliasy typu

---

CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"

Obsługiwane wartości do kontrolowania zachowania boksów reklamowych podczas zwijania.

Zobacz też

• PageSettingsConfig.collapseDiv
• SlotSettingsConfig.collapseDiv

---

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar" | "inactivity" | "endOfArticle" | "continueReading" | "backward"

Obsługiwane reguły reklam pełnoekranowych.

Uwaga: od 15 czerwca 2026 r. reguła backward nie będzie już obsługiwana, a jej włączenie nie będzie miało żadnego efektu. Więcej informacji znajdziesz w informacjach o wersji GPT.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Obsługiwane ustawienia dotyczące respektowania prywatności przez wydawcę.

---

Taksonomia

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Obsługiwane taksonomie w przypadku sygnałów dostarczanych przez wydawcę.

Zobacz też

• Taksonomia odbiorców IAB 1.1
• Taksonomia treści IAB w wersji 2.2

---

googletag.config.AdExpansionConfig

Ustawienia umożliwiające kontrolowanie rozwijania reklam.

Właściwości
enabled?	Określa, czy rozwijanie reklamy 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 rozwijanie reklamy jest włączone czy wyłączone.

Ustawienie tej wartości zastępuje domyślną wartość skonfigurowaną w usłudze Google Ad Manager.

Zobacz też

• Rozwijanie reklam na komputerach i tabletach
• Rozwijanie reklam w internecie mobilnym (na część ekranu)

---

googletag.config.AdSenseAttributesConfig

Ustawienia umożliwiające kontrolowanie zachowania reklam AdSense.

Te atrybuty mogą służyć do zastępowania ustawień po stronie serwera w poszczególnych żądaniach.

Właściwości
adsense_ad_format?	Format reklamy AdSense.
adsense_channel_ids?	Identyfikatory kanałów AdSense.
adsense_test_mode?	Informacja o tym, czy tryb testowy jest włączony.
document_language?	Język strony, na której wyświetlane są reklamy.
page_url?	Adres URL strony, na której wyświetlane są reklamy.

Zobacz też

• PageSettingsConfig.adsenseAttributes
• SlotSettingsConfig.adsenseAttributes

Właściwości

---

Optional adsense_ad_format

adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"

Format reklamy AdSense.

---

Optional adsense_channel_ids

adsense_channel_ids?: string

Identyfikatory kanałów AdSense.

Dozwolone wartości to identyfikatory kanałów rozdzielone znakiem „+”.

Przykład: 271828183+314159265

Zobacz też

• Śledzenie skuteczności jednostek reklamowych za pomocą kanałów niestandardowych

---

Optional adsense_test_mode

adsense_test_mode?: "on"

Określa, czy tryb testowy jest włączony.

Jeśli ustawisz wartość on, reklamy będą oznaczone jako przeznaczone tylko do testów i nie będą uwzględniane w zliczaniu ani rozliczeniach. To ustawienie musi być wyłączone w przypadku ruchu produkcyjnego, który nie jest ruchem testowym.

---

Optional document_language

document_language?: string

Język strony, na której wyświetlane są reklamy.

Dozwolone wartości to prawidłowe kody języka ISO 639-1.

Przykład: en

Zobacz też

• Lista kodów języków w standardzie ISO 639

---

Optional page_url

page_url?: string

Adres URL strony, na której wyświetlane są reklamy.

Dozwolone wartości to prawidłowe adresy URL.

Przykład: http://www.example.com

---

googletag.config.AutoRefreshConfig

Ustawienia konfiguracji automatycznego odświeżania.

Właściwości
backForwardCache?	Określa, czy GPT będzie automatycznie odświeżać aktywnie wyświetlany boks reklamowy, gdy strona zostanie przywrócona z pamięci podręcznej stanu strony internetowej.
heavyAds?	Określa, czy GPT będzie automatycznie odświeżać boks reklamowy, jeśli w ramce iframe reklamy w boksie zostanie aktywowana interwencja w zakresie obciążających reklam w Chrome.

Właściwości

---

Optional backForwardCache

backForwardCache?: boolean

Określa, czy GPT będzie automatycznie odświeżać aktywnie wyświetlany boks reklamowy, gdy strona zostanie przywrócona z pamięci podręcznej stanu strony internetowej. Wartość domyślna to true.

Przykład

JavaScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

JavaScript (starsza wersja)

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on
// back/forward cache restore.
googletag.setConfig({ autoRefresh: { backForwardCache: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

Zobacz też

• Pamięć podręczna stanu strony internetowej

---

Optional heavyAds

heavyAds?: boolean

Określa, czy GPT będzie automatycznie odświeżać boks reklamowy, jeśli w ramce iframe reklamy w boksie zostanie aktywowana interwencja w zakresie obciążających reklam w Chrome. Domyślna wartość to true.

Przykład

JavaScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

JavaScript (starsza wersja)

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration, disabling auto refresh on heavy
// ad intervention.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration, restoring to default behavior.
googletag.setConfig({ autoRefresh: null });

Zobacz też

• Interwencje Chrome dotyczące reklam obciążających zasoby

---

googletag.config.ContinueButtonConfig

Ustawienia umożliwiające skonfigurowanie działania przycisku Kontynuuj.

Właściwości
backgroundColor?	Kolor tła przycisku.
font?	Rodzina czcionek tekstu przycisku.
fontColor?	Kolor tekstu przycisku.
freqCapIntervalMinutes?	Interwał ograniczenia liczby wyświetleń w minutach.
targetId?	Identyfikator elementu HTML, na którym ma zostać wyrenderowany lub aktywowany przycisk kontynuacji.

Zobacz też

• SlotSettingsConfig.continueButton

Właściwości

---

Optional backgroundColor

backgroundColor?: string

Kolor tła przycisku.

Przykłady: 'blue', '#94B1FF'

---

Optional czcionka

font?: string

Rodzina czcionek tekstu przycisku.

Przykład: 'Arial'

---

Optional fontColor

fontColor?: string

Kolor tekstu przycisku.

Przykłady: 'white', '#B73B87'

---

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number

thought Interwał ograniczenia liczby wyświetleń w minutach.

Musi być liczbą całkowitą większą lub równą 1.

---

Optional targetId

targetId?: string

Identyfikator elementu HTML, na którym ma zostać wyrenderowany lub aktywowany przycisk kontynuacji.

---

googletag.config.InterstitialConfig

Obiekt, który definiuje zachowanie pojedynczego boksu reklamy pełnoekranowej.

Właściwości
requireStorageAccess?	Czy do wyświetlenia tej reklamy pełnoekranowej wymagana jest zgoda na dostęp do pamięci lokalnej.
triggers?	Konfiguracja aktywatora reklamy pełnoekranowej dla tej reklamy pełnoekranowej.

Właściwości

---

Optional requireStorageAccess

requireStorageAccess?: boolean

Określa, czy do wyświetlania tej reklamy pełnoekranowej wymagana jest zgoda na korzystanie z pamięci lokalnej.

GPT używa pamięci lokalnej do egzekwowania limitu wyświetleń na użytkownika w przypadku reklam pełnoekranowych. Jednak użytkownicy, którzy nie wyrazili zgody na korzystanie z pamięci lokalnej, nadal mogą widzieć reklamy pełnoekranowe. Ustawienie tej właściwości na true powoduje wyłączenie działania domyślnego i zapewnia, że reklamy pełnoekranowe będą wyświetlane tylko użytkownikom, którzy wyrazili zgodę na korzystanie z pamięci lokalnej.

Przykład

JavaScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

JavaScript (starsza wersja)

// Opt out of showing interstitials to users
// without local storage consent.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

TypeScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

Zobacz też

• Trafikowanie reklam pełnoekranowych w przeglądarce

---

Optional reguły

triggers?: Partial<Record<InterstitialTrigger, boolean>>

Konfiguracja reguły reklamy pełnoekranowej w przypadku tej reklamy pełnoekranowej.

Ustawienie wartości reguły reklamy pełnoekranowej na true spowoduje jej włączenie, a na false – wyłączenie. Spowoduje to zastąpienie wartości domyślnych skonfigurowanych w usłudze Google Ad Manager.

Przykład

JavaScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

JavaScript (starsza wersja)

// Define a GPT managed web interstitial ad slot.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
var enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

TypeScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

Zobacz też

• Wyświetlanie reklamy pełnoekranowej w przeglądarce

---

googletag.config.LazyLoadConfig

Ustawienia umożliwiające kontrolowanie korzystania z leniwego ładowania w GPT.

Właściwości
fetchMarginPercent?	Minimalna odległość boksu od bieżącego widocznego obszaru, jaką musi on osiągnąć, zanim wyślemy żądanie reklamy, wyrażona jako odsetek rozmiaru widocznego obszaru.
mobileScaling?	Mnożnik stosowany do marginesów na urządzeniach mobilnych.
renderMarginPercent?	Minimalna odległość boksu od bieżącego widocznego obszaru, jaką musi on osiągnąć, zanim wyrenderujemy reklamę, wyrażona jako odsetek rozmiaru widocznego obszaru.

Zobacz też

• PageSettingsConfig.lazyLoad

Właściwości

---

Optional fetchMarginPercent

fetchMarginPercent?: number

Minimalna odległość od bieżącego widocznego obszaru, w jakiej musi znajdować się boks, zanim wyślemy żądanie reklamy, wyrażona jako procent rozmiaru widocznego obszaru.

To ustawienie, używane w połączeniu z renderMarginPercent, umożliwia pobieranie z wyprzedzeniem reklamy, ale opóźnia renderowanie i pobieranie innych zasobów podrzędnych. Dlatego ta wartość powinna być zawsze większa niż renderMarginPercent lub jej równa.

Wartość 0 oznacza „gdy boks wejdzie do widocznego obszaru”, 100 oznacza „gdy reklama jest oddalona o 1 widoczny obszar” itd.

---

Optional mobileScaling

mobileScaling?: number

Mnożnik stosowany do marginesów na urządzeniach mobilnych. Ten mnożnik jest stosowany zarówno do fetchMarginPercent, jak i renderMarginPercent.

Umożliwia to stosowanie różnych marginesów na urządzeniach mobilnych i komputerach, na których rozmiary widocznego obszaru i szybkość przewijania mogą się różnić. Na przykład wartość 2,0 spowoduje pomnożenie wszystkich marginesów przez 2 na urządzeniach mobilnych, co zwiększy minimalną odległość, w jakiej boks może znajdować się od widocznego obszaru przed pobraniem i wyrenderowaniem.

---

Optional renderMarginPercent

renderMarginPercent?: number

Minimalna odległość od bieżącego widocznego obszaru, w jakiej musi znajdować się boks, zanim wyrenderujemy reklamę, wyrażona jako odsetek rozmiaru widocznego obszaru.

To ustawienie, używane w połączeniu z fetchMarginPercent, umożliwia wstępne pobranie reklamy, ale opóźnia renderowanie i pobieranie innych zasobów podrzędnych. Dlatego ta wartość powinna być zawsze mniejsza lub równa fetchMarginPercent.

Wartość 0 oznacza „gdy boks wejdzie do widocznego obszaru”, 100 oznacza „gdy reklama jest oddalona o 1 widoczny obszar” itd.

---

googletag.config.PageSettingsConfig

Główny interfejs konfiguracji ustawień na poziomie strony.

Umożliwia ustawienie wielu funkcji za pomocą jednego wywołania interfejsu API.

Wszystkie właściwości wymienione poniżej są przykładowe i nie odzwierciedlają rzeczywistych funkcji, które korzystają z setConfig. Zestaw funkcji znajdziesz w polach typu PageSettingsConfig poniżej.

Przykłady:

• Modyfikowane 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 metody 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 wyczyścić, przekazując null.

    // Configure features delta, golf, and hotel.
    googletag.setConfig({
        delta: {...},
        golf: {...},
        hotel: {...},
    });
  
    // Feature delta and hotel are cleared, but feature golf remains set.
    googletag.setConfig({
        delta: null,
        hotel: null,
    });

Właściwości
adExpansion?	Ustawienia umożliwiające kontrolowanie rozwijania reklam.
adsenseAttributes?	Ustawienie umożliwiające konfigurowanie atrybutów AdSense.
adYield?	Wycofano.
autoRefresh?	Ustawienie umożliwiające skonfigurowanie działania automatycznego odświeżania reklam.
categoryExclusion?	Ustawienie umożliwiające konfigurowanie wykluczeń kategorii reklam.
centering?	Ustawienie umożliwiające wyśrodkowanie reklam w poziomie.
collapseDiv?	Ustawienie umożliwiające kontrolowanie zachowania boksów reklamowych podczas zwijania.
disableInitialLoad?	Ustawienie określające, kiedy wysyłane są żądania reklam.
lazyLoad?	Ustawienia umożliwiające kontrolowanie korzystania z leniwego ładowania w GPT.
location?	Ustawienie kierowania geograficznego elementów zamówienia na położenia geograficzne.
pps?	Ustawienia umożliwiające kontrolowanie sygnałów dostarczanych przez wydawcę.
privacyTreatments?	Ustawienia umożliwiające kontrolowanie procedur wydawcy dotyczących prywatności.
requestHookTimeoutMs?	Ustawienie określające maksymalny czas, przez jaki GPT będzie czekać na zakończenie wszystkich zarejestrowanych punktów zaczepienia żądania, zanim przejdzie do żądania reklamy.
safeFrame?	Ustawienia umożliwiające kontrolowanie użycia SafeFrame w GPT.
singleRequest?	Ustawienie umożliwiające włączenie lub wyłączenie architektury z pojedynczym żądaniem (SRA).
targeting?	Ustawienie umożliwiające kontrolowanie kierowania na pary klucz-wartość.
threadYield?	Ustawienie określające, czy tag GPT powinien przekazywać wątek JS podczas żądania i renderowania kreacji.
videoAds?	Ustawienia do kontrolowania reklam wideo.

Właściwości

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Ustawienia umożliwiające kontrolowanie rozwijania reklam.

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Ustawienie umożliwiające skonfigurowanie atrybutów AdSense.

Atrybuty AdSense skonfigurowane za pomocą tego ustawienia będą stosowane do wszystkich boksów reklamowych na stronie. To ustawienie można wywołać wielokrotnie, aby zdefiniować wiele wartości atrybutów lub zastąpić istniejące wartości.

Zmiany atrybutów AdSense dotyczą tylko żądań reklam wysłanych po wywołaniu tej metody. Z tego powodu zalecamy wywołanie tej metody przed wszelkimi wywołaniami googletag.display lub PubAdsService.refresh.

Przykład

JavaScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

JavaScript (starsza wersja)

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

TypeScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

---

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Wycofane: zamiast tego użyj threadYield. Wkrótce zostanie usunięta.

---

Optional autoRefresh

autoRefresh?: AutoRefreshConfig

Ustawienie umożliwiające skonfigurowanie automatycznego odświeżania reklam.

Przykład

JavaScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

JavaScript (starsza wersja)

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

TypeScript

// Set the auto refresh configuration.
googletag.setConfig({ autoRefresh: { heavyAds: false } });

// Clear the auto refresh configuration.
googletag.setConfig({ autoRefresh: null });

---

Optional categoryExclusion

categoryExclusion?: string[]

Ustawienie umożliwiające konfigurowanie wykluczeń kategorii reklam.

Przykład

JavaScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

JavaScript (starsza wersja)

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

TypeScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

Zobacz też

• Etykiety własne do blokowania reklam

---

Optional wyśrodkowanie

centering?: boolean

Ustawienie umożliwiające wyśrodkowanie reklam w poziomie. Wyśrodkowanie jest domyślnie wyłączone.

Zmiany wyśrodkowania w poziomie dotyczą tylko reklam, których żądanie zostało wysłane po wywołaniu tej metody. Z tego powodu zalecamy wywołanie tej metody przed wszelkimi wywołaniami googletag.display lub PubAdsService.refresh.

Przykład

JavaScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

JavaScript (starsza wersja)

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

TypeScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Ustawienie umożliwiające kontrolowanie zachowania boksów reklamowych po zwinięciu.

Zwinięty boks reklamowy nie zajmuje miejsca na stronie.

Obsługiwane wartości:

• null (domyślna): boks nie zostanie zwinięty.
• DISABLED: boks nie zostanie zwinięty, niezależnie od tego, czy reklama zostanie zwrócona.
• BEFORE_FETCH: boks będzie początkowo zwinięty i rozwinie się, gdy zostanie zwrócona reklama.
• ON_NO_FILL: boks będzie początkowo rozwinięty, a jeśli nie zostanie zwrócona żadna reklama, zostanie zwinięty.

Przykład

JavaScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

JavaScript (starsza wersja)

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

TypeScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

Zobacz też

• Zwijanie pustych boksów reklamowych
• Minimalizowanie przesunięcia układu

---

Optional disableInitialLoad

disableInitialLoad?: boolean

Ustawienie określające, kiedy wysyłane są żądania reklam.

Domyślnie metoda googletag.display rejestruje boksy reklamowe i wysyła żądania reklam, które mają się w nich wyświetlać. Czasami jednak lepiej jest rozdzielić te działania, aby dokładniej kontrolować, kiedy treść reklamy jest wczytywana.

Po włączeniu tego ustawienia reklamy nie będą żądane w przypadku zarejestrowanych boksów, gdy zostanie wywołana metoda display(). Zamiast tego należy wykonać osobne wywołanie metody PubAdsService.refresh, aby zainicjować żądanie reklamy.

Tę metodę należy wywołać przed wywołaniem metody googletag.enableServices.

Przykład

JavaScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

JavaScript (starsza wersja)

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

TypeScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

Zobacz też

• Kontrolowanie wczytywania i odświeżania reklam
• Kontrolowanie grupowania w architekturze SRA

---

Optional lazyLoad

lazyLoad?: LazyLoadConfig

Ustawienia umożliwiające kontrolowanie leniwego ładowania w GPT.

Leniwe ładowanie to technika, która opóźnia wysyłanie żądań reklam i ich renderowanie do momentu, gdy znajdą się one w pobliżu widocznego obszaru użytkownika. Bardziej szczegółowy przykład znajdziesz w artykule o leniwym ładowaniu.

Uwaga: jeśli włączona jest funkcja singleRequest, leniwe pobieranie działa tylko wtedy, gdy wszystkie boksy znajdują się poza marginesem pobierania.

W przypadku wszystkich ustawień leniwego ładowania, które nie zostały określone podczas wywoływania funkcji setConfig(), zostanie użyta wartość domyślna ustawiona przez Google. Te ustawienia domyślne mogą się z czasem zmieniać. Aby wyłączyć określone ustawienie, ustaw wartość na null.

Przykład

JavaScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

JavaScript (starsza wersja)

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

TypeScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

Zobacz też

• Sprawdzone metody dotyczące reklam: nadawanie priorytetu „ważnym” boksom reklamowym
• Leniwe ładowanie

---

Optional lokalizacja

location?: string

Ustawienie umożliwiające kierowanie geograficzne elementów zamówienia na położenia geograficzne.

Przykład

JavaScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

JavaScript (starsza wersja)

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

TypeScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

Zobacz też

• Kierowanie na położenia geograficzne w celu wyświetlania

---

Optional pps

pps?: PublisherProvidedSignalsConfig

Ustawienia umożliwiające kontrolowanie sygnałów dostarczanych przez wydawcę.

---

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig

Ustawienia umożliwiające kontrolowanie procedur wydawcy dotyczących prywatności.

---

Optional Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"

Ustawienie określające maksymalny czas, przez jaki GPT będzie czekać na zakończenie wszystkich zarejestrowanych punktów zaczepienia żądania, zanim przejdzie do żądania reklamy.

Wszystkie zarejestrowane punkty zaczepienia żądania są wykonywane równolegle. Ten limit czasu określa górną granicę czasu, przez jaki proces żądania reklamy będzie wstrzymany podczas oczekiwania na zakończenie tych równoległych wykonań.

Obsługiwane wartości:

• Liczba dodatnia w milisekundach: niestandardowy okres oczekiwania.
• 'auto': GPT używa limitu czasu zoptymalizowanego przez Google.
• null: wyłącza limity czasu (GPT czeka bez ograniczeń czasowych na zakończenie działania punktów zaczepienia).

Przykład

JavaScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

JavaScript (starsza wersja)

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

TypeScript

// Set a 1000ms timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: 1000 });

// Use a Google-optimized timeout for request hooks.
googletag.setConfig({ requestHookTimeoutMs: "auto" });

// Clear the timeout.
googletag.setConfig({ requestHookTimeoutMs: null });

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Ustawienia umożliwiające kontrolowanie użycia SafeFrame w GPT.

Wartości skonfigurowane za pomocą tego ustawienia będą stosowane do wszystkich boksów reklamowych na stronie. Poszczególne boksy reklamowe mogą zastępować te wartości za pomocą SlotSettingsConfig.safeFrame.

Przykład

JavaScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

JavaScript (starsza wersja)

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

TypeScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

---

Optional singleRequest

singleRequest?: boolean

Ustawienie umożliwiające włączenie lub wyłączenie architektury z pojedynczym żądaniem (SRA).

Gdy architektura SRA jest włączona, wszystkie boksy reklamowe zdefiniowane przed wywołaniem googletag.display lub PubAdsService.refresh zostaną połączone w jedno żądanie reklamy. Zapewnia to korzyści związane ze skutecznością, ale jest też niezbędne do prawidłowego działania reklam na wyłączność i wykluczeń konkurencji.

Gdy architektura SRA jest wyłączona, żądania są wysyłane osobno dla każdego boksu reklamowego. Jest to domyślne działanie GPT.

Tę metodę należy wywołać przed wywołaniem googletag.enableServices.

Przykład

JavaScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

JavaScript (starsza wersja)

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

TypeScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

Zobacz też

• Informacje o reklamach na wyłączność
• Sprawdzone metody dotyczące reklam: prawidłowe korzystanie z architektury z pojedynczym żądaniem
• Kontrolowanie grupowania w architekturze SRA

---

Optional kierowanie

targeting?: Record<string, string | string[]>

Ustawienie umożliwiające kontrolowanie kierowania na pary klucz-wartość.

Kierowanie skonfigurowane za pomocą tego ustawienia będzie stosowane do wszystkich boksów reklamowych na stronie. To ustawienie można wywołać wielokrotnie, aby zdefiniować wiele par klucz-wartość kierowania lub zastąpić istniejące wartości. Klucze kierowania są definiowane na koncie Google Ad Managera.

Przykład

JavaScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

JavaScript (starsza wersja)

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

TypeScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

Zobacz też

• Kierowanie na pary klucz-wartość

---

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Ustawienie określające, czy GPT powinien przekazywać wątek JS podczas żądania i renderowania kreacji.

GPT będzie przekazywać wątek tylko w przypadku przeglądarek, które obsługują interfejs API Scheduler.postTask lub Scheduler.yield.

Obsługiwane wartości:

• null (domyślna): GPT będzie przekazywać wątek JS w przypadku boksów poza widocznym obszarem.
• ENABLED_ALL_SLOTS: GPT będzie przekazywać wątek JS w przypadku wszystkich boksów, niezależnie od tego, czy dany boks znajduje się w widocznym obszarze.
• DISABLED: GPT nie będzie przekazywać 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ż

• Scheduler

---

Optional videoAds

videoAds?: VideoAdsConfig

Ustawienia umożliwiające kontrolowanie reklam wideo.

Przykład

JavaScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

JavaScript (starsza wersja)

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

TypeScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

Zobacz też

• Przetwarzanie treści wideo

---

googletag.config.PrivacyTreatmentsConfig

Ustawienia umożliwiające kontrolowanie procedur wydawcy dotyczących prywatności.

Właściwości
treatments	Tablica opcji respektowania prywatności przez wydawcę, które mają zostać włączone.

Właściwości

---

treatments

treatments: "disablePersonalization"[]

Tablica ustawień Publisher Privacy Treatment, które mają zostać włączone.

Przykład

JavaScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

JavaScript (starsza wersja)

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

TypeScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

---

googletag.config.PublisherProvidedSignalsConfig

Obiekt konfiguracji sygnałów dostarczanych przez wydawcę.

Właściwości
taxonomies	Obiekt zawierający mapowania taksonomii lub wartość null, aby wyczyścić konfigurację.

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'
    },
  },
});

Zobacz też

• Sygnały dostarczane przez wydawcę (beta)
• Taksonomia odbiorców IAB 1.1
• Taksonomia treści IAB w wersji 2.2

Właściwości

---

taxonomies

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Obiekt zawierający mapowania taksonomii lub wartość null, aby wyczyścić konfigurację.

---

googletag.config.SafeFrameConfig

Ustawienia umożliwiające kontrolowanie SafeFrame w GPT.

Właściwości
allowOverlayExpansion?	Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez nakładanie jej na treść strony.
allowPushExpansion?	Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez przesuwanie treści strony.
forceSafeFrame?	Określa, czy reklamy mają być renderowane przy użyciu kontenera SafeFrame.
sandbox?	Określa, czy SafeFrame ma używać atrybutu sandbox HTML5, aby zapobiegać nawigacji na najwyższym poziomie bez interakcji użytkownika.
useUniqueDomain?	Wycofano. Określa, czy SafeFrame ma używać losowych subdomen w przypadku kreacji z rezerwacji.

Zobacz też

• PageSettingsConfig.safeFrame
• SlotSettingsConfig.safeFrame

Właściwości

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez nakładanie jej na treść strony.

---

Optional allowPushExpansion

allowPushExpansion?: boolean

Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez przesuwanie treści strony.

---

Optional forceSafeFrame

forceSafeFrame?: boolean

Określa, czy reklamy mają być renderowane przy użyciu kontenera SafeFrame.

---

Optional piaskownica

sandbox?: boolean

Określa, czy SafeFrame ma używać atrybutu sandbox HTML5, aby zapobiegać 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 sandbox wyłącza wtyczki (np. Flash).

---

Optional useUniqueDomain

useUniqueDomain?: boolean

Określa, czy SafeFrame ma używać losowych subdomen w przypadku kreacji z rezerwacji. Przekaż null, aby wyczyścić zapisaną wartość.

Uwaga: ta funkcja jest domyślnie włączona.

Wycofana: nie można już wyłączyć tej funkcji. Ustawienie useUniqueDomain nie ma zastosowania.

Zobacz też

• Renderowanie kreacji przy użyciu SafeFrame

---

googletag.config.SlotSettingsConfig

Główny interfejs konfiguracji ustawień na poziomie boksu.

Umożliwia ustawienie wielu funkcji za pomocą jednego wywołania interfejsu API dla pojedynczego boksu.

Wszystkie wymienione poniżej właściwości są przykładowe i nie odzwierciedlają rzeczywistych funkcji, które wykorzystują setConfig. Zestaw funkcji znajdziesz w polach typu 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 przy każdym wywołaniu metody Slot.setConfig.

    // Configure feature charlie to echo = 1, foxtrot = true.
    slot.setConfig({
        charlie: {
            echo: 1,
            foxtrot: true,
        }
    });
  
    // Update feature charlie to echo = 2. Since foxtrot was not specified,
    // the value is cleared.
    slot.setConfig({
        charlie: {
            echo: 2
        }
    });

• Wszystkie ustawienia funkcji można wyczyścić, przekazując null.

    // Configure features delta, golf, and hotel.
    slot.setConfig({
        delta: {...},
        golf: {...},
        hotel: {...},
    });
  
    // Feature delta and hotel are cleared, but feature golf remains set.
    slot.setConfig({
        delta: null,
        hotel: null,
    });

Właściwości
adExpansion?	Ustawienia umożliwiające skonfigurowanie rozwijania reklam.
adsenseAttributes?	Ustawienie umożliwiające konfigurowanie atrybutów AdSense.
categoryExclusion?	Ustawienie umożliwiające konfigurowanie wykluczeń kategorii reklam.
clickUrl?	Ustawienie umożliwiające skonfigurowanie adresu URL, na który użytkownicy będą przekierowywani po kliknięciu reklamy.
collapseDiv?	Ustawienie umożliwiające skonfigurowanie zachowania boksu reklamowego podczas zwijania.
continueButton?	Ustawienia umożliwiające skonfigurowanie działania przycisku Kontynuuj w przypadku reklam w trakcie pauzy.
interstitial?	Ustawienia, które konfigurują działanie boksu reklamy pełnoekranowej.
safeFrame?	Ustawienia umożliwiające skonfigurowanie użycia SafeFrame w GPT.
targeting?	Ustawienie umożliwiające skonfigurowanie kierowania na pary klucz-wartość.

Właściwości

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Ustawienia umożliwiające skonfigurowanie rozwijania reklam.

Zobacz też

• Rozwijanie reklamy

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Ustawienie umożliwiające konfigurowanie atrybutów AdSense.

Atrybuty AdSense skonfigurowane za pomocą tego ustawienia będą stosowane tylko do boksu reklamowego. To ustawienie można wywołać wielokrotnie, aby zdefiniować wiele wartości atrybutów lub zastąpić istniejące wartości.

Zmiany atrybutów AdSense dotyczą tylko żądań reklam wysłanych po wywołaniu tej metody. Z tego powodu zalecamy wywołanie tej metody przed wszelkimi wywołaniami googletag.display lub PubAdsService.refresh.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

---

Optional categoryExclusion

categoryExclusion?: string[]

Ustawienie umożliwiające konfigurowanie wykluczeń kategorii reklam.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

Zobacz też

• Etykiety własne do blokowania reklam

---

Optional clickUrl

clickUrl?: string

Ustawienie umożliwiające skonfigurowanie adresu URL, na który użytkownicy będą przekierowywani po kliknięciu reklamy.

Serwery Google Ad Managera nadal rejestrują kliknięcie, nawet jeśli klikany URL zostanie zastąpiony. Do podanej wartości dołączany jest adres URL strony docelowej powiązany z wyświetlaną kreacją. Ustawienie tej wartości więcej niż raz spowoduje zastąpienie wcześniej skonfigurowanej wartości. null spowoduje wyczyszczenie wartości.

Uwaga: to ustawienie dotyczy tylko żądań innych niż SRA.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Ustawienie umożliwiające skonfigurowanie zachowania zwijania boksu reklamowego.

Zwinięty boks reklamowy nie zajmuje miejsca na stronie.

Obsługiwane wartości:

• null (domyślna): boks nie zostanie zwinięty.
• DISABLED: boks nie zostanie zwinięty, niezależnie od tego, czy reklama zostanie zwrócona.
• BEFORE_FETCH: boks będzie początkowo zwinięty i rozwinie się, gdy zostanie zwrócona reklama.
• ON_NO_FILL: boks będzie początkowo rozwinięty, a jeśli nie zostanie zwrócona żadna reklama, zostanie zwinięty.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

Zobacz też

• Zwijanie pustych boksów reklamowych
• Minimalizowanie przesunięcia układu

---

Optional continueButton

continueButton?: ContinueButtonConfig

Ustawienia umożliwiające skonfigurowanie działania przycisku kontynuacji w przypadku reklam w trakcie pauzy.

Te ustawienia umożliwiają dostosowanie wyglądu i działania interakcji związanych z wyjściem i kontynuowaniem czytania, które są powiązane z formatami reklam w trakcie pauzy.

W przypadku wszystkich ustawień przycisku kontynuacji, które nie zostały określone podczas wywoływania setConfig(), zostanie użyta wartość domyślna ustawiona przez Google.

Aby wyłączyć lub wyczyścić wszystkie ustawienia przycisku kontynuacji, przekaż null.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

---

Optional reklama pełnoekranowa

interstitial?: InterstitialConfig

Ustawienia, które konfigurują zachowanie boksu reklamy pełnoekranowej.

Zobacz też

• Trafikowanie reklam pełnoekranowych w przeglądarce

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Ustawienia umożliwiające skonfigurowanie użycia SafeFrame w GPT.

Wartości skonfigurowane za pomocą tego ustawienia będą stosowane tylko do boksu reklamowego i będą zastępować wartości ustawione za pomocą PageSettingsConfig.safeFrame.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

---

Optional kierowanie

targeting?: Record<string, string | string[]>

Ustawienie umożliwiające skonfigurowanie kierowania na pary klucz-wartość.

Kierowanie skonfigurowane za pomocą tego ustawienia będzie stosowane tylko do boksu reklamowego. To ustawienie można wywołać wielokrotnie, aby zdefiniować wiele par klucz-wartość kierowania lub zastąpić istniejące wartości. Klucze kierowania są definiowane na koncie Google Ad Managera.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

Zobacz też

• Kierowanie na pary klucz-wartość

---

googletag.config.TaxonomyData

Obiekt zawierający wartości dla pojedynczej mapy kategorii.

Właściwości
values	Lista wartości taksonomii.

Właściwości

---

values

values: readonly string[]

Lista wartości taksonomii.

---

googletag.config.VideoAdsConfig

Ustawienia umożliwiające skonfigurowanie ustawień związanych z reklamami wideo.

Właściwości
enableVideoAds	Czy na stronie będą wyświetlane reklamy wideo.
videoCmsId?	Identyfikator źródła treści wideo.
videoContentId?	Identyfikator treści wideo.

Zobacz też

• PageSettingsConfig.videoAds

Właściwości

---

enableVideoAds

enableVideoAds: boolean

Określa, czy na stronie będą wyświetlane reklamy wideo.

Jeśli ustawisz wartość true, włączysz ograniczenia dotyczące wykluczania treści w reklamach displayowych i wideo.

Jeśli treść wideo jest znana, ustaw parametry videoContentId i videoCmsId na wartości podane w usłudze przetwarzania treści Google Ad Managera, aby korzystać z wykluczania treści w reklamach displayowych.

---

Optional videoCmsId

videoCmsId?: string

Identyfikator źródła treści wideo.

Jest to unikalna wartość przypisana przez usługę przetwarzania treści Google Ad Managera, która identyfikuje źródło treści wideo określone przez videoContentId.

Zobacz też

• cmsid (Identyfikator źródła treści)

---

Optional videoContentId

videoContentId?: string

Identyfikator treści wideo.

Jest to unikalna wartość, która identyfikuje konkretny film ze źródła treści określonego przez parametr videoCmsId. Jest ona przypisywana przez system CMS, który hostuje Twoje treści wideo.

Zobacz też

• vid (Identyfikator filmu)

---

googletag.enums

Jest to przestrzeń nazw, której GPT używa w przypadku typów wyliczeniowych.

Wyliczenia
OutOfPageFormat	Formaty poza stroną obsługiwane przez GPT.
TagForAgeTreatment	Ustawienia traktowania treści z uwzględnieniem wieku obsługiwane przez GPT.
TrafficSource	Źródła wizyt obsługiwane przez GPT.

Wyliczenia

---

OutOfPageFormat

OutOfPageFormat

Formaty poza stroną obsługiwane przez GPT.

Zobacz też

• defineOutOfPageSlot

Elementy wyliczenia
AD_INTENTS	Format reklamy związany z intencjami.
BOTTOM_ANCHOR	Format zakotwiczony, w którym boks jest przyklejony do dołu widocznego obszaru.
GAME_MANUAL_INTERSTITIAL	Format ręcznie wywoływanej reklamy pełnoekranowej w grze. Uwaga: ręcznie wywoływana reklama pełnoekranowa w grze to format z ograniczonym dostępem.
INTERSTITIAL	Format kreacji pełnoekranowej w przeglądarce.
LEFT_SIDE_RAIL	Format reklamy w lewej kolumnie bocznej.
REWARDED	Format z nagrodą.
RIGHT_SIDE_RAIL	Format reklamy w prawej kolumnie bocznej.
TOP_ANCHOR	Format zakotwiczony, w którym boks jest przyklejony do góry widocznego obszaru.

---

TagForAgeTreatment

TagForAgeTreatment

Ustawienia traktowania ze względu na wiek obsługiwane przez GPT.

Zobacz też

• PrivacySettingsConfig.tagForAgeTreatment

Elementy wyliczenia
CHILD	Wskazuje, że żądania reklamy powinny być traktowane jako treści skierowane do dzieci.
TEEN	Wskazuje, że żądania reklamy powinny być traktowane jako dotyczące treści skierowanych do nastolatków.
UNSPECIFIED	Wartość domyślna. Wskazuje, że do żądania reklamy nie ma zastosowania żaden konkretny sygnał dotyczący przetwarzania z ograniczeniami wiekowymi.

---

TrafficSource

TrafficSource

Źródła wizyt obsługiwane przez GPT.

Zobacz też

• PrivacySettingsConfig.trafficSource

Elementy wyliczenia
ORGANIC	bezpośrednie wpisywanie adresu URL, wyszukiwanie w witrynie lub pobieranie aplikacji.
PURCHASED	Ruch przekierowywany z usług innych firm (przez pozyskanie lub w wyniku innego działania stanowiącego zachętę).

---

googletag.events

Jest to przestrzeń nazw, której GPT używa do zdarzeń. Twój kod może reagować na te zdarzenia za pomocą funkcji Service.addEventListener.

Interfejsy
Event	Interfejs podstawowy dla wszystkich zdarzeń GPT.
EventTypeMap	Jest to pseudotyp, który mapuje nazwę zdarzenia na odpowiadający mu typ obiektu zdarzenia dla Service.addEventListener i Service.removeEventListener.
GameManualInterstitialSlotClosedEvent	To zdarzenie jest wywoływane, gdy użytkownik zamknie boks ręcznej reklamy pełnoekranowej w grze.
GameManualInterstitialSlotReadyEvent	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.
ImpressionViewableEvent	To zdarzenie jest wywoływane, gdy wyświetlenie staje się widoczne zgodnie z kryteriami Widoku aktywnego.
RewardedSlotClosedEvent	To zdarzenie jest wywoływane, gdy użytkownik zamknie boks reklamowy z reklamą z nagrodą.
RewardedSlotGrantedEvent	To zdarzenie jest wywoływane, gdy użytkownik otrzymuje nagrodę za obejrzenie reklamy z nagrodą.
RewardedSlotReadyEvent	To zdarzenie jest wywoływane, gdy reklama z nagrodą jest gotowa do wyświetlenia.
RewardedSlotVideoCompletedEvent	To zdarzenie jest wywoływane po zakończeniu odtwarzania reklamy wideo z nagrodą.
SlotOnloadEvent	To zdarzenie jest wywoływane, gdy element iframe kreacji wywołuje zdarzenie wczytywania.
SlotRenderEndedEvent	To zdarzenie jest wywoływane, gdy kod kreacji jest wstrzykiwany do boksu.
SlotRequestedEvent	To zdarzenie jest wywoływane, gdy żądana jest reklama do określonego boksu.
SlotResponseReceived	To zdarzenie jest wywoływane, gdy zostanie odebrana odpowiedź na reklamę dla określonego boksu.
SlotVisibilityChangedEvent	To zdarzenie jest wywoływane, gdy zmienia się procent obszaru boksu reklamowego widocznego na ekranie.

---

googletag.events.Event

Interfejs podstawowy dla wszystkich zdarzeń GPT. Wszystkie zdarzenia GPT poniżej będą zawierać te pola.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie.
slot	Boks, który wywołał zdarzenie.

Zobacz też

• Detektory zdarzeń reklamowych

Właściwości

---

serviceName

serviceName: string

Nazwa usługi, która wywołała zdarzenie.

---

slot

slot: Slot

Boks, który wywołał zdarzenie.

---

googletag.events.EventTypeMap

Jest to pseudotyp, który mapuje nazwę zdarzenia na odpowiadający mu typ obiektu zdarzenia dla funkcji Service.addEventListener i Service.removeEventListener. Jest on udokumentowany tylko do celów referencyjnych i związanych z zabezpieczeniami wpisywania.

Właściwości
gameManualInterstitialSlotClosed	Alias dla events.GameManualInterstitialSlotClosedEvent.
gameManualInterstitialSlotReady	Alias dla events.GameManualInterstitialSlotReadyEvent.
impressionViewable	Alias dla events.ImpressionViewableEvent.
rewardedSlotClosed	Alias dla events.RewardedSlotClosedEvent.
rewardedSlotGranted	Alias dla events.RewardedSlotGrantedEvent.
rewardedSlotReady	Alias dla events.RewardedSlotReadyEvent.
rewardedSlotVideoCompleted	Alias dla events.RewardedSlotVideoCompletedEvent.
slotOnload	Alias dla events.SlotOnloadEvent.
slotRenderEnded	Alias dla events.SlotRenderEndedEvent.
slotRequested	Alias dla events.SlotRequestedEvent.
slotResponseReceived	Alias dla events.SlotResponseReceived.
slotVisibilityChanged	Alias dla events.SlotVisibilityChangedEvent.

Właściwości

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Alias dla events.GameManualInterstitialSlotClosedEvent.

---

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Alias dla events.GameManualInterstitialSlotReadyEvent.

---

impressionViewable

impressionViewable: ImpressionViewableEvent

Alias dla events.ImpressionViewableEvent.

---

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Alias dla events.RewardedSlotClosedEvent.

---

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

Alias dla events.RewardedSlotGrantedEvent.

---

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

Alias dla events.RewardedSlotReadyEvent.

---

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent

Alias dla events.RewardedSlotVideoCompletedEvent.

---

slotOnload

slotOnload: SlotOnloadEvent

Alias dla events.SlotOnloadEvent.

---

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

Alias dla events.SlotRenderEndedEvent.

---

slotRequested

slotRequested: SlotRequestedEvent

Alias dla events.SlotRequestedEvent.

---

slotResponseReceived

slotResponseReceived: SlotResponseReceived

Alias dla events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Alias dla events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy użytkownik zamknie boks ręcznej reklamy pełnoekranowej w grze.

Uwaga: ręczna reklama pełnoekranowa w grze to format o ograniczonym dostępie.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

Przykład

JavaScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  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 interstitial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  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 interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  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.
    }
  });
}

Zobacz też

• Detektory zdarzeń reklamowych
• Wyświetlanie reklamy pełnoekranowej z ręczną konfiguracją w grze

---

googletag.events.GameManualInterstitialSlotReadyEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy boks reklamy pełnoekranowej konfigurowanej ręcznie w grze jest gotowy do wyświetlenia użytkownikowi.

Uwaga: reklama pełnoekranowa konfigurowana ręcznie w grze to format z ograniczonym dostępem.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

Metody
makeGameManualInterstitialVisible	Wyświetla użytkownikowi reklamę pełnoekranową konfigurowaną ręcznie 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,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  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,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  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,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  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.
    }
  });
}

Zobacz też

• Detektory zdarzeń reklamowych
• Wyświetlanie reklamy pełnoekranowej z ręczną konfiguracją w grze

Metody

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean

Wyświetla użytkownikowi reklamę pełnoekranową konfigurowaną ręcznie w grze. Zwraca informację, czy reklama została wyświetlona.

Zwroty
boolean

---

googletag.events.ImpressionViewableEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy wyświetlenie staje się widoczne zgodnie z kryteriami Widoku aktywnego.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

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ż

• Detektory zdarzeń reklamowych

---

googletag.events.RewardedSlotClosedEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy użytkownik zamknie boks reklamowy z reklamą z nagrodą. Może zostać wywołane przed przyznaniem nagrody lub po nim. Aby sprawdzić, czy nagroda została przyznana, użyj zdarzenia events.RewardedSlotGrantedEvent.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

Przykład

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  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)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  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

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Zobacz też

• Detektory zdarzeń reklamowych
• Wyświetlanie reklamy z nagrodą

---

googletag.events.RewardedSlotGrantedEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy użytkownik otrzymuje nagrodę za obejrzenie reklamy z nagrodą. Jeśli reklama zostanie zamknięta przed spełnieniem kryteriów przyznania nagrody, to zdarzenie nie zostanie wywołane.

Właściwości
payload	Obiekt zawierający informacje o przyznanej nagrodzie.
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

Przykład

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Zobacz też

• Detektory zdarzeń reklamowych
• Wyświetlanie reklamy z nagrodą

Właściwości

---

payload

payload: RewardedPayload

Obiekt zawierający informacje o przyznanej nagrodzie.

---

googletag.events.RewardedSlotReadyEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy reklama z nagrodą jest gotowa do wyświetlenia. Wydawca odpowiada za wyświetlenie użytkownikowi opcji obejrzenia reklamy przed jej wyświetleniem.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

Metody
makeRewardedVisible	Wyświetla reklamę z nagrodą.

Przykład

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  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.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    const userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Zobacz też

• Detektory zdarzeń reklamowych
• Wyświetlanie reklamy z nagrodą

Metody

---

makeRewardedVisible

makeRewardedVisible(): boolean

Wyświetla reklamę z nagrodą. Tej metody nie należy wywoływać, dopóki użytkownik nie wyrazi zgody na wyświetlenie reklamy.

Zwroty
boolean	Czy reklama z nagrodą została wyświetlona.

---

googletag.events.RewardedSlotVideoCompletedEvent

Rozszerza Event

To zdarzenie jest wywoływane po zakończeniu odtwarzania reklamy wideo z nagrodą.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

Przykład

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (starsza wersja)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", function (event) {
    var slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

Zobacz też

• Detektory zdarzeń reklamowych
• Wyświetlanie reklamy z nagrodą

---

googletag.events.SlotOnloadEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy element iframe kreacji wywołuje zdarzenie wczytywania. Podczas renderowania reklam multimedialnych w trybie renderowania synchronicznego nie jest używana ramka iframe, więc zdarzenie SlotOnloadEvent nie zostanie wywołane.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

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ż

• Detektory zdarzeń reklamowych

---

googletag.events.SlotRenderEndedEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy kod kreacji jest wstrzykiwany do boksu. To zdarzenie wystąpi przed pobraniem zasobów kreacji, więc kreacja może nie być jeszcze widoczna. Jeśli chcesz wiedzieć, kiedy wszystkie zasoby kreacji w boksie zostały wczytane, użyj zdarzenia events.SlotOnloadEvent.

Właściwości
advertiserId	Identyfikator reklamodawcy wyrenderowanej reklamy.
campaignId	Identyfikator kampanii wyrenderowanej reklamy.
companyIds	Identyfikatory firm, które licytowały wyrenderowaną reklamę zapasową.
creativeId	Identyfikator kreacji wyrenderowanej reklamy z rezerwacji.
creativeTemplateId	Identyfikator szablonu kreacji wyrenderowanej reklamy z rezerwacji.
isBackfill	Czy reklama była reklamą zapasową.
isEmpty	Czy w przypadku boksu została zwrócona reklama.
labelIds	Wycofano.
lineItemId	Identyfikator elementu zamówienia wyrenderowanej reklamy z rezerwacji.
responseIdentifier	Identyfikator odpowiedzi to unikalny identyfikator odpowiedzi na żądanie reklamy.
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
size	Wskazuje rozmiar wyrenderowanej kreacji w pikselach.
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot
slotContentChanged	Czy zawartość boksu została zmieniona przez wyrenderowaną reklamę.
sourceAgnosticCreativeId	Identyfikator kreacji wyrenderowanej reklamy z rezerwacji lub reklamy zapasowej.
sourceAgnosticLineItemId	Identyfikator elementu zamówienia wyrenderowanej reklamy z rezerwacji lub reklamy zapasowej.
yieldGroupIds	Identyfikatory grup zysku dla wyrenderowanej reklamy zapasowej.

Przykład

JavaScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("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ż

• Detektory zdarzeń reklamowych

Właściwości

---

advertiserId

advertiserId: number

Identyfikator reklamodawcy wyrenderowanej reklamy. Wartość wynosi null w przypadku pustych boksów, reklam zapasowych i kreacji renderowanych przez usługi inne niż PubAdsService.

---

campaignId

campaignId: number

Identyfikator kampanii wyrenderowanej reklamy. Wartość wynosi null w przypadku pustych boksów, reklam zapasowych i kreacji renderowanych przez usługi inne niż PubAdsService.

---

companyIds

companyIds: number[]

Identyfikatory firm, które licytowały wyrenderowaną reklamę zapasową. Wartość wynosi null w przypadku pustych boksów, reklam z rezerwacji i kreacji renderowanych przez usługi inne niż PubAdsService.

---

creativeId

creativeId: number

Identyfikator kreacji wyrenderowanej reklamy z rezerwacji. Wartość wynosi null w przypadku pustych boksów, reklam zapasowych i kreacji renderowanych przez usługi inne niż PubAdsService.

---

creativeTemplateId

creativeTemplateId: number

Identyfikator szablonu kreacji wyrenderowanej reklamy z rezerwacji. Wartość wynosi null w przypadku pustych boksów, reklam zapasowych i kreacji renderowanych przez usługi inne niż PubAdsService.

---

isBackfill

isBackfill: boolean

Czy reklama była reklamą zapasową. Wartość true, jeśli reklama była reklamą zapasową, w przeciwnym razie false.

---

isEmpty

isEmpty: boolean

Czy w przypadku boksu została zwrócona reklama. Wartość wynosi true, jeśli nie została zwrócona żadna reklama, lub false w przeciwnym razie.

---

labelIds

labelIds: number[]

Wycofane: to pole nie jest już wypełniane.

---

lineItemId

lineItemId: number

Identyfikator elementu zamówienia wyrenderowanej reklamy z rezerwacji. Wartość wynosi null w przypadku pustych boksów, reklam zapasowych i kreacji renderowanych przez usługi inne niż PubAdsService.

---

responseIdentifier

responseIdentifier: string

Identyfikator odpowiedzi to unikalny identyfikator odpowiedzi na żądanie reklamy. Możesz użyć tej wartości do zidentyfikowania i zablokowania reklamy w Centrum oceny reklam.

---

size

size: string | number[]

Wskazuje rozmiar wyrenderowanej kreacji w pikselach. Przykład: [728, 90]. Wartość null oznacza puste boksy reklamowe.

---

slotContentChanged

slotContentChanged: boolean

Czy zawartość boksu została zmieniona przez wyrenderowaną reklamę. Wartość to true, jeśli treść została zmieniona, lub false w przeciwnym razie.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number

Identyfikator kreacji wyrenderowanej reklamy z rezerwacji lub reklamy zapasowej. Wartość wynosi null, jeśli reklama nie jest rezerwacją ani elementem zamówienia typu uzupełnianie lub kreacja jest renderowana przez usługi inne niż PubAdsService.

---

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number

Identyfikator elementu zamówienia wyrenderowanej reklamy z rezerwacji lub reklamy zapasowej. Wartość wynosi null, jeśli reklama nie jest rezerwacją ani elementem zamówienia typu uzupełnianie lub kreacja jest renderowana przez usługi inne niż PubAdsService.

---

yieldGroupIds

yieldGroupIds: number[]

Identyfikatory grup zysku dla wyrenderowanej reklamy zapasowej. Wartość wynosi null w przypadku pustych boksów, reklam z rezerwacji i kreacji renderowanych przez usługi inne niż PubAdsService.

---

googletag.events.SlotRequestedEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy żądana jest reklama do określonego boksu.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

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ż

• Detektory zdarzeń reklamowych

---

googletag.events.SlotResponseReceived

Rozszerza Event

To zdarzenie jest wywoływane, gdy zostanie odebrana odpowiedź na reklamę dla określonego boksu.

Właściwości
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

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ż

• Detektory zdarzeń reklamowych

---

googletag.events.SlotVisibilityChangedEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy zmienia się procent obszaru boksu reklamowego widocznego na ekranie. Zdarzenie jest ograniczane i nie będzie wywoływane częściej niż raz na 200 ms.

Właściwości
inViewPercentage	Procent widocznego obszaru reklamy.
serviceName	Nazwa usługi, która wywołała zdarzenie. Odziedziczone z usługi Event.serviceName
slot	Boks, który wywołał zdarzenie. Odziedziczone z usługi Event.slot

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ż

• Detektory zdarzeń reklamowych

Właściwości

---

inViewPercentage

inViewPercentage: number

Procent widocznego obszaru reklamy. Wartość jest liczbą od 0 do 100.

---

googletag.secureSignals

Jest to przestrzeń nazw, której GPT używa do zarządzania bezpiecznymi sygnałami.

Interfejsy
BidderSignalProvider	Zwraca bezpieczny sygnał dla określonego licytującego.
PublisherSignalProvider	Zwraca bezpieczny sygnał dla konkretnego wydawcy.
SecureSignalProvidersArray	Interfejs do zarządzania bezpiecznymi sygnałami.

Aliasy typu
SecureSignalProvider	Interfejs do zwracania bezpiecznego sygnału dla określonego licytującego lub dostawcy.

Aliasy typu

---

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

Interfejs do zwracania bezpiecznego sygnału dla określonego licytującego lub dostawcy. Należy podać wartość id lub networkCode, ale nie obie.

---

googletag.secureSignals.BidderSignalProvider

Zwraca bezpieczny sygnał dla określonego licytującego.

Dostawca bezpiecznych sygnałów licytującego składa się z 2 części:

1. Funkcja kolektora, która zwraca obiekt Promise prowadzący do bezpiecznego sygnału.
2. id, który identyfikuje licytującego powiązanego z sygnałem.

Aby zwrócić bezpieczny sygnał dla wydawcy, użyj secureSignals.PublisherSignalProvider.

Właściwości
collectorFunction	Funkcja, która zwraca obiekt Promise, który jest rozpoznawany jako bezpieczny sygnał.
id	Unikalny identyfikator modułu zbierającego powiązanego z tym bezpiecznym sygnałem, zarejestrowany w usłudze Google Ad Manager.

Przykład

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (starsza wersja)

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

Zobacz też

• Udostępnianie bezpiecznych sygnałów licytującym

Właściwości

---

collectorFunction

collectorFunction: (() => Promise<string>)

Funkcja, która zwraca obiekt Promise, który jest rozpoznawany jako bezpieczny sygnał.

---

id

id: string

Unikalny identyfikator modułu zbierającego powiązanego z tym bezpiecznym sygnałem, zarejestrowany w usłudze Google Ad Manager.

---

googletag.secureSignals.PublisherSignalProvider

Zwraca bezpieczny sygnał dla konkretnego wydawcy.

Dostawca sygnałów wydawcy składa się z 2 części:

1. Funkcja kolektora, która zwraca obiekt Promise prowadzący do bezpiecznego sygnału.
2. networkCode, który identyfikuje wydawcę powiązanego z sygnałem.

Aby zwrócić bezpieczny sygnał dla licytującego, użyj interfejsu secureSignals.BidderSignalProvider.

Właściwości
collectorFunction	Funkcja, która zwraca obiekt Promise, który jest rozpoznawany jako bezpieczny sygnał.
networkCode	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");
  },
});

Zobacz też

• Udostępnianie bezpiecznych sygnałów licytującym

Właściwości

---

collectorFunction

collectorFunction: (() => Promise<string>)

Funkcja, która zwraca obiekt Promise, który jest rozpoznawany jako bezpieczny sygnał.

---

networkCode

networkCode: string

Kod sieci (widoczny w ścieżce jednostki reklamowej) wydawcy powiązanego z tym bezpiecznym sygnałem.

---

googletag.secureSignals.SecureSignalProvidersArray

Interfejs do zarządzania bezpiecznymi sygnałami.

Metody
clearAllCache	Usuwa z pamięci podręcznej wszystkie sygnały dotyczące wszystkich modułów zbierających.
push	Dodaje nowy obiekt secureSignals.SecureSignalProvider do tablicy dostawców sygnałów i rozpoczyna proces generowania sygnałów.

Metody

---

clearAllCache

clearAllCache(): void

Usuwa z pamięci podręcznej wszystkie sygnały ze wszystkich modułów zbierających.

Wywoływanie tej metody może zmniejszyć prawdopodobieństwo uwzględnienia sygnałów w żądaniach reklamy w przypadku bieżących i przyszłych wyświetleń strony. Z tego powodu należy wywoływać ją tylko wtedy, gdy stan ulega istotnym zmianom, np. w przypadku zdarzeń wskazujących na nowego użytkownika (logowanie się, wylogowywanie się, rejestrowanie się itp.).

---

push

push(provider: SecureSignalProvider): void

Dodaje nowy obiekt secureSignals.SecureSignalProvider do tablicy dostawców sygnałów i rozpoczyna proces generowania sygnałów.

Parametry
provider: SecureSignalProvider	Obiekt secureSignals.SecureSignalProvider, który ma zostać dodany do tablicy.