Dokumentacja GPT

push

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

Wykonuje sekwencję funkcji określonych w argumentach w kolejności.

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 do wykonania. Wiązanie w czasie działania będzie zawsze globalThis. Rozważ przekazanie funkcji strzałki, aby zachować wartość this otaczającego kontekstu leksykalnego.

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

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

Określa, czy niewypełnione boksy towarzyszące mają być automatycznie wypełniane reklamami zapasowymi.

Metodę tę można wywoływać wielokrotnie w trakcie istnienia strony, aby włączać i wyłączać wypełnianie zapasowe. Wypełnianie zapasowe będzie dotyczyć tylko boksów, które są zarejestrowane w PubAdsService. Ze względu na ograniczenia związane z zasadami ta metoda nie jest przeznaczona do wypełniania pustych slotów towarzyszących podczas wyświetlania reklamy wideo z Ad Exchange.

Przykład

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (starsza wersja)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

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

Optional childDirectedTreatment

childDirectedTreatment?: null | boolean

Wskazuje, czy stronę należy traktować jako skierowaną do dzieci. Ustaw wartość na null, aby wyczyścić konfigurację.

Optional limitedAds

limitedAds?: boolean

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

Możesz poprosić GPT o wyświetlenie reklam w ramach ograniczonego wyświetlania na 2 sposoby:

• Automatycznie, korzystając z sygnału z platformy do zarządzania zgodą użytkowników IAB TCF 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 po załadowaniu tagów GPT ze standardowego adresu URL spowoduje wyświetlenie ostrzeżenia w Konsoli Google dla wydawców.

Pamiętaj, że nie musisz ręcznie włączać ograniczonych reklam, jeśli 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 reklamy z ograniczonym wyświetlaniem

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean

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

Optional restrictDataProcessing

restrictDataProcessing?: boolean

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

Optional trafficSource

trafficSource?: TrafficSource

Wskazuje, czy żądania pochodzą z ruchu kupionego czy bezpłatnego. Ta wartość wypełnia wymiar Źródło wizyty w raportach Ad Managera. Jeśli nie jest ustawiony, w raportach źródło wizyty przyjmuje domyślnie wartość undefined.

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?: null | boolean

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

clear

clear(slots?: Slot[]): boolean

Usuwa reklamy z podanych miejsc i zastępuje je pustymi treściami. Miejsca docelowe zostaną oznaczone jako niewybierane.

Usunięcie miejsca docelowego powoduje usunięcie reklamy z długotrwałego wyświetlenia strony w tagu wydawcy Google, dzięki czemu przyszłe żądania nie będą już podlegać blokadom ani wykluczeniom konkurencji dotyczącym tej reklamy.

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 przedziałów do wyczyszczenia. Tablica jest opcjonalna. Jeśli nie zostanie określona, wszystkie gniazda zostaną wyczyszczone.

Zwroty
boolean	Zwraca wartość true, jeśli sloty zostały usunięte, a w przeciwnym razie – wartość false.

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

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

Przykład

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

JavaScript (starsza wersja)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

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

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

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

Zobacz też

• Etykiety własne do blokowania reklam

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

clearTargeting

clearTargeting(key?: string): PubAdsService

Czyści parametry kierowania niestandardowego w przypadku określonego klucza lub wszystkich kluczy.

Przykład

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

JavaScript (starsza wersja)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

Zobacz też

• Kierowanie według par klucz-wartość

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

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

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Umożliwia zwijanie elementów div boksu, aby nie zajmowały miejsca na stronie, gdy nie ma treści reklamy do wyświetlenia. Ten tryb musi być ustawiony przed włączeniem usługi.

Zobacz też

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

Parametry
Optional collapseBeforeAdFetch: boolean	Określa, czy sloty mają być zwężane jeszcze przed pobraniem reklam. Ten parametr jest opcjonalny. Jeśli nie podasz żadnej wartości, jako domyślna zostanie użyta wartość false.

Zwroty
boolean	Zwraca true, jeśli włączono tryb zwijania div, oraz false, jeśli nie można włączyć trybu zwijania, ponieważ metoda została wywołana po włączeniu usługi.

disableInitialLoad

disableInitialLoad(): void

Wyłącza żądania reklam podczas wczytywania strony, ale umożliwia wysyłanie żądań reklam za pomocą wywołania PubAdsService.refresh. Należy to ustawić przed włączeniem usługi. Musisz użyć trybu asynchronicznego, ponieważ w przeciwnym razie nie będzie można wysyłać żądań reklam za pomocą metody refresh.

Zobacz też

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

wyświetlacz

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void

Tworzy i wyświetla boks reklamowy o podanej ścieżce i rozmiarze jednostki reklamowej. Ta metoda nie działa w trybie pojedynczego żądania.

Uwaga: gdy wywoływana jest ta metoda, tworzony jest stan migawki slotu i strony, aby zapewnić spójność podczas wysyłania żądania reklamy i renderowania odpowiedzi. Wszelkie zmiany wprowadzone w stanie slotu lub strony po wywołaniu tej metody (w tym ustawienia kierowania, 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 do wyrenderowania.
size: GeneralSize	Szerokość i wysokość slotu.
Optional div: string | Element	Identyfikator elementu div zawierającego slot lub sam element div.
Optional clickUrl: string	Adres URL kliknięcia, który ma być używany w tym slocie.

enableLazyLoad

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

Umożliwia opóźnione wczytywanie w GPT zgodnie z definicją obiektu konfiguracji. Bardziej szczegółowe przykłady znajdziesz w artykule Leniwe ładowanie.

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

Przykład

JavaScript

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

JavaScript (starsza wersja)

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

TypeScript

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

Zobacz też

• Sprawdzone metody dotyczące reklam: priorytetowe traktowanie „ważnych” miejsc na reklamy
• Leniwe ładowanie

Parametry

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

Obiekt konfiguracji umożliwia dostosowanie działania funkcji lazy. W przypadku pominiętej konfiguracji zostanie użyty domyślny zestaw ustawień określony przez Google, który będzie dostosowywany z upływem czasu. Aby wyłączyć określone ustawienie, np. margines pobierania, ustaw wartość na -1. fetchMarginPercent Minimalna odległość boksu od bieżącego widocznego obszaru, zanim pobieramy reklamę, wyrażona jako odsetek rozmiaru widocznego obszaru. Wartość 0 oznacza „gdy boks znajdzie się w widocznym obszarze”, 100 oznacza „gdy reklama jest w 1 widocznym obszarze”, itd. renderMarginPercent Minimalna odległość boksu od bieżącego widocznego obszaru, zanim zaczniemy renderować reklamę. Umożliwia to wstępny odczyt reklamy, ale z opóźnieniem w przypadku renderowania i pobierania innych zasobów podrzędnych. Ta wartość działa tak samo jak fetchMarginPercent jako odsetek widoku. mobileScaling Współczynnik stosowany do marży na urządzeniach mobilnych. Dzięki temu możesz stosować różne marże na urządzeniach mobilnych i komputerach. Na przykład wartość 2,0 spowoduje pomnożenie wszystkich marginesów przez 2 na urządzeniach mobilnych, co zwiększy minimalną odległość, w jakiej może znajdować się slot przed pobraniem i renderowaniem.

enableSingleRequest

enableSingleRequest(): boolean

Włącza tryb pojedynczego żądania do pobierania wielu reklam jednocześnie. Wymaga to zdefiniowania wszystkich boksów reklamowych wydawcy i ich dodania do usługi PubAdsService przed jej włączeniem. Przed włączeniem usługi należy ustawić tryb pojedynczego żądania.

Zobacz też

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

Zwroty
boolean	Zwraca true, jeśli tryb pojedynczego żądania był 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 zastosowanie ograniczeń wykluczeń konkurencji w przypadku reklam displayowych i wideo. Jeśli treść filmu jest znana, wywołaj metodę PubAdsService.setVideoContent, aby móc używać wykluczeń treści w reklamach displayowych.

get

get(key: string): null | string

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

Przykład

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (starsza wersja)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

Zobacz też

• Atrybuty AdSense

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

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

getAttributeKeys

getAttributeKeys(): string[]

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

Przykład

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (starsza wersja)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

Zwroty
string[]	Tablica kluczy atrybutów ustawionych w tej usłudze. kolejność nie jest zdefiniowana;

getTargeting

getTargeting(key: string): string[]

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

Przykład

JavaScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

JavaScript (starsza wersja)

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

TypeScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

Parametry
key: string	Klucz kierowania, którego szukasz.

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

getTargetingKeys

getTargetingKeys(): string[]

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

Przykład

JavaScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

JavaScript (starsza wersja)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

Zwroty
string[]	Tablica kluczy kierowania. kolejność nie jest zdefiniowana;

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Zwraca informację, czy w ramach poprzedniego wywołania PubAdsService.disableInitialLoad udało się wyłączyć początkowe żądania reklam.

Zwroty
boolean	Zwraca true, jeśli poprzednie wywołanie metody PubAdsService.disableInitialLoad zakończyło się powodzeniem, a w przeciwnym razie – false.

odśwież

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

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

Aby zapewnić prawidłowe działanie we wszystkich przeglądarkach, wywołanie funkcji refresh musi być poprzedzone wywołaniem display miejsca na reklamę. Jeśli wywołanie funkcji display zostanie pominięte, odświeżanie może działać nieoczekiwanie. W razie potrzeby możesz użyć metody PubAdsService.disableInitialLoad, aby uniemożliwić display pobieranie reklamy.

Odświeżenie boksu powoduje usunięcie starej reklamy z długotrwałego widoku strony w GPT, dzięki czemu przyszłe żądania nie będą już podlegać blokadom ani wykluczeniom konkurencji dotyczącym tej reklamy.

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: null | Slot[]	Slots to refresh (miejsca do odświeżenia). Tablica jest opcjonalna. Jeśli nie zostanie określona, wszystkie sloty zostaną odświeżone.
Optional options: {   changeCorrelator: boolean; }	Opcje konfiguracji powiązane z tym wywołaniem odświeżania. changeCorrelator Określa, czy nowy korelator ma być generowany do pobierania reklam. Nasze serwery reklam przechowują tę wartość przez krótki czas (obecnie przez 30 sekund, ale może się to zmienić), dzięki czemu żądania z tą samą wartością korelatora odebrane w niewielkim odstępie czasu są uznawane za pojedyncze wyświetlenie strony. Domyślnie nowy korelator jest generowany przy każdym odświeżeniu. Uwaga: ta opcja nie ma wpływu na długotrwały widok strony w GPT, który automatycznie odzwierciedla reklamy wyświetlane obecnie na stronie i nie ma daty wygaśnięcia.

set

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

Ustawia wartości atrybutów AdSense, które mają zastosowanie do wszystkich boksów reklamowych w usłudze Reklamy wydawcy.

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

Przykład

JavaScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");

JavaScript (starsza wersja)

googletag.pubads().set("adsense_background_color", "#FFFFFF");

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");

Zobacz też

• Atrybuty AdSense

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

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

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

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

Przykład

JavaScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

JavaScript (starsza wersja)

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

TypeScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

Zobacz też

• Etykiety własne do blokowania reklam

Parametry
categoryExclusion: string	Etykieta wykluczenia kategorii reklam do dodania.

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

setCentering

setCentering(centerAds: boolean): void

Włącza i wyłącza poziome wyśrodkowanie reklam. Domyślnie wyśrodkowywanie jest wyłączone. W starszej wersji pliku gpt_mobile.js wyśrodkowanie jest domyślnie włączone.

Metodę tę należy wywołać przed wywołaniem metody display lub refresh, ponieważ tylko reklamy, które zostaną zażądane po wywołaniu tej metody, będą wyśrodkowane.

Przykład

JavaScript

// Make ads centered.
googletag.pubads().setCentering(true);

JavaScript (starsza wersja)

// Make ads centered.
googletag.pubads().setCentering(true);

TypeScript

// Make ads centered.
googletag.pubads().setCentering(true);

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

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Określa, czy wszystkie reklamy na stronie powinny być wymuszone do renderowania przy użyciu kontenera SafeFrame.

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

• To ustawienie będzie miało zastosowanie tylko do kolejnych żądań reklamy wysłanych do odpowiednich slotów.
• Ustawienie na poziomie boksu, jeśli zostanie określone, zawsze zastąpi ustawienie na poziomie strony.
• Jeśli ustawisz wartość true (na poziomie boksu reklamowego lub strony), reklama będzie zawsze renderowana przy użyciu kontenera SafeFrame niezależnie od wyboru dokonanego w interfejsie Google Ad Manager.
• Jeśli jednak ustawisz wartość false lub nie określisz jej w ogóle, reklama zostanie wyrenderowana 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 działanie kreacji, które próbują wyjść poza element iframe lub które wymagają renderowania bezpośrednio na stronie wydawcy.

Przykład

JavaScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (starsza wersja)

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Zobacz też

• Renderowanie kreacji za pomocą SafeFrame

Parametry
forceSafeFrame: boolean	true, aby wymusić renderowanie wszystkich reklam na stronie w SafeFrames, oraz false, aby zmienić poprzednie ustawienie na „fałsz”. Ustawienie tej wartości na false, jeśli nie została wcześniej określona, nie spowoduje żadnych zmian.

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

setLocation

setLocation(address: string): PubAdsService

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

Przykład

JavaScript

// Postal code:
googletag.pubads().setLocation("10001,US");

JavaScript (starsza wersja)

// Postal code:
googletag.pubads().setLocation("10001,US");

TypeScript

// Postal code:
googletag.pubads().setLocation("10001,US");

Parametry
address: string	Adres w dowolnym formacie.

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

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Umożliwia konfigurowanie wszystkich ustawień prywatności z pojedynczego 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 reklamy z ograniczonym wyświetlaniem

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

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

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

Ustawia wartość identyfikatora podanego przez wydawcę.

Przykład

JavaScript

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

JavaScript (starsza wersja)

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

TypeScript

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

Zobacz też

• Informacje o identyfikatorach podawanych przez wydawców

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

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

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

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

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

Przykład

JavaScript

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (starsza wersja)

googletag.pubads().setForceSafeFrame(true);

var pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Zobacz też

• Renderowanie kreacji za pomocą SafeFrame

Parametry
config: SafeFrameConfig	Obiekt konfiguracji.

Zwroty
PubAdsService	Obiekt usługi, w 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 miejsc reklamowych usługi Publisher Ads. Wywołanie tej funkcji kilka razy dla tego samego klucza spowoduje zastąpienie starych wartości. Klucze te są zdefiniowane na koncie Google Ad Managera.

Przykład

JavaScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

JavaScript (starsza wersja)

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

TypeScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

Zobacz też

• Kierowanie według par klucz-wartość

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

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

setVideoContent

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

Określa informacje o treściach wideo, które mają być wysyłane wraz z żądaniami reklamy na potrzeby kierowania i wykluczania treści. Reklamy wideo zostaną automatycznie włączone po wywołaniu tej metody. W przypadku parametrów videoContentId i videoCmsId użyj wartości przekazanych do usługi przetwarzania treści Google Ad Managera.

Zobacz też

• Parametry adresu URL tagu reklamy VAST

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

updateCorrelator

updateCorrelator(): PubAdsService

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

Uwaga: nie ma to wpływu na długotrwały widok strony tagu GPT, który automatycznie odzwierciedla reklamy faktycznie znajdujące się na stronie i nie ma daty wygaśnięcia.

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, w którym wywołano funkcję.

advertiserId

advertiserId: null | number

Identyfikator reklamodawcy.

campaignId

campaignId: null | number

Identyfikator kampanii.

creativeId

creativeId: null | number

Identyfikator kreacji.

creativeTemplateId

creativeTemplateId: null | number

Identyfikator szablonu reklamy.

lineItemId

lineItemId: null | number

Identyfikator elementu zamówienia.

amount

amount: number

Liczba elementów zawartych w nagrodzie.

type

type: string

Typ elementu zawartego w nagrodzie (np. „coin”, czyli „moneta”).

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Określa, czy SafeFrame ma zezwalać na powiększanie treści reklamy przez nakładanie jej na zawartość strony.

Optional allowPushExpansion

allowPushExpansion?: boolean

Określa, czy SafeFrame ma zezwalać na powiększanie treści reklamy przez przesuwanie treści strony.

Optional sandbox

sandbox?: boolean

Określa, czy SafeFrame ma używać atrybutu piaskownicy HTML5, aby zapobiec nawigacji na najwyższym poziomie bez interakcji użytkownika. Jedyną prawidłową wartością jest true (nie można wymusić wartości false). Pamiętaj, że atrybut piaskownicy wyłącza wtyczki (np. Flash).

Optional useUniqueDomain

useUniqueDomain?: null | boolean

Określa, czy SafeFrame ma używać losowych subdomen w przypadku kreacji z rezerwacji. Przekaż wartość null, aby wyczyścić zapisaną wartość.

Uwaga: ta funkcja jest domyślnie włączona.

Zobacz też

• Renderowanie kreacji za pomocą SafeFrame

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 JavaScript po wystąpieniu na stronie określonego zdarzenia 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
Podczas wywołania detektora przekazywany jest mu obiekt odpowiedniego typu zdarzenia.

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ń związanych z reklamami

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

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

getSlots

getSlots(): Slot[]

Wyświetl listę slotów powiązanych z tą usługą.

Zwroty
Slot[]	sloty w kolejności dodania do usługi.

removeEventListener

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

usuwa wcześniej zarejestrowanego słuchacza.

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 tekstowy reprezentujący typ zdarzenia wygenerowanego przez GPT. W typach zdarzeń jest rozróżniana wielkość liter.
listener: ((event: EventTypeMap[K]) => void)	Funkcja, która przyjmuje pojedynczy argument obiektu zdarzenia.

addSize

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

Dodaje mapowanie z tablicy o pojedynczym rozmiarze (przedstawiającej widoczny obszar) do tablicy o pojedynczym lub wielu rozmiarach, która reprezentuje 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(): null | SizeMappingArray

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

Jeśli podano nieprawidłowe mapowania, ta metoda zwróci null. W przeciwnym razie zwraca specyfikację w odpowiednim formacie do przekazania do Slot.defineSizeMapping.

Uwaga: zachowanie konstruktora po wywołaniu tej metody nie jest zdefiniowane.

Zwroty
null | SizeMappingArray	Wynik wygenerowany przez ten kreator. Może być puste, jeśli podano nieprawidłowe mapowania rozmiarów.

addService

addService(service: Service): Slot

Dodaje do tego boksu usługę.

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 do dodania.

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

clearCategoryExclusions

clearCategoryExclusions(): Slot

Czyści wszystkie etykiety wykluczenia kategorii reklam na poziomie boksu reklamowego w tym boksie.

Przykład

JavaScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

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

JavaScript (starsza wersja)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

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

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

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

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

clearTargeting

clearTargeting(key?: string): Slot

Czyści określone lub wszystkie parametry kierowania na boks reklamowy na poziomie boksu reklamowego.

Przykład

JavaScript

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

JavaScript (starsza wersja)

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

TypeScript

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

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

Zobacz też

• Kierowanie według par klucz-wartość

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

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Określa tablicę mapowania od minimalnego rozmiaru widocznego obszaru do rozmiaru tego slotu.

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ą klasy SizeMappingBuilder. Każde mapowanie rozmiaru to tablica zawierająca 2 elementy: SingleSizeArray i GeneralSize.

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

get

get(key: string): null | string

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

Przykład

JavaScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (starsza wersja)

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

Zobacz też

• Atrybuty AdSense

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

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

getAdUnitPath

getAdUnitPath(): string

Zwraca pełną ścieżkę jednostki reklamowej, w tym kod 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 slocie. Aby zobaczyć klucze atrybutów na poziomie usługi odziedziczonych przez ten slot, użyj metody PubAdsService.getAttributeKeys.

Przykład

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (starsza wersja)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

Zwroty
string[]	Tablica kluczy atrybutów. kolejność nie jest zdefiniowana;

getCategoryExclusions

getCategoryExclusions(): string[]

Zwraca etykiety wykluczenia kategorii reklam w przypadku tego boksu.

Przykład

JavaScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

JavaScript (starsza wersja)

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

Zwroty
string[]	Etykiety wykluczenia kategorii reklam w tym boksie lub pusty tablicowy, jeśli nie ma żadnych ustawień.

getResponseInformation

getResponseInformation(): null | ResponseInformation

Zwraca informacje o odpowiedzi na reklamę. Jest ona określana na podstawie ostatniej odpowiedzi reklamy w tym miejscu. Jeśli ta metoda zostanie wywołana, gdy w boksie nie ma reklamy, zwrócona zostanie wartość null.

Zwroty
null | ResponseInformation	Najnowsze informacje o odpowiedzi na reklamę lub null, jeśli w boksie nie ma reklamy.

getSlotElementId

getSlotElementId(): string

Zwraca identyfikator slotu div podany podczas definiowania slotu.

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 miejsca div.

getTargeting

getTargeting(key: string): string[]

Zwraca określony parametr kierowania niestandardowego ustawiony na tym slocie. Nie uwzględnia ona parametrów kierowania na poziomie usługi.

Przykład

JavaScript

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

JavaScript (starsza wersja)

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

TypeScript

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

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

Parametry
key: string	Klucz kierowania, którego szukasz.

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

getTargetingKeys

getTargetingKeys(): string[]

Zwraca listę wszystkich kluczy kierowania niestandardowego ustawionych w tym slocie. Nie uwzględnia się kluczy kierowania na poziomie usługi.

Przykład

JavaScript

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

JavaScript (starsza wersja)

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

TypeScript

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

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

Zwroty
string[]	Tablica kluczy kierowania. kolejność nie jest zdefiniowana;

set

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

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

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

Przykład

JavaScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

JavaScript (starsza wersja)

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

Zobacz też

• Atrybuty AdSense

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

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

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

Przykład

JavaScript

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

JavaScript (starsza wersja)

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

TypeScript

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

Zobacz też

• Etykiety własne do blokowania reklam

Parametry
categoryExclusion: string	Etykieta wykluczenia kategorii reklam do dodania.

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

setClickUrl

setClickUrl(value: string): Slot

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

Serwery Google Ad Managera nadal rejestrują kliknięcia, nawet jeśli docelowy URL zostanie zastąpiony. Do podanej wartości dołączany jest dowolny adres URL strony docelowej powiązany z wyświetlaną kreacją. Kolejne wywołania zastąpią tę wartość. Ta opcja działa tylko w przypadku żądań innych niż żądania dotyczące usług RMA.

Przykład

JavaScript

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

JavaScript (starsza wersja)

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

TypeScript

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

Parametry
value: string	Adres URL kliknięcia do ustawienia.

Zwroty
Slot	Obiekt slotu, w 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ąpi to ustawienia na poziomie usługi.

Przykład

JavaScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

JavaScript (starsza wersja)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

Zobacz też

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

Parametry
collapse: boolean	Określa, czy boks ma się zwinąć, jeśli nie zostanie zwrócona żadna reklama.
Optional collapseBeforeAdFetch: boolean	Określa, czy boks ma być zwinięty jeszcze przed pobraniem reklamy. Zignorowana, jeśli wartość collapse nie jest true.

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

setConfig

setConfig(slotConfig: SlotSettingsConfig): void

Ustawia ogólne opcje konfiguracji dla tego slotu.

Parametry
slotConfig: SlotSettingsConfig	Obiekt konfiguracji.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Określa, czy reklamy w tym boksie powinny być wymuszane do renderowania przy użyciu kontenera SafeFrame.

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

• To ustawienie będzie miało zastosowanie tylko do kolejnych żądań reklamy wysłanych do odpowiednich slotów.
• Ustawienie na poziomie boksu, jeśli zostanie określone, zawsze zastąpi ustawienie na poziomie strony.
• Jeśli ustawisz wartość true (na poziomie boksu reklamowego lub strony), reklama będzie zawsze renderowana przy użyciu kontenera SafeFrame niezależnie od wyboru dokonanego w interfejsie Google Ad Manager.
• Jeśli jednak ustawisz wartość false lub nie określisz jej w ogóle, reklama zostanie wyrenderowana 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 działanie kreacji, które próbują wyjść poza element iframe lub które wymagają renderowania bezpośrednio na stronie wydawcy.

Przykład

JavaScript

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

JavaScript (starsza wersja)

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

TypeScript

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

Zobacz też

• Renderowanie kreacji za pomocą SafeFrame

Parametry
forceSafeFrame: boolean	true, aby wymusić renderowanie wszystkich reklam w tym boksie w kontenerze SafeFrame, oraz false, aby zrezygnować z ustawienia na poziomie strony (jeśli występuje). Ustawienie wartości false, gdy nie jest określone na poziomie strony, nie spowoduje żadnych zmian.

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

setSafeFrameConfig

setSafeFrameConfig(config: null | SafeFrameConfig): Slot

Ustawia ustawienia na poziomie slotu dla konfiguracji SafeFrame. Wszystkie nierozpoznane klucze w obiekcie konfiguracji zostaną zignorowane. Jeśli dla rozpoznawanego klucza zostanie podana nieprawidłowa wartość, cała konfiguracja zostanie zignorowana.

Wszelkie preferencje na poziomie boksu, jeśli zostaną określone, zastąpią preferencje na poziomie strony.

Przykład

JavaScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (starsza wersja)

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

Zobacz też

• Renderowanie kreacji za pomocą SafeFrame

Parametry
config: null | SafeFrameConfig	Obiekt konfiguracji.

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

setTargeting

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

Ustawia parametr kierowania niestandardowego dla tego miejsca docelowego. Wywołanie tej metody kilka razy dla tego samego klucza spowoduje zastąpienie starych wartości. Wartości ustawione tutaj zastąpią parametry kierowania ustawione na poziomie usługi. Klucze te są zdefiniowane na koncie Google Ad Managera.

Przykład

JavaScript

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

JavaScript (starsza wersja)

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

TypeScript

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

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

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

Zobacz też

• Kierowanie według par klucz-wartość

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

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

updateTargetingFromMap

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

Ustawia parametry kierowania niestandardowego dla tego slotu na podstawie mapy klucz-wartość w obiekcie JSON. Jest to tożsame z wywołaniem metody Slot.setTargeting dla wszystkich wartości kluczy obiektu. Klucze te są zdefiniowane na koncie Google Ad Managera.

Uwagi:

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

Przykład

JavaScript

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

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

JavaScript (starsza wersja)

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

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

TypeScript

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

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

Parametry
map: {   [adUnitPath: string]: string | string[]; }	Mapa par klucz-wartość parametrów kierowania.

Zwroty
Slot	Obiekt slotu, w którym wywołano metodę.

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"

Obsługiwane reguły reklam pełnoekranowych.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Obsługiwane metody ochrony prywatności wydawców

Taksonomia

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

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

Zobacz też

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

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

Zobacz też

• Protected Audience API Seller guide: run ad auctions

Właściwości

Właściwości

Właściwości

Właściwości

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

Właściwości

Właściwości

OutOfPageFormat

OutOfPageFormat

Formaty poza stroną obsługiwane przez GPT.

Zobacz też

• defineOutOfPageSlot

Elementy listy wyliczenia
BOTTOM_ANCHOR	Format kotwiczy, w którym boks reklamowy jest przytwierdzony do dolnej części widocznego obszaru.
GAME_MANUAL_INTERSTITIAL	Format ręcznej reklamy pełnoekranowej w instrukcji do gry. Uwaga: ręczna reklama pełnoekranowa w instrukcji do gry to format z ograniczonym dostępem.
INTERSTITIAL	Format kreacji pełnoekranowej w internecie.
LEFT_SIDE_RAIL	Format lewej kolumny bocznej.
REWARDED	Format reklamy z nagrodą.
RIGHT_SIDE_RAIL	Format reklamy w kolumnie bocznej po prawej stronie.
TOP_ANCHOR	Format kotwicy, w którym boks reklamowy jest przytwierdzony u góry widocznego obszaru.

TrafficSource

TrafficSource

Źródła wizyt obsługiwane przez GPT.

Zobacz też

• PrivacySettingsConfig.trafficSource

Elementy listy 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ę).

Zobacz też

• Detektory zdarzeń związanych z reklamami

Właściwości

Właściwości

Przykład

JavaScript

// This listener is called when a game manual interstial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (starsza wersja)

// This listener is called when a game manual interstial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) {
  var slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a game manual interstial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Zobacz też

• Detektory zdarzeń reklamowych
• Wyświetlanie reklamy pełnoekranowej z ręczną konfiguracją w grze

Przykład

JavaScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
  const slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.");

  //Replace with custom logic.
  const displayGmiAd = true;
  if (displayGmiAd) {
    event.makeGameManualInterstitialVisible();
  }

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (starsza wersja)

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) {
  var slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.");

  //Replace with custom logic.
  var displayGmiAd = true;
  if (displayGmiAd) {
    event.makeGameManualInterstitialVisible();
  }

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);
googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
  const slot = event.slot;
  console.log("Game manual interstital slot", slot.getSlotElementId(), "is ready to be displayed.");

  //Replace with custom logic.
  const displayGmiAd = true;
  if (displayGmiAd) {
    event.makeGameManualInterstitialVisible();
  }

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Zobacz też

• Detektory zdarzeń związanych z reklamami
• Wyświetlanie reklamy pełnoekranowej z ręczną konfiguracją w grze

Metody

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ń związanych z reklamami

Przykład

JavaScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (starsza wersja)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

Zobacz też

• Detektory zdarzeń związanych z reklamami
• Wyświetlanie reklamy z nagrodą