Dokumentacja GPT

W tym artykule do opisywania typów używana jest notacja TypeScript. W poniższej tabeli znajdziesz i wyjaśnić na przykładach.

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

Aby dowiedzieć się więcej o obsługiwanych typach i wyrażeniach, zapoznaj się z Podręcznik TypeScript .

Wpisz adnotacje

Dwukropek po zmiennej, nazwie parametru, nazwie właściwości lub podpisie funkcji oznacza typu adnotacji. Adnotacje typu opisują typy elementu po lewej stronie dwukropka który może zaakceptować lub zwrócić. W tabeli poniżej znajdziesz przykłady adnotacji typów, które mogą się pojawić w tym odnośniku.

Adnotacja typu
param: string Wskazuje, że funkcja param akceptuje lub zwraca wartość ciągu znaków. Ta składnia jest używana zmiennych, parametrów, właściwości i zwracanych typów.
param?: number | string Wskazuje, że pole param jest opcjonalne, ale może zawierać liczbę lub ciąg znaków gdy zostanie określona. Ta składnia jest używana w parametrach i właściwościach.
...params: Array<() => void> Wskazuje, że params to parametr spoczynku , która akceptuje funkcje. Parametry spoczynku przyjmują nieograniczoną liczbę wartości określonego typu.

Definicje typów

Typy
SingleSize | MultiSize

Prawidłowa konfiguracja rozmiaru boksu, która może mieć jeden lub wiele rozmiarów.
SingleSize[]

Lista pojedynczych prawidłowych rozmiarów.
"fluid" | ["fluid"]

Nazwane rozmiary, które mogą mieć boks. Najczęściej jest to prostokąt o stałym rozmiarze, ale niekiedy potrzebne są inne rodzaje danych. Prawidłowe są tylko nazwane rozmiary:

  • elastyczny: kontener reklamy przyjmuje 100% szerokości nadrzędnego elementu div i zmienia jego wysokość, by pasował do treści kreacji. Przypomina działanie zwykłych blokowanych elementów na stronie. Używany w przypadku reklam natywnych (zobacz powiązany artykuł). Pamiętaj, że do deklarowania rozmiaru boksu jako elastycznej można używać zarówno fluid, jak i ['fluid'].
SingleSizeArray | NamedSize

Jeden prawidłowy rozmiar dla boksu.
[number, number]

Tablica dwóch liczb reprezentujących szerokość, wysokość.
[SingleSizeArray, GeneralSize]

Mapowanie rozmiaru widocznego obszaru na rozmiary reklam. Używany na potrzeby reklam elastycznych.
SizeMapping[]

Lista mapowań rozmiaru.
"unhideWindow" | "navBar"

Obsługiwane reguły dotyczące reklam pełnoekranowych.
"disablePersonalization"

Obsługiwane metody ochrony prywatności wydawcy.
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Obsługiwane taksonomie sygnałów dostarczanych przez wydawcę.
BidderSignalProvider | PublisherSignalProvider

Interfejs zwracania bezpiecznego sygnału w przypadku określonego licytującego lub dostawcy. Należy podać jedną z tych wartości: id lub networkCode, ale nie obie.

Typy enum

Wartości w polu enum
googletag.enums.OutOfPageFormat
Formaty reklam poza stroną obsługiwane przez GPT.
googletag.enums.TrafficSource
Źródła wizyt obsługiwane przez GPT.

googletag.enums.OutOfPageFormat

  • Formaty reklam poza stroną obsługiwane przez GPT.

  • Zobacz też
  • Wartości
    BOTTOM_ANCHOR
    Format reklamy zakotwiczonej, w której boks przykleja się do dolnej części widocznego obszaru.
    GAME_MANUAL_INTERSTITIAL
    Format pełnoekranowej instrukcji obsługi gry.

    Uwaga: reklama pełnoekranowa w instrukcji do gry ma format z ograniczonym dostępem.
    INTERSTITIAL
    Format kreacji pełnoekranowej w przeglądarce.
    LEFT_SIDE_RAIL
    Format lewej kolumny bocznej.
    REWARDED
    Format reklamy z nagrodą.
    RIGHT_SIDE_RAIL
    Format prawej kolumny bocznej.
    TOP_ANCHOR
    Format zakotwiczenia, w którym boks przykleja się do górnej części widocznego obszaru.

googletag.enums.TrafficSource

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

  • Zobacz też
  • Wartości
    ORGANIC
    Bezpośrednie wprowadzanie adresu URL, wyszukiwanie w witrynie lub pobieranie aplikacji
    PURCHASED
    Ruch przekierowywany z usług innych firm (pozyskiwany lub stanowiący zachętę w inny sposób).

googletag

Globalna przestrzeń nazw interfejsu API tagu wydawcy Google.

Podsumowanie zmiennej
apiReady
Flaga wskazująca, że interfejs GPT API został załadowany i gotowy do wywołania.
cmd
Odniesienie do globalnej kolejki poleceń służącej do asynchronicznego wykonywania wywołań dotyczących GPT.
pubadsReady
Flaga z informacją, że usługa PubAdsService jest włączona, wczytana i w pełni działa.
secureSignalProviders
Odwołanie do tablicy dostawców bezpiecznych sygnałów.
Podsumowanie funkcji
companionAds
Zwraca odwołanie do funkcji CompanionAdsService.
defineOutOfPageSlot
Konstruuje boks reklamowy poza stroną o podanej ścieżce jednostki reklamowej.
defineSlot
Konstruuje 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 oraz usuwa z GPT wszystkie powiązane obiekty i odwołania do tych boksów.
disablePublisherConsole
Wyłącza Konsolę Google dla wydawcy.
display
Instruuje usługi przedziałów do renderowania boksu.
enableServices
Włącza wszystkie usługi GPT zdefiniowane na potrzeby boksów reklamowych na stronie.
getVersion
Zwraca bieżącą wersję GPT.
openConsole
Otwiera Konsolę Google dla wydawcy.
pubads
Zwraca odwołanie do funkcji PubAdsService.
setAdIframeTitle
Ustawia tytuł wszystkich elementów iframe kontenerów reklam utworzonych od tego momentu przez PubAdsService.
setConfig
Ustawia ogólne opcje konfiguracji strony.
sizeMapping
Tworzy nowy element SizeMappingBuilder.

googletagapiReady

  • apiReady: boolean | undefined

  • Flaga wskazująca, że interfejs GPT API został załadowany i gotowy do wywołania. Do momentu, gdy interfejs API nie będzie gotowy, ta właściwość będzie po prostu undefined.

    Zalecaną metodą obsługi asynchronizacji jest użycie tagu googletag.cmd do umieszczania wywołań zwrotnych w kolejce, gdy tag GPT jest gotowy. Te wywołania zwrotne nie muszą sprawdzać googletag.apiReady, ponieważ są gwarantowane do wykonania po skonfigurowaniu interfejsu API.

  • Przykład

    JavaScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    JavaScript (starsza wersja)

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    TypeScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

googletagcmd

  • cmd: Array<(this: typeof globalThis) => void> | CommandArray

  • Odniesienie do globalnej kolejki poleceń służącej do asynchronicznego wykonywania wywołań związanych z GPT.

    Zmienna googletag.cmd jest inicjowana przez składnię tagu GPT na stronie pustą tablicę JavaScript, a cmd.push to standardowa metoda Array.push, która dodaje element na końcu tablicy. Gdy skrypt JavaScript GPT jest załadowany, przegląda tablicę i wykonuje po kolei wszystkie funkcje. Następnie skrypt zastępuje cmd obiektem CommandArray, którego metoda push jest zdefiniowana tak, aby wykonać przekazaną do niej funkcję. Ten mechanizm umożliwia GPT zmniejszenie postrzeganego opóźnienia dzięki asynchronicznemu pobieraniu kodu JavaScript przy jednoczesnym umożliwieniu przeglądarce kontynuowania renderowania strony.

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

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

googletagpubadsReady

  • pubadsReady: boolean | undefined

  • Flaga z informacją, że usługa PubAdsService jest włączona, wczytana i w pełni działa. Ta właściwość będzie po prostu undefined do czasu wywołania funkcji enableServices oraz załadowania i zainicjowania funkcji PubAdsService.

googletagsecureSignalProviders

  • secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

  • Odwołanie do tablicy dostawców bezpiecznych sygnałów.

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

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

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

googletagcompanionAds

googletagdefineOutOfPageSlot

  • 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 zarządzanych przez GPT reklam poza stroną div jest obsługiwany format OutOfPageFormat.

  • Przykład

    JavaScript

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

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

    JavaScript (starsza wersja)

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

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

    TypeScript

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

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    Zobacz też
  • Parametry
    adUnitPath: string
    Pełna ścieżka jednostki reklamowej zawierająca kod sieci i kod jednostki reklamowej.
    div?: string | OutOfPageFormat
    Identyfikator elementu div, który będzie zawierać tę jednostkę reklamową lub format OutOfPageFormat.
  • Zwroty
    Slot | null
    Nowo utworzony boks lub null, jeśli nie można utworzyć boksu.

googletagdefineSlot

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

  • Konstruuje 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ż
  • Parametry
    adUnitPath: string
    Pełna ścieżka jednostki reklamowej zawierająca kod sieci i kod jednostki.
    size: GeneralSize
    Szerokość i wysokość dodanego boksu. Ten rozmiar jest używany w żądaniu reklamy, jeśli nie ma mapowania rozmiaru elastycznego lub rozmiar widocznego obszaru jest mniejszy niż najmniejszy rozmiar podany w mapowaniu.
    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.

googletagdestroySlots

  • destroySlots(slots?: Slot[]): boolean

  • Niszczy podane boksy oraz usuwa z GPT wszystkie powiązane obiekty i odwołania do tych boksów. Ten interfejs API nie obsługuje boksów z przebiegiem zwrotnym 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 obiektu boksu spowoduje nieoczekiwane zachowanie. Pamiętaj, że przeglądarka może nadal nie zwolnić pamięci powiązanej z tym boksem, jeśli odwołuje się do niego strona wydawcy. Wywołanie tego interfejsu API umożliwia ponowne wykorzystanie elementu div powiązanego z tym boksem.

    W szczególności zniszczenie boksu powoduje usunięcie reklamy z długotrwałej odsłony w GPT, więc reklamy na wyłączność ani wykluczenia konkurencji związane z tą reklamą nie będą miały wpływu na przyszłe żądania. Jeśli nie wywołasz tej funkcji przed usunięciem elementu div boksu ze strony, spowoduje to nieoczekiwane zachowanie.

  • Przykład

    JavaScript

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

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

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

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

    JavaScript (starsza wersja)

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

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

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

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

    TypeScript

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

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

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

// This call to destroy all slots.
googletag.destroySlots();
  • Parametry
    slots?: Slot[]
    Tablica przedziałów do zniszczenia. Tablica jest opcjonalna. Jeśli nie określono inaczej, wszystkie przedziały zostaną zniszczone.
  • Zwroty
    boolean
    true, jeśli przedziały zostały zniszczone. W przeciwnym razie false.

googletagdisablePublisherConsole

googletagdisplay

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

  • Instruuje usługi przedziałów do renderowania boksu. Każdy boks reklamowy powinien być wyświetlany na stronie tylko raz. Przed wyświetleniem każdy boks musi zostać zdefiniowany i mieć powiązaną usługę. Wywołanie metody displayowej nie może zostać zrealizowane, dopóki element nie znajdzie się w DOM. Standardowym sposobem, aby to osiągnąć, jest umieszczenie go w bloku skryptu w elemencie div określonym w wywołaniu metody.

    Jeśli używana jest architektura z pojedynczym żądaniem (SRA), wszystkie niepobrane boksy reklamowe w momencie wywołania tej metody zostaną pobrane jednocześnie. Aby wymusić brak wyświetlania boksu reklamowego, musisz usunąć cały element div.

  • Przykład

    JavaScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});

    JavaScript (starsza wersja)

    googletag.cmd.push(function () {
  googletag.display("div-1");
});

    TypeScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});
    Zobacz też
  • Parametry
    divOrSlot: string | Element | Slot
    Identyfikator elementu div zawierającego boks reklamowy lub element div albo obiektu boksu. Jeśli został podany element div, musi on mieć parametr „id” który pasuje do identyfikatora przekazanego do defineSlot.

googletagenableServices

  • enableServices(): void

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

googletaggetVersion

  • getVersion(): string

  • Zwraca bieżącą wersję GPT.

  • Zobacz też
  • Zwroty
    string
    Aktualnie wykonywany ciąg znaków wersji GPT.

googletagopenConsole

  • openConsole(div?: string): void

  • Otwiera Konsolę Google dla wydawcy.

  • Przykład

    JavaScript

    // Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

    JavaScript (starsza wersja)

    // Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

    TypeScript

    // Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();
    Zobacz też
  • Parametry
    div?: string
    Identyfikator elementu div boksu reklamowego. Ta wartość jest opcjonalna. Jeśli Konsola wydawcy zostanie podana, spróbuje się otworzyć ze szczegółowymi informacjami o widocznym boksie reklamowym.

googletagpubads

googletagsetAdIframeTitle

  • setAdIframeTitle(title: string): void

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

  • Przykład

    JavaScript

    googletag.setAdIframeTitle("title");

    JavaScript (starsza wersja)

    googletag.setAdIframeTitle("title");

    TypeScript

    googletag.setAdIframeTitle("title");
  • Parametry
    title: string
    Nowy tytuł wszystkich elementów iframe w kontenerach reklam.

googletagsetConfig

googletagsizeMapping

googletagCommandArray

Tablica poleceń akceptuje sekwencję funkcji i wywołuje je po kolei. Ma ona zastąpić standardową tablicę służącą do kolejkowania funkcji, które mają być wywoływane po załadowaniu tagu GPT.

Podsumowanie metod
push
Wykonuje sekwencję funkcji określonych w argumentach w odpowiedniej kolejności.

push

  • push(...f: Array<(this: typeof globalThis) => void>): number

  • Wykonuje sekwencję funkcji określonych w argumentach w odpowiedniej 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
    ...f: Array<(this: typeof globalThis) => void>
    Funkcja JavaScript do wykonania. Powiązaniem środowiska wykonawczego będzie zawsze globalThis. Rozważ przekazanie funkcji strzałki, aby zachować wartość this otaczającego kontekstu leksycznego.
  • Zwroty
    number
    Liczba przetworzonych do tej pory poleceń. Jest to zgodne ze zwracaną wartością funkcji Array.push (bieżącą długością tablicy).

googletagCompanionAdsService

Rozszerza Service

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

Podsumowanie metod
addEventListener
Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT.
getSlots
Pobierz listę przedziałów powiązanych z tą usługą.
removeEventListener
Usuwa wcześniej zarejestrowanego detektora.
setRefreshUnfilledSlots
Określa, czy boksy towarzyszące, które nie zostały wypełnione, będą automatycznie uzupełniane.
Zobacz też

setRefreshUnfilledSlots

  • setRefreshUnfilledSlots(value: boolean): void

  • Określa, czy niewypełnione boksy towarzyszące będą automatycznie uzupełniane.

    Tę metodę można wywoływać wiele razy od początku istnienia strony, by włączyć lub wyłączyć uzupełnianie. Uzupełnione zostaną tylko boksy zarejestrowane w PubAdsService. Ze względu na ograniczenia wynikające z zasad ta metoda nie służy do wypełniania pustych boksów towarzyszących podczas wyświetlania filmu z Ad Exchange.

  • Przykład

    JavaScript

    googletag.companionAds().setRefreshUnfilledSlots(true);

    JavaScript (starsza wersja)

    googletag.companionAds().setRefreshUnfilledSlots(true);

    TypeScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
  • Parametry
    value: boolean
    true, aby automatycznie uzupełniać niewypełnione boksy, lub false, aby je pozostawić bez zmian.

googletagPrivacySettingsConfig

Obiekt konfiguracji ustawień prywatności.

Podsumowanie właściwości
childDirectedTreatment
Wskazuje, czy stronę należy traktować jako skierowaną do dzieci.
limitedAds
Umożliwia wyświetlanie reklam w trybie ograniczonego wyświetlania reklam, aby ułatwić wydawcom zachowanie zgodności z przepisami.
nonPersonalizedAds
Umożliwia wyświetlanie reklam w trybie reklam niespersonalizowanych, aby ułatwić wydawcom zachowanie zgodności z przepisami.
restrictDataProcessing
Umożliwia wyświetlanie reklam w trybie ograniczonego przetwarzania, co ułatwia wydawcom zachowanie zgodności z przepisami.
trafficSource
Wskazuje, czy żądania dotyczą ruchu kupionego czy bezpłatnego.
underAgeOfConsent
Wskazuje, czy chcesz oznaczać żądania reklamy jako pochodzące od użytkowników, którzy nie osiągnęli wieku świadomego wyrażenia zgody.
Zobacz też

childDirectedTreatment

limitedAds

  • limitedAds: boolean

  • Umożliwia wyświetlanie w trybie ograniczonego wyświetlania reklam, by pomóc wydawcy zachować zgodność z przepisami.

    Możesz polecić GPT na 2 sposoby żądania ograniczonego wyświetlania reklam:

    Ręczne konfigurowanie ograniczonego wyświetlania reklam jest możliwe tylko wtedy, gdy tag GPT jest ładowany z adresu URL ograniczonego wyświetlania reklam. Próba zmiany tego ustawienia, gdy tag GPT został wczytany 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ż

nonPersonalizedAds

  • nonPersonalizedAds: boolean

  • Umożliwia wyświetlanie reklam w trybie reklam niespersonalizowanych, aby ułatwić wydawcom zachowanie zgodności z przepisami.

restrictDataProcessing

trafficSource

  • trafficSource: TrafficSource

  • Wskazuje, czy żądania dotyczą ruchu kupionego czy bezpłatnego. Ta wartość wypełnia wymiar Źródło wizyt w raportach Ad Managera. Jeśli jej nie skonfigurujesz, źródło wizyt w raportach będzie 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,
});

underAgeOfConsent

googletagPubAdsService

Rozszerza Service

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

Podsumowanie metod
addEventListener
Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT.
clear
Usuwa reklamy z wybranych boksów i zastępuje je pustymi treściami.
clearCategoryExclusions
Usuwa wszystkie etykiety wykluczenia kategorii reklam na poziomie strony.
clearTargeting
Usuwa niestandardowe parametry kierowania dla konkretnego lub wszystkich kluczy.
collapseEmptyDivs
Umożliwia zwijanie elementów div boksu, by nie zajmowały miejsca na stronie, gdy nie ma treści reklamy do wyświetlenia.
disableInitialLoad
Wyłącza żądania reklam podczas wczytywania strony, ale umożliwia żądania reklam za pomocą wywołania PubAdsService.refresh.
display
Tworzy i wyświetla boks reklamowy o danej ścieżce i rozmiarze jednostki reklamowej.
enableLazyLoad
Włącza leniwe ładowanie w GPT, określone przez obiekt config.
enableSingleRequest
Włącza tryb pojedynczego żądania, umożliwiający pobieranie wielu reklam naraz.
enableVideoAds
Informuje tag GPT, że na stronie będą znajdować się reklamy wideo.
get
Zwraca wartość atrybutu AdSense powiązanego z podanym kluczem.
getAttributeKeys
Zwraca klucze atrybutów ustawione w tej usłudze.
getSlots
Pobierz listę przedziałów powiązanych z tą usługą.
getTargeting
Zwraca określony niestandardowy parametr kierowania na poziomie usługi.
getTargetingKeys
Zwraca listę wszystkich ustawionych kluczy kierowania na poziomie usługi.
isInitialLoadDisabled
Wskazuje, czy początkowe żądania reklam zostały wyłączone przez poprzednie wywołanie PubAdsService.disableInitialLoad.
refresh
Pobiera i wyświetla nowe reklamy dla określonych lub wszystkich boksów na stronie.
removeEventListener
Usuwa wcześniej zarejestrowanego detektora.
set
Ustawia wartości atrybutów AdSense stosowanych dla wszystkich boksów reklamowych w usłudze Reklamy wydawcy.
setCategoryExclusion
Ustawia wykluczenie kategorii reklam na poziomie strony dla danej nazwy etykiety.
setCentering
Włącza i wyłącza wyśrodkowanie reklam w poziomie.
setForceSafeFrame
Określa, czy wszystkie reklamy na stronie mają wymuszać renderowanie za pomocą kontenera SafeFrame.
setLocation
Przekazuje informacje o lokalizacji z witryn, aby umożliwić kierowanie geograficzne elementów zamówienia do określonych lokalizacji.
setPrivacySettings
Umożliwia konfigurowanie wszystkich ustawień prywatności z poziomu pojedynczego interfejsu API za pomocą obiektu config.
setPublisherProvidedId
Określa wartość identyfikatora podanego przez wydawcę.
setSafeFrameConfig
Określa ustawienia konfiguracji SafeFrame na poziomie strony.
setTargeting
Ustawia dla danego klucza parametry kierowania niestandardowego, które będą stosowane do wszystkich boksów reklamowych usługi Reklamy wydawcy.
setVideoContent
Określa informacje o treści wideo, które będą wysyłane razem z żądaniami reklam na potrzeby kierowania i wykluczania treści.
updateCorrelator
Zmienia korelatora, który jest wysyłany z żądaniami reklamy, co w efekcie uruchamia nowe wyświetlenie strony.

clear

  • clear(slots?: Slot[]): boolean

  • Usuwa reklamy z wybranych boksów i zastępuje je pustymi treściami. Boksy zostaną oznaczone jako niepobrane.

    W szczególności wyczyszczenie boksu spowoduje usunięcie reklamy z długotrwałej odsłony w GPT, więc reklamy na wyłączność ani wykluczenia konkurencji związane z tą reklamą nie będą miały wpływu na przyszłe żądania.

  • Przykład

    JavaScript

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

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

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

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

    JavaScript (starsza wersja)

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

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

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

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

    TypeScript

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

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

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

// This call to clear all slots.
googletag.pubads().clear();
  • Parametry
    slots?: Slot[]
    Tablica przedziałów do wyczyszczenia. Tablica jest opcjonalna. Jeśli nie określono tego ustawienia, wszystkie boksy zostaną wyczyszczone.
  • Zwroty
    boolean
    Zwraca true, jeśli przedziały zostały wyczyszczone. W przeciwnym razie false.

clearCategoryExclusions

  • clearCategoryExclusions(): PubAdsService

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

  • 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ż
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano metodę.

clearTargeting

  • clearTargeting(key?: string): PubAdsService

  • Usuwa niestandardowe parametry kierowania dla konkretnego lub wszystkich kluczy.

  • Przykład

    JavaScript

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

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

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

    JavaScript (starsza wersja)

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

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

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

    TypeScript

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

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

googletag.pubads().clearTargeting();
// All targeting has been cleared.
    Zobacz też
  • Parametry
    key?: string
    Klucz parametru kierowania. Klucz jest opcjonalny. Jeśli nie określono inaczej, wszystkie parametry kierowania zostaną wyczyszczone.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano metodę.

collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

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

  • Zobacz też
  • Parametry
    collapseBeforeAdFetch?: boolean
    Określa, czy zwinąć boksy jeszcze przed pobraniem reklam. Ten parametr jest opcjonalny. Jeśli nie zostanie podany, domyślną wartością będzie false.
  • Zwroty
    boolean
    Zwraca true, jeśli włączony był tryb zwijania div, lub false, jeśli nie można włączyć trybu zwijania, ponieważ metoda została wywołana po włączeniu usługi.

disableInitialLoad

display

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

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

    Uwaga: po jej wywołaniu tworzony jest zrzut stanu boksu i strony, co zapewnia spójność przy wysyłaniu żądania reklamy i renderowaniu odpowiedzi. Wszystkie zmiany wprowadzone w stanie boksu lub strony po wywołaniu tej metody (w tym ustawienia kierowania, ustawień prywatności, wymuszania SafeFrame itp.) będą stosowane 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ż
  • Parametry
    adUnitPath: string
    Ścieżka jednostki reklamowej boksu do renderowania.
    size: GeneralSize
    Szerokość i wysokość boksu.
    div?: string | Element
    Identyfikator elementu div zawierającego boks lub sam element div.
    clickUrl?: string
    Klikany adres URL, który ma być używany w tym boksie.

enableLazyLoad

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

  • Włącza leniwe ładowanie w GPT, określone przez obiekt config. Bardziej szczegółowe przykłady znajdziesz w przykładzie Leniwe ładowanie.

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

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});
    Zobacz też
  • Parametry
    config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
    Obiekt konfiguracji umożliwia dostosowanie leniwego działania. Wszystkie pominięte konfiguracje będą używać wartości domyślnych ustawionych przez Google, które z czasem zostaną dostrojone. Aby wyłączyć określone ustawienie, takie jak margines pobierania, ustaw tę wartość na -1.
    • fetchMarginPercent

      Minimalna odległość boksu reklamowego od bieżącego widocznego obszaru określona jako procent rozmiaru widocznego obszaru przed pobraniem reklamy. Wartość 0 oznacza „gdy boks znajdzie się w widocznym obszarze”, 100 oznacza „gdy reklama znajduje się w odległości 1 widocznego obszaru” itd.
    • renderMarginPercent

      Minimalna odległość boksu reklamowego od bieżącego widocznego obszaru przed wyrenderowaniem reklamy. Umożliwia to wstępne pobieranie reklamy, ale oczekiwanie na wyrenderowanie i pobranie innych zasobów podrzędnych. Ta wartość działa tak samo jak fetchMarginPercent, jako procent widocznego obszaru.
    • mobileScaling

      Mnożnik zastosowany do marż na urządzeniach mobilnych. Pozwala to uzyskać różne marże na komputerach i urządzeniach mobilnych. Na przykład wartość 2, 0 powoduje pomnożenie wszystkich marż przez 2 na urządzeniach mobilnych, co zwiększa minimalną odległość boksu przed pobraniem i renderowaniem.

enableSingleRequest

  • enableSingleRequest(): boolean

  • Włącza tryb pojedynczego żądania, umożliwiający pobieranie wielu reklam naraz. Wymaga to zdefiniowania i dodania wszystkich boksów reklam wydawcy do usługi PubAdsService przed jej włączeniem. Tryb pojedynczego żądania należy ustawić przed włączeniem usługi.

  • Zobacz też
  • Zwroty
    boolean
    Zwraca true, jeśli tryb pojedynczego żądania był włączony, oraz false, jeśli nie można włączyć trybu pojedynczego żądania, ponieważ metoda została wywołana po włączeniu usługi.

enableVideoAds

  • enableVideoAds(): void

  • Informuje tag GPT, że na stronie będą znajdować się reklamy wideo. Umożliwia to stosowanie w reklamach displayowych i wideo ograniczeń w zakresie wykluczenia konkurencji. Jeśli treść wideo jest znana, wywołaj PubAdsService.setVideoContent, aby móc używać wykluczenia treści w przypadku reklam displayowych.

get

  • get(key: string): null | string

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

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.
    Zobacz też
  • Parametry
    key: string
    Nazwa atrybutu do wyszukania.
  • Zwroty
    null | 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.

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

  • 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, na który należy zwrócić uwagę.
  • 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 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

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

  • Zwroty
    boolean
    Zwraca true, jeśli poprzednie wywołanie funkcji PubAdsService.disableInitialLoad zakończyło się powodzeniem. W przeciwnym razie zwraca wartość false.

refresh

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

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

    Aby zapewnić prawidłowe działanie we wszystkich przeglądarkach, wywołanie refresh musi być poprzedzone wywołaniem display boksu reklamowego. Jeśli wywołanie funkcji display zostanie pominięte, odświeżenie może działać w nieoczekiwany sposób. W razie potrzeby można użyć metody PubAdsService.disableInitialLoad, by uniemożliwić usłudze display pobranie reklamy.

    Odświeżenie boksu spowoduje usunięcie starej reklamy z długotrwałej odsłony w GPT, więc reklamy na wyłączność ani wykluczenia konkurencji związane z tą reklamą nie będą miały wpływu na przyszłe żądania.

  • Przykład

    JavaScript

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

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

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

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

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

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

    JavaScript (starsza wersja)

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

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

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

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

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

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

    TypeScript

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

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

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

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

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

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });
    Zobacz też
  • Parametry
    slots?: null | Slot[]
    Przedziały do odświeżenia. Tablica jest opcjonalna. Jeśli nie określono tego ustawienia, wszystkie przedziały zostaną odświeżone.
    options?: { changeCorrelator: boolean }
    Opcje konfiguracji powiązane z tym wywołaniem odświeżania.
    • changeCorrelator

      Określa, czy do pobierania reklam ma zostać wygenerowany nowy korelator. Nasze serwery reklam utrzymują tę wartość korelatora przez krótki czas (obecnie przez 30 sekund, ale może się to zmienić), dzięki czemu żądania z tym samym korelatorem otrzymane blisko siebie będą uznawane za pojedyncze wyświetlenie strony. Domyślnie dla każdego odświeżenia generowany jest nowy korelator.

      Uwaga: ta opcja nie ma wpływu na długotrwałe wyświetlenie strony GPT, która automatycznie odzwierciedla reklamy znajdujące się obecnie na stronie i nie ma określonej daty ważności.

set

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

  • Ustawia wartości atrybutów AdSense stosowanych do wszystkich boksów reklamowych w ramach usługi Reklamy wydawcy.

    Wywołanie tej funkcji więcej niż raz z jednym kluczem spowoduje zastąpienie poprzednio ustawionych dla niego wartości. Przed wywołaniem funkcji display lub refresh należy ustawić wszystkie wartości.

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    Zobacz też
  • Parametry
    key: string
    Nazwa atrybutu.
    value: string
    Wartość atrybutu.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano metodę.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): PubAdsService

  • Ustawia wykluczenie kategorii reklam na poziomie strony dla danej nazwy etykiety.

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
    Zobacz też
  • Parametry
    categoryExclusion: string
    Etykieta wykluczenia kategorii reklamy, którą chcesz dodać.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego 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 pliku gpt_mobile.js wyśrodkowanie jest domyślnie włączone.

    Tę metodę należy wywołać przed wywołaniem funkcji display lub refresh, ponieważ wyśrodkowane będą tylko reklamy żądane po jej wywołaniu.

  • 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 strony.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

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

    Korzystając z tego interfejsu API, pamiętaj o tych kwestiach:

    • To ustawienie będzie obowiązywać tylko w przypadku kolejnych żądań reklamy wysyłanych do odpowiednich boksów.
    • Ustawienie na poziomie boksu, jeśli zostanie określone, zawsze zastąpi ustawienie na poziomie strony.
    • Jeśli ustawisz wartość true (na poziomie boksu lub strony), reklama będzie zawsze renderowana przy użyciu kontenera SafeFrame niezależnie od opcji wybranych w interfejsie Google Ad Managera.
    • Jeśli jednak ustawisz wartość false lub nie określisz tego ustawienia, reklama będzie renderowana przy użyciu kontenera SafeFrame w zależności od typu kreacji i ustawień wybranych w interfejsie Google Ad Managera.
    • Z tego interfejsu API należy korzystać z rozwagą, ponieważ może on wpływać na zachowanie kreacji, które próbują wyjść z elementów iframe lub polegają na renderowaniu ich bezpośrednio na stronie wydawcy.

  • Przykład

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    JavaScript (starsza wersja)

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

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

googletag.display("div-1");
googletag.display("div-2");
    Zobacz też
  • Parametry
    forceSafeFrame: boolean
    true, by wymusić renderowanie wszystkich reklam na stronie w SafeFrame, a false, by zmienić poprzednie ustawienie na „false”. Jeśli nie określono wcześniej ustawienia na false, nic nie zmieni.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano funkcję.

setLocation

  • setLocation(address: string): PubAdsService

  • Przekazuje informacje o lokalizacji z witryn, aby umożliwić kierowanie geograficzne elementów zamówienia do określonych lokalizacji.

  • 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
    Dowolny adres.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano metodę.

setPrivacySettings

  • setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

  • Umożliwia konfigurowanie wszystkich ustawień prywatności z poziomu pojedynczego interfejsu API za pomocą obiektu config.

  • Przykład

    JavaScript

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

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

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

    JavaScript (starsza wersja)

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

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

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

    TypeScript

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

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

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});
    Zobacz też
  • Parametry
    privacySettings: PrivacySettingsConfig
    Obiekt zawierający konfigurację ustawień prywatności.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano funkcję.

setPublisherProvidedId

  • setPublisherProvidedId(ppid: string): PubAdsService

  • Określa wartość identyfikatora podanego przez wydawcę.

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    Zobacz też
  • Parametry
    ppid: string
    Identyfikator alfanumeryczny podany przez wydawcę. Musi mieć od 32 do 150 znaków.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano metodę.

setSafeFrameConfig

  • setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

  • Określa ustawienia konfiguracji SafeFrame na poziomie strony. Wszystkie nierozpoznane klucze w obiekcie konfiguracji będą ignorowane. Jeśli dla rozpoznanego klucza zostanie przekazana nieprawidłowa wartość, cała konfiguracja zostanie zignorowana.

    Te preferencje na poziomie strony zostaną zastąpione przez ustawienia na poziomie boksu, jeśli zostaną określone.

  • Przykład

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

    JavaScript (starsza wersja)

    googletag.pubads().setForceSafeFrame(true);

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

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

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

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

googletag.display("div-1");
googletag.display("div-2");
    Zobacz też
  • Parametry
    config: SafeFrameConfig
    Obiekt konfiguracji.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano metodę.

setTargeting

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

  • Ustawia dla danego klucza parametry kierowania niestandardowego, które będą stosowane do wszystkich boksów reklamowych usługi Reklamy wydawcy. Wywołanie tej metody kilka razy z jednym kluczem 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ż
  • Parametry
    key: string
    Klucz parametru kierowania.
    value: string | string[]
    Wartość parametru kierowania lub tablica wartości.
  • Zwroty
    PubAdsService
    Obiekt usługi, dla którego wywołano metodę.

setVideoContent

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

  • Określa informacje o treści wideo, które będą wysyłane razem z żądaniami reklam na potrzeby kierowania i wykluczania treści. Reklamy wideo będą włączane automatycznie po wywołaniu tej metody. W przypadku videoContentId i videoCmsId użyj wartości podanych w usłudze przetwarzania treści Google Ad Managera.

  • Zobacz też
  • Parametry
    videoContentId: string
    Identyfikator treści filmu.
    videoCmsId: string
    Identyfikator CMS filmu.

updateCorrelator

  • updateCorrelator(): PubAdsService

  • Zmienia korelatora, który jest wysyłany z żądaniami reklamy, co w efekcie uruchamia nowe wyświetlenie strony. Korelator jest taki sam w przypadku wszystkich żądań reklamy pochodzących z jednego wyświetlenia strony i niepowtarzalny dla wszystkich wyświetleń strony. Dotyczy tylko trybu asynchronicznego.

    Uwaga: nie ma to wpływu na długotrwałe wyświetlenie strony GPT, które automatycznie odzwierciedla rzeczywiste reklamy na stronie i nie ma czasu 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, dla którego wywołano funkcję.

googletagResponseInformation

Obiekt reprezentujący pojedynczą odpowiedź na żądanie reklamy.

Podsumowanie właściwości
advertiserId
Identyfikator reklamodawcy.
campaignId
Identyfikator kampanii.
creativeId
Identyfikator kreacji.
creativeTemplateId
Identyfikator szablonu reklamy.
lineItemId
Identyfikator elementu zamówienia.
Zobacz też

advertiserId

  • advertiserId: null | number

  • Identyfikator reklamodawcy.

campaignId

  • campaignId: null | number

  • Identyfikator kampanii.

creativeId

  • creativeId: null | number

  • Identyfikator kreacji.

creativeTemplateId

  • creativeTemplateId: null | number

  • Identyfikator szablonu reklamy.

lineItemId

  • lineItemId: null | number

  • Identyfikator elementu zamówienia.

googletagRewardedPayload

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

Podsumowanie właściwości
amount
Liczba produktów w nagrodzie.
type
Typ przedmiotu zawartego w nagrodzie (np. „moneta”).
Zobacz też

amount

  • amount: number

  • Liczba produktów w nagrodzie.

type

  • type: string

  • Typ przedmiotu zawartego w nagrodzie (np. „moneta”).

googletagSafeFrameConfig

Obiekt konfiguracji kontenerów SafeFrame.

Podsumowanie właściwości
allowOverlayExpansion
Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez nakładanie się zawartości strony.
allowPushExpansion
Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez przepychanie treści strony.
sandbox
Określa, czy SafeFrame ma używać atrybutu piaskownicy HTML5, aby uniemożliwiać nawigację najwyższego poziomu bez interakcji użytkownika.
useUniqueDomain
Wycofano. Określa, czy SafeFrame ma używać w przypadku kreacji z rezerwacji losowych subdomen.
Zobacz też

allowOverlayExpansion

  • allowOverlayExpansion: boolean

  • Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez nakładanie się zawartości strony.

allowPushExpansion

  • allowPushExpansion: boolean

  • Określa, czy SafeFrame ma zezwalać na rozwijanie treści reklamy przez przepychanie treści strony.

sandbox

  • sandbox: boolean

  • Określa, czy SafeFrame ma używać atrybutu piaskownicy HTML5, aby uniemożliwiać nawigację najwyższego poziomu bez interakcji użytkownika. Jedyna prawidłowa wartość to true (nie można jej wymusić na false). Pamiętaj, że atrybut piaskownicy (np. Flash) wyłącza wtyczki.

useUniqueDomain

  • useUniqueDomain: null | boolean

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

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

  • Zobacz też

googletagService

Podstawowa klasa usługi zawierająca metody wspólne dla wszystkich usług.

Podsumowanie metod
addEventListener
Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT.
getSlots
Pobierz listę przedziałów powiązanych z tą usługą.
removeEventListener
Usuwa wcześniej zarejestrowanego detektora.

addEventListener

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

  • Rejestruje element nasłuchujący, który umożliwia skonfigurowanie i wywołanie funkcji JavaScript, gdy na stronie zachodzi określone zdarzenie GPT. Obsługiwane są te zdarzenia:

    Obiekt odpowiedniego typu zdarzenia jest przekazywany do detektora w momencie wywołania.

  • Przykład

    JavaScript

    // 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

    JavaScript (starsza wersja)

    // 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", function (event) {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

    TypeScript

    // 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});
    Zobacz też
  • Parametry
    eventType: K
    Ciąg znaków reprezentujący typ zdarzenia 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, dla którego wywołano metodę.

getSlots

  • getSlots(): Slot[]

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

  • Zwroty
    Slot[]
    Przedziały 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 zarejestrowanego detektora.

  • 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 pojedynczy argument obiektu zdarzenia.

googletagSizeMappingBuilder

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

Podsumowanie metod
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 rozmiaru na podstawie mapowań dodanych do tego kreatora.
Zobacz też

addSize

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

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

  • Przykład

    JavaScript

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

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

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

    JavaScript (starsza wersja)

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

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

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

    TypeScript

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

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

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]
  • Parametry
    viewportSize: SingleSizeArray
    Rozmiar widocznego obszaru dla tego wpisu mapowania.
    slotSize: GeneralSize
    Rozmiary przedziału dla tego wpisu mapowania.
  • Zwroty
    SizeMappingBuilder
    Odwołanie do tego kreatora.

build

  • build(): null | SizeMappingArray

  • Tworzy specyfikację mapy rozmiaru na podstawie mapowań dodanych do tego kreatora.

    Jeśli zostały podane nieprawidłowe mapowania, ta metoda zwróci wartość null. W przeciwnym razie zwraca specyfikację w prawidłowym formacie, który należy przekazać do metody Slot.defineSizeMapping.

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

  • Zwroty
    null | SizeMappingArray
    Wynik utworzony przez ten kreator. Może mieć wartość null, jeśli podano nieprawidłowe mapowania rozmiaru.

googletagSlot

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

Podsumowanie metod
addService
Dodaje element Service do tego boksu.
clearCategoryExclusions
Usuwa wszystkie etykiety wykluczenia kategorii reklam na poziomie boksu dla tego boksu.
clearTargeting
Usuwa określone lub wszystkie parametry kierowania niestandardowego na poziomie boksu.
defineSizeMapping
Ustawia tablicę mapowań od minimalnego rozmiaru widocznego obszaru do rozmiaru boksu dla tego boksu.
get
Zwraca wartość atrybutu AdSense powiązanego z podanym kluczem dla tego boksu.
getAdUnitPath
Zwraca pełną ścieżkę jednostki reklamowej wraz z kodem sieci i ścieżką jednostki reklamowej.
getAttributeKeys
Zwraca listę kluczy atrybutów ustawionych w tym boksie.
getCategoryExclusions
Zwraca etykiety wykluczenia kategorii reklam dla tego boksu.
getResponseInformation
Zwraca informacje o odpowiedzi na żądanie reklamy.
getSlotElementId
Zwraca identyfikator boksu div podanego podczas jego zdefiniowania.
getTargeting
Zwraca określony parametr kierowania niestandardowego ustawiony w tym boksie.
getTargetingKeys
Zwraca listę wszystkich kluczy kierowania niestandardowego ustawionych w tym boksie.
set
Ustawia wartość atrybutu AdSense w tym boksie reklamowym.
setCategoryExclusion
Ustawia etykietę wykluczenia kategorii reklamy na poziomie boksu w tym boksie.
setClickUrl
Ustawia klikany URL, na który użytkownicy są przekierowywani po kliknięciu reklamy.
setCollapseEmptyDiv
Określa, czy boks div ma być ukryty, gdy nie ma w nim reklamy.
setConfig
Ustawia ogólne opcje konfiguracji tego przedziału.
setForceSafeFrame
Określa, czy reklamy w tym boksie mają wymuszać renderowanie za pomocą kontenera SafeFrame.
setSafeFrameConfig
Określa ustawienia na poziomie boksu w przypadku konfiguracji SafeFrame.
setTargeting
Ustawia parametr kierowania niestandardowego dla tego boksu.
updateTargetingFromMap
Ustawia niestandardowe parametry kierowania dla tego boksu z mapy klucz:wartość w obiekcie JSON.

addService

  • addService(service: Service): Slot

  • Dodaje element Service do tego boksu.

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
    Zobacz też
  • Parametry
    service: Service
    Usługa, która ma zostać dodana.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

clearCategoryExclusions

  • clearCategoryExclusions(): Slot

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

  • Przykład

    JavaScript

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

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

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

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

    JavaScript (starsza wersja)

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

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

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

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

    TypeScript

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

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

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

// Make an ad request. Any ad can be returned for the slot.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

clearTargeting

  • clearTargeting(key?: string): Slot

  • Usuwa określone lub wszystkie parametry kierowania niestandardowego na poziomie boksu.

  • Przykład

    JavaScript

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

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

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

    JavaScript (starsza wersja)

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

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

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

    TypeScript

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

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

slot.clearTargeting();
// All targeting has been cleared.
    Zobacz też
  • Parametry
    key?: string
    Klucz parametru kierowania. Klucz jest opcjonalny. Jeśli nie określono inaczej, wszystkie parametry kierowania zostaną wyczyszczone.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

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ż
  • Parametry
    sizeMapping: SizeMappingArray
    Tablica mapowań rozmiarów. Aby go utworzyć, możesz użyć narzędzia SizeMappingBuilder. Każde mapowanie rozmiaru składa się z 2 elementów: SingleSizeArray i GeneralSize.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

get

  • get(key: string): null | string

  • Zwraca wartość atrybutu AdSense powiązanego z podanym kluczem dla tego boksu. Aby zobaczyć atrybuty na poziomie usługi odziedziczone przez ten przedział, użyj tagu PubAdsService.get.

  • Przykład

    JavaScript

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

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

    JavaScript (starsza wersja)

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

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

    TypeScript

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

slot.get("adsense_background_color");
// Returns '#FFFFFF'.
    Zobacz też
  • Parametry
    key: string
    Nazwa atrybutu do wyszukania.
  • Zwroty
    null | string
    Bieżąca wartość klucza atrybutu lub null, jeśli klucz nie istnieje.

getAdUnitPath

  • getAdUnitPath(): string

  • Zwraca pełną ścieżkę jednostki reklamowej wraz 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 odziedziczonych przez ten przedział, użyj narzędzia 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 dla tego boksu.

  • Przykład

    JavaScript

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

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

    JavaScript (starsza wersja)

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

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

    TypeScript

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

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].
  • Zwroty
    string[]
    Etykiety wykluczenia kategorii reklam dla tego boksu lub pusta tablica, jeśli nie ustawiono żadnej.

getResponseInformation

  • getResponseInformation(): null | ResponseInformation

  • Zwraca informacje o odpowiedzi na żądanie reklamy. Jest ona obliczana na podstawie ostatniej odpowiedzi na reklamę w danym boksie. Jeśli ta funkcja jest wywoływana, gdy boks nie zawiera reklamy, zwracana jest metoda null.

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

getSlotElementId

  • getSlotElementId(): string

  • Zwraca identyfikator boksu div podanego podczas jego zdefiniowania.

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

getTargeting

  • getTargeting(key: string): string[]

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

  • Przykład

    JavaScript

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

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

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

    JavaScript (starsza wersja)

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

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

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

    TypeScript

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

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

slot.getTargeting("age");
// Returns [] (empty array).
  • Parametry
    key: string
    Klucz kierowania, na który należy zwrócić uwagę.
  • 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.

  • 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 dla danego klucza na poziomie usługi.

    Wywołanie tej metody więcej niż raz dla tego samego klucza spowoduje zastąpienie wcześniej ustawionych dla niego wartości. Przed wywołaniem funkcji display lub refresh należy ustawić wszystkie wartości.

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    // Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());
    Zobacz też
  • Parametry
    key: string
    Nazwa atrybutu.
    value: string
    Wartość atrybutu.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): Slot

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

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    // Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());
    Zobacz też
  • Parametry
    categoryExclusion: string
    Etykieta wykluczenia kategorii reklamy, którą chcesz dodać.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

setClickUrl

  • setClickUrl(value: string): Slot

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

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

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());
  • Parametry
    value: string
    Klikany URL do ustawienia.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

setCollapseEmptyDiv

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

  • Określa, czy boks div ma być ukryty, gdy nie ma w nim reklamy. Spowoduje to zastąpienie ustawień na poziomie usługi.

  • Przykład

    JavaScript

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

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

    JavaScript (starsza wersja)

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

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

    TypeScript

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.
    Zobacz też
  • Parametry
    collapse: boolean
    Określa, czy zwinąć boks, jeśli nie zostanie zwrócona żadna reklama.
    collapseBeforeAdFetch?: boolean
    Określa, czy zwinąć boks jeszcze przed pobraniem reklamy. Ignorowane, jeśli zwijanie nie jest typu true.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

setConfig

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): Slot

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

    Korzystając z tego interfejsu API, pamiętaj o tych kwestiach:

    • To ustawienie będzie obowiązywać tylko w przypadku kolejnych żądań reklamy wysyłanych do odpowiednich boksów.
    • Ustawienie na poziomie boksu, jeśli zostanie określone, zawsze zastąpi ustawienie na poziomie strony.
    • Jeśli ustawisz wartość true (na poziomie boksu lub strony), reklama będzie zawsze renderowana przy użyciu kontenera SafeFrame niezależnie od opcji wybranych w interfejsie Google Ad Managera.
    • Jeśli jednak ustawisz wartość false lub nie określisz tego ustawienia, reklama będzie renderowana przy użyciu kontenera SafeFrame w zależności od typu kreacji i ustawień wybranych w interfejsie Google Ad Managera.
    • Z tego interfejsu API należy korzystać z rozwagą, ponieważ może on wpływać na zachowanie kreacji, które próbują wyjść z elementów iframe lub polegają na renderowaniu ich bezpośrednio na stronie wydawcy.

  • Przykład

    JavaScript

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

    JavaScript (starsza wersja)

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

    TypeScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());
    Zobacz też
  • Parametry
    forceSafeFrame: boolean
    true, aby wymusić renderowanie w SafeFrame wszystkich reklam w tym boksie, a false – rezygnację z ustawienia na poziomie strony (jeśli taka opcja jest dostępna). Ustawienie wartości false, jeśli nie jest ono określone na poziomie strony, niczego nie zmieni.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig): Slot

  • Określa ustawienia na poziomie boksu w przypadku konfiguracji SafeFrame. Wszystkie nierozpoznane klucze w obiekcie konfiguracji będą ignorowane. Jeśli dla rozpoznanego klucza zostanie przekazana nieprawidłowa wartość, cała konfiguracja zostanie zignorowana.

    Te ustawienia na poziomie boksu, jeśli zostaną określone, zastąpią wszelkie ustawienia na poziomie strony.

  • Przykład

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    JavaScript (starsza wersja)

    googletag.pubads().setForceSafeFrame(true);

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

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

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

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

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

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

googletag.display("div-1");
googletag.display("div-2");
    Zobacz też
  • Parametry
    config: null | SafeFrameConfig
    Obiekt konfiguracji.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

setTargeting

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

  • Ustawia parametr kierowania niestandardowego dla tego boksu. Wielokrotne wywołanie tej metody z jednym kluczem spowoduje zastąpienie starych wartości. Wartości ustawione tutaj zastępują parametry kierowania ustawione na poziomie usługi. Klucze te są zdefiniowane na koncie Google Ad Managera.

  • Przykład

    JavaScript

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

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

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

    JavaScript (starsza wersja)

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

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

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

    TypeScript

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

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

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);
    Zobacz też
  • Parametry
    key: string
    Klucz parametru kierowania.
    value: string | string[]
    Wartość parametru kierowania lub tablica wartości.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

updateTargetingFromMap

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

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

    Uwagi:

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

  • Przykład

    JavaScript

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

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

    JavaScript (starsza wersja)

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

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

    TypeScript

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

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});
  • Parametry
    map: {  [adUnitPath: string]: string | string[] }
    Mapa klucz:wartość parametru kierowania.
  • Zwroty
    Slot
    Obiekt boksu, dla którego została wywołana metoda.

, googletagconfigAdExpansionConfig

Ustawienia zarządzania rozwijaniem reklam.

Podsumowanie właściwości
enabled
Określa, czy rozwijanie reklam jest włączone czy wyłączone.
Przykład

JavaScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

JavaScript (starsza wersja)

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

enabled

, googletagconfigComponentAuctionConfig

Obiekt reprezentujący aukcję z jednym komponentem w aukcji reklam na urządzeniu.

Podsumowanie właściwości
auctionConfig
Obiekt konfiguracji aukcji na potrzeby tej aukcji komponentu.
configKey
Klucz konfiguracji powiązany z tą aukcją komponentów.
Zobacz też

auctionConfig

  • auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: {  [buyer: string]: number }, perBuyerGroupLimits: {  [buyer: string]: number }, perBuyerSignals: {  [buyer: string]: unknown }, perBuyerTimeouts: {  [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }

  • Obiekt konfiguracji aukcji dla tej aukcji komponentów.

    Jeśli ta wartość jest ustawiona na null, istniejąca konfiguracja określonego zasobu (configKey) zostanie usunięta.

  • Przykład

    JavaScript

    const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

    JavaScript (starsza wersja)

    var componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

    TypeScript

    const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});
    Zobacz też

configKey

  • configKey: string

  • Klucz konfiguracji powiązany z tą aukcją komponentu.

    Ta wartość nie może być pusta i powinna być unikalna. Jeśli 2 obiekty ComponentAuctionConfig mają taką samą wartość configKey, ten, który zostanie ustawiony jako ostatni, zastąpi poprzednie konfiguracje.

, googletagconfigInterstitialConfig

Obiekt, który określa działanie pojedynczego pełnoekranowego boksu reklamowego.

Podsumowanie właściwości
triggers
Konfiguracja reguły powiązanej z tą reklamą pełnoekranową.

triggers

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

  • Konfiguracja reguły reguły dla tej reklamy pełnoekranowej.

    Ustawienie wartości reguły dla reklamy pełnoekranowej na true spowoduje jej włączenie, a false spowoduje jej 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ż

, googletagconfigPageSettingsConfig

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

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

Wszystkie właściwości wymienione poniżej są przykładami i nie odzwierciedlają rzeczywistych funkcji korzystających z metody setConfig. Listę funkcji można znaleźć w polach typu PageSettingsConfig poniżej.

Przykłady:

  • Zmodyfikowane są tylko funkcje określone w wywołaniu setConfig. 
      // Configure feature alpha.
  googletag.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  googletag.setConfig({
     bravo: {...}
  });
  • Wszystkie ustawienia danej funkcji są aktualizowane po każdym wywołaniu funkcji setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  googletag.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  googletag.setConfig({
      charlie: {
          echo: 2
      }
  });
  • Wszystkie ustawienia funkcji można wyczyścić, uzyskując wynik null. 
      // Configure features delta, golf, and hotel.
  googletag.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

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

Podsumowanie właściwości
adExpansion
Ustawienia zarządzania rozwijaniem reklam.
adYield
Wycofano. .
pps
Ustawienia umożliwiające kontrolowanie sygnałów dostarczanych przez wydawcę.
privacyTreatments
Ustawienia umożliwiające zarządzanie opcjami prywatności wydawcy.
threadYield
Ustawienie określające, czy GPT ma generować wątek JS podczas renderowania kreacji.

adExpansion

adYield

  • adYield: null | "DISABLED" | "ENABLED_ALL_SLOTS"

pps

privacyTreatments

  • privacyTreatments: null | PrivacyTreatmentsConfig

  • Ustawienia umożliwiające zarządzanie opcjami prywatności wydawcy.

threadYield

  • threadYield: null | "DISABLED" | "ENABLED_ALL_SLOTS"

  • Ustawienie określające, czy GPT ma generować wątek JS podczas renderowania kreacji.

    GPT będzie wyświetlać reklamy tylko w przeglądarkach, które obsługują interfejs Scheduler.postTask API.

    Obsługiwane wartości:

    • null (domyślnie): w przypadku boksów poza widocznym obszarem GPT zwraca ona wątek JS.
    • ENABLED_ALL_SLOTS: GPT zwróci wątek JS dla wszystkich boksów niezależnie od tego, czy boks znajduje się w widocznym obszarze.
    • DISABLED: GPT nie zwróci wątku JS.

  • Przykład

    JavaScript

    // Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

    JavaScript (starsza wersja)

    // Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

    TypeScript

    // Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });
    Zobacz też

, googletagconfigPrivacyTreatmentsConfig

Ustawienia umożliwiające zarządzanie opcjami prywatności wydawcy.

Podsumowanie właściwości
treatments
Szereg metod ochrony prywatności wydawcy, które można włączyć.

treatments

  • treatments: "disablePersonalization"[]

  • Szereg metod ochrony prywatności wydawcy, które można włączyć.

  • Przykład

    JavaScript

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

    JavaScript (starsza wersja)

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

    TypeScript

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

, googletagconfigPublisherProvidedSignalsConfig

Obiekt konfiguracji sygnałów dostarczanych przez wydawcę.

Podsumowanie właściwości
taxonomies
Obiekt zawierający mapowania taksonomii.
Przykład

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

JavaScript (starsza wersja)

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
Zobacz też

taxonomies

, googletagconfigSlotSettingsConfig

Główny interfejs konfiguracyjny ustawień na poziomie przedziału.

Umożliwia ustawienie wielu funkcji za pomocą pojedynczego wywołania API dla jednego przedziału.

Wszystkie właściwości wymienione poniżej są przykładami i nie odzwierciedlają rzeczywistych funkcji korzystających z metody setConfig. Aby dowiedzieć się więcej o zestawie funkcji, zapoznaj się z polami poniżej typu SlotSettingsConfig.

Przykłady:

  • Zmodyfikowane są tylko funkcje określone w wywołaniu Slot.setConfig. 
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);

  // Configure feature alpha.
  slot.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  slot.setConfig({
     bravo: {...}
  });
  • Wszystkie ustawienia danej funkcji są aktualizowane po każdym wywołaniu funkcji Slot.setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  slot.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  slot.setConfig({
      charlie: {
          echo: 2
      }
  });
  • Wszystkie ustawienia funkcji można wyczyścić, uzyskując wynik null. 
      // Configure features delta, golf, and hotel.
  slot.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

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

Podsumowanie właściwości
adExpansion
Ustawienia zarządzania rozwijaniem reklam.
componentAuction
Tablica aukcji komponentów, które mają być uwzględnione w aukcji reklam na urządzeniu.
interstitial
Ustawienia, które kontrolują działanie pełnoekranowych boksów reklamowych.

adExpansion

componentAuction

  • componentAuction: ComponentAuctionConfig[]

  • Tablica aukcji komponentów, które mają być uwzględnione w aukcji reklam na urządzeniu.

interstitial

  • interstitial: InterstitialConfig

  • Ustawienia, które kontrolują działanie pełnoekranowych boksów reklamowych.

, googletagconfigTaxonomyData

Obiekt zawierający wartości pojedynczej taksonomii.

Podsumowanie właściwości
values
Lista wartości z taksonomii.

values

, googletageventsEvent

Podstawowy interfejs wszystkich zdarzeń GPT. Wszystkie poniższe zdarzenia GPT będą miały podane niżej pola.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
Zobacz też

serviceName

  • serviceName: string

  • Nazwa usługi, która wywołała zdarzenie.

slot

  • slot: Slot

  • Przedział, który wywołał zdarzenie.

, googletageventsEventTypeMap

Jest to pseudotyp, który mapuje nazwę zdarzenia na odpowiedni typ obiektu zdarzenia Service.addEventListener i Service.removeEventListener. Jest ona udokumentowana wyłącznie w celach informacyjnych i dotyczących bezpieczeństwa podczas wpisywania.

Podsumowanie właściwości
gameManualInterstitialSlotClosed
gameManualInterstitialSlotReady
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
slotOnload
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

gameManualInterstitialSlotClosed

gameManualInterstitialSlotReady

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotVisibilityChanged

, googletageventsGameManualInterstitialSlotClosedEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy użytkownik zamknął boks reklamy pełnoekranowej z ręczną konfiguracją.

Uwaga: reklama pełnoekranowa utworzona ręcznie w grze ma format z ograniczonym dostępem.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
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ż

, googletageventsGameManualInterstitialSlotReadyEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy ręczna reklama pełnoekranowa w grze jest gotowa do wyświetlenia użytkownikowi.

Uwaga: ręczna reklama pełnoekranowa w grze ma format z ograniczonym dostępem.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
Podsumowanie metod
makeGameManualInterstitialVisible
Wyświetla użytkownikowi reklamę pełnoekranową z ręczną grą.
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ż

makeGameManualInterstitialVisible

  • makeGameManualInterstitialVisible(): void

  • Wyświetla użytkownikowi reklamę pełnoekranową z ręczną konfiguracją gry.

, googletageventsImpressionViewableEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy wyświetlenie staje się widoczne zgodnie z kryteriami Widoku aktywnego.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
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ż

, googletageventsRewardedSlotClosedEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy użytkownik zamknie boks reklamowy z nagrodą. Może się uruchomić przed przyznaniem nagrody lub po jej przyznaniu. Aby sprawdzić, czy nagroda została przyznana, użyj parametru events.RewardedSlotGrantedEvent.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
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ż

, googletageventsRewardedSlotGrantedEvent

Rozszerza Event

To zdarzenie jest wywoływane po przyznaniu nagrody za obejrzenie reklamy z nagrodą. Jeśli reklama zostanie zamknięta, zanim zostaną spełnione kryteria przyznania nagrody, zdarzenie nie uruchomi się.

Podsumowanie właściwości
payload
Obiekt z informacjami o przyznanej nagrodzie.
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
Przykład

JavaScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

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

JavaScript (starsza wersja)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
  var _a, _b;
  var slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
  console.log(
    "Reward amount:",
    (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount
  );
  console.groupEnd();

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

TypeScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

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

payload

  • payload: null | RewardedPayload

  • Obiekt z informacjami o przyznanej nagrodzie.

, googletageventsRewardedSlotReadyEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy reklama z nagrodą jest gotowa do wyświetlenia. Wydawca odpowiada za umożliwienie użytkownikowi obejrzenia reklamy przed jej wyświetleniem.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
Podsumowanie metod
makeRewardedVisible
Wyświetla reklamę z nagrodą.
Przykład

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

JavaScript (starsza wersja)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

makeRewardedVisible

  • makeRewardedVisible(): void

  • Wyświetla reklamę z nagrodą. Ta metoda nie powinna być wywoływana, dopóki użytkownik nie wyrazi zgody na wyświetlenie reklamy.

, googletageventsSlotOnloadEvent

Rozszerza Event

To zdarzenie jest wywoływane, gdy element iframe kreacji uruchomi zdarzenie wczytywania. Podczas renderowania reklam multimedialnych w trybie renderowania synchronicznego nie są używane żadne elementy iframe, więc tag SlotOnloadEvent nie jest wywoływany.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
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ż

, googletageventsSlotRenderEndedEvent

Rozszerza Event

To zdarzenie jest wywoływane po wstrzykiwaniu kodu kreacji w boksie. To zdarzenie nastąpi przed pobraniem zasobów kreacji, więc kreacja może nie być jeszcze widoczna. Jeśli chcesz dowiedzieć się, kiedy wszystkie zasoby kreacji w danym boksie zostaną wczytane, skorzystaj z instrukcji events.SlotOnloadEvent.

Podsumowanie właściwości
advertiserId
Identyfikator reklamodawcy renderowanej reklamy.
campaignId
Identyfikator kampanii renderowanej reklamy.
companyIds
Identyfikatory firm, które ustalały stawki za wyrenderowaną reklamę zapasową.
creativeId
Identyfikator kreacji wyrenderowanej reklamy z rezerwacją.
creativeTemplateId
Identyfikator szablonu kreacji wyrenderowanej reklamy z rezerwacją.
isBackfill
Wskazuje, czy reklama była reklamą zapasową.
isEmpty
Wskazuje, czy reklama została zwrócona dla boksu.
labelIds
Identyfikatory etykiet renderowanej reklamy.
lineItemId
Identyfikator elementu zamówienia wyrenderowanej reklamy z rezerwacji.
serviceName
Nazwa usługi, która wywołała zdarzenie.
size
Wskazuje rozmiar renderowanej kreacji w pikselach.
slot
Przedział, który wywołał zdarzenie.
slotContentChanged
Określa, czy treść boksu została zmieniona z wyrenderowaną reklamą.
sourceAgnosticCreativeId
Identyfikator kreacji renderowanej reklamy z rezerwacją lub zapasowej.
sourceAgnosticLineItemId
Identyfikator elementu zamówienia wyrenderowanej reklamy z rezerwacji lub reklamy zapasowej.
yieldGroupIds
Identyfikatory grup zysku wyrenderowanej reklamy zapasowej.
Przykład

JavaScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

JavaScript (starsza wersja)

// This listener is called when a slot has finished rendering.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", function (event) {
  var slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

TypeScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

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

advertiserId

  • advertiserId: null | number

  • Identyfikator reklamodawcy renderowanej reklamy. Wartość to null w przypadku pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niż PubAdsService.

campaignId

  • campaignId: null | number

  • Identyfikator kampanii renderowanej reklamy. Wartość to null w przypadku pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niż PubAdsService.

companyIds

  • companyIds: null | number[]

  • Identyfikatory firm, które ustalały stawki za wyrenderowaną reklamę zapasową. Wartość to null w przypadku pustych boksów, reklam z rezerwacji i kreacji renderowanych przez usługi inne niż PubAdsService.

creativeId

  • creativeId: null | number

  • Identyfikator kreacji wyrenderowanej reklamy z rezerwacją. Wartość to null w przypadku pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niż PubAdsService.

creativeTemplateId

  • creativeTemplateId: null | number

  • Identyfikator szablonu kreacji wyrenderowanej reklamy z rezerwacją. Wartość to null w przypadku pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niż PubAdsService.

isBackfill

  • isBackfill: boolean

  • Wskazuje, czy reklama była reklamą zapasową. Wartość to true, jeśli była to reklama zapasowa. W przeciwnym razie wartość to false.

isEmpty

  • isEmpty: boolean

  • Wskazuje, czy reklama została zwrócona dla boksu. Wartość to true, jeśli nie została zwrócona żadna reklama. W przeciwnym razie false.

labelIds

  • labelIds: null | number[]

  • Identyfikatory etykiet renderowanej reklamy. Wartość to null w przypadku pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niż PubAdsService.

lineItemId

  • lineItemId: null | number

  • Identyfikator elementu zamówienia wyrenderowanej reklamy z rezerwacji. Wartość to null w przypadku pustych boksów, zapasowych reklam i kreacji renderowanych przez usługi inne niż PubAdsService.

size

  • size: null | string | number[]

  • Wskazuje rozmiar renderowanej kreacji w pikselach. Przykład: [728, 90]. Wartość to null (puste boksy reklamowe).

slotContentChanged

  • slotContentChanged: boolean

  • Określa, czy treść boksu została zmieniona z wyrenderowaną reklamą. Wartość to true, jeśli treść została zmieniona, lub false w innym przypadku.

sourceAgnosticCreativeId

  • sourceAgnosticCreativeId: null | number

  • Identyfikator kreacji renderowanej reklamy z rezerwacją lub zapasowej. Wartość to null, jeśli reklama nie jest rezerwacją ani zapasowego elementu zamówienia lub kreacja jest renderowana przez usługi inne niż PubAdsService.

sourceAgnosticLineItemId

  • sourceAgnosticLineItemId: null | number

  • Identyfikator elementu zamówienia wyrenderowanej reklamy z rezerwacji lub reklamy zapasowej. Wartość to null, jeśli reklama nie jest rezerwacją ani zapasowego elementu zamówienia lub kreacja jest renderowana przez usługi inne niż PubAdsService.

yieldGroupIds

  • yieldGroupIds: null | number[]

  • Identyfikatory grup zysku wyrenderowanej reklamy zapasowej. Wartość to null w przypadku pustych boksów, reklam z rezerwacji i kreacji renderowanych przez usługi inne niż PubAdsService.

, googletageventsSlotRequestedEvent

Rozszerza Event

To zdarzenie jest wywoływane po wysłaniu żądania reklamy dla określonego boksu.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
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ż

, googletageventsSlotResponseReceived

Rozszerza Event

To zdarzenie jest wywoływane po otrzymaniu odpowiedzi na reklamę w danym boksie.

Podsumowanie właściwości
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
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ż

, googletageventsSlotVisibilityChangedEvent

Rozszerza Event

To zdarzenie jest wywoływane po każdej zmianie odsetka powierzchni boksu reklamowego na ekranie. Zdarzenie jest ograniczane i uruchamiane nie częściej niż co 200 ms.

Podsumowanie właściwości
inViewPercentage
Odsetek obszaru reklamy, który jest widoczny.
serviceName
Nazwa usługi, która wywołała zdarzenie.
slot
Przedział, który wywołał zdarzenie.
Przykład

JavaScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

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

JavaScript (starsza wersja)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

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

TypeScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

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

inViewPercentage

  • inViewPercentage: number

  • Odsetek obszaru reklamy, który jest widoczny. Wartość musi być liczbą od 0 do 100.

, googletagsecureSignalsBidderSignalProvider

Zwraca bezpieczny sygnał dla konkretnego licytującego.

Dostawca bezpiecznych sygnałów licytującego składa się z 2 części:

  1. Funkcja kolektora, która zwraca pole Promise kierujące do bezpiecznego sygnału.
  2. Identyfikator id, który identyfikuje licytującego powiązanego z sygnałem.
Aby zwrócić bezpieczny sygnał wydawcy, użyj narzędzia secureSignals.PublisherSignalProvider.

Podsumowanie właściwości
collectorFunction
.
id
Unikalny identyfikator sprzedawcy powiązany z tym bezpiecznym sygnałem zarejestrowany w usłudze Google Ad Manager.
Przykład

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (starsza wersja)

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
Zobacz też

collectorFunction

  • collectorFunction: () => Promise<string>

id

  • id: string

  • Unikalny identyfikator sprzedawcy powiązany z tym bezpiecznym sygnałem zarejestrowany w usłudze Google Ad Manager.

, googletagsecureSignalsPublisherSignalProvider

Zwraca bezpieczny sygnał dla określonego wydawcy.

Dostawca sygnałów wydawcy składa się z 2 części:

  1. Funkcja kolektora, która zwraca pole Promise kierujące do bezpiecznego sygnału.
  2. Identyfikator networkCode, który identyfikuje wydawcę powiązanego z sygnałem.
Aby zwrócić bezpieczny sygnał licytującego, użyj narzędzia secureSignals.BidderSignalProvider.

Podsumowanie właściwości
collectorFunction
.
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ż

collectorFunction

  • collectorFunction: () => Promise<string>

networkCode

  • networkCode: string

  • Kod sieci (widoczny w ścieżce jednostki reklamowej) wydawcy powiązanego z tym bezpiecznym sygnałem.

, googletagsecureSignalsSecureSignalProvidersArray

Interfejs do zarządzania bezpiecznymi sygnałami.

Podsumowanie metod
clearAllCache
Usuwa z pamięci podręcznej wszystkie sygnały wszystkich kolektorów.
push
Dodaje nowy obiekt secureSignals.SecureSignalProvider do tablicy dostawcy sygnału i rozpoczyna proces generowania sygnału.

clearAllCache

  • clearAllCache(): void

  • Usuwa z pamięci podręcznej wszystkie sygnały wszystkich odbiorców zbierających dane.

    Wywołanie tej metody może zmniejszyć prawdopodobieństwo uwzględnienia sygnałów w żądaniach reklamy dla bieżących i potencjalnie późniejszych wyświetleń strony. Z tego względu powinna być wywoływana tylko wtedy, gdy wystąpią znaczące zmiany stanu, np. zdarzenia wskazujące nowego użytkownika (logowanie, wylogowanie, rejestracja itp.).

push