Aidez-nous à améliorer l'expérience des développeurs Google Publisher Tag en répondant à l'enquête 2024 destinée aux développeurs sur les tags Google Publisher Tag.

Cette page a été traduite par l'API Cloud Translation.

Documentation de référence sur GPT

Ce document de référence utilise la notation TypeScript pour décrire les types. Le tableau suivant fournit une brève explication par exemple.

Expression de type
`string`	Type de chaîne primitif.
`string[]`	Type de tableau, où les valeurs ne peuvent être que des chaînes.
`number \| string`	Type d'union, où la valeur peut être un nombre ou une chaîne.
`Array<number \| string>`	Type de tableau, où les valeurs sont de type complexe (union).
`[number, string]`	Type de tuple, où la valeur est un tableau à deux éléments qui doit contenir un nombre et une chaîne dans cet ordre.
`Slot`	Un type d'objet, dont la valeur est une instance de `googletag.Slot`.
`() => void`	Type de fonction sans arguments définis ni valeur renvoyée.

Pour en savoir plus sur les types et les expressions de type acceptés, consultez le Manuel TypeScript .

Annotations de type

Un deux-points après une variable, un nom de paramètre, un nom de propriété ou une signature de fonction indique une annotation de type. Les annotations de type décrivent les types que l'élément situé à gauche du deux-points peut accepter ou renvoyer. Le tableau suivant présente des exemples d'annotations de type que vous pouvez voir dans cette documentation de référence.

Annotation de type
`param: string`	Indique que `param` accepte ou renvoie une valeur de chaîne. Cette syntaxe est utilisée pour les variables, les paramètres, les propriétés et les types de retour.
`param?: number \| string`	Indique que `param` est facultatif, mais accepte un nombre ou une chaîne lorsqu'il est spécifié. Cette syntaxe est utilisée pour les paramètres et les propriétés.
`...params: Array<() => void>`	Indique que `params` est un paramètre de repos qui accepte des fonctions. Les paramètres REST acceptent un nombre illimité de valeurs du type spécifié.

googletag

Espace de noms global utilisé par la balise Google Publisher Tag pour son API.

Espaces de noms
`config`	Interface de configuration principale pour les paramètres au niveau de la page.
`enums`	Il s'agit de l'espace de noms que GPT utilise pour les types d'énumération.
`events`	Il s'agit de l'espace de noms que GPT utilise pour les événements.
`secureSignals`	Il s'agit de l'espace de noms que GPT utilise pour gérer les signaux sécurisés.

Interfaces
`CommandArray`	Le tableau de commandes accepte une séquence de fonctions et les appelle dans l'ordre.
`CompanionAdsService`	Service Annonces associées.
`PrivacySettingsConfig`	Objet de configuration pour les paramètres de confidentialité.
`PubAdsService`	Service Annonces de l'éditeur
`ResponseInformation`	Objet représentant une seule réponse d'annonce.
`RewardedPayload`	Objet représentant la récompense associée à une annonce avec récompense.
`SafeFrameConfig`	Objet de configuration pour les conteneurs SafeFrame.
`Service`	Classe de service de base contenant les méthodes communes à tous les services.
`SizeMappingBuilder`	Compilateur pour les objets de spécification de mappage de taille.
`Slot`	Un emplacement est un objet représentant un seul espace publicitaire sur une page.

Alias de type
`GeneralSize`	Configuration de taille valide pour un emplacement, qui peut être une ou plusieurs tailles.
`MultiSize`	Liste de tailles uniques valides.
`NamedSize`	Tailles nommées qu'un emplacement peut avoir.
`SingleSize`	Taille unique valide pour un emplacement.
`SingleSizeArray`	Tableau de deux nombres représentant [largeur, hauteur].
`SizeMapping`	Mappage de la taille de la fenêtre d'affichage sur les tailles d'annonce.
`SizeMappingArray`	Liste des mappages de taille.

Variables
`apiReady`	Indicateur indiquant que l'API GPT est chargée et prête à être appelée.
`cmd`	Référence à la file d'attente de commandes globale pour l'exécution asynchrone des appels liés à GPT.
`pubadsReady`	Indicateur indiquant que PubAdsService est activé, chargé et entièrement opérationnel.
`secureSignalProviders`	Référence au tableau des fournisseurs de signaux sécurisés.

Fonctions
`companionAds`	Renvoie une référence à CompanionAdsService.
`defineOutOfPageSlot`	Construit un espace publicitaire hors page avec le chemin d'accès au bloc d'annonces donné.
`defineSlot`	Crée un espace publicitaire avec un chemin d'accès et une taille de bloc d'annonces donnés, puis l'associe à l'ID d'un élément div sur la page qui contiendra l'annonce.
`destroySlots`	Détruit les emplacements donnés, en supprimant tous les objets et références associés de ces emplacements du GPT.
`disablePublisherConsole`	Désactive la Console Google pour les éditeurs.
`display`	Indique aux services de slot d'afficher le slot.
`enableServices`	Active tous les services GPT qui ont été définis pour les espaces publicitaires de la page.
`getVersion`	Affiche la version actuelle de GPT.
`openConsole`	Ouvre la Console Google pour les éditeurs.
`pubads`	Renvoie une référence au PubAdsService.
`setAdIframeTitle`	Définit le titre de toutes les iFrames de conteneur d'annonces créées par PubAdsService à partir de ce point.
`setConfig`	Définit les options de configuration générales de la page.
`sizeMapping`	Crée un objet SizeMappingBuilder.

Alias de type

GeneralSize

GeneralSize: SingleSize | MultiSize

Une configuration de taille valide pour un emplacement, qui peut être une ou plusieurs tailles.

MultiSize

MultiSize: SingleSize[]

Liste des tailles valides uniques.

NamedSize

NamedSize: "fluid" | ["fluid"]

Tailles nommées qu'un emplacement peut avoir. Dans la plupart des cas, la taille est un rectangle de taille fixe, mais il existe des cas où nous avons besoin d'autres types de spécifications de taille. Seules les tailles nommées suivantes sont valides:

fluide: le conteneur d'annonce occupe 100% de la largeur de l'élément div parent, puis redimensionne sa hauteur pour s'adapter au contenu de la création. Comme les éléments de bloc standard sur une page. Utilisé pour les annonces natives (voir l'article associé). Notez que les valeurs fluid et ['fluid'] sont toutes deux acceptables pour déclarer une taille d'emplacement comme fluide.

SingleSize

SingleSize: SingleSizeArray | NamedSize

Taille unique valide pour un emplacement.

SingleSizeArray

SingleSizeArray: [number, number]

Tableau de deux nombres représentant [largeur, hauteur].

SizeMapping

SizeMapping: [SingleSizeArray, GeneralSize]

Mappage de la taille de la fenêtre d'affichage sur les tailles d'annonce. Utilisé pour les annonces responsives.

SizeMappingArray

SizeMappingArray: SizeMapping[]

Liste des mappages de taille.

Variables

`Const` apiReady

apiReady: boolean | undefined

Indicateur indiquant que l'API GPT est chargée et prête à être appelée. Cette propriété sera simplement undefined jusqu'à ce que l'API soit prête.

Notez que la méthode recommandée pour gérer l'async est d'utiliser googletag.cmd pour mettre en file d'attente les rappels lorsque GPT est prêt. Ces rappels n'ont pas besoin de vérifier googletag.apiReady, car ils sont garantis d'être exécutés une fois l'API configurée.

`Const` cmd

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

Référence à la file d'attente de commandes globale pour l'exécution asynchrone des appels liés à GPT.

La variable googletag.cmd est initialisée sur un tableau JavaScript vide par la syntaxe du tag GPT sur la page, et cmd.push est la méthode Array.push standard qui ajoute un élément à la fin du tableau. Lorsque le code JavaScript GPT est chargé, il examine le tableau et exécute toutes les fonctions dans l'ordre. Le script remplace ensuite cmd par un objet CommandArray dont la méthode push est définie pour exécuter l'argument de fonction qui lui est transmis. Ce mécanisme permet à GPT de réduire la latence perçue en récupérant le code JavaScript de manière asynchrone, tout en permettant au navigateur de continuer à afficher la page.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

`Const` pubadsReady

pubadsReady: boolean | undefined

Indique que PubAdsService est activé, chargé et entièrement opérationnel. Cette propriété sera simplement undefined jusqu'à ce que enableServices soit appelé et que PubAdsService soit chargé et initialisé.

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

Référence au tableau des fournisseurs de signaux sécurisés.

Le tableau des fournisseurs de signaux sécurisés accepte une séquence de fonctions générant des signaux et les appelle dans l'ordre. Il est destiné à remplacer un tableau standard utilisé pour mettre en file d'attente des fonctions générant des signaux à appeler une fois le GPT chargé.

Exemple

JavaScript

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

JavaScript (ancien)

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

Voir aussi

Partager des signaux sécurisés avec les enchérisseurs

Fonctions

companionAds

companionAds(): CompanionAdsService

Renvoie une référence à CompanionAdsService.

Renvoie
`CompanionAdsService`	Le service Annonces associées.

defineOutOfPageSlot

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

Construit un espace publicitaire hors page avec le chemin d'accès au bloc d'annonces indiqué.

Pour les annonces hors page personnalisées, div correspond à l'ID de l'élément div qui contiendra l'annonce. Pour en savoir plus, consultez l'article sur les créations hors page.

Pour les annonces hors page gérées par GPT, div est un OutOfPageFormat compatible.

Exemple

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 (ancien)

// 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);

Voir aussi

Paramètres
`adUnitPath: string`	Chemin d'accès complet au bloc d'annonces avec le code de réseau et le code du bloc d'annonces.
`Optional div: string \| OutOfPageFormat`	ID de la div qui contiendra ce bloc d'annonces ou ce OutOfPageFormat.

Renvoie
`Slot \| null`	Emplacement nouvellement créé, ou `null` si aucun espace ne peut être créé.

defineSlot

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

Crée un espace publicitaire avec un chemin d'accès et une taille de bloc d'annonces donnés, puis l'associe à l'ID d'un élément div sur la page qui contiendra l'annonce.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Voir aussi

Premiers pas avec les tags Google Publisher Tag

Paramètres
`adUnitPath: string`	Chemin d'accès complet du bloc d'annonces avec le code du réseau et le code de l'unité.
`size: GeneralSize`	Largeur et hauteur de l'emplacement ajouté. Il s'agit de la taille utilisée dans la demande d'annonce si aucun mappage de taille responsive n'est fourni ou si la taille de la fenêtre d'affichage est inférieure à la plus petite taille fournie dans le mappage.
`Optional div: string`	ID de la div qui contiendra ce bloc d'annonces.

Renvoie
`Slot \| null`	L'emplacement nouvellement créé ou `null` si aucun emplacement ne peut être créé.

destroySlots

destroySlots(slots?: Slot[]): boolean

Détruit les emplacements donnés, en supprimant tous les objets et références associés de ces emplacements du GPT. Cette API n'est pas compatible avec les emplacements de renvoi et associés.

En appelant cette API sur un espace publicitaire, l'annonce est effacée et l'objet de l'espace publicitaire est supprimé de l'état interne géré par GPT. L'appel d'autres fonctions sur l'objet Emplacement entraîne un comportement non défini. Notez que le navigateur peut toujours ne pas libérer la mémoire associée à cet emplacement si une référence y est maintenue par la page de l'éditeur. L'appel de cette API rend le div associé à cet espace disponible pour être réutilisé.

Plus précisément, la destruction d'un espace supprime l'annonce de la vue de page de longue durée de GPT. Les futures requêtes ne seront donc pas influencées par les obstacles ou les exclusions concurrentielles impliquant cette annonce. Si vous n'appelez pas cette fonction avant de supprimer le div d'un emplacement de la page, un comportement indéfini se produira.

Exemple

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 (ancien)

// 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();

Paramètres
`Optional slots: Slot[]`	Tableau des emplacements à détruire. Le tableau est facultatif. Tous les emplacements seront détruits s'il n'est pas spécifié.

Renvoie
`boolean`	`true` si les emplacements ont été détruits, et `false` dans le cas contraire.

disablePublisherConsole

disablePublisherConsole(): void

Désactive la Console Google pour les éditeurs.

Voir aussi

Console Google pour les éditeurs

Écran

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

Indique aux services de slot d'afficher le slot. Chaque espace publicitaire ne doit être affiché qu'une seule fois par page. Tous les espaces publicitaires doivent être définis et associés à un service avant d'être affichés. L'appel d'affichage ne doit pas se produire tant que l'élément n'est pas présent dans le DOM. La méthode habituelle consiste à le placer dans un bloc de script dans l'élément div nommé dans l'appel de méthode.

Si l'architecture de demande simple (SRA) est utilisée, tous les espaces publicitaires non récupérés au moment de l'appel de cette méthode seront récupérés en même temps. Pour forcer un espace publicitaire à ne pas s'afficher, vous devez supprimer l'intégralité de l'élément div.

Voir aussi

Paramètres
`divOrSlot: string \| Element \| Slot`	ID de l'élément div contenant l'emplacement d'annonce, ou élément div, ou objet d'emplacement. Si un élément div est fourni, il doit comporter un attribut "id" correspondant à l'ID transmis à defineSlot.

enableServices

enableServices(): void

Active tous les services GPT qui ont été définis pour les espaces publicitaires de la page.

getVersion

getVersion(): string

Renvoie la version actuelle de GPT.

Voir aussi

Historique des versions GPT

Renvoie
`string`	Chaîne de version GPT en cours d'exécution.

openConsole

openConsole(div?: string): void

Ouvre la Console Google pour les éditeurs.

Exemple

JavaScript

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

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

JavaScript (ancien)

// 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();

Voir aussi

Console Google pour les éditeurs

Paramètres
`Optional div: string`	ID de l'élément DIV de l'espace publicitaire. Cette valeur est facultative. Si vous fournissez un emplacement d'annonce, la Console pour les éditeurs tentera de s'ouvrir avec les détails de l'emplacement d'annonce spécifié à l'écran.

pubads

pubads(): PubAdsService

Renvoie une référence au PubAdsService.

Renvoie
`PubAdsService`	Le service Annonces pour les éditeurs

setAdIframeTitle

setAdIframeTitle(title: string): void

Définit le titre de toutes les iFrames de conteneur d'annonces créées par PubAdsService à partir de ce point.

Exemple

JavaScript

googletag.setAdIframeTitle("title");

JavaScript (ancien)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Paramètres
`title: string`	Nouveau titre de toutes les iFrames de conteneur d'annonces.

setConfig

setConfig(config: PageSettingsConfig): void

Définit les options de configuration générales de la page.

Paramètres
`config: PageSettingsConfig`

sizeMapping

sizeMapping(): SizeMappingBuilder

Crée un objet SizeMappingBuilder.

Voir aussi

Tailles d'annonces: annonces responsives

Renvoie
`SizeMappingBuilder`	Un nouveau générateur.

googletag.CommandArray

Le tableau de commandes accepte une séquence de fonctions et les appelle dans l'ordre. Il est destiné à remplacer un tableau standard utilisé pour mettre en file d'attente des fonctions à appeler une fois le GPT chargé.

Méthodes
`push`	Exécute la séquence de fonctions spécifiée dans les arguments dans l'ordre.

Méthodes

push

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

Exécute la séquence de fonctions spécifiée dans les arguments dans l'ordre.

Exemple

JavaScript

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

JavaScript (ancien)

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

Paramètres
`Rest ...f: ((this: typeof globalThis) => void)[]`	Fonction JavaScript à exécuter. La liaison d'exécution sera toujours `globalThis`. Envisagez de transmettre une fonction fléchée pour conserver la valeur `this` du contexte lexical englobant.

Renvoie
`number`	Nombre de commandes traitées jusqu'à présent. Cette valeur est compatible avec la valeur renvoyée par `Array.push` (la longueur actuelle du tableau).

googletag.CompanionAdsService

Étend Service

Service Annonces associées. Ce service est utilisé par les annonces vidéo pour diffuser des annonces associées.

Méthodes
`addEventListener`	Enregistre un écouteur qui vous permet de configurer et d'appeler une fonction JavaScript lorsqu'un événement GPT spécifique se produit sur la page. Hérité de `Service.addEventListener`
`getSlots`	Obtenez la liste des créneaux horaires associés à ce service. Hérité de `Service.getSlots`
`removeEventListener`	Supprime un écouteur précédemment enregistré. Hérité de `Service.removeEventListener`
`setRefreshUnfilledSlots`	Indique si les espaces publicitaires associés n'ayant pas reçu d'annonce recevront automatiquement une annonce de remplissage.

Voir aussi

Annonces associées pour la vidéo et l'audio

Méthodes

setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void

Détermine si les espaces publicitaires associés qui n'ont pas été remplis seront automatiquement remplis.

Cette méthode peut être appelée plusieurs fois au cours de la durée de vie de la page pour activer et désactiver le remplissage. Seuls les espaces publicitaires également enregistrés auprès de PubAdsService seront remplis. En raison de restrictions liées aux règles, cette méthode n'est pas conçue pour remplir les emplacements associés vides lorsqu'une vidéo Ad Exchange est diffusée.

Exemple

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (ancien)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Paramètres
`value: boolean`	`true` pour remplir automatiquement les emplacements vides, `false` pour les laisser inchangés.

googletag.PrivacySettingsConfig

Objet de configuration pour les paramètres de confidentialité.

Propriétés
`childDirectedTreatment?`	Indique si la page doit être traitée comme étant destinée aux enfants.
`limitedAds?`	Active la diffusion en mode annonces limitées pour aider les éditeurs à respecter les exigences réglementaires.
`nonPersonalizedAds?`	Active la diffusion en mode annonces non personnalisées pour aider les éditeurs à respecter les exigences réglementaires.
`restrictDataProcessing?`	Permet à la diffusion de s'exécuter en mode de traitement restreint pour aider les éditeurs à répondre à leurs obligations réglementaires.
`trafficSource?`	Indique si les demandes représentent du trafic acheté ou généré par les résultats naturels.
`underAgeOfConsent?`	Indique s'il faut marquer les demandes d'annonces comme provenant d'utilisateurs n'ayant pas atteint l'âge minimal requis.

Voir aussi

Configurer les paramètres de confidentialité

Propriétés

`Optional` childDirectedTreatment

childDirectedTreatment?: null | boolean

Indique si la page doit être traitée comme étant destinée aux enfants. Définissez sur null pour effacer la configuration.

`Optional` limitedAds

limitedAds?: boolean

Permet de diffuser des annonces en mode annonces limitées pour aider les éditeurs à respecter les exigences réglementaires.

Vous pouvez demander à GPT de demander des annonces limitées de deux manières:

Automatiquement, à l'aide d'un signal provenant d'une plate-forme de gestion du consentement conforme au TCF v2.0 de l'IAB.
Manuellement, en définissant la valeur de ce champ sur true.

URL des annonces limitées

avertissement de la console pour les éditeurs

Exemple

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 (ancien)

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

Voir aussi

Diffuser une annonce limitée

`Optional` nonPersonalizedAds

nonPersonalizedAds?: boolean

Active la diffusion en mode annonces non personnalisées pour aider les éditeurs à respecter les exigences réglementaires.

`Optional` restrictDataProcessing

restrictDataProcessing?: boolean

Permet à la diffusion de s'exécuter en mode de traitement restreint pour aider les éditeurs à répondre à leurs obligations réglementaires.

`Optional` trafficSource

trafficSource?: TrafficSource

Indique si les requêtes représentent du trafic acheté ou généré par les résultats naturels. Cette valeur renseigne la dimension Source de trafic dans les rapports Ad Manager. Si ce champ n'est pas défini, la source de trafic est définie par défaut sur undefined dans les rapports.

Exemple

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 (ancien)

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

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

TypeScript

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

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

`Optional` underAgeOfConsent

underAgeOfConsent?: null | boolean

Indique si les demandes d'annonces doivent être marquées comme provenant d'utilisateurs n'ayant pas atteint l'âge de consentement. Définissez la valeur sur null pour effacer la configuration.

googletag.PubAdsService

Étend Service

Service Annonces de l'éditeur Ce service permet d'extraire et d'afficher les annonces de votre compte Google Ad Manager.

Méthodes
`addEventListener`	Enregistre un écouteur qui vous permet de configurer et d'appeler une fonction JavaScript lorsqu'un événement GPT spécifique se produit sur la page. Hérité de `Service.addEventListener`
`clear`	Supprime les annonces des emplacements donnés et les remplace par du contenu vide.
`clearCategoryExclusions`	Efface tous les libellés d'exclusion de catégorie d'annonces au niveau de la page.
`clearTargeting`	Efface les paramètres de ciblage personnalisé pour une clé spécifique ou pour toutes les clés.
`collapseEmptyDivs`	Active le repli des divs d'espace publicitaire afin qu'ils ne prennent aucun espace sur la page lorsqu'il n'y a aucune annonce à afficher.
`disableInitialLoad`	Désactive les requêtes d'annonces au chargement de la page, mais permet de les demander avec un appel PubAdsService.refresh.
`display`	Crée et affiche un espace publicitaire avec le chemin d'accès et la taille du bloc d'annonces donnés.
`enableLazyLoad`	Active le chargement paresseux dans GPT, comme défini par l'objet de configuration.
`enableSingleRequest`	Active le mode de requête unique pour extraire plusieurs annonces en même temps.
`enableVideoAds`	Indique à GPT que des annonces vidéo seront diffusées sur la page.
`get`	Renvoie la valeur de l'attribut AdSense associé à la clé donnée.
`getAttributeKeys`	Renvoie les clés d'attribut définies sur ce service.
`getSlots`	Obtenez la liste des créneaux horaires associés à ce service. Hérité de `Service.getSlots`
`getTargeting`	Renvoie un paramètre de ciblage personnalisé au niveau du service qui a été défini.
`getTargetingKeys`	Renvoie la liste de toutes les clés de ciblage personnalisées au niveau du service qui ont été définies.
`isInitialLoadDisabled`	Indique si les requêtes initiales d'annonces ont été désactivées par un appel PubAdsService.disableInitialLoad précédent.
`refresh`	Récupère et affiche de nouvelles annonces pour des espaces publicitaires spécifiques ou pour tous les espaces de la page.
`removeEventListener`	Supprime un écouteur précédemment enregistré. Hérité de `Service.removeEventListener`
`set`	Définit les valeurs des attributs AdSense qui s'appliquent à tous les espaces publicitaires du service Annonces pour les éditeurs.
`setCategoryExclusion`	Définit une exclusion de catégorie d'annonces au niveau de la page pour le nom d'étiquette donné.
`setCentering`	Active et désactive le centrage horizontal des annonces.
`setForceSafeFrame`	Configure si l'affichage de toutes les annonces de la page doit être forcé à l'aide d'un conteneur SafeFrame.
`setLocation`	Transmet des informations de localisation provenant de sites Web afin que vous puissiez géocibler des éléments de campagne sur des zones géographiques spécifiques.
`setPrivacySettings`	Permet de configurer tous les paramètres de confidentialité à partir d'une seule API à l'aide d'un objet de configuration.
`setPublisherProvidedId`	Définit la valeur de l'identifiant fourni par l'éditeur.
`setSafeFrameConfig`	Définit les préférences au niveau de la page pour la configuration de SafeFrame.
`setTargeting`	Définit des paramètres de ciblage personnalisé pour une clé donnée qui s'appliquent à tous les emplacements publicitaires du service Annonces pour les éditeurs.
`setVideoContent`	Définit les informations sur le contenu vidéo à envoyer avec les demandes d'annonces à des fins de ciblage et d'exclusion de contenu.
`updateCorrelator`	Modifie le corrélateur envoyé avec les demandes d'annonces, ce qui lance une nouvelle page vue.

Méthodes

effacer

clear(slots?: Slot[]): boolean

Supprime les annonces des emplacements donnés et les remplace par du contenu vide. Les emplacements seront marqués comme non récupérés.

En particulier, effacer un emplacement supprime l'annonce de la vue de page persistante du GPT. Les futures requêtes ne seront donc pas influencées par les obstacles ou les exclusions concurrentielles impliquant cette annonce.

Exemple

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 (ancien)

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();

Paramètres
`Optional slots: Slot[]`	Tableau des emplacements à effacer. Le tableau est facultatif. Tous les emplacements seront effacés s'il n'est pas spécifié.

Renvoie
`boolean`	Renvoie `true` si les emplacements ont été effacés, ou `false` dans le cas contraire.

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService

Efface tous les libellés d'exclusion de catégorie d'annonces au niveau de la page. Cette option est utile si vous souhaitez actualiser l'emplacement.

Exemple

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 (ancien)

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

Voir aussi

Libellés personnalisés pour bloquer les annonces

Renvoie
`PubAdsService`	Objet de service sur lequel la méthode a été appelée.

clearTargeting

clearTargeting(key?: string): PubAdsService

Efface les paramètres de ciblage personnalisé pour une clé spécifique ou pour toutes les clés.

Exemple

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 (ancien)

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.

Voir aussi

Ciblage par clé-valeurs

Paramètres
`Optional key: string`	Clé du paramètre de ciblage. La clé est facultative. Si elle n'est pas spécifiée, tous les paramètres de ciblage seront effacés.

Renvoie
`PubAdsService`	Objet de service sur lequel la méthode a été appelée.

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Active le repli des divs d'espace publicitaire afin qu'ils ne prennent aucun espace sur la page lorsqu'il n'y a aucune annonce à afficher. Ce mode doit être défini avant l'activation du service.

Voir aussi

Paramètres
`Optional collapseBeforeAdFetch: boolean`	Indique si les espaces publicitaires doivent être réduits avant même que les annonces ne soient récupérées. Ce paramètre est facultatif. S'il n'est pas fourni, `false` est utilisé comme valeur par défaut.

Renvoie
`boolean`	Renvoie `true` si le mode de réduction de l'élément div est activé et `false` s'il est impossible d'activer ce mode, car la méthode a été appelée après l'activation du service.

disableInitialLoad

disableInitialLoad(): void

Désactive les requêtes d'annonces au chargement de la page, mais permet de les demander avec un appel PubAdsService.refresh. Ce paramètre doit être défini avant d'activer le service. Le mode asynchrone doit être utilisé. Sinon, il sera impossible de demander des annonces à l'aide de refresh.

Voir aussi

écran

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

Crée et affiche un espace publicitaire avec le chemin d'accès et la taille du bloc d'annonces donnés. Cette méthode ne fonctionne pas avec le mode de requête unique.

Remarque:Lorsque cette méthode est appelée, un instantané de l'emplacement et de l'état de la page est créé pour assurer la cohérence lors de l'envoi de la requête d'annonce et de l'affichage de la réponse. Toutes les modifications apportées à l'état de l'espace publicitaire ou de la page après l'appel de cette méthode (y compris le ciblage, les paramètres de confidentialité, les cadres SafeFrame, etc.) ne s'appliqueront qu'aux requêtes display() ou refresh() ultérieures.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Voir aussi

Paramètres
`adUnitPath: string`	Chemin d'accès du bloc d'annonces de l'espace à afficher.
`size: GeneralSize`	Largeur et hauteur de l'emplacement.
`Optional div: string \| Element`	ID de l'élément div contenant l'emplacement ou élément div lui-même.
`Optional clickUrl: string`	URL de suivi des clics à utiliser pour cet emplacement.

enableLazyLoad

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

Active le chargement paresseux dans GPT, comme défini par l'objet de configuration. Pour obtenir des exemples plus détaillés, consultez l'exemple de chargement différé.

Remarque:Le chargement différé dans SRA ne fonctionne que si tous les emplacements se trouvent en dehors de la marge de récupération.

Exemple

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 (ancien)

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

Voir aussi

Paramètres

Paramètres
`Optional config: { fetchMarginPercent?: number; mobileScaling?: number; renderMarginPercent?: number; }`	L'objet de configuration permet de personnaliser le comportement paresseux. Les configurations omises utiliseront une valeur par défaut définie par Google, qui sera ajustée au fil du temps. Pour désactiver un paramètre particulier, tel qu'une marge d'extraction, définissez la valeur sur `-1`. `fetchMarginPercent` Distance minimale de la fenêtre d'affichage actuelle pour laquelle un emplacement doit se trouver avant la récupération de l'annonce, sous la forme d'un pourcentage de la taille de la fenêtre d'affichage. Une valeur de 0 signifie "lorsque l'espace publicitaire entre dans la fenêtre d'affichage", 100 signifie "lorsque l'annonce est à une fenêtre d'affichage de distance", etc. `renderMarginPercent` Distance minimale à laquelle un espace doit se trouver par rapport à la fenêtre d'affichage actuelle avant que nous puissions afficher une annonce. Cela permet de précharger l'annonce, mais d'attendre de pouvoir afficher et télécharger d'autres sous-ressources. La valeur fonctionne exactement comme `fetchMarginPercent` en pourcentage de la fenêtre d'affichage. `mobileScaling` Multiplicateur appliqué aux marges sur les appareils mobiles. Cela permet de varier les marges sur mobile et sur ordinateur. Par exemple, une valeur de 2,0 multiplie toutes les marges par deux sur les appareils mobiles, ce qui augmente la distance minimale qu'un emplacement peut avoir avant l'extraction et le rendu.

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

L'objet de configuration permet de personnaliser le comportement paresseux. Les configurations omises utiliseront une valeur par défaut définie par Google, qui sera ajustée au fil du temps. Pour désactiver un paramètre particulier, tel qu'une marge d'extraction, définissez la valeur sur -1.

fetchMarginPercent

Distance minimale de la fenêtre d'affichage actuelle pour laquelle un emplacement doit se trouver avant la récupération de l'annonce, sous la forme d'un pourcentage de la taille de la fenêtre d'affichage. Une valeur de 0 signifie "lorsque l'espace publicitaire entre dans la fenêtre d'affichage", 100 signifie "lorsque l'annonce est à une fenêtre d'affichage de distance", etc.
renderMarginPercent

Distance minimale à laquelle un espace doit se trouver par rapport à la fenêtre d'affichage actuelle avant que nous puissions afficher une annonce. Cela permet de précharger l'annonce, mais d'attendre de pouvoir afficher et télécharger d'autres sous-ressources. La valeur fonctionne exactement comme fetchMarginPercent en pourcentage de la fenêtre d'affichage.
mobileScaling

Multiplicateur appliqué aux marges sur les appareils mobiles. Cela permet de varier les marges sur mobile et sur ordinateur. Par exemple, une valeur de 2,0 multiplie toutes les marges par deux sur les appareils mobiles, ce qui augmente la distance minimale qu'un emplacement peut avoir avant l'extraction et le rendu.

enableSingleRequest

enableSingleRequest(): boolean

Active le mode de requête unique pour extraire plusieurs annonces en même temps. Pour ce faire, vous devez définir et ajouter tous les emplacements d'annonces de l'éditeur au PubAdsService avant d'activer le service. Le mode de requête unique doit être défini avant l'activation du service.

Voir aussi

Renvoie
`boolean`	Renvoie `true` si le mode de demande simple a été activé et `false` s'il est impossible d'activer ce mode, car la méthode a été appelée après l'activation du service.

enableVideoAds

enableVideoAds(): void

Indique à GPT que des annonces vidéo seront présentes sur la page. Cela permet d'appliquer des contraintes d'exclusion réciproque sur les annonces display et vidéo. Si le contenu vidéo est connu, appelez PubAdsService.setVideoContent afin de pouvoir utiliser l'exclusion de contenu pour les annonces display.

get

get(key: string): null | string

Renvoie la valeur de l'attribut AdSense associé à la clé donnée.

Exemple

JavaScript

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

JavaScript (ancien)

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

Voir aussi

Attributs AdSense

Paramètres
`key: string`	Nom de l'attribut à rechercher.

Renvoie
`null \| string`	Valeur actuelle de la clé d'attribut, ou `null` si la clé n'est pas présente.

getAttributeKeys

getAttributeKeys(): string[]

Renvoie les clés d'attributs définies sur ce service.

Exemple

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 (ancien)

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

Renvoie
`string[]`	Tableau des clés d'attribut définies sur ce service. L'ordre est indéfini.

getTargeting

getTargeting(key: string): string[]

Renvoie un paramètre de ciblage personnalisé au niveau du service spécifique qui a été défini.

Exemple

JavaScript

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

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

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

JavaScript (ancien)

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

Paramètres
`key: string`	Clé de ciblage à rechercher.

Renvoie
`string[]`	Valeurs associées à cette clé, ou tableau vide si aucune clé de ce type n'existe.

getTargetingKeys

getTargetingKeys(): string[]

Affiche la liste de toutes les clés de ciblage personnalisé au niveau du service qui ont été définies.

Exemple

JavaScript

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

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

JavaScript (ancien)

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

Renvoie
`string[]`	Tableau de clés de ciblage. L'ordre est indéfini.

isInitialLoadDisabled

isInitialLoadDisabled(): boolean

Indique si les demandes initiales d'annonces ont bien été désactivées par un appel PubAdsService.disableInitialLoad précédent.

Renvoie
`boolean`	Renvoie `true` si un appel précédent à PubAdsService.disableInitialLoad a abouti, ou `false` dans le cas contraire.

actualiser

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

Extrait et affiche de nouvelles annonces pour certains espaces publicitaires de la page ou pour l'ensemble de ceux-ci. Ne fonctionne que en mode de rendu asynchrone.

Pour un comportement correct dans tous les navigateurs, l'appel de refresh doit être précédé d'un appel à display l'emplacement d'annonce. Si l'appel à display est omis, l'actualisation peut se comporter de manière inattendue. Si vous le souhaitez, vous pouvez utiliser la méthode PubAdsService.disableInitialLoad pour empêcher display d'extraire une annonce.

L'actualisation d'un espace supprime l'ancienne annonce de la vue de page persistante de GPT. Les futures requêtes ne seront donc pas influencées par les obstacles ou les exclusions concurrentielles impliquant cette annonce.

Exemple

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 (ancien)

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

Voir aussi

Paramètres

Optional slots: null | Slot[] Les emplacements à actualiser. Le tableau est facultatif. Si ce n'est pas le cas, tous les emplacements seront actualisés.

Paramètres
`Optional slots: null \| Slot[]`	Les emplacements à actualiser. Le tableau est facultatif. Si ce n'est pas le cas, tous les emplacements seront actualisés.
`Optional options: { changeCorrelator: boolean; }`	Options de configuration associées à cet appel d'actualisation. `changeCorrelator` Indique si un nouveau corrélateur doit être généré pour extraire les annonces. Nos ad servers conservent cette valeur de corrélation brièvement (actuellement pendant 30 secondes, mais cela peut changer), de sorte que les demandes avec le même corrélateur reçues à proximité les unes des autres soient considérées comme une seule page vue. Par défaut, un nouveau corrélateur est généré pour chaque actualisation. Remarque:Cette option n'a aucun effet sur la vue de page à long terme de GPT, qui reflète automatiquement les annonces actuellement présentes sur la page et n'a pas de date d'expiration.

Optional options: { 
  changeCorrelator: boolean; 
}

Options de configuration associées à cet appel d'actualisation.

changeCorrelator

Indique si un nouveau corrélateur doit être généré pour extraire les annonces. Nos ad servers conservent cette valeur de corrélation brièvement (actuellement pendant 30 secondes, mais cela peut changer), de sorte que les demandes avec le même corrélateur reçues à proximité les unes des autres soient considérées comme une seule page vue. Par défaut, un nouveau corrélateur est généré pour chaque actualisation.

Remarque:Cette option n'a aucun effet sur la vue de page à long terme de GPT, qui reflète automatiquement les annonces actuellement présentes sur la page et n'a pas de date d'expiration.

set

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

Définit des valeurs pour les attributs AdSense qui s'appliquent à tous les espaces publicitaires dans le service Annonces d'éditeur.

Si vous appelez cette méthode plusieurs fois pour la même clé, les valeurs précédemment définies pour cette clé seront ignorées. Toutes les valeurs doivent être définies avant d'appeler display ou refresh.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Voir aussi

Attributs AdSense

Paramètres
`key: string`	Nom de l'attribut.
`value: string`	Valeur d'attribut.

Renvoie
`PubAdsService`	Objet de service sur lequel la méthode a été appelée.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService

Définit une exclusion de catégorie d'annonces au niveau de la page pour le nom d'étiquette donné.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Voir aussi

Libellés personnalisés pour bloquer les annonces

Paramètres
`categoryExclusion: string`	Libellé d'exclusion de la catégorie d'annonces à ajouter.

Renvoie
`PubAdsService`	Objet de service sur lequel la méthode a été appelée.

setCentering

setCentering(centerAds: boolean): void

Active et désactive le centrage horizontal des annonces. Le centrage est désactivé par défaut. Dans l'ancienne version gpt_mobile.js, le centrage est activé par défaut.

Cette méthode doit être appelée avant d'appeler display ou refresh, car seules les annonces demandées après l'appel de cette méthode seront centrées.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Paramètres
`centerAds: boolean`	`true` pour centrer les annonces, `false` pour les aligner à gauche.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Détermine si toutes les annonces de la page doivent s'afficher d'office à l'aide d'un conteneur SafeFrame.

Veuillez tenir compte des points suivants lorsque vous utilisez cette API:

Ce paramètre ne s'applique qu'aux demandes d'annonces ultérieures effectuées pour les emplacements respectifs.
Si un paramètre au niveau de l'espace est spécifié, il remplace toujours le paramètre au niveau de la page.
Si la valeur est true (au niveau de l'espace publicitaire ou de la page), l'annonce est toujours affichée dans un conteneur SafeFrame, quel que soit le choix effectué dans l'interface utilisateur de Google Ad Manager.
Toutefois, si la valeur est définie sur false ou n'est pas spécifiée, l'annonce sera affichée dans un conteneur SafeFrame en fonction du type de création et de la sélection effectuée dans l'interface utilisateur de Google Ad Manager.
Utilisez cette API avec précaution, car elle peut avoir un impact sur le comportement des créations qui tentent de sortir de leurs iFrames ou qui s'appuient sur leur affichage direct sur la page d'un éditeur.

Exemple

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 (ancien)

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");

Voir aussi

Afficher des créations à l'aide de cadres SafeFrame

Paramètres
`forceSafeFrame: boolean`	`true` pour forcer l'affichage de toutes les annonces de la page dans des SafeFrames et `false` pour définir le paramètre précédent sur "false". Le fait de définir cette valeur sur `false` alors qu'il n'a pas été spécifié précédemment ne change rien.

Renvoie
`PubAdsService`	Objet de service sur lequel la fonction a été appelée.

setLocation

setLocation(address: string): PubAdsService

Transmet des informations de localisation provenant de sites Web afin que vous puissiez géocibler des éléments de campagne sur des zones géographiques spécifiques.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Paramètres
`address: string`	Adresse au format libre.

Renvoie
`PubAdsService`	Objet de service sur lequel la méthode a été appelée.

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

Permet de configurer tous les paramètres de confidentialité à partir d'une seule API à l'aide d'un objet de configuration.

Exemple

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 (ancien)

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

Voir aussi

Paramètres
`privacySettings: PrivacySettingsConfig`	Objet contenant la configuration des paramètres de confidentialité.

Renvoie
`PubAdsService`	Objet de service sur lequel la fonction a été appelée.

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService

Définit la valeur de l'identifiant fourni par l'éditeur.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Voir aussi

À propos des identifiants fournis par l'éditeur

Paramètres
`ppid: string`	Identifiant alphanumérique fourni par l'éditeur. Doit comporter entre 32 et 150 caractères.

Renvoie
`PubAdsService`	Objet de service sur lequel la méthode a été appelée.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

Définit les préférences de configuration des cadres SafeFrame au niveau de la page. Toutes les clés non reconnues de l'objet de configuration sont ignorées. L'intégralité de la configuration sera ignorée si une valeur non valide est transmise pour une clé reconnue.

Ces préférences au niveau de la page seront remplacées par les préférences au niveau de l'espace, le cas échéant.

Exemple

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 (ancien)

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");

Voir aussi

Afficher des créations à l'aide de cadres SafeFrame

Paramètres
`config: SafeFrameConfig`	Objet de configuration

Renvoie
`PubAdsService`	Objet de service sur lequel la méthode a été appelée.

setTargeting

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

Définit des paramètres de ciblage personnalisé pour une clé donnée qui s'appliquent à tous les emplacements publicitaires du service Annonces pour les éditeurs. Si vous appelez cette méthode plusieurs fois pour la même clé, les anciennes valeurs seront écrasées. Ces clés sont définies dans votre compte Google Ad Manager.

Exemple

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 (ancien)

// 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"]);

Voir aussi

Ciblage par clé-valeurs

Paramètres
`key: string`	Clé du paramètre de ciblage.
`value: string \| string[]`	Valeur ou tableau de valeurs du paramètre de ciblage.

Renvoie
`PubAdsService`	Objet de service sur lequel la méthode a été appelée.

setVideoContent

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

Définit les informations sur le contenu vidéo à envoyer avec les demandes d'annonces à des fins de ciblage et d'exclusion de contenu. Les annonces vidéo seront automatiquement activées lorsque cette méthode sera appelée. Pour videoContentId et videoCmsId, utilisez les valeurs fournies au service d'ingestion de contenu Google Ad Manager.

Voir aussi

Paramètres d'URL du tag d'emplacement publicitaire VAST

Paramètres
`videoContentId: string`	Identifiant de contenu vidéo.
`videoCmsId: string`	ID dans le CMS de la vidéo.

updateCorrelator

updateCorrelator(): PubAdsService

Modifie le corrélateur envoyé avec les demandes d'annonces, ce qui lance une nouvelle page vue. Le corrélateur est le même pour toutes les demandes d'annonces provenant d'une page vue et unique pour chaque page vue. Ne s'applique qu'au mode asynchrone.

Remarque:Cela n'a aucun effet sur la page vue de longue durée de GPT, qui reflète automatiquement les annonces réellement sur la page et n'a pas de délai d'expiration.

Exemple

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 (ancien)

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

Renvoie
`PubAdsService`	Objet de service sur lequel la fonction a été appelée.

googletag.ResponseInformation

Objet représentant une seule réponse d'annonce.

Propriétés
`advertiserId`	Référence de l'annonceur.
`campaignId`	Identifiant de la campagne.
`creativeId`	Identifiant de la création.
`creativeTemplateId`	ID du modèle de l'annonce.
`lineItemId`	Identifiant de la ligne.

Voir aussi

Slot.getResponseInformation

Propriétés

advertiserId

advertiserId: null | number

ID de l'annonceur.

campaignId

campaignId: null | number

Identifiant de la campagne.

creativeId

creativeId: null | number

Identifiant de la création.

creativeTemplateId

creativeTemplateId: null | number

ID du modèle de l'annonce.

lineItemId

lineItemId: null | number

Identifiant de la ligne.

googletag.RewardedPayload

Objet représentant la récompense associée à une annonce avec récompense

Propriétés
`amount`	Nombre d'articles inclus dans la récompense.
`type`	Type d'élément inclus dans la récompense (par exemple, "pièce").

Voir aussi

Afficher une annonce avec récompense

Propriétés

amount

amount: number

Le nombre d'éléments inclus dans la récompense.

type

type: string

Type d'élément inclus dans la récompense (par exemple, "pièce").

googletag.SafeFrameConfig

Objet de configuration pour les conteneurs SafeFrame.

Propriétés
`allowOverlayExpansion?`	Indique si SafeFrame doit autoriser le contenu de l'annonce à se développer en recouvrant le contenu de la page.
`allowPushExpansion?`	Indique si les cadres SafeFrame doivent autoriser le développement du contenu de l'annonce en transférant le contenu de la page.
`sandbox?`	Indique si SafeFrame doit utiliser l'attribut HTML5 sandbox pour empêcher la navigation de niveau supérieur sans interaction de l'utilisateur.
`useUniqueDomain?`	Obsolète. Indique si SafeFrame doit utiliser des sous-domaines aléatoires pour les créations de réservation.

Voir aussi

PubAdsService.setSafeFrameConfig

Propriétés

`Optional` allowOverlayExpansion

allowOverlayExpansion?: boolean

Indique si les cadres SafeFrame doivent permettre au contenu de l'annonce de se développer en se superposant au contenu de la page.

`Optional` allowPushExpansion

allowPushExpansion?: boolean

Indique si SafeFrame doit autoriser le contenu de l'annonce à se développer en poussant le contenu de la page.

`Optional` bac à sable

sandbox?: boolean

Indique si SafeFrame doit utiliser l'attribut HTML5 sandbox pour empêcher la navigation de niveau supérieur sans interaction de l'utilisateur. La seule valeur valide est true (vous ne pouvez pas forcer la valeur false). Notez que l'attribut bac à sable désactive les plug-ins (par exemple, Flash).

`Optional` useUniqueDomain

useUniqueDomain?: null | boolean

Indique si SafeFrame doit utiliser des sous-domaines aléatoires pour les créations de réservation. Transmettez null pour effacer la valeur stockée.

Remarque: Cette fonctionnalité est activée par défaut.

Obsolète:il n'est plus possible de désactiver cette fonctionnalité. La définition de useUniqueDomain n'a aucun effet.

Voir aussi

Afficher des créations à l'aide de cadres SafeFrame

googletag.Service

Classe de service de base contenant les méthodes communes à tous les services.

Méthodes
`addEventListener`	Enregistre un écouteur qui vous permet de configurer et d'appeler une fonction JavaScript lorsqu'un événement GPT spécifique se produit sur la page.
`getSlots`	Obtenez la liste des créneaux horaires associés à ce service.
`removeEventListener`	Supprime un écouteur précédemment enregistré.

Méthodes

addEventListener

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

Enregistre un écouteur qui vous permet de configurer et d'appeler une fonction JavaScript lorsqu'un événement GPT spécifique se produit sur la page. Les événements suivants sont acceptés:

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Écouteurs d'événements d'annonces

Paramètres
`eventType: K`	Chaîne représentant le type d'événement généré par GPT. Les types d'événements sont sensibles à la casse.
`listener: ((arg: EventTypeMap[K]) => void)`	Fonction qui accepte un seul argument d'objet d'événement.

Renvoie
`Service`	Objet de service sur lequel la méthode a été appelée.

getSlots

getSlots(): Slot[]

Obtenez la liste des créneaux horaires associés à ce service.

Renvoie
`Slot[]`	Emplacements selon leur ordre d'ajout au service.

removeEventListener

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

Supprime un écouteur précédemment enregistré.

Exemple

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 (ancien)

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

Paramètres
`eventType: K`	Chaîne représentant le type d'événement généré par GPT. Les types d'événements sont sensibles à la casse.
`listener: ((event: EventTypeMap[K]) => void)`	Fonction qui accepte un seul argument d'objet d'événement.

googletag.SizeMappingBuilder

Compilateur pour les objets de spécification de mappage de taille. Cet outil de création permet de créer facilement des spécifications de taille.

Méthodes
`addSize`	Ajoute une mise en correspondance d'un tableau à taille unique (représentant la fenêtre d'affichage) à un tableau à taille unique ou multiple représentant l'espace.
`build`	Crée une spécification de carte de taille à partir des mises en correspondance ajoutées à ce générateur.

Voir aussi

Tailles d'annonces: annonces responsives

Méthodes

addSize

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

Ajoute la mise en correspondance d'un tableau de taille unique (représentant la fenêtre d'affichage) à un tableau de tailles simples ou multiples représentant l'emplacement.

Exemple

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 &lt; 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 (ancien)

// 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 &lt; 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 &lt; 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]

Paramètres
`viewportSize: SingleSizeArray`	Taille de la fenêtre d'affichage pour cette entrée de mappage.
`slotSize: GeneralSize`	Tailles de l'emplacement pour cette entrée de mappage.

Renvoie
`SizeMappingBuilder`	Référence à ce générateur.

build

build(): null | SizeMappingArray

Crée une spécification de mappage de taille à partir des mappages ajoutés à cet outil de création.

Si des mappages non valides ont été fournis, cette méthode renvoie null. Sinon, il renvoie une spécification au format approprié à transmettre à Slot.defineSizeMapping.

Remarque: le comportement du générateur après l'appel de cette méthode n'est pas défini.

Renvoie
`null \| SizeMappingArray`	Résultat créé par ce compilateur. Peut être nul si des mappages de taille non valides ont été fournis.

googletag.Slot

Un emplacement est un objet représentant un seul espace publicitaire sur une page.

Méthodes
`addService`	Ajoute un service à cet emplacement.
`clearCategoryExclusions`	Efface tous les libellés d'exclusion de catégories d'annonces au niveau de l'espace publicitaire pour cet espace.
`clearTargeting`	Efface des paramètres de ciblage personnalisés spécifiques ou tous les paramètres de ciblage personnalisés au niveau de l'emplacement pour cet emplacement.
`defineSizeMapping`	Définit un tableau de mappages entre une taille de fenêtre d'affichage minimale et la taille de l'emplacement pour cet emplacement.
`get`	Renvoie la valeur de l'attribut AdSense associé à la clé donnée pour cet emplacement.
`getAdUnitPath`	Renvoie le chemin d'accès complet du bloc d'annonces, avec le code de réseau et le chemin d'accès du bloc d'annonces.
`getAttributeKeys`	Renvoie la liste des clés d'attribut définies sur ce créneau.
`getCategoryExclusions`	Renvoie les libellés d'exclusion de catégories d'annonces pour cet emplacement.
`getResponseInformation`	Renvoie les informations sur la réponse de l'annonce.
`getSlotElementId`	Renvoie l'ID de l'espace publicitaire `div` fourni lors de sa définition.
`getTargeting`	Renvoie un paramètre de ciblage personnalisé spécifique défini sur cet emplacement.
`getTargetingKeys`	Renvoie la liste de toutes les clés de ciblage personnalisé définies sur cet emplacement.
`set`	Définit une valeur pour un attribut AdSense sur cet espace publicitaire.
`setCategoryExclusion`	Définit un libellé d'exclusion de catégorie d'annonces au niveau de cet espace.
`setClickUrl`	Définit l'URL de suivi des clics vers laquelle les utilisateurs sont redirigés après avoir cliqué sur l'annonce.
`setCollapseEmptyDiv`	Détermine si l'espace publicitaire `div` doit être masqué lorsqu'il n'y a aucune annonce.
`setConfig`	Définit les options de configuration générales pour cet emplacement.
`setForceSafeFrame`	Détermine si les annonces de cet espace doivent être forcées à s'afficher dans un conteneur SafeFrame.
`setSafeFrameConfig`	Définit les préférences au niveau de l'emplacement pour la configuration SafeFrame.
`setTargeting`	Définit un paramètre de ciblage personnalisé pour cet emplacement.
`updateTargetingFromMap`	Définit les paramètres de ciblage personnalisé pour cet emplacement à partir d'une mappage clé-valeur dans un objet JSON.

Méthodes

addService

addService(service: Service): Slot

Ajoute un service à cet emplacement.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Voir aussi

Paramètres
`service: Service`	Service à ajouter.

Renvoie
`Slot`	Objet d'emplacement sur lequel la méthode a été appelée.

clearCategoryExclusions

clearCategoryExclusions(): Slot

Efface tous les libellés d'exclusion de catégorie d'annonces au niveau de cet emplacement.

Exemple

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 (ancien)

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

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

clearTargeting

clearTargeting(key?: string): Slot

Efface certains paramètres de ciblage au niveau de l'espace publicitaire, ou tous les paramètres personnalisés pour cet espace.

Exemple

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 (ancien)

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.

Voir aussi

Ciblage par clé-valeurs

Paramètres
`Optional key: string`	Clé du paramètre de ciblage. La clé est facultative. Si elle n'est pas spécifiée, tous les paramètres de ciblage seront effacés.

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Définit un tableau de mappages entre une taille de fenêtre d'affichage minimale et la taille de l'emplacement pour cet emplacement.

Exemple

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 (ancien)

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!);

Voir aussi

Tailles d'annonces: annonces responsives

Paramètres
`sizeMapping: SizeMappingArray`	Tableau de mappages de tailles. Vous pouvez la créer à l'aide de SizeMappingBuilder. Chaque mappage de taille est un tableau de deux éléments: SingleSizeArray et GeneralSize.

Renvoie
`Slot`	Objet d'emplacement sur lequel la méthode a été appelée.

get

get(key: string): null | string

Renvoie la valeur de l'attribut AdSense associé à la clé donnée pour cet espace. Pour afficher les attributs de niveau de service hérités par cet emplacement, utilisez PubAdsService.get.

Exemple

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 (ancien)

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

Voir aussi

Attributs AdSense

Paramètres
`key: string`	Nom de l'attribut à rechercher.

Renvoie
`null \| string`	Valeur actuelle de la clé d'attribut, ou `null` si la clé n'est pas présente.

getAdUnitPath

getAdUnitPath(): string

Renvoie le chemin d'accès complet du bloc d'annonces, avec le code de réseau et le chemin d'accès du bloc d'annonces.

Exemple

JavaScript

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

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

JavaScript (ancien)

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

Renvoie
`string`	Chemin d'accès du bloc d'annonces.

getAttributeKeys

getAttributeKeys(): string[]

Renvoie la liste des clés d'attribut définies sur cet emplacement. Pour afficher les clés des attributs de niveau de service hérités par cet emplacement, utilisez PubAdsService.getAttributeKeys.

Exemple

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 (ancien)

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

Renvoie
`string[]`	Tableau de clés d'attribut. L'ordre est indéfini.

getCategoryExclusions

getCategoryExclusions(): string[]

Renvoie les libellés d'exclusion de catégories d'annonces pour cet emplacement.

Exemple

JavaScript

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

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

JavaScript (ancien)

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

Renvoie
`string[]`	Libellés d'exclusion de catégories d'annonces pour cet emplacement, ou tableau vide si aucun n'a été défini.

getResponseInformation

getResponseInformation(): null | ResponseInformation

Renvoie les informations sur la réponse de l'annonce. Cette valeur est basée sur la dernière réponse d'annonce pour l'espace publicitaire. Si cette méthode est appelée alors que l'espace ne contient pas d'annonce, null est renvoyé.

Renvoie
`null \| ResponseInformation`	Dernières informations de réponse d'annonce, ou `null` si l'espace ne contient aucune annonce.

getSlotElementId

getSlotElementId(): string

Renvoie l'ID de l'emplacement div fourni lors de la définition de l'emplacement.

Exemple

JavaScript

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

slot.getSlotElementId();
// Returns 'div'.

JavaScript (ancien)

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

Renvoie
`string`	ID de l'espace `div`.

getTargeting

getTargeting(key: string): string[]

Renvoie un paramètre de ciblage personnalisé spécifique défini sur cet emplacement. Les paramètres de ciblage au niveau du service ne sont pas inclus.

Exemple

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 (ancien)

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

Paramètres
`key: string`	Clé de ciblage à rechercher.

Renvoie
`string[]`	Valeurs associées à cette clé, ou tableau vide si aucune clé de ce type n'existe.

getTargetingKeys

getTargetingKeys(): string[]

Renvoie la liste de toutes les clés de ciblage personnalisé définies sur cet emplacement. Les clés de ciblage au niveau du service ne sont pas incluses.

Exemple

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 (ancien)

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

Renvoie
`string[]`	Tableau de clés de ciblage. L'ordre n'est pas défini.

set

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

Définit une valeur pour un attribut AdSense sur cet espace publicitaire. Les valeurs définies au niveau du service pour cette clé seront ignorées.

Si vous appelez cette méthode plusieurs fois pour la même clé, les valeurs précédemment définies pour cette clé seront ignorées. Toutes les valeurs doivent être définies avant d'appeler display ou refresh.

Exemple

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 (ancien)

// 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());

Voir aussi

Attributs AdSense

Paramètres
`key: string`	Nom de l'attribut.
`value: string`	Valeur d'attribut.

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot

Définit un libellé d'exclusion de catégorie d'annonces au niveau de cet espace.

Exemple

JavaScript

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

JavaScript (ancien)

// 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());

Voir aussi

Libellés personnalisés pour bloquer les annonces

Paramètres
`categoryExclusion: string`	Libellé d'exclusion de la catégorie d'annonces à ajouter.

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

setClickUrl

setClickUrl(value: string): Slot

Définit l'URL de destination vers laquelle les utilisateurs sont redirigés après avoir cliqué sur l'annonce.

Les serveurs Google Ad Manager enregistrent toujours un clic, même si l'URL de destination est remplacée. Toute URL de page de destination associée à la création diffusée est ajoutée à la valeur fournie. Les appels suivants écrasent la valeur. Cette méthode ne fonctionne que pour les requêtes autres que les requêtes de type SRA.

Exemple

JavaScript

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

JavaScript (ancien)

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());

Paramètres
`value: string`	URL de clic à définir.

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

setCollapseEmptyDiv

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

Indique si l'espace div doit être masqué lorsqu'aucune annonce n'y est diffusée. Cette option remplace les paramètres au niveau du service.

Exemple

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 (ancien)

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.

Voir aussi

Paramètres
`collapse: boolean`	Indique si l'espace publicitaire doit être réduit si aucune annonce n'est renvoyée.
`Optional collapseBeforeAdFetch: boolean`	Indique si l'espace publicitaire doit être replié avant même qu'une annonce ne soit récupérée. Ignoré si la valeur de collapse n'est pas `true`.

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

setConfig

setConfig(slotConfig: SlotSettingsConfig): void

Définit les options de configuration générales pour cet emplacement.

Paramètres
`slotConfig: SlotSettingsConfig`	Objet de configuration.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Détermine si les annonces de cet espace doivent être affichées d'office à l'aide d'un conteneur SafeFrame.

Gardez à l'esprit les points suivants lorsque vous utilisez cette API:

Ce paramètre ne s'applique qu'aux demandes d'annonces ultérieures effectuées pour les emplacements respectifs.
Si un paramètre au niveau de l'espace est spécifié, il remplace toujours le paramètre au niveau de la page.
Si la valeur est true (au niveau de l'espace publicitaire ou de la page), l'annonce est toujours affichée dans un conteneur SafeFrame, quel que soit le choix effectué dans l'interface utilisateur de Google Ad Manager.
Toutefois, si la valeur est définie sur false ou n'est pas spécifiée, l'annonce sera affichée dans un conteneur SafeFrame en fonction du type de création et de la sélection effectuée dans l'interface utilisateur de Google Ad Manager.
Utilisez cette API avec précaution, car elle peut avoir un impact sur le comportement des créations qui tentent de sortir de leurs iFrames ou qui s'appuient sur leur affichage direct sur la page d'un éditeur.

Exemple

JavaScript

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

JavaScript (ancien)

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());

Voir aussi

Afficher des créations à l'aide de cadres SafeFrame

Paramètres
`forceSafeFrame: boolean`	`true` pour forcer l'affichage de toutes les annonces de cet emplacement dans des SafeFrames et `false` pour désactiver un paramètre au niveau de la page (le cas échéant). Si vous définissez cette valeur sur `false`, aucune modification ne sera apportée au niveau de la page.

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

setSafeFrameConfig

setSafeFrameConfig(config: null | SafeFrameConfig): Slot

Définit les préférences au niveau de l'emplacement pour la configuration SafeFrame. Toutes les clés non reconnues de l'objet de configuration sont ignorées. L'intégralité de la configuration sera ignorée si une valeur non valide est transmise pour une clé reconnue.

Si elles sont spécifiées, ces préférences au niveau de l'espace publicitaire remplaceront toutes les préférences au niveau de la page.

Exemple

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 (ancien)

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");

Voir aussi

Afficher des créations à l'aide de cadres SafeFrame

Paramètres
`config: null \| SafeFrameConfig`	Objet de configuration

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

setTargeting

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

Définit un paramètre de ciblage personnalisé pour cet emplacement. Si vous appelez cette méthode plusieurs fois pour la même clé, les anciennes valeurs seront remplacées. Les valeurs définies ici écrasent les paramètres de ciblage définis au niveau du service. Ces clés sont définies dans votre compte Google Ad Manager.

Exemple

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 (ancien)

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"]);

Voir aussi

Ciblage par clé-valeur

Paramètres
`key: string`	Clé du paramètre de ciblage.
`value: string \| string[]`	Valeur ou tableau de valeurs du paramètre de ciblage.

Renvoie
`Slot`	Objet de la fente sur laquelle la méthode a été appelée.

updateTargetingFromMap

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

Définit des paramètres de ciblage personnalisés pour cet espace publicitaire, à partir d'un mappage clé-valeur dans un objet JSON. Cela revient à appeler Slot.setTargeting pour toutes les valeurs de clé de l'objet. Ces clés sont définies dans votre compte Google Ad Manager.

Remarques :

En cas d'écrasement, seule la dernière valeur est conservée.
Si la valeur est un tableau, toute valeur précédente sera écrasée, et non fusionnée.
Les valeurs définies ici écrasent les paramètres de ciblage définis au niveau du service.

Exemple

JavaScript

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

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

JavaScript (ancien)

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

Paramètres
`map: { [adUnitPath: string]: string \| string[]; }`	Mappage clé-valeur du paramètre de ciblage.

Renvoie
`Slot`	Objet d'emplacement sur lequel la méthode a été appelée.

googletag.config

Interface de configuration principale pour les paramètres au niveau de la page.

Interfaces
`AdExpansionConfig`	Paramètres permettant de contrôler l'expansion des annonces.
`ComponentAuctionConfig`	Objet représentant une seule mise aux enchères de composant dans une mise aux enchères d'annonces sur l'appareil.
`InterstitialConfig`	Objet qui définit le comportement d'un seul emplacement publicitaire interstitiel.
`PageSettingsConfig`	Interface de configuration principale pour les paramètres au niveau de la page.
`PrivacyTreatmentsConfig`	Paramètres permettant de contrôler les traitements de confidentialité des éditeurs.
`PublisherProvidedSignalsConfig`	Objet de configuration des signaux fournis par l'éditeur (PPS).
`SlotSettingsConfig`	Interface de configuration principale pour les paramètres au niveau de l'emplacement.
`TaxonomyData`	Objet contenant les valeurs d'une seule taxonomie.

Alias de type
`InterstitialTrigger`	Déclencheurs d'annonces interstitielles compatibles.
`PrivacyTreatment`	Traitements de confidentialité acceptés par les éditeurs.
`Taxonomy`	Taxonomies compatibles avec les signaux fournis par l'éditeur (PPS).

Alias de type

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"

Déclencheurs d'annonces interstitielles compatibles.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Traitements de confidentialité pour les éditeurs compatibles

Taxonomie

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Taxonomies compatibles avec les signaux fournis par l'éditeur (PPS).

Voir aussi

googletag.config.AdExpansionConfig

Paramètres permettant de contrôler l'expansion des annonces.

Propriétés
`enabled?`	Indique si l'expansion des annonces est activée ou désactivée.

Exemple

JavaScript

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

JavaScript (ancien)

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

Propriétés

`Optional` activé

enabled?: boolean

Indique si l'expansion des annonces est activée ou désactivée.

La valeur définie remplace celle configurée par défaut dans Google Ad Manager.

Voir aussi

googletag.config.ComponentAuctionConfig

Objet représentant une seule mise aux enchères de composant dans une mise aux enchères d'annonces sur l'appareil.

Propriétés
`auctionConfig`	Objet de configuration des enchères pour cette mise aux enchères de composants.
`configKey`	Clé de configuration associée à cette mise aux enchères de composant.

Voir aussi

Guide pour les vendeurs de l'API Protected Audience: lancer des enchères publicitaires

Propriétés

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

Objet de configuration de la mise aux enchères pour cette enchère du composant.

Si cette valeur est définie sur null, toute configuration existante pour l'enchère configKey spécifiée sera supprimée.

Exemple

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 (ancien)

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

Voir aussi

API Protected Audience: lancer une mise aux enchères sur l'appareil

configKey

configKey: string

Clé de configuration associée à cette mise aux enchères de composant.

Cette valeur ne doit pas être vide et doit être unique. Si deux objets ComponentAuctionConfig partagent la même valeur configKey, le dernier à être défini écrase les configurations précédentes.

googletag.config.InterstitialConfig

Objet définissant le comportement d'un seul espace publicitaire interstitielle.

Propriétés
`triggers?`	Configuration du déclencheur d'interstitiel pour cette annonce interstitielle.

Propriétés

`Optional` déclencheurs

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

Configuration du déclencheur d'interstitiel pour cette annonce interstitielle.

Si vous définissez la valeur d'un déclencheur d'interstitiel sur true, il sera activé. Si vous la définissez sur false, il sera désactivé. Les valeurs par défaut configurées dans Google Ad Manager seront remplacées.

Exemple

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 (ancien)

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

Voir aussi

Afficher une annonce interstitielle pour le Web

googletag.config.PageSettingsConfig

Interface de configuration principale pour les paramètres au niveau de la page.

Permet de définir plusieurs fonctionnalités avec un seul appel d'API.

Toutes les propriétés listées ci-dessous sont des exemples et ne reflètent pas les fonctionnalités réelles qui utilisent setConfig. Pour l'ensemble de fonctionnalités, consultez les champs du type PageSettingsConfig ci-dessous.

Exemples:

Seules les fonctionnalités spécifiées dans l'appel googletag.setConfig sont modifiées.

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

  // Configure feature bravo. Feature alpha is unchanged.
  googletag.setConfig({
     bravo: {...}
  });

Tous les paramètres d'une fonctionnalité donnée sont mis à jour à chaque appel de googletag.setConfig.

  // Configure feature charlie to echo = 1, foxtrot = true.
  googletag.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  googletag.setConfig({
      charlie: {
          echo: 2
      }
  });

Tous les paramètres d'une fonctionnalité peuvent être effacés en transmettant 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,
  });

Propriétés
`adExpansion?`	Paramètres permettant de contrôler l'expansion des annonces.
`adYield?`	Obsolète.
`pps?`	Paramètres permettant de contrôler les signaux fournis par l'éditeur (PPS).
`privacyTreatments?`	Paramètres permettant de contrôler les traitements de confidentialité des éditeurs.
`threadYield?`	Paramètre permettant de contrôler si GPT doit générer le thread JS lors de l'affichage des créations.

Propriétés

`Optional` adExpansion

adExpansion?: null | AdExpansionConfig

Paramètres permettant de contrôler l'expansion des annonces.

`Optional` adYield

adYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

`Optional` pps

pps?: null | PublisherProvidedSignalsConfig

Paramètres permettant de contrôler les signaux fournis par l'éditeur (PPS).

`Optional` privacyTreatments

privacyTreatments?: null | PrivacyTreatmentsConfig

Paramètres permettant de contrôler les traitements de confidentialité des éditeurs.

`Optional` threadYield

threadYield?: null | "DISABLED" | "ENABLED_ALL_SLOTS"

Paramètre permettant de contrôler si la GPT doit céder le thread JavaScript lors du rendu des créations.

La GPT ne cède le thread que pour les navigateurs compatibles avec l'API Scheduler.postTask ou Scheduler.yield.

Valeurs acceptées:

null (par défaut): GPT génère le thread JavaScript pour les emplacements en dehors de la fenêtre d'affichage.
ENABLED_ALL_SLOTS: GPT génère le thread JavaScript pour tous les emplacements, que l'emplacement se trouve dans la fenêtre d'affichage ou non.
DISABLED: GPT ne génère pas le fil de discussion JS.

Exemple

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 (ancien)

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

Voir aussi

Scheduler

googletag.config.PrivacyTreatmentsConfig

Paramètres permettant de contrôler les traitements de confidentialité des éditeurs.

Propriétés
`treatments`	Tableau des traitements de confidentialité à activer pour les éditeurs.

Propriétés

traitements

treatments: "disablePersonalization"[]

Tableau des traitements de confidentialité à activer pour les éditeurs.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

googletag.config.PublisherProvidedSignalsConfig

Objet de configuration des signaux fournis par l'éditeur (PPS).

Propriétés
`taxonomies`	Un objet contenant des mappages de Taxonomy.

Exemple

JavaScript

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

JavaScript (ancien)

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

TypeScript

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

Voir aussi

Propriétés

taxonomies

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Objet contenant des mappages de taxonomie.

googletag.config.SlotSettingsConfig

Interface de configuration principale pour les paramètres au niveau de l'emplacement.

Permet de définir plusieurs fonctionnalités avec un seul appel d'API pour un seul emplacement.

Toutes les propriétés listées ci-dessous sont des exemples et ne reflètent pas les fonctionnalités réelles qui utilisent setConfig. Pour l'ensemble de fonctionnalités, consultez les champs du type SlotSettingsConfig ci-dessous.

Exemples:

Seules les fonctionnalités spécifiées dans l'appel Slot.setConfig sont modifiées.

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

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

  // Configure feature bravo. Feature alpha is unchanged.
  slot.setConfig({
     bravo: {...}
  });

Tous les paramètres d'une fonctionnalité donnée sont mis à jour à chaque appel de 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
      }
  });

Tous les paramètres d'une fonctionnalité peuvent être effacés en transmettant 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,
  });

Propriétés
`adExpansion?`	Paramètres permettant de contrôler l'expansion des annonces.
`componentAuction?`	Tableau d'enchères de composants à inclure dans les enchères publicitaires sur l'appareil.
`interstitial?`	Paramètres qui contrôlent le comportement des espaces publicitaires interstitiels.

Propriétés

`Optional` adExpansion

adExpansion?: AdExpansionConfig

Paramètres permettant de contrôler l'expansion des annonces.

`Optional` componentAuction

componentAuction?: ComponentAuctionConfig[]

Tableau d'enchères de composants à inclure dans une mise aux enchères d'annonces sur l'appareil.

`Optional` interstitielle

interstitial?: InterstitialConfig

Paramètres qui contrôlent le comportement des espaces publicitaires interstitiels.

googletag.config.TaxonomyData

Objet contenant les valeurs d'une seule taxonomie.

Propriétés
`values`	Liste des valeurs de taxonomie.

Propriétés

valeurs

values: string[]

Liste de valeurs de taxonomie.

googletag.enums

Il s'agit de l'espace de noms que GPT utilise pour les types d'énumération.

Énumérations
`OutOfPageFormat`	Formats hors page compatibles avec GPT
`TrafficSource`	Sources de trafic compatibles avec GPT.

Énumérations

OutOfPageFormat

OutOfPageFormat

Formats hors page compatibles avec GPT

Voir aussi

defineOutOfPageSlot

Membres de l'énumération
`BOTTOM_ANCHOR`	Format d'ancrage où l'espace se fixe au bas de la fenêtre d'affichage.
`GAME_MANUAL_INTERSTITIAL`	Format d'interstitiel manuel pour un jeu. Remarque:L'interstitiel manuel pour un jeu est un format à accès limité.
`INTERSTITIAL`	Format de création interstitielle sur le Web.
`LEFT_SIDE_RAIL`	Format du side rail gauche.
`REWARDED`	Format avec récompense
`RIGHT_SIDE_RAIL`	Format du side rail droit.
`TOP_ANCHOR`	Format d'ancrage où l'espace publicitaire reste en haut de la fenêtre d'affichage.

TrafficSource

TrafficSource

Sources de trafic acceptées par GPT.

Voir aussi

PrivacySettingsConfig.trafficSource

Membres de l'énumération
`ORGANIC`	Saisie directe d'URL, recherche sur un site ou téléchargement d'application
`PURCHASED`	Trafic redirigé à partir de propriétés non détenues (activité acquise ou incitée)

googletag.events

Il s'agit de l'espace de noms utilisé par GPT pour les événements. Votre code peut réagir à ces événements à l'aide de Service.addEventListener.

Interfaces
`Event`	Interface de base pour tous les événements GPT.
`EventTypeMap`	Il s'agit d'un pseudo-type qui mappe un nom d'événement au type d'objet d'événement correspondant pour Service.addEventListener et Service.removeEventListener.
`GameManualInterstitialSlotClosedEvent`	Cet événement se déclenche lorsqu'un emplacement d'interstitiel manuel de jeu a été fermé par l'utilisateur.
`GameManualInterstitialSlotReadyEvent`	Cet événement se déclenche lorsqu'un espace interstitiel manuel du jeu est prêt à être présenté à l'utilisateur.
`ImpressionViewableEvent`	Cet événement est déclenché lorsqu'une impression devient visible, selon les critères Active View.
`RewardedSlotClosedEvent`	Cet événement est déclenché lorsqu'un espace publicitaire avec récompense est fermé par l'utilisateur.
`RewardedSlotGrantedEvent`	Cet événement se déclenche lorsqu'une récompense est accordée pour avoir regardé une annonce avec récompense.
`RewardedSlotReadyEvent`	Cet événement se déclenche lorsqu'une annonce avec récompense est prête à être diffusée.
`SlotOnloadEvent`	Cet événement est déclenché lorsque l'iframe de la création déclenche son événement de chargement.
`SlotRenderEndedEvent`	Cet événement est déclenché lorsque le code de la création est injecté dans un emplacement.
`SlotRequestedEvent`	Cet événement est déclenché lorsqu'une annonce a été demandée pour un espace publicitaire particulier.
`SlotResponseReceived`	Cet événement est déclenché lorsqu'une réponse d'annonce a été reçue pour un emplacement particulier.
`SlotVisibilityChangedEvent`	Cet événement se déclenche chaque fois que le pourcentage à l'écran de la zone d'un emplacement d'annonce change.

googletag.events.Event

Interface de base pour tous les événements GPT. Tous les événements GPT ci-dessous comportent les champs suivants.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement.
`slot`	Emplacement ayant déclenché l'événement.

Voir aussi

Écouteurs d'événements d'annonces

Propriétés

serviceName

serviceName: string

Nom du service qui a déclenché l'événement.

emplacement

slot: Slot

Emplacement ayant déclenché l'événement.

googletag.events.EventTypeMap

Il s'agit d'un pseudo-type qui met en correspondance un nom d'événement avec son type d'objet d'événement correspondant pour Service.addEventListener et Service.removeEventListener. Il est documenté à des fins de référence et de sécurité de type uniquement.

Propriétés
`gameManualInterstitialSlotClosed`	Alias de events.GameManualInterstitialSlotClosedEvent.
`gameManualInterstitialSlotReady`	Alias pour events.GameManualInterstitialSlotReadyEvent.
`impressionViewable`	Alias de events.ImpressionViewableEvent.
`rewardedSlotClosed`	Alias de events.RewardedSlotClosedEvent.
`rewardedSlotGranted`	Alias pour events.RewardedSlotGrantedEvent.
`rewardedSlotReady`	Alias pour events.RewardedSlotReadyEvent.
`slotOnload`	Alias de events.SlotOnloadEvent.
`slotRenderEnded`	Alias pour events.SlotRenderEndedEvent.
`slotRequested`	Alias de events.SlotRequestedEvent.
`slotResponseReceived`	Alias de events.SlotResponseReceived.
`slotVisibilityChanged`	Alias pour events.SlotVisibilityChangedEvent.

Propriétés

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Alias pour events.GameManualInterstitialSlotClosedEvent.

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent

Alias de events.GameManualInterstitialSlotReadyEvent.

impressionViewable

impressionViewable: ImpressionViewableEvent

Alias de events.ImpressionViewableEvent.

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent

Alias de events.RewardedSlotClosedEvent.

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent

Alias de events.RewardedSlotGrantedEvent.

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent

Alias de events.RewardedSlotReadyEvent.

slotOnload

slotOnload: SlotOnloadEvent

Alias de events.SlotOnloadEvent.

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent

Alias pour events.SlotRenderEndedEvent.

slotRequested

slotRequested: SlotRequestedEvent

Alias de events.SlotRequestedEvent.

slotResponseReceived

slotResponseReceived: SlotResponseReceived

Alias pour events.SlotResponseReceived.

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Alias de events.SlotVisibilityChangedEvent.

googletag.events.GameManualInterstitialSlotClosedEvent

Étend Event

Cet événement se déclenche lorsque l'utilisateur ferme l'emplacement interstitiel manuel d'un jeu.

Remarque:L'interstitiel manuel de jeu est un format en accès limité.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

googletag.events.GameManualInterstitialSlotReadyEvent

Étend Event

Cet événement se déclenche lorsqu'un espace interstitiel manuel de jeu est prêt à être présenté à l'utilisateur.

Remarque:L'interstitiel manuel de jeu est un format en accès limité.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`

Méthodes
`makeGameManualInterstitialVisible`	Affiche l'annonce interstitielle manuelle pour jeu auprès de l'utilisateur.

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Méthodes

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void

Affiche l'annonce interstitielle manuelle pour jeu auprès de l'utilisateur.

googletag.events.ImpressionViewableEvent

Étend Event

Cet événement est déclenché lorsqu'une impression devient visible, selon les critères d'Active View.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement qui a déclenché l'événement. Hérité de `Event.slot`

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Écouteurs d'événements d'annonces

googletag.events.RewardedSlotClosedEvent

Étend Event

Cet événement est déclenché lorsqu'un emplacement d'annonce avec récompense est fermé par l'utilisateur. Il peut se déclencher avant ou après l'attribution d'une récompense. Pour déterminer si une récompense a été accordée, utilisez plutôt events.RewardedSlotGrantedEvent.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

googletag.events.RewardedSlotGrantedEvent

Étend Event

Cet événement se déclenche lorsqu'une récompense est accordée pour avoir regardé une annonce avec récompense. Si l'annonce est fermée avant que les critères d'attribution d'une récompense ne soient remplis, cet événement ne se déclenchera pas.

Propriétés
`payload`	Objet contenant des informations sur la récompense accordée.
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Propriétés

charge utile

payload: null | RewardedPayload

Objet contenant des informations sur la récompense accordée.

googletag.events.RewardedSlotReadyEvent

Étend Event

Cet événement se déclenche lorsqu'une annonce avec récompense est prête à être diffusée. L'éditeur est responsable de proposer à l'utilisateur la possibilité de visionner l'annonce avant de l'afficher.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`

Méthodes
`makeRewardedVisible`	Affiche l'annonce avec récompense.

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Méthodes

makeRewardedVisible

makeRewardedVisible(): void

Affiche l'annonce avec récompense. Cette méthode ne doit pas être appelée tant que l'utilisateur n'a pas donné son consentement pour afficher l'annonce.

googletag.events.SlotOnloadEvent

Prolongations Event

Cet événement est déclenché lorsque l'iframe de la création déclenche son événement de chargement. Lorsque vous affichez des annonces rich media en mode de rendu synchronisé, aucune iFrame n'est utilisée. Par conséquent, aucun SlotOnloadEvent n'est déclenché.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement qui a déclenché l'événement. Hérité de `Event.slot`

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Écouteurs d'événements d'annonces

googletag.events.SlotRenderEndedEvent

Prolongations Event

Cet événement est déclenché lorsque le code de la création est injecté dans un emplacement. Cet événement se produit avant que les ressources de la création ne soient récupérées. Il est donc possible que la création ne soit pas encore visible. Si vous devez savoir quand toutes les ressources de la création d'un emplacement ont été chargées, utilisez plutôt events.SlotOnloadEvent.

Propriétés
`advertiserId`	Référence annonceur de l'annonce affichée.
`campaignId`	ID de la campagne de l'annonce affichée.
`companyIds`	ID des entreprises qui ont enchéri sur l'annonce de remplissage affichée.
`creativeId`	ID de la création de l'annonce de réservation affichée.
`creativeTemplateId`	ID du modèle de création de l'annonce de réservation affichée.
`isBackfill`	Indique si une annonce était une annonce de remplissage.
`isEmpty`	Indique si une annonce a été renvoyée pour l'espace publicitaire.
`labelIds`	Obsolète.
`lineItemId`	ID de l'élément de campagne de l'annonce de réservation affichée.
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`size`	Indique la taille en pixels de la création affichée.
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`
`slotContentChanged`	Indique si le contenu de l'emplacement a été modifié avec l'annonce affichée.
`sourceAgnosticCreativeId`	ID de la création de la réservation affichée ou de l'annonce de remplissage.
`sourceAgnosticLineItemId`	ID de l'élément de campagne de la réservation affichée ou de l'annonce de remplissage.
`yieldGroupIds`	ID des groupes de rendement de l'annonce de remplissage affichée.

Exemple

JavaScript

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

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

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

JavaScript (ancien)

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

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

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

TypeScript

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

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

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

Voir aussi

Écouteurs d'événements d'annonces

Propriétés

advertiserId

advertiserId: null | number

Référence annonceur de l'annonce affichée. La valeur est null pour les espaces vides, les annonces de remplissage et les créations générées par des services autres que PubAdsService.

campaignId

campaignId: null | number

ID de la campagne de l'annonce affichée. La valeur est null pour les espaces vides, les annonces de remplissage et les créations générées par des services autres que PubAdsService.

companyIds

companyIds: null | number[]

ID des entreprises qui ont enchéri sur l'annonce de remplissage affichée. La valeur est null pour les emplacements vides, les annonces de réservation et les créations générées par des services autres que PubAdsService.

creativeId

creativeId: null | number

ID de la création de l'annonce de réservation affichée. La valeur est null pour les espaces vides, les annonces de remplissage et les créations générées par des services autres que PubAdsService.

creativeTemplateId

creativeTemplateId: null | number

ID du modèle de création de l'annonce de réservation affichée. La valeur est null pour les espaces vides, les annonces de remplissage et les créations générées par des services autres que PubAdsService.

isBackfill

isBackfill: boolean

Indique si une annonce est une annonce de remplissage. La valeur est true si l'annonce était une annonce de remplissage, sinon false.

isEmpty

isEmpty: boolean

Indique si une annonce a été renvoyée pour l'espace publicitaire. La valeur est true si aucune annonce n'a été renvoyée, et false dans le cas contraire.

labelIds

labelIds: null | number[]

lineItemId

lineItemId: null | number

ID de l'élément de campagne de l'annonce de réservation affichée. La valeur est null pour les espaces vides, les annonces de remplissage et les créations générées par des services autres que PubAdsService.

taille

size: null | string | number[]

Indique la taille en pixels de la création affichée. Exemple : [728, 90] La valeur est null pour les espaces publicitaires vides.

slotContentChanged

slotContentChanged: boolean

Indique si le contenu de l'emplacement a été modifié avec l'annonce affichée. La valeur est true si le contenu a été modifié, et false dans le cas contraire.

sourceAgnosticCreativeId

sourceAgnosticCreativeId: null | number

ID de la création de la réservation affichée ou de l'annonce de remplissage. La valeur est null si l'annonce n'est pas une annonce de remplissage de réservation ou d'élément de campagne, ou si la création est affichée par des services autres que PubAdsService.

sourceAgnosticLineItemId

sourceAgnosticLineItemId: null | number

ID de l'élément de campagne de la réservation affichée ou de l'annonce de remplissage. La valeur est null si l'annonce n'est pas un remplissage de réservation ou d'élément de campagne, ou si la création est affichée par des services autres que PubAdsService.

yieldGroupIds

yieldGroupIds: null | number[]

ID des groupes de rendement de l'annonce de remplissage affichée. La valeur est null pour les emplacements vides, les annonces de réservation et les créations générées par des services autres que PubAdsService.

googletag.events.SlotRequestedEvent

Étend Event

Cet événement est déclenché lorsqu'une annonce a été demandée pour un espace publicitaire particulier.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Écouteurs d'événements d'annonces

googletag.events.SlotResponseReceived

Étend Event

Cet événement est déclenché lorsqu'une réponse d'annonce a été reçue pour un emplacement particulier.

Propriétés
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Écouteurs d'événements d'annonces

googletag.events.SlotVisibilityChangedEvent

Étend Event

Cet événement se déclenche chaque fois que le pourcentage à l'écran de la zone d'un emplacement d'annonce change. L'événement est limité et ne se déclenche pas plus d'une fois toutes les 200 ms.

Propriétés
`inViewPercentage`	Pourcentage de la zone de l'annonce qui est visible.
`serviceName`	Nom du service qui a déclenché l'événement. Hérité de `Event.serviceName`
`slot`	Emplacement ayant déclenché l'événement. Hérité de `Event.slot`

Exemple

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 (ancien)

// 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.
  }
});

Voir aussi

Écouteurs d'événements d'annonces

Propriétés

inViewPercentage

inViewPercentage: number

Pourcentage de la zone de l'annonce qui est visible. La valeur est un nombre compris entre 0 et 100.

googletag.secureSignals

Il s'agit de l'espace de noms que GPT utilise pour gérer les signaux sécurisés.

Interfaces
`BidderSignalProvider`	Renvoie un signal sécurisé pour un enchérisseur spécifique.
`PublisherSignalProvider`	Renvoie un signal sécurisé pour un éditeur spécifique.
`SecureSignalProvidersArray`	Interface permettant de gérer les signaux sécurisés.

Alias de type
`SecureSignalProvider`	Interface permettant de renvoyer un signal sécurisé pour un enchérisseur ou un fournisseur spécifique.

Alias de type

SecureSignalProvider

SecureSignalProvider: BidderSignalProvider | PublisherSignalProvider

Interface permettant de renvoyer un signal sécurisé pour un enchérisseur ou un fournisseur spécifique. Vous devez indiquer id ou networkCode, mais pas les deux.

googletag.secureSignals.BidderSignalProvider

Renvoie un signal sécurisé pour un enchérisseur spécifique.

Un fournisseur de signaux sécurisés pour les enchérisseurs se compose de deux éléments:

Fonction de collecte, qui renvoie un Promise qui se résout en un signal sécurisé.
id qui identifie l'enchérisseur associé au signal.

Pour renvoyer un signal sécurisé pour un éditeur, utilisez plutôt secureSignals.PublisherSignalProvider.

Propriétés
`collectorFunction`	Fonction qui renvoie un `Promise` qui se résout en un signal sécurisé.
`id`	Identifiant unique du collecteur associé à ce signal sécurisé, tel qu'enregistré dans Google Ad Manager.

Exemple

JavaScript

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

JavaScript (ancien)

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

Voir aussi

Partager des signaux sécurisés avec les enchérisseurs

Propriétés

collectorFunction

collectorFunction: (() => Promise<string>)

Fonction qui renvoie un Promise qui se résout en un signal sécurisé.

id

id: string

Identifiant unique du collecteur associé à ce signal sécurisé, tel qu'enregistré dans Google Ad Manager.

googletag.secureSignals.PublisherSignalProvider

Renvoie un signal sécurisé pour un éditeur spécifique.

Un fournisseur de signaux d'éditeur se compose de deux parties:

Fonction de collecte, qui renvoie un Promise qui se résout en un signal sécurisé.
networkCode qui identifie l'éditeur associé au signal.

Pour renvoyer un signal sécurisé pour un enchérisseur, utilisez plutôt secureSignals.BidderSignalProvider.

Propriétés
`collectorFunction`	Fonction qui renvoie un `Promise` qui se résout en un signal sécurisé.
`networkCode`	Code de réseau (tel qu'il apparaît dans le chemin du bloc d'annonces) de l'éditeur associé à ce signal sécurisé.

Exemple

JavaScript

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

JavaScript (ancien)

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

Voir aussi

Partager des signaux sécurisés avec les enchérisseurs

Propriétés

collectorFunction

collectorFunction: (() => Promise<string>)

Fonction qui renvoie un Promise qui se résout en un signal sécurisé.

networkCode

networkCode: string

Code du réseau (tel qu'il apparaît dans le chemin d'accès du bloc d'annonces) de l'éditeur associé à ce signal sécurisé.

googletag.secureSignals.SecureSignalProvidersArray

Interface permettant de gérer les signaux sécurisés.

Méthodes
`clearAllCache`	Efface le cache de tous les signaux pour tous les collecteurs.
`push`	Ajoute un secureSignals.SecureSignalProvider au tableau du fournisseur de signaux et lance le processus de génération de signaux.

Méthodes

clearAllCache

clearAllCache(): void

Efface tous les signaux de tous les collecteurs du cache.

L'appel de cette méthode peut réduire la probabilité que des signaux soient inclus dans les demandes d'annonces pour les pages vues actuelles et ultérieures. Par conséquent, il ne doit être appelé que lorsque des changements d'état significatifs se produisent, tels que des événements indiquant un nouvel utilisateur (connexion, déconnexion, inscription, etc.).

push

push(provider: SecureSignalProvider): void

Ajoute un secureSignals.SecureSignalProvider au tableau du fournisseur de signaux et lance le processus de génération de signaux.

Paramètres
`provider: SecureSignalProvider`	Objet secureSignals.SecureSignalProvider à ajouter au tableau.

Documentation de référence sur GPT

Annotations de type

googletag

Alias de type

GeneralSize

MultiSize

NamedSize

SingleSize

SingleSizeArray

SizeMapping

SizeMappingArray

Variables

Const apiReady

Const cmd

JavaScript

JavaScript (ancien)

TypeScript

Const pubadsReady

secureSignalProviders

JavaScript

JavaScript (ancien)

TypeScript

Fonctions

companionAds

defineOutOfPageSlot

JavaScript

JavaScript (ancien)

TypeScript

defineSlot

JavaScript

JavaScript (ancien)

TypeScript

destroySlots

JavaScript

JavaScript (ancien)

TypeScript

disablePublisherConsole

Écran

enableServices

getVersion

openConsole

JavaScript

JavaScript (ancien)

TypeScript

pubads

setAdIframeTitle

JavaScript

JavaScript (ancien)

TypeScript

setConfig

sizeMapping

googletag.CommandArray

Méthodes

push

JavaScript

JavaScript (ancien)

TypeScript

googletag.CompanionAdsService

Hérité de Service.addEventListener

Hérité de Service.getSlots

Hérité de Service.removeEventListener

Méthodes

setRefreshUnfilledSlots

JavaScript

JavaScript (ancien)

TypeScript

googletag.PrivacySettingsConfig

Propriétés

Optional childDirectedTreatment

Optional limitedAds

JavaScript

JavaScript (ancien)

TypeScript

Optional nonPersonalizedAds

Optional restrictDataProcessing

Optional trafficSource

JavaScript

JavaScript (ancien)

TypeScript

Optional underAgeOfConsent

`Const` apiReady

`Const` cmd

`Const` pubadsReady

Hérité de `Service.addEventListener`

Hérité de `Service.getSlots`

Hérité de `Service.removeEventListener`

`Optional` childDirectedTreatment

`Optional` limitedAds

`Optional` nonPersonalizedAds

`Optional` restrictDataProcessing

`Optional` trafficSource

`Optional` underAgeOfConsent

Hérité de `Service.addEventListener`

Hérité de `Service.getSlots`

Hérité de `Service.removeEventListener`