Documentation de référence sur GPT

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

Saisissez une expression
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 d'un 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	Type d'objet, où 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 compatibles, consultez le manuel TypeScript .

Annotations de type

Un signe 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 à gauche du signe 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 renvoyés.
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 REST qui accepte les fonctions. Les paramètres REST acceptent un nombre illimité de valeurs du type spécifié.

---

googletag

Espace de noms global utilisé par le tag d'éditeur Google 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 utilisé par GPT pour les types d'énumération.
events	Il s'agit de l'espace de noms utilisé par GPT pour les événements.
secureSignals	Il s'agit de l'espace de noms utilisé par GPT 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 d'annonces associées.
PrivacySettingsConfig	Objet de configuration pour les paramètres de confidentialité.
PubAdsService	Services publicitaires pour les éditeurs.
RequestHook	Fonction de rappel appelée avant chaque demande d'annonce lorsqu'elle est enregistrée via PubAdsService.registerRequestHook.
ResponseInformation	Objet représentant une seule réponse d'annonce.
RewardedPayload	Objet représentant la récompense associée à une annonce avec récompense.
Service	Classe de service de base contenant des méthodes communes à tous les services.
SizeMappingBuilder	Compilateur pour les objets de spécification de mappage de taille.
Slot	"Slot" est un objet représentant un seul espace publicitaire sur une page.

Alias de type
FluidSize	Chaîne de taille dans laquelle le conteneur d'annonce occupe 100% de la largeur de son élément div parent, puis redimensionne sa hauteur pour s'adapter au contenu de la création.
GeneralSize	Configuration de taille valide pour un espace publicitaire, qui peut être une ou plusieurs tailles.
MultiSize	Liste de tailles valides uniques.
NamedSize	Tailles nommées qu'un emplacement peut avoir.
SingleSize	Une seule taille valide pour un espace.
SingleSizeArray	Tableau de deux nombres représentant [largeur, hauteur].
SizeMapping	Mappage de la taille de la fenêtre d'affichage aux tailles d'annonce.
SizeMappingArray	Liste des mappages de tailles.

Variables
apiReady	Indicateur signalant 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 aux GPT.
pubadsReady	Indique 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	Crée un espace publicitaire hors page avec le chemin d'accès du bloc d'annonces indiqué.
defineSlot	Crée un espace publicitaire avec un chemin d'accès et une taille de bloc d'annonces donnés, et l'associe à l'ID d'un élément div sur la page qui contiendra l'annonce.
destroySlots	Détruit les espaces publicitaires indiqués, en supprimant de GPT tous les objets et références associés à ces espaces.
disablePublisherConsole	Désactive la Console Google pour les éditeurs.
display	Indique aux services d'emplacement d'afficher l'emplacement.
enableServices	Active tous les services GPT définis pour les espaces publicitaires de la page.
getConfig	Récupère une copie figée des options de configuration générales de la page définie par setConfig.
getVersion	Renvoie la version actuelle de GPT.
openConsole	Ouvre la Console Google pour les éditeurs.
pubads	Renvoie une référence à PubAdsService.
setAdIframeTitle	Définit le titre de tous les iFrames de conteneur d'annonces créés par PubAdsService à partir de ce moment.
setConfig	Définit les options de configuration générales de la page.
sizeMapping	Crée un objet SizeMappingBuilder.

Alias de type

---

FluidSize

FluidSize: "fluid"

Chaîne de taille dans laquelle le conteneur d'annonce occupe 100% de la largeur de son élément div parent, puis redimensionne sa hauteur pour s'adapter au contenu de la création. Le comportement est semblable à celui des éléments de bloc standards sur une page. Utilisé pour les annonces natives et les bannières (voir l'article associé).

---

GeneralSize

GeneralSize: SingleSize | MultiSize

Configuration de taille valide pour un espace publicitaire, qui peut être une ou plusieurs tailles.

---

MultiSize

MultiSize: SingleSize[]

Liste de tailles valides uniques.

---

NamedSize

NamedSize: FluidSize | [FluidSize]

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

• fluid : le conteneur d'annonce occupe 100% de la largeur de son élément div parent, puis redimensionne sa hauteur pour s'adapter au contenu de la création. Le comportement est semblable à celui des éléments de bloc standards sur une page. Utilisé pour les annonces natives et les bannières (voir l'article associé). Notez que fluid et ['fluid'] sont tous deux des formats acceptables pour déclarer une taille d'emplacement comme fluide.

---

SingleSize

SingleSize: SingleSizeArray | NamedSize

Une seule taille valide pour un espace.

---

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 aux tailles d'annonce. Utilisé pour les annonces responsives.

---

SizeMappingArray

SizeMappingArray: SizeMapping[]

Liste des mappages de tailles.

Variables

---

Const apiReady

apiReady: boolean | undefined

Indicateur signalant 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'asynchronisme consiste à 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 de s'exécuter 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 parcourt 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());
});

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 de génération de signaux et les appelle dans l'ordre. Il est destiné à remplacer un tableau standard utilisé pour mettre en file d'attente les fonctions de génération de signaux à appeler une fois que GPT est chargé.

Exemple

JavaScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    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 des enchérisseurs

Fonctions

---

companionAds

companionAds(): CompanionAdsService

Renvoie une référence à CompanionAdsService.

Renvoie
CompanionAdsService	Service Companion Ads.

---

defineOutOfPageSlot

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

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

Pour les annonces hors page personnalisées, div est 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);

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

• Afficher une annonce avec récompense
• Afficher une annonce interstitielle pour le Web
• Afficher une annonce ancrée
• Afficher une annonce hors page

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

Renvoie
Slot | null	Emplacement nouvellement créé, ou null si un emplacement ne peut pas ê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, et 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");

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 réseau et le code du bloc.
size: GeneralSize	Largeur et hauteur de l'espace publicitaire 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 l'élément div qui contiendra ce bloc d'annonces.

Renvoie
Slot | null	Emplacement nouvellement créé, ou null si un emplacement ne peut pas être créé.

---

destroySlots

destroySlots(slots?: Slot[]): boolean

Détruit les espaces publicitaires indiqués, en supprimant de GPT tous les objets et références associés à ces espaces. Cette API n'est pas compatible avec les espaces publicitaires de passback et les espaces publicitaires associés.

L'appel de cette API sur un espace publicitaire efface l'annonce et supprime l'objet d'espace publicitaire de l'état interne géré par GPT. L'appel de fonctions supplémentaires sur l'objet d'emplacement entraînera un comportement non défini. Notez que le navigateur peut ne pas libérer la mémoire associée à cet espace si une référence à celui-ci est conservée par la page de l'éditeur. L'appel de cette API rend l'élément div associé à cet espace disponible pour être réutilisé.

En particulier, la destruction d'un espace supprime l'annonce de la page vue de longue durée de GPT. Les futures demandes ne seront donc pas influencées par les roadblocks ou les exclusions de concurrents impliquant cette annonce. Si vous n'appelez pas cette fonction avant de supprimer la balise div d'un espace de la page, un comportement non dé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();

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, false sinon.

---

disablePublisherConsole

disablePublisherConsole(): void

Désactive la Console Google pour les éditeurs.

Voir aussi

• Console Google pour les éditeurs

---

display

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

Indique aux services d'emplacement d'afficher l'emplacement. Chaque espace publicitaire ne doit être affiché qu'une seule fois par page. Tous les emplacements doivent être définis et associés à un service avant d'être affichés. L'appel d'affichage ne doit pas avoir lieu tant que l'élément n'est pas présent dans le DOM. Pour ce faire, il est d'usage de le placer dans un bloc de script au sein de 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 la balise div.

Voir aussi

• Premiers pas avec les tags Google Publisher Tag
• Afficher une annonce test
• Contrôler le chargement et l'actualisation des annonces

Paramètres
divOrSlot: string | Element | Slot	ID de l'élément div contenant l'espace publicitaire, élément div ou objet d'espace publicitaire. 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 définis pour les espaces publicitaires de la page.

---

getConfig

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

Récupère une copie figée des options de configuration générale de la page définies par setConfig.

Cette méthode n'est pas compatible avec toutes les propriétés setConfig(). Voici les propriétés acceptées :

• adsenseAttributes
• disableInitialLoad
• targeting

Exemple

JavaScript

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

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

TypeScript

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

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

Paramètres
keys: string | string[]	Clés des options de configuration à obtenir.

Renvoie
Readonly<Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">>	Copie figée des options de configuration de la page.

---

getVersion

getVersion(): string

Renvoie la version actuelle de GPT.

Voir aussi

• Historique des versions de GPT

Renvoie
string	Chaîne de la version de 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();

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 l'indiquez, la Console pour les éditeurs tentera de s'ouvrir en affichant les détails de l'espace publicitaire spécifié.

---

pubads

pubads(): PubAdsService

Renvoie une référence à PubAdsService.

Renvoie
PubAdsService	Service Publisher Ads.

---

setAdIframeTitle

setAdIframeTitle(title: string): void

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

Exemple

JavaScript

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");

Paramètres
title: string	Nouveau titre pour tous les iFrames de conteneur d'annonce.

---

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

Voir aussi

• Tailles d'annonces : annonces responsives

Renvoie
SizeMappingBuilder	Un nouveau compilateur.

---

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 les fonctions à appeler une fois que GPT est 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());
});

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

Extends Service

Service d'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 la méthode Service.addEventListener
getSlots	Obtenez la liste des emplacements associés à ce service. Hérité de la méthode Service.getSlots
removeEventListener	Supprime un écouteur précédemment enregistré. Hérité de la méthode 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

Indique si les espaces publicitaires associés n'ayant pas reçu d'annonce recevront automatiquement une annonce de remplissage.

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

Exemple

JavaScript

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);

Paramètres
value: boolean	true pour remplir automatiquement les emplacements non remplis, 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?	Permet d'activer la diffusion en mode Annonces limitées pour aider les éditeurs à respecter les exigences de conformité réglementaire.
nonPersonalizedAds?	Permet d'activer la diffusion en mode annonces non personnalisées pour aider les éditeurs à respecter les exigences de conformité réglementaire.
restrictDataProcessing?	Permet d'exécuter la diffusion en mode de traitement restreint pour aider les éditeurs à répondre à leurs besoins de conformité réglementaire.
tagForAgeTreatment?	Traitement lié à l'âge, indiquant si la demande d'annonce doit être traitée comme étant destinée aux enfants, aux adolescents ou non spécifiée.
trafficSource?	Indique si les demandes représentent du trafic acheté ou généré par les résultats naturels.
underAgeOfConsent?	Indique si les demandes d'annonces doivent être marquées 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?: 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 d'activer la diffusion en mode Annonces limitées pour aider les éditeurs à respecter les exigences de conformité réglementaire.

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

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

Vous ne pouvez configurer manuellement les annonces limitées que lorsque GPT est chargé à partir de l'URL des annonces limitées. Si vous essayez de modifier ce paramètre alors que GPT a été chargé à partir de l'URL standard, un avertissement s'affichera dans la Console pour les éditeurs.

Notez qu'il n'est pas nécessaire d'activer manuellement les annonces limitées lorsqu'une CMP est utilisée.

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

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

Permet d'activer la diffusion en mode annonces non personnalisées pour aider les éditeurs à respecter les exigences de conformité réglementaire.

---

Optional restrictDataProcessing

restrictDataProcessing?: boolean

Permet d'exécuter la diffusion en mode de traitement restreint pour aider les éditeurs à répondre à leurs besoins de conformité réglementaire.

---

Optional tagForAgeTreatment

tagForAgeTreatment?: TagForAgeTreatment

Le traitement lié à l'âge, qui indique si la demande d'annonce doit être traitée comme étant destinée aux enfants, aux adolescents ou à un public non spécifié.

Consultez votre conseiller juridique pour déterminer les paramètres de traitement de l'âge de vos utilisateurs en fonction de vos obligations légales et réglementaires. Pour en savoir plus sur ce paramètre, consultez cet article du Centre d'aide.

En définissant cette propriété, vous certifiez que cette notification est exacte et que vous êtes autorisé à agir au nom du propriétaire du site. comprendre que toute utilisation abusive de ce paramètre peut entraîner la clôture de votre compte Google.

Exemple

JavaScript

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

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

TypeScript

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

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

---

Optional trafficSource

trafficSource?: TrafficSource

Indique si les demandes 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,
});

TypeScript

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

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

---

Optional underAgeOfConsent

underAgeOfConsent?: boolean

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

---

googletag.PubAdsService

Extends Service

Services publicitaires pour les éditeurs. Ce service permet de récupérer 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 la méthode Service.addEventListener
clear	Supprime les annonces des emplacements donnés et les remplace par un contenu vide.
clearCategoryExclusions	Obsolète. Supprime tous les libellés d'exclusion de catégories d'annonces au niveau de la page.
clearTargeting	Obsolète. Efface les paramètres de ciblage personnalisé pour une clé spécifique ou pour toutes les clés.
collapseEmptyDivs	Obsolète. Active le repli des éléments div des espaces publicitaires afin qu'ils n'occupent pas d'espace sur la page lorsqu'il n'y a pas de contenu d'annonce à afficher.
disableInitialLoad	Obsolète. Désactive les demandes d'annonces lors du chargement de la page, mais autorise les demandes d'annonces 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 indiqués.
enableLazyLoad	Obsolète. Active le chargement différé dans GPT, tel que défini par l'objet de configuration.
enableSingleRequest	Obsolète. Active le mode de requête unique pour récupérer plusieurs annonces en même temps.
enableVideoAds	Obsolète. Indique à GPT que des annonces vidéo seront présentes sur la page.
get	Obsolète. Renvoie la valeur de l'attribut AdSense associé à la clé donnée.
getAttributeKeys	Obsolète. Renvoie les clés d'attribut qui ont été définies sur ce service.
getSlots	Obtenez la liste des emplacements associés à ce service. Hérité de la méthode Service.getSlots
getTargeting	Obsolète.  Renvoie un paramètre de ciblage personnalisé spécifique au niveau du service qui a été défini.
getTargetingKeys	Obsolète. Renvoie la liste de toutes les clés de ciblage personnalisées définies au niveau du service.
isInitialLoadDisabled	Obsolète. Indique si les demandes initiales d'annonces ont bien été désactivées par un appel PubAdsService.disableInitialLoad précédent.
refresh	Récupère et affiche de nouvelles annonces pour des espaces spécifiques ou tous les espaces de la page.
registerRequestHook	Enregistre un hook à exécuter en parallèle avec d'autres hooks enregistrés avant chaque demande d'annonce sur la page, dans un délai avant expiration global.
removeEventListener	Supprime un écouteur précédemment enregistré. Hérité de la méthode Service.removeEventListener
set	Obsolète. Définit les valeurs des attributs AdSense qui s'appliquent à tous les espaces publicitaires du service Publisher Ads.
setCategoryExclusion	Obsolète. Définit une exclusion de catégorie d'annonces au niveau de la page pour le nom de libellé donné.
setCentering	Obsolète. Active et désactive le centrage horizontal des annonces.
setForceSafeFrame	Obsolète. Indique si toutes les annonces de la page doivent être affichées dans un conteneur SafeFrame.
setLocation	Obsolète. Transmet les informations de localisation des sites Web afin que vous puissiez cibler géographiquement 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	Obsolète. Définit les préférences au niveau de la page pour la configuration SafeFrame.
setTargeting	Obsolète. Définit des paramètres de ciblage personnalisé pour une clé donnée qui s'appliquent à tous les espaces publicitaires du service Publisher Ads.
setVideoContent	Obsolète. 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

---

clear

clear(slots?: Slot[]): boolean

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

En particulier, l'effacement d'un emplacement supprime l'annonce de la page vue de longue durée de GPT. Les futures demandes ne seront donc pas influencées par les roadblocks ou les exclusions de concurrents 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();

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égories d'annonces au niveau de la page. Cette méthode est utile si vous souhaitez actualiser l'emplacement.

Obsolète : utilisez plutôt PageSettingsConfig.categoryExclusion.

Exemple

JavaScript

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

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

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

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

TypeScript

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

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

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

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

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.

Obsolète : utilisez plutôt PageSettingsConfig.targeting.

Exemple

JavaScript

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

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

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

TypeScript

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

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

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

Voir aussi

• Ciblage par clé-valeur

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

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

---

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

Permet de réduire les éléments div des espaces publicitaires afin qu'ils n'occupent pas d'espace sur la page lorsqu'il n'y a pas de contenu d'annonce à afficher. Ce mode doit être défini avant l'activation du service.

Obsolète : utilisez plutôt PageSettingsConfig.collapseDiv.

Voir aussi

• Réduire les espaces publicitaires vides
• Réduire le décalage de mise en page

Paramètres
Optional collapseBeforeAdFetch: boolean	Indique si les emplacements 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 sera utilisé comme valeur par défaut.

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

---

disableInitialLoad

disableInitialLoad(): void

Désactive les demandes d'annonces lors du chargement de page, mais autorise les demandes d'annonces avec un appel PubAdsService.refresh. Cette option doit être définie avant d'activer le service. Le mode asynchrone doit être utilisé. Sinon, il sera impossible de demander des annonces à l'aide de refresh.

Obsolète : utilisez plutôt PageSettingsConfig.disableInitialLoad.

Voir aussi

• Contrôler le chargement et l'actualisation des annonces
• Contrôler le traitement par lot SRA

---

display

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

Construit et affiche un espace publicitaire avec le chemin d'accès et la taille du bloc d'annonces donnés.

Cette méthode est un raccourci équivalent à l'appel de googletag.defineSlot suivi immédiatement de googletag.display.

Le comportement de cette méthode dépend de l'activation ou non de l'architecture de demande simple (SRA) :

• SRA activée : tous les espaces publicitaires définis jusqu'au moment de cet appel seront regroupés et demandés ensemble.
• SRA désactivée (par défaut) : l'espace publicitaire sera demandé individuellement.

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

Exemple

JavaScript

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

TypeScript

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

Voir aussi

• Afficher une annonce test
• Contrôler le chargement et l'actualisation des annonces

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'élément div lui-même.
Optional clickUrl: string	URL de suivi des clics à utiliser sur cet emplacement.

---

enableLazyLoad

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

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

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

Obsolète : utilisez plutôt PageSettingsConfig.lazyLoad.

Exemple

JavaScript

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

TypeScript

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

Voir aussi

• Bonnes pratiques concernant les annonces : priorisez les espaces publicitaires "importants"
• Chargement différé

Paramètres

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

L'objet de configuration permet de personnaliser le comportement différé. Toute configuration omise utilisera un ensemble par défaut défini par Google, qui sera ajusté au fil du temps. Pour désactiver un paramètre particulier, tel qu'une marge de récupération, définissez la valeur sur -1. fetchMarginPercent Distance minimale entre l'emplacement et la fenêtre d'affichage actuelle avant que nous récupérions l'annonce, exprimée en pourcentage de la taille de la fenêtre d'affichage. La valeur 0 signifie "lorsque l'espace publicitaire entre dans la fenêtre d'affichage", 100 signifie "lorsque l'annonce se trouve à une distance d'une fenêtre d'affichage", et ainsi de suite. renderMarginPercent Distance minimale entre la fenêtre d'affichage actuelle et un espace publicitaire avant que nous ne diffusions une annonce. Cela permet de précharger l'annonce, mais d'attendre avant d'afficher et de télécharger d'autres sous-ressources. La valeur fonctionne comme fetchMarginPercent en tant que pourcentage de la fenêtre d'affichage. mobileScaling Multiplicateur appliqué aux marges sur les appareils mobiles. Cela permet d'avoir des marges différentes sur mobile et sur ordinateur. Par exemple, une valeur de 2,0 multipliera toutes les marges par 2 sur les appareils mobiles, ce qui augmentera la distance minimale qu'un espace peut avoir avant la récupération et l'affichage.

---

enableSingleRequest

enableSingleRequest(): boolean

Active le mode de requête unique pour récupérer plusieurs annonces en même temps. Pour cela, tous les espaces publicitaires de l'éditeur doivent être définis et ajoutés au service PubAdsService avant d'activer le service. Le mode de requête unique doit être défini avant l'activation du service.

Obsolète : utilisez plutôt PageSettingsConfig.singleRequest.

Voir aussi

• Bonnes pratiques concernant les annonces : utilisez correctement l'architecture de demande simple
• Contrôler le traitement par lot SRA

Renvoie
boolean	Renvoie true si le mode de demande simple a été activé et false s'il est impossible d'activer le mode de demande simple, 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 aux annonces display et vidéo. Si le contenu vidéo est connu, appelez PubAdsService.setVideoContent pour pouvoir utiliser l'exclusion de contenu pour les annonces display.

Obsolète : utilisez plutôt PageSettingsConfig.videoAds.

---

get

get(key: string): string

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

Obsolète : utilisez plutôt googletag.getConfig.

Exemple

JavaScript

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

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

TypeScript

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

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

Voir aussi

• Attributs AdSense

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

Renvoie
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'attribut qui ont été définies sur ce service.

Obsolète : utilisez plutôt googletag.getConfig.

Exemple

JavaScript

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

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

TypeScript

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

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

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

---

getTargeting

getTargeting(key: string): string[]

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

Obsolète : utilisez plutôt googletag.getConfig.

Exemple

JavaScript

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

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

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

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

TypeScript

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

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

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

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

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

Renvoie
string[]	Valeurs associées à cette clé, ou tableau vide s'il n'existe pas de clé de ce type.

---

getTargetingKeys

getTargetingKeys(): string[]

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

Obsolète : utilisez plutôt googletag.getConfig.

Exemple

JavaScript

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

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

TypeScript

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

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

Renvoie
string[]	Tableau de clés de ciblage. L'ordre n'est pas dé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.

Obsolète : utilisez plutôt googletag.getConfig.

Renvoie
boolean	Renvoie true si un appel précédent à PubAdsService.disableInitialLoad a réussi, ou false si ce n'est pas le cas.

---

refresh

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

Récupère et affiche de nouvelles annonces pour des espaces spécifiques ou tous les espaces de la page. Ne fonctionne qu'en mode d'affichage asynchrone.

Pour un comportement correct dans tous les navigateurs, l'appel de refresh doit être précédé d'un appel à display de l'espace publicitaire. 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 de récupérer une annonce.

L'actualisation d'un espace supprime l'ancienne annonce de la page vue de longue durée de GPT. Les futures demandes ne seront donc pas influencées par les roadblocks ou les exclusions de concurrents 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 });

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

• Contrôler le chargement et l'actualisation des annonces
• Actualiser les espaces publicitaires

Paramètres
Optional slots: Slot[]	Emplacements à actualiser. Le tableau est facultatif. Tous les emplacements seront actualisés s'il n'est pas spécifié.
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 récupérer les annonces. Nos ad servers conservent brièvement cette valeur de corrélation (actuellement pendant 30 secondes, mais cela peut changer). Ainsi, les demandes reçues à peu d'intervalle avec la même valeur de corrélation sont considérées comme une seule page vue. Par défaut, un nouveau corrélateur est généré à chaque actualisation. Remarque : Cette option n'a aucun effet sur la page vue de longue durée de GPT, qui reflète automatiquement les annonces actuellement diffusées sur la page et n'a pas de délai d'expiration.

---

registerRequestHook

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

Experimental Enregistre un hook à exécuter en parallèle avec d'autres hooks enregistrés avant chaque demande d'annonce sur la page dans un délai avant expiration global.

Exemple

JavaScript

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

// Unregister the hook.
unregister();

TypeScript

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

// Unregister the hook.
unregister();

Paramètres
hook: RequestHook	Fonction qui accepte un objet contenant la liste des emplacements demandés et renvoie une promesse qui se résout une fois que toutes les actions asynchrones sont terminées.
hookId: string	ID permettant d'étiqueter le hook pour améliorer les diagnostics.

Renvoie
(() => void)	Fonction permettant de désenregistrer le hook.

---

set

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

Définit les valeurs des attributs AdSense qui s'appliquent à tous les espaces publicitaires du service Publisher Ads.

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

Obsolète : utilisez plutôt PageSettingsConfig.adsenseAttributes.

Exemple

JavaScript

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

TypeScript

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

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 de libellé donné.

Obsolète : utilisez plutôt PageSettingsConfig.categoryExclusion.

Exemple

JavaScript

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

TypeScript

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

Voir aussi

• Libellés personnalisés pour bloquer les annonces

Paramètres
categoryExclusion: string	Libellé d'exclusion de catégorie d'annonce à 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 de gpt_mobile.js, le centrage est activé par défaut.

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

Obsolète : utilisez plutôt PageSettingsConfig.centering.

Exemple

JavaScript

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

TypeScript

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

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

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

Indique si toutes les annonces de la page doivent être affichées de force dans un conteneur SafeFrame.

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

• Ce paramètre ne s'appliquera qu'aux demandes d'annonces ultérieures effectuées pour les emplacements respectifs.
• Le paramètre au niveau de l'espace publicitaire, s'il est spécifié, remplace toujours le paramètre au niveau de la page.
• Si la valeur est définie sur true (au niveau de l'espace publicitaire ou de la page), l'annonce s'affichera toujours 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 si elle 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.

Obsolète : utilisez plutôt PageSettingsConfig.safeFrame.

Exemple

JavaScript

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

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

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

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

TypeScript

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

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

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

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

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". Si vous définissez cette option sur false alors qu'elle n'était pas spécifiée auparavant, rien ne changera.

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

---

setLocation

setLocation(address: string): PubAdsService

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

Obsolète : utilisez plutôt PageSettingsConfig.location.

Exemple

JavaScript

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

TypeScript

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

Paramètres
address: string	Adresse à 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,
});

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

• Configurer les paramètres de confidentialité
• Diffuser une annonce limitée

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

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 22 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 au niveau de la page pour la configuration SafeFrame. Toutes les clés non reconnues dans l'objet de configuration seront ignorées. La configuration entière 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'emplacement, si elles sont spécifiées.

Obsolète : utilisez plutôt PageSettingsConfig.safeFrame.

Exemple

JavaScript

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

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

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

TypeScript

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

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setConfig({
    safeFrame: {
      allowOverlayExpansion: false,
    },
  })
  .addService(googletag.pubads());

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

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

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 espaces publicitaires du service Publisher Ads. Si vous l'appelez 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.

Obsolète : utilisez plutôt PageSettingsConfig.targeting.

Exemple

JavaScript

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

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

TypeScript

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

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

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

Obsolète : utilisez plutôt PageSettingsConfig.videoAds.

Voir aussi

• Paramètres d'URL de tag d'emplacement publicitaire VAST

Paramètres
videoContentId: string	Identifiant de contenu vidéo.
videoCmsId: string	ID 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 il est unique pour chaque page vue. S'applique uniquement au mode asynchrone.

Remarque : Cela n'a aucune incidence sur la page vue de longue durée de GPT, qui reflète automatiquement les annonces réellement présentes 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.

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

Fonction de rappel appelée avant chaque demande d'annonce lorsqu'elle est enregistrée via PubAdsService.registerRequestHook.

---

googletag.ResponseInformation

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

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

Voir aussi

• Slot.getResponseInformation

Propriétés

---

advertiserId

advertiserId: number

ID de l'annonceur.

---

campaignId

campaignId: number

Identifiant de la campagne.

---

creativeId

creativeId: number

ID de la création.

---

creativeTemplateId

creativeTemplateId: number

ID du modèle de l'annonce.

---

lineItemId

lineItemId: number

ID de l'élément de campagne.

---

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

Nombre d'articles inclus dans la récompense.

---

type

type: string

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

---

googletag.Service

Classe de service de base contenant des 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 emplacements 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 :

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

Un objet du type d'événement approprié est transmis à l'écouteur lorsqu'il est appelé.

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

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

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 n'accepte qu'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 emplacements associés à ce service.

Renvoie
Slot[]	Emplacements dans l'ordre dans lequel ils ont été ajoutés 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();
});

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 n'accepte qu'un seul argument d'objet d'événement.

---

googletag.SizeMappingBuilder

Compilateur pour les objets de spécification de mappage de taille. Ce compilateur est fourni pour vous aider à créer facilement des spécifications de taille.

Méthodes
addSize	Ajoute un mappage d'un tableau à taille unique (représentant la fenêtre d'affichage) à un tableau à taille unique ou à tailles multiples représentant l'espace publicitaire.
build	Crée une spécification de mappage de taille à partir des mappages ajoutés à ce compilateur.

Voir aussi

• Tailles d'annonces : annonces responsives

Méthodes

---

addSize

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

Ajoute un mappage d'un tableau à taille unique (représentant la fenêtre d'affichage) à un tableau à taille unique ou à tailles multiples représentant l'espace publicitaire.

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 < 640x480
  .build();

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

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

TypeScript

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

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

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

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

---

build

build(): SizeMappingArray

Crée une spécification de mappage de tailles à partir des mappages ajoutés à ce compilateur.

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

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

Renvoie
SizeMappingArray	Le résultat créé par ce compilateur. Peut être nul si des mappages de tailles non valides ont été fournis.

---

googletag.Slot

"Slot" est un objet représentant un seul espace publicitaire sur une page.

Méthodes
addService	Ajoute un service à cet espace.
clearCategoryExclusions	Obsolète. Supprime tous les libellés d'exclusion de catégories d'annonces au niveau de l'espace pour cet espace.
clearTargeting	Obsolète. Supprime tous les paramètres de ciblage personnalisés au niveau de l'espace publicitaire ou certains d'entre eux.
defineSizeMapping	Définit un tableau de mappages entre une taille minimale de fenêtre d'affichage et une taille d'emplacement pour cet emplacement.
get	Obsolète. Renvoie la valeur de l'attribut AdSense associé à la clé donnée pour cet espace.
getAdUnitPath	Renvoie le chemin d'accès complet du bloc d'annonces, avec le code réseau et le chemin d'accès du bloc d'annonces.
getAttributeKeys	Obsolète. Renvoie la liste des clés d'attribut définies sur cet espace publicitaire.
getCategoryExclusions	Obsolète. Renvoie les libellés d'exclusion de catégorie d'annonce pour cet espace.
getConfig	Récupère une copie figée des options de configuration générales de l'emplacement défini par setConfig.
getResponseInformation	Renvoie les informations de la réponse d'annonce.
getSlotElementId	Renvoie l'ID de l'emplacement div fourni lors de la définition de l'emplacement.
getTargeting	Obsolète. Renvoie un paramètre de ciblage personnalisé spécifique défini sur cet espace.
getTargetingKeys	Obsolète.  Renvoie la liste de toutes les clés de ciblage personnalisé définies pour cet espace.
set	Obsolète. Définit une valeur pour un attribut AdSense sur cet espace publicitaire.
setCategoryExclusion	Obsolète. Définit un libellé d'exclusion de catégorie d'annonces au niveau de l'espace publicitaire pour cet espace.
setClickUrl	Obsolète. Définit l'URL de suivi des clics vers laquelle les utilisateurs seront redirigés après avoir cliqué sur l'annonce.
setCollapseEmptyDiv	Obsolète. Indique si l'espace publicitaire div doit être masqué lorsqu'il ne contient aucune annonce.
setConfig	Définit les options de configuration générales pour cet emplacement.
setForceSafeFrame	Obsolète. Indique si les annonces de cet espace doivent être affichées de force dans un conteneur SafeFrame.
setSafeFrameConfig	Obsolète. Définit les préférences au niveau de l'emplacement pour la configuration SafeFrame.
setTargeting	Obsolète. Définit un paramètre de ciblage personnalisé pour cet espace publicitaire.
updateTargetingFromMap	Obsolète. Définit les paramètres de ciblage personnalisé pour cet espace, à partir d'un 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());

TypeScript

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

Voir aussi

• Premiers pas avec les tags Google Publisher Tag
• Afficher une annonce test

Paramètres
service: Service	Service à ajouter.

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

---

clearCategoryExclusions

clearCategoryExclusions(): Slot

Supprime tous les libellés d'exclusion de catégories d'annonces au niveau de l'espace pour cet espace.

Obsolète : utilisez plutôt SlotSettingsConfig.categoryExclusion.

Exemple

JavaScript

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

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

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

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

TypeScript

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

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

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

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

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

---

clearTargeting

clearTargeting(key?: string): Slot

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

Obsolète : utilisez plutôt SlotSettingsConfig.targeting.

Exemple

JavaScript

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

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

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

TypeScript

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

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

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

Voir aussi

• Ciblage par clé-valeur

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

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

---

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot

Définit un tableau de mappages entre une taille minimale de fenêtre d'affichage et une taille d'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);

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 utiliser SizeMappingBuilder pour le créer. Chaque mappage de tailles 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): string

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

Obsolète : utilisez plutôt googletag.Slot.getConfig.

Exemple

JavaScript

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

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

TypeScript

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

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

Voir aussi

• Attributs AdSense

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

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

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 au niveau du service hérités par cet espace, utilisez PubAdsService.getAttributeKeys.

Obsolète : utilisez plutôt googletag.Slot.getConfig.

Exemple

JavaScript

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

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

TypeScript

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

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

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

---

getCategoryExclusions

getCategoryExclusions(): string[]

Renvoie les libellés d'exclusion de catégorie d'annonce pour cet espace publicitaire.

Obsolète : utilisez plutôt googletag.Slot.getConfig.

Exemple

JavaScript

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

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

TypeScript

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

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

Renvoie
string[]	Libellés d'exclusion de catégorie d'annonce pour cet espace, ou tableau vide si aucun n'a été défini.

---

getConfig

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

Récupère une copie figée des options de configuration générale de l'emplacement défini par setConfig.

Cette méthode n'est pas compatible avec toutes les propriétés setConfig(). Voici les propriétés acceptées :

• adsenseAttributes
• categoryExclusion
• targeting

Exemple

JavaScript

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

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

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

TypeScript

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

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

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

Paramètres
keys: string | string[]	Clés des options de configuration à obtenir.

Renvoie
Readonly<Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">>	Copie figée des options de configuration de l'emplacement.

---

getResponseInformation

getResponseInformation(): ResponseInformation

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

Renvoie
ResponseInformation	Les dernières informations sur la réponse d'annonce, ou null si l'emplacement 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'.

TypeScript

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

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

Renvoie
string	ID de l'emplacement div.

---

getTargeting

getTargeting(key: string): string[]

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

Obsolète : utilisez plutôt googletag.Slot.getConfig.

Exemple

JavaScript

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

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

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

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

TypeScript

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

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

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

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

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

Renvoie
string[]	Valeurs associées à cette clé, ou tableau vide s'il n'existe pas de clé de ce type.

---

getTargetingKeys

getTargetingKeys(): string[]

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

Obsolète : utilisez plutôt googletag.Slot.getConfig.

Exemple

JavaScript

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

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

TypeScript

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

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

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. Cela remplacera toutes les valeurs définies au niveau du service pour cette clé.

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

Obsolète : utilisez plutôt SlotSettingsConfig.adsenseAttributes.

Exemple

JavaScript

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

TypeScript

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

Voir aussi

• Attributs AdSense

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

Renvoie
Slot	Objet d'emplacement sur lequel 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 l'espace publicitaire sur cet espace.

Obsolète : utilisez plutôt SlotSettingsConfig.categoryExclusion.

Exemple

JavaScript

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

TypeScript

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

Voir aussi

• Libellés personnalisés pour bloquer les annonces

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

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

---

setClickUrl

setClickUrl(value: string): Slot

Définit l'URL de suivi des clics vers laquelle les utilisateurs seront redirigés après avoir cliqué sur l'annonce.

Les serveurs Google Ad Manager enregistrent toujours un clic, même si l'URL de suivi des clics 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 non SRA.

Obsolète : utilisez plutôt SlotSettingsConfig.clickUrl.

Exemple

JavaScript

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

TypeScript

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

Paramètres
value: string	URL de suivi des clics à définir.

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

---

setCollapseEmptyDiv

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

Indique si l'espace publicitaire div doit être masqué lorsqu'il ne contient aucune annonce. Cette méthode remplace les paramètres au niveau du service.

Obsolète : utilisez plutôt SlotSettingsConfig.collapseDiv.

Exemple

JavaScript

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

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

TypeScript

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

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

Voir aussi

• Réduire les espaces publicitaires vides
• Réduire le décalage de mise en page

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

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

---

setConfig

setConfig(slotConfig: SlotSettingsConfig): Slot

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

Paramètres
slotConfig: SlotSettingsConfig	Objet de configuration.

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

---

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot

Indique si les annonces de cet espace doivent être affichées de force dans un conteneur SafeFrame.

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

• Ce paramètre ne s'appliquera qu'aux demandes d'annonces ultérieures effectuées pour les emplacements respectifs.
• Le paramètre au niveau de l'espace publicitaire, s'il est spécifié, remplace toujours le paramètre au niveau de la page.
• Si la valeur est définie sur true (au niveau de l'espace publicitaire ou de la page), l'annonce s'affichera toujours 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 si elle 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.

Obsolète : utilisez plutôt SlotSettingsConfig.safeFrame.

Exemple

JavaScript

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 espace 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 alors qu'elle n'est pas spécifiée au niveau de la page, cela ne changera rien.

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

---

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot

Définit les préférences au niveau de l'emplacement pour la configuration SafeFrame. Toutes les clés non reconnues dans l'objet de configuration seront ignorées. La configuration entière sera ignorée si une valeur non valide est transmise pour une clé reconnue.

Ces préférences au niveau de l'emplacement, si elles sont spécifiées, remplaceront toutes les préférences au niveau de la page.

Obsolète : utilisez plutôt SlotSettingsConfig.safeFrame.

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

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: SafeFrameConfig	Objet de configuration.

Renvoie
Slot	Objet d'emplacement sur lequel 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 espace. Si vous appelez cette méthode plusieurs fois pour la même clé, les anciennes valeurs seront écrasées. Les valeurs définies ici écraseront les paramètres de ciblage définis au niveau du service. Ces clés sont définies dans votre compte Google Ad Manager.

Obsolète : utilisez plutôt SlotSettingsConfig.targeting.

Exemple

JavaScript

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

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

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

TypeScript

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

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

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

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 d'emplacement sur lequel la méthode a été appelée.

---

updateTargetingFromMap

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

Définit les paramètres de ciblage personnalisé pour cet espace, à 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 sera 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 écraseront les paramètres de ciblage définis au niveau du service.

Obsolète : utilisez plutôt SlotSettingsConfig.targeting.

Exemple

JavaScript

const 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.
AdSenseAttributesConfig	Paramètres permettant de contrôler le comportement des annonces AdSense.
AutoRefreshConfig	Paramètres de configuration de l'actualisation automatique.
ContinueButtonConfig	Paramètres permettant de configurer le comportement du bouton "Continuer".
InterstitialConfig	Objet qui définit le comportement d'un seul espace d'annonce interstitielle.
LazyLoadConfig	Paramètres permettant de contrôler l'utilisation du chargement différé dans GPT.
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é de l'éditeur.
PublisherProvidedSignalsConfig	Objet de configuration des signaux fournis par l'éditeur (PPS).
SafeFrameConfig	Paramètres permettant de contrôler SafeFrame dans GPT.
SlotSettingsConfig	Interface de configuration principale pour les paramètres au niveau de l'emplacement.
TaxonomyData	Objet contenant les valeurs d'une seule taxonomie.
VideoAdsConfig	Paramètres permettant de configurer les paramètres liés aux annonces vidéo.

Alias de type
CollapseDivBehavior	Valeurs acceptées pour contrôler le comportement de réduction des espaces publicitaires.
InterstitialTrigger	Déclencheurs d'annonces interstitielles compatibles.
PrivacyTreatment	Traitements de la confidentialité pour les éditeurs compatibles.
Taxonomy	Taxonomies compatibles avec les signaux fournis par l'éditeur (PPS).

Alias de type

---

CollapseDivBehavior

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

Valeurs acceptées pour contrôler le comportement de réduction des espaces publicitaires.

Voir aussi

• PageSettingsConfig.collapseDiv
• SlotSettingsConfig.collapseDiv

---

InterstitialTrigger

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

Déclencheurs d'annonces interstitielles acceptés.

Remarque : À partir du 15 juin 2026, le déclencheur backward ne sera plus accepté et son activation n'aura aucun effet. Pour en savoir plus, consultez les notes de version de GPT.

---

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"

Traitements de la 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

• Taxonomie d'audience de l'IAB 1.1
• Taxonomie de contenu de l'IAB 2.2

---

googletag.config.AdExpansionConfig

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

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

Exemple

JavaScript

// 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 d'annonce est activée ou désactivée.

La définition de cette valeur remplace la valeur par défaut configurée dans Google Ad Manager.

Voir aussi

• Développer les annonces sur les ordinateurs et les tablettes
• Développer des annonces sur le Web mobile (écran partiel)

---

googletag.config.AdSenseAttributesConfig

Paramètres permettant de contrôler le comportement des annonces AdSense.

Ces attributs peuvent être utilisés pour remplacer les paramètres côté serveur pour chaque demande.

Propriétés
adsense_ad_format?	Format d'annonce AdSense.
adsense_channel_ids?	ID de canaux AdSense.
adsense_test_mode?	Indique si le mode test est activé ou non.
document_language?	Langue de la page sur laquelle les annonces sont diffusées.
page_url?	URL de la page sur laquelle les annonces sont diffusées.

Voir aussi

• PageSettingsConfig.adsenseAttributes
• SlotSettingsConfig.adsenseAttributes

Propriétés

---

Optional adsense_ad_format

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

Format d'annonce AdSense.

---

Optional adsense_channel_ids

adsense_channel_ids?: string

ID de canaux AdSense.

Les valeurs autorisées sont les ID de canaux séparés par un signe plus (+).

Exemple : 271828183+314159265

Voir aussi

• Suivre les performances des blocs d'annonces avec des critères personnalisés

---

Optional adsense_test_mode

adsense_test_mode?: "on"

Indique si le mode test est activé ou non.

Lorsque la valeur est définie sur on, les annonces sont marquées comme étant réservées aux tests et ne sont pas incluses dans le comptage ni la facturation. Ce paramètre ne doit pas être défini pour le trafic de production (hors test).

---

Optional document_language

document_language?: string

Langue de la page sur laquelle les annonces sont diffusées.

Les valeurs autorisées sont des codes de langue ISO 639-1 valides.

Exemple : en

Voir aussi

• Liste des codes de langue ISO 639

---

Optional page_url

page_url?: string

URL de la page sur laquelle les annonces sont diffusées.

Les valeurs autorisées sont des URL valides.

Exemple : http://www.example.com

---

googletag.config.AutoRefreshConfig

Paramètres de configuration de l'actualisation automatique.

Propriétés
backForwardCache?	Indique si GPT actualisera automatiquement un espace publicitaire activement consulté lorsque la page sera restaurée à partir du cache back/forward.
heavyAds?	Indique si GPT actualisera automatiquement un espace publicitaire si l'intervention sur les annonces lourdes de Chrome se déclenche sur l'iFrame de l'annonce de l'espace.

Propriétés

---

Optional backForwardCache

backForwardCache?: boolean

Indique si GPT actualisera automatiquement un espace publicitaire activement consulté lorsque la page sera restaurée à partir du cache back/forward. La valeur par défaut est true.

Exemple

JavaScript

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

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

TypeScript

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

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

Voir aussi

• Cache back/forward

---

Optional heavyAds

heavyAds?: boolean

Indique si GPT actualisera automatiquement un espace publicitaire si l'intervention sur les annonces lourdes de Chrome se déclenche sur l'iFrame de l'annonce de l'espace. La valeur par défaut est true.

Exemple

JavaScript

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

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

TypeScript

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

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

Voir aussi

• Comprendre les interventions de Chrome concernant les annonces lourdes

---

googletag.config.ContinueButtonConfig

Paramètres permettant de configurer le comportement du bouton "Continuer".

Propriétés
backgroundColor?	Couleur d'arrière-plan du bouton.
font?	Famille de polices du texte du bouton.
fontColor?	Couleur du texte du bouton.
freqCapIntervalMinutes?	Intervalle de limitation de la fréquence d'exposition, en minutes.
targetId?	ID de l'élément HTML sur lequel afficher/déclencher le bouton "Continuer".

Voir aussi

• SlotSettingsConfig.continueButton

Propriétés

---

Optional backgroundColor

backgroundColor?: string

Couleur d'arrière-plan du bouton.

Exemple : 'blue', '#94B1FF'

---

Optional font

font?: string

Famille de polices du texte du bouton.

Exemple : 'Arial'

---

Optional fontColor

fontColor?: string

Couleur du texte du bouton.

Exemple : 'white', '#B73B87'

---

Optional freqCapIntervalMinutes

freqCapIntervalMinutes?: number

Intervalle de limitation de la fréquence d'exposition en minutes.

Doit être un entier supérieur ou égal à 1.

---

Optional targetId

targetId?: string

ID de l'élément HTML sur lequel afficher/déclencher le bouton "Continuer".

---

googletag.config.InterstitialConfig

Objet qui définit le comportement d'un seul espace d'annonce interstitielle.

Propriétés
requireStorageAccess?	Indique si l'autorisation de stockage local est requise pour afficher cette annonce interstitielle.
triggers?	Configuration du déclencheur d'interstitiel pour cette annonce interstitielle.

Propriétés

---

Optional requireStorageAccess

requireStorageAccess?: boolean

Indique si le consentement pour le stockage local est requis pour afficher cette annonce interstitielle.

GPT utilise le stockage local pour appliquer une limite de la fréquence d'exposition pour les annonces interstitielles. Toutefois, les utilisateurs n'ayant pas donné leur consentement pour le stockage local peuvent toujours voir des annonces interstitielles. Si vous définissez cette propriété sur true, vous désactivez le comportement par défaut et vous vous assurez que les annonces interstitielles ne sont diffusées qu'auprès des utilisateurs qui ont donné leur consentement pour le stockage local.

Exemple

JavaScript

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

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

TypeScript

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

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

Voir aussi

• Effectuer le trafficking des interstitiels pour le Web

---

Optional déclencheurs

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

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

Définir la valeur d'un déclencheur d'interstitiel sur true l'activera, et sur false le désactivera. Cela remplacera les valeurs par défaut configurées dans Google Ad Manager.

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

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

Paramètres permettant de contrôler l'utilisation du chargement différé dans GPT.

Propriétés
fetchMarginPercent?	Distance minimale entre la fenêtre d'affichage actuelle et un espace publicitaire avant qu'une annonce ne soit demandée, exprimée en pourcentage de la taille de la fenêtre d'affichage.
mobileScaling?	Multiplicateur appliqué aux marges sur les appareils mobiles.
renderMarginPercent?	Distance minimale entre l'emplacement et la fenêtre d'affichage actuelle avant l'affichage d'une annonce, exprimée en pourcentage de la taille de la fenêtre d'affichage.

Voir aussi

• PageSettingsConfig.lazyLoad

Propriétés

---

Optional fetchMarginPercent

fetchMarginPercent?: number

Distance minimale entre l'emplacement et la fenêtre d'affichage actuelle avant de demander une annonce, exprimée en pourcentage de la taille de la fenêtre d'affichage.

Utilisé conjointement avec renderMarginPercent, ce paramètre permet de précharger une annonce, mais d'attendre avant d'afficher et de télécharger d'autres sous-ressources. Par conséquent, cette valeur doit toujours être supérieure ou égale à renderMarginPercent.

La valeur 0 signifie "lorsque l'emplacement entre dans la fenêtre d'affichage", 100 signifie "lorsque l'annonce est à une fenêtre d'affichage de distance", etc.

---

Optional mobileScaling

mobileScaling?: number

Multiplicateur appliqué aux marges sur les appareils mobiles. Ce multiplicateur est appliqué à fetchMarginPercent et à renderMarginPercent.

Cela permet d'avoir des marges différentes sur mobile et sur ordinateur, où les tailles de fenêtre d'affichage et les vitesses de défilement peuvent être différentes. Par exemple, une valeur de 2,0 multiplie toutes les marges par 2 sur les appareils mobiles, ce qui augmente la distance minimale entre un espace et la fenêtre d'affichage avant la récupération et l'affichage.

---

Optional renderMarginPercent

renderMarginPercent?: number

Distance minimale entre l'emplacement et la fenêtre d'affichage actuelle avant d'afficher une annonce, exprimée en pourcentage de la taille de la fenêtre d'affichage.

Utilisé conjointement avec fetchMarginPercent, ce paramètre permet de précharger une annonce, mais d'attendre pour afficher et télécharger d'autres sous-ressources. Par conséquent, cette valeur doit toujours être inférieure ou égale à fetchMarginPercent.

La valeur 0 signifie "lorsque l'emplacement entre dans la fenêtre d'affichage", 100 signifie "lorsque l'annonce est à une fenêtre d'affichage de distance", etc.

---

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 connaître l'ensemble des 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.
adsenseAttributes?	Paramètre permettant de configurer les attributs AdSense.
adYield?	Obsolète.
autoRefresh?	Paramètre permettant de configurer le comportement d'actualisation automatique des annonces.
categoryExclusion?	Paramètre permettant de configurer les exclusions de catégories d'annonces.
centering?	Paramètre permettant de contrôler le centrage horizontal des annonces.
collapseDiv?	Paramètre permettant de contrôler le comportement de réduction des espaces publicitaires.
disableInitialLoad?	Paramètre permettant de contrôler quand les annonces sont demandées.
lazyLoad?	Paramètres permettant de contrôler l'utilisation du chargement différé dans GPT.
location?	Paramètre permettant de cibler des éléments de campagne sur des emplacements géographiques.
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é de l'éditeur.
requestHookTimeoutMs?	Paramètre permettant de contrôler le temps d'attente maximal de GPT avant que tous les hooks de requête enregistrés ne soient terminés, avant de procéder à une demande d'annonce.
safeFrame?	Paramètres permettant de contrôler l'utilisation de SafeFrame dans GPT.
singleRequest?	Paramètre permettant d'activer ou de désactiver l'architecture de demande simple (SRA).
targeting?	Paramètre permettant de contrôler le ciblage par clé-valeur.
threadYield?	Paramètre permettant de contrôler si GPT doit céder le thread JS lors de la demande et de l'affichage des créations.
videoAds?	Paramètres permettant de contrôler les annonces vidéo.

Propriétés

---

Optional adExpansion

adExpansion?: AdExpansionConfig

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

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Paramètre permettant de configurer les attributs AdSense.

Les attributs AdSense configurés via ce paramètre s'appliqueront à tous les espaces publicitaires de la page. Ce paramètre peut être appelé plusieurs fois pour définir plusieurs valeurs d'attribut ou écraser des valeurs existantes.

Les modifications apportées aux attributs AdSense ne s'appliquent qu'aux annonces demandées après l'appel de cette méthode. C'est pourquoi nous vous recommandons d'appeler cette méthode avant tout appel de googletag.display ou PubAdsService.refresh.

Exemple

JavaScript

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

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

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

TypeScript

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

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

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

---

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Obsolète : utilisez plutôt threadYield. Cette option sera bientôt supprimée.

---

Optional autoRefresh

autoRefresh?: AutoRefreshConfig

Paramètre permettant de configurer le comportement d'actualisation automatique des annonces.

Exemple

JavaScript

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

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

TypeScript

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

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

---

Optional categoryExclusion

categoryExclusion?: string[]

Paramètre permettant de configurer les exclusions de catégories d'annonces.

Exemple

JavaScript

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

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

TypeScript

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

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

Voir aussi

• Libellés personnalisés pour bloquer les annonces

---

Optional centering

centering?: boolean

Paramètre permettant de contrôler le centrage horizontal des annonces. Le centrage est désactivé par défaut.

Les modifications du centrage horizontal ne s'appliquent qu'aux annonces demandées après l'appel de cette méthode. C'est pourquoi nous vous recommandons d'appeler cette méthode avant tout appel de googletag.display ou PubAdsService.refresh.

Exemple

JavaScript

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

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

TypeScript

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

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

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Paramètre permettant de contrôler le comportement de réduction des espaces publicitaires.

Un espace publicitaire réduit n'occupe aucun espace sur la page.

Valeurs acceptées :

• null (par défaut) : l'emplacement ne sera pas réduit.
• DISABLED : l'espace publicitaire ne sera pas réduit, qu'une annonce soit renvoyée ou non.
• BEFORE_FETCH : l'espace publicitaire est initialement réduit, puis se développe lorsqu'une annonce est renvoyée.
• ON_NO_FILL : l'espace publicitaire est développé au départ, puis réduit si aucune annonce n'est renvoyée.

Exemple

JavaScript

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

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

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

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

TypeScript

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

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

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

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

Voir aussi

• Réduire les espaces publicitaires vides
• Réduire le décalage de mise en page

---

Optional disableInitialLoad

disableInitialLoad?: boolean

Paramètre permettant de contrôler quand les annonces sont demandées.

Par défaut, la méthode googletag.display enregistre les espaces publicitaires et demande des annonces pour ceux-ci. Toutefois, il est parfois préférable de séparer ces actions afin de contrôler plus précisément le moment où le contenu de l'annonce est chargé.

Si vous activez ce paramètre, aucune annonce ne sera demandée pour les emplacements enregistrés lorsque la méthode display() sera appelée. À la place, un appel distinct à PubAdsService.refresh doit être effectué pour lancer une demande d'annonce.

Cette méthode doit être appelée avant d'appeler googletag.enableServices.

Exemple

JavaScript

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

TypeScript

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

Voir aussi

• Contrôler le chargement et l'actualisation des annonces
• Contrôler le traitement par lot SRA

---

Optional lazyLoad

lazyLoad?: LazyLoadConfig

Paramètres permettant de contrôler l'utilisation du chargement différé dans GPT.

Le chargement différé est une technique qui permet de retarder la demande et l'affichage des annonces jusqu'à ce qu'elles s'approchent de la fenêtre d'affichage de l'utilisateur. Pour un exemple plus détaillé, consultez l'exemple de chargement différé.

Remarque : Si singleRequest est activé, la récupération différée ne fonctionne que lorsque tous les emplacements se trouvent en dehors de la marge de récupération.

Tous les paramètres de chargement différé qui ne sont pas spécifiés lors de l'appel de setConfig() utiliseront une valeur par défaut définie par Google. Ces valeurs par défaut peuvent être ajustées au fil du temps. Pour désactiver un paramètre particulier, définissez la valeur sur null.

Exemple

JavaScript

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

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

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

TypeScript

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

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

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

Voir aussi

• Bonnes pratiques concernant les annonces : priorisez les espaces publicitaires "importants"
• Chargement différé

---

Optional emplacement

location?: string

Paramètre permettant de cibler des éléments de campagne sur des zones géographiques.

Exemple

JavaScript

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

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

TypeScript

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

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

Voir aussi

• Cibler des emplacements géographiques en vue de la diffusion

---

Optional pps

pps?: PublisherProvidedSignalsConfig

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

---

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig

Paramètres permettant de contrôler les traitements de confidentialité de l'éditeur.

---

Optional Experimental requestHookTimeoutMs

requestHookTimeoutMs?: number | "auto"

Paramètre permettant de contrôler le temps d'attente maximal de GPT avant que tous les hooks de requête enregistrés ne soient terminés, avant de procéder à une demande d'annonce.

Tous les hooks de requête enregistrés sont exécutés en parallèle. Ce délai avant expiration définit la limite supérieure de la durée de mise en pause du processus de demande d'annonce en attendant la fin de ces exécutions parallèles.

Valeurs acceptées :

• Nombre positif en millisecondes : délai d'attente personnalisé.
• 'auto' : GPT utilise un délai avant expiration optimisé par Google.
• null : désactive les délais avant expiration (GPT attend indéfiniment que les hooks se terminent).

Exemple

JavaScript

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

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

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

TypeScript

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

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

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

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Paramètres permettant de contrôler l'utilisation de SafeFrame dans GPT.

Les valeurs configurées via ce paramètre s'appliqueront à tous les espaces publicitaires de la page. Les espaces publicitaires individuels peuvent remplacer ces valeurs via SlotSettingsConfig.safeFrame.

Exemple

JavaScript

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

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

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

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

TypeScript

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

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

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

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

---

Optional singleRequest

singleRequest?: boolean

Paramètre permettant d'activer ou de désactiver l'architecture de demande simple (SRA).

Lorsque la SRA est activée, tous les espaces publicitaires définis avant un appel googletag.display ou PubAdsService.refresh sont regroupés dans une seule demande d'annonce. Cela améliore les performances, mais est également nécessaire pour garantir le respect des roadblocks et des exclusions réciproques.

Lorsque l'architecture SRA est désactivée, chaque espace publicitaire est demandé individuellement. Il s'agit du comportement par défaut de GPT.

Cette méthode doit être appelée avant googletag.enableServices.

Exemple

JavaScript

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

TypeScript

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

Voir aussi

• À propos des roadblocks
• Bonnes pratiques concernant les annonces : utilisez correctement l'architecture de demande simple
• Contrôler le traitement par lot SRA

---

Optional ciblage

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

Paramètre permettant de contrôler le ciblage par clé-valeur.

Le ciblage configuré via ce paramètre s'appliquera à tous les espaces publicitaires de la page. Ce paramètre peut être appelé plusieurs fois pour définir plusieurs clés-valeurs de ciblage ou écraser des valeurs existantes. Les clés de ciblage sont définies dans votre compte Google Ad Manager.

Exemple

JavaScript

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

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

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

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

TypeScript

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

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

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

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

Voir aussi

• Ciblage par clé-valeur

---

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Paramètre permettant de contrôler si GPT doit céder le thread JS lors de la demande et de l'affichage des créations.

GPT ne cédera 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 JS pour les emplacements situés en dehors de la fenêtre d'affichage.
• ENABLED_ALL_SLOTS : GPT génère le thread JS pour tous les emplacements, qu'ils se trouvent ou non dans la fenêtre d'affichage.
• DISABLED : GPT ne génère pas le thread 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 });

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

---

Optional videoAds

videoAds?: VideoAdsConfig

Paramètres permettant de contrôler les annonces vidéo.

Exemple

JavaScript

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

TypeScript

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

Voir aussi

• Ingestion de contenu vidéo

---

googletag.config.PrivacyTreatmentsConfig

Paramètres permettant de contrôler les traitements de confidentialité de l'éditeur.

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

Propriétés

---

traitements

treatments: "disablePersonalization"[]

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

Exemple

JavaScript

// 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	Objet contenant des mappages de taxonomie ou valeur nulle pour effacer la configuration.

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

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

• À propos des signaux fournis par l'éditeur (bêta)
• Taxonomie d'audience de l'IAB 1.1
• Taxonomie de contenu de l'IAB 2.2

Propriétés

---

taxonomies

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>

Objet contenant des mappages de taxonomie ou valeur nulle pour effacer la configuration.

---

googletag.config.SafeFrameConfig

Paramètres permettant de contrôler SafeFrame dans GPT.

Propriétés
allowOverlayExpansion?	Indique si SafeFrame doit autoriser le contenu de l'annonce à se développer en se superposant au contenu de la page.
allowPushExpansion?	Indique si SafeFrame doit autoriser le contenu de l'annonce à se développer en repoussant le contenu de la page.
forceSafeFrame?	Indique si les annonces doivent être affichées de force à l'aide d'un conteneur SafeFrame.
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

• PageSettingsConfig.safeFrame
• SlotSettingsConfig.safeFrame

Propriétés

---

Optional allowOverlayExpansion

allowOverlayExpansion?: boolean

Indique si SafeFrame doit autoriser le contenu de l'annonce à 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 repoussant le contenu de la page.

---

Optional forceSafeFrame

forceSafeFrame?: boolean

Indique si les annonces doivent être affichées de force à l'aide d'un conteneur SafeFrame.

---

Optional sandbox

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 (ne peut pas être forcée sur false). Notez que l'attribut sandbox désactive les plug-ins (par exemple, Flash).

---

Optional useUniqueDomain

useUniqueDomain?: 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é. Définir useUniqueDomain n'a aucun effet.

Voir aussi

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

---

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 connaître l'ensemble des 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 configurer l'expansion d'annonce.
adsenseAttributes?	Paramètre permettant de configurer les attributs AdSense.
categoryExclusion?	Paramètre permettant de configurer les exclusions de catégories d'annonces.
clickUrl?	Paramètre permettant de configurer l'URL vers laquelle les utilisateurs seront redirigés après avoir cliqué sur l'annonce.
collapseDiv?	Paramètre permettant de configurer le comportement de réduction de l'espace publicitaire.
continueButton?	Paramètres permettant de configurer le comportement du bouton "Continuer" pour les annonces pendant la pause du contenu.
interstitial?	Paramètres qui configurent le comportement des espaces publicitaires interstitiels.
safeFrame?	Paramètres permettant de configurer l'utilisation de SafeFrame dans GPT.
targeting?	Paramètre permettant de configurer le ciblage par clé-valeur.

Propriétés

---

Optional adExpansion

adExpansion?: AdExpansionConfig

Paramètres permettant de configurer l'expansion d'annonce.

Voir aussi

• Expansion d'annonce

---

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig

Paramètre permettant de configurer les attributs AdSense.

Les attributs AdSense configurés via ce paramètre ne s'appliqueront qu'à l'espace publicitaire. Ce paramètre peut être appelé plusieurs fois pour définir plusieurs valeurs d'attribut ou écraser des valeurs existantes.

Les modifications apportées aux attributs AdSense ne s'appliquent qu'aux annonces demandées après l'appel de cette méthode. C'est pourquoi nous vous recommandons d'appeler cette méthode avant tout appel de googletag.display ou PubAdsService.refresh.

Exemple

JavaScript

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

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

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

TypeScript

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

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

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

---

Optional categoryExclusion

categoryExclusion?: string[]

Paramètre permettant de configurer les exclusions de catégories d'annonces.

Exemple

JavaScript

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

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

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

TypeScript

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

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

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

Voir aussi

• Libellés personnalisés pour bloquer les annonces

---

Optional clickUrl

clickUrl?: string

Paramètre permettant de configurer l'URL vers laquelle les utilisateurs seront redirigés après avoir cliqué sur l'annonce.

Les serveurs Google Ad Manager enregistrent toujours un clic, même si l'URL de suivi des clics est remplacée. Toute URL de page de destination associée à la création diffusée est ajoutée à la valeur fournie. Si vous définissez cette valeur plusieurs fois, toute valeur précédemment configurée sera écrasée. Si vous transmettez null, la valeur sera effacée.

Remarque : Ce paramètre ne s'applique qu'aux requêtes non SRA.

Exemple

JavaScript

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

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

TypeScript

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

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

---

Optional collapseDiv

collapseDiv?: CollapseDivBehavior

Paramètre permettant de configurer le comportement de réduction de l'espace publicitaire.

Un espace publicitaire réduit n'occupe aucun espace sur la page.

Valeurs acceptées :

• null (par défaut) : l'emplacement ne sera pas réduit.
• DISABLED : l'espace publicitaire ne sera pas réduit, qu'une annonce soit renvoyée ou non.
• BEFORE_FETCH : l'espace publicitaire est initialement réduit, puis se développe lorsqu'une annonce est renvoyée.
• ON_NO_FILL : l'espace publicitaire est développé au départ, puis réduit si aucune annonce n'est renvoyée.

Exemple

JavaScript

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

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

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

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

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

TypeScript

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

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

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

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

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

Voir aussi

• Réduire les espaces publicitaires vides
• Réduire le décalage de mise en page

---

Optional continueButton

continueButton?: ContinueButtonConfig

Paramètres permettant de configurer le comportement du bouton "Continuer" pour les annonces pendant la pause du contenu.

Ces paramètres permettent de personnaliser l'apparence et le comportement des interactions de sortie et de poursuite de la lecture associées aux formats d'annonce pendant la pause du contenu.

Tous les paramètres du bouton "Continuer" qui ne sont pas spécifiés lors de l'appel de setConfig() utiliseront une valeur par défaut définie par Google.

Pour désactiver ou effacer tous les paramètres du bouton "Continuer", transmettez null.

Exemple

JavaScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());
// Configure continue button settings.
slot.setConfig({
  continueButton: {
    font: "Arial",
    fontColor: "white",
    backgroundColor: "blue",
    targetId: "target-div-id",
    freqCapIntervalMinutes: 20,
  },
});

// Clear continue button settings.
slot.setConfig({ continueButton: null });

---

Optional interstitiel

interstitial?: InterstitialConfig

Paramètres qui configurent le comportement des espaces publicitaires interstitiels.

Voir aussi

• Effectuer le trafficking des interstitiels pour le Web

---

Optional safeFrame

safeFrame?: SafeFrameConfig

Paramètres permettant de configurer l'utilisation de SafeFrame dans GPT.

Les valeurs configurées via ce paramètre ne s'appliqueront qu'à l'espace publicitaire et remplaceront les valeurs définies via PageSettingsConfig.safeFrame.

Exemple

JavaScript

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

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

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

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

TypeScript

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

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

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

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

---

Optional ciblage

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

Paramètre permettant de configurer le ciblage par clé-valeur.

Le ciblage configuré via ce paramètre ne s'appliquera qu'à l'espace publicitaire. Ce paramètre peut être appelé plusieurs fois pour définir plusieurs clés-valeurs de ciblage ou écraser des valeurs existantes. Les clés de ciblage sont définies dans votre compte Google Ad Manager.

Exemple

JavaScript

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

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

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

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

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

// Clear all targeting keys.
slot.setConfig({ targeting: null });

TypeScript

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

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

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

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

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

// Clear all targeting keys.
slot.setConfig({ targeting: null });

Voir aussi

• Ciblage par clé-valeur

---

googletag.config.TaxonomyData

Objet contenant les valeurs d'une seule taxonomie.

Propriétés
values	Liste de valeurs Taxonomy.

Propriétés

---

values

values: readonly string[]

Liste de valeurs Taxonomy.

---

googletag.config.VideoAdsConfig

Paramètres permettant de configurer les paramètres liés aux annonces vidéo.

Propriétés
enableVideoAds	Indique si des annonces vidéo seront présentes sur la page.
videoCmsId?	ID de la source de contenu vidéo.
videoContentId?	Identifiant de contenu vidéo.

Voir aussi

• PageSettingsConfig.videoAds

Propriétés

---

enableVideoAds

enableVideoAds: boolean

Indique si des annonces vidéo seront présentes sur la page.

Lorsque la valeur est définie sur true, cela active les contraintes d'exclusion de contenu sur les annonces display et vidéo.

Si le contenu vidéo est connu, définissez videoContentId et videoCmsId sur les valeurs fournies au service d'ingestion de contenu Google Ad Manager pour utiliser l'exclusion de contenu pour les annonces display.

---

Optional videoCmsId

videoCmsId?: string

ID de la source du contenu vidéo.

Il s'agit d'une valeur unique attribuée par le service d'ingestion de contenu de Google Ad Manager pour identifier la source du contenu vidéo spécifié par videoContentId.

Voir aussi

• cmsid (ID de la source de contenu)

---

Optional videoContentId

videoContentId?: string

ID du contenu vidéo.

Il s'agit d'une valeur unique qui identifie une vidéo spécifique de la source de contenu spécifiée par videoCmsId. Cette valeur est attribuée par le CMS qui héberge votre contenu vidéo.

Voir aussi

• vid (ID vidéo)

---

googletag.enums

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

Énumérations
OutOfPageFormat	Formats hors page compatibles avec GPT.
TagForAgeTreatment	Paramètres de traitement selon l'âge 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
AD_INTENTS	Format d'intentions publicitaires.
BOTTOM_ANCHOR	Format d'ancrage où l'emplacement reste en bas de la fenêtre d'affichage.
GAME_MANUAL_INTERSTITIAL	Format d'interstitiel de jeu manuel. Remarque : L'interstitiel de jeu manuel est un format en accès limité.
INTERSTITIAL	Format de création d'interstitiel pour le Web.
LEFT_SIDE_RAIL	Format side rail gauche.
REWARDED	Format avec récompense.
RIGHT_SIDE_RAIL	Format side rail droit.
TOP_ANCHOR	Format d'ancrage où l'emplacement reste en haut de la fenêtre d'affichage.

---

TagForAgeTreatment

TagForAgeTreatment

Paramètres de traitement selon l'âge compatibles avec GPT.

Voir aussi

• PrivacySettingsConfig.tagForAgeTreatment

Membres de l'énumération
CHILD	Indique que les demandes d'annonces doivent bénéficier d'un traitement adapté aux ENFANTS.
TEEN	Indique que les demandes d'annonces doivent bénéficier d'un traitement adapté aux adolescents.
UNSPECIFIED	Valeur par défaut. Indique qu'aucun signal de traitement spécifique avec restriction d'âge ne s'applique à la demande d'annonce.

---

TrafficSource

TrafficSource

Sources de trafic compatibles avec 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 à son type d'objet d'événement correspondant pour Service.addEventListener et Service.removeEventListener.
GameManualInterstitialSlotClosedEvent	Cet événement est déclenché lorsqu'un emplacement d'interstitiel manuel pour jeux a été fermé par l'utilisateur.
GameManualInterstitialSlotReadyEvent	Cet événement est déclenché 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, conformément aux critères Active View.
RewardedSlotClosedEvent	Cet événement est déclenché lorsqu'un espace d'annonce avec récompense est fermé par l'utilisateur.
RewardedSlotGrantedEvent	Cet événement est déclenché lorsqu'une récompense est accordée pour avoir visionné une annonce avec récompense.
RewardedSlotReadyEvent	Cet événement est déclenché lorsqu'une annonce avec récompense est prête à être diffusée.
RewardedSlotVideoCompletedEvent	Cet événement est déclenché lorsqu'une annonce vidéo avec récompense a fini d'ê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 espace.
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 espace publicitaire particulier.
SlotVisibilityChangedEvent	Cet événement est déclenché chaque fois que le pourcentage de la zone d'un espace publicitaire visible à l'écran 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 qui a déclenché l'événement.

Voir aussi

• Écouteurs d'événements d'annonce

Propriétés

---

serviceName

serviceName: string

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

---

slot

slot: Slot

Emplacement qui a déclenché l'événement.

---

googletag.events.EventTypeMap

Il s'agit d'un pseudo-type qui mappe un nom d'événement à 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ûreté du typage uniquement.

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

Propriétés

---

gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent

Alias de 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.

---

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent

Alias de events.RewardedSlotVideoCompletedEvent.

---

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 de events.SlotResponseReceived.

---

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent

Alias de events.SlotVisibilityChangedEvent.

---

googletag.events.GameManualInterstitialSlotClosedEvent

Extends Event

Cet événement est déclenché lorsqu'un emplacement d'interstitiel de jeu manuel a été fermé par l'utilisateur.

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

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

Exemple

JavaScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

TypeScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

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

Voir aussi

• Écouteurs d'événements d'annonce
• Afficher une annonce interstitielle manuelle pour un jeu

---

googletag.events.GameManualInterstitialSlotReadyEvent

Extends Event

Cet événement est déclenché 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 la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété Event.slot

Méthodes
makeGameManualInterstitialVisible	Affiche l'annonce interstitielle manuelle du jeu pour 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,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

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

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

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

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

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

Voir aussi

• Écouteurs d'événements d'annonce
• Afficher une annonce interstitielle manuelle pour un jeu

Méthodes

---

makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): boolean

Affiche l'annonce interstitielle manuelle du jeu pour l'utilisateur. Indique si l'annonce a bien été affichée.

Renvoie
boolean

---

googletag.events.ImpressionViewableEvent

Extends Event

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

Propriétés
serviceName	Nom du service qui a déclenché l'événement. Hérité de la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété 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.
  }
});

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

---

googletag.events.RewardedSlotClosedEvent

Extends Event

Cet événement est déclenché lorsqu'un espace 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 la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété Event.slot

Exemple

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

Voir aussi

• Écouteurs d'événements d'annonce
• Afficher une annonce avec récompense

---

googletag.events.RewardedSlotGrantedEvent

Extends Event

Cet événement est déclenché lorsqu'une récompense est accordée pour avoir visionné 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éclenche 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 la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété Event.slot

Exemple

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

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

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

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

Voir aussi

• Écouteurs d'événements d'annonce
• Afficher une annonce avec récompense

Propriétés

---

payload

payload: RewardedPayload

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

---

googletag.events.RewardedSlotReadyEvent

Extends Event

Cet événement est déclenché lorsqu'une annonce avec récompense est prête à être diffusée. L'éditeur est chargé de proposer à l'utilisateur 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 la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété 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.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

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

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

Voir aussi

• Écouteurs d'événements d'annonce
• Afficher une annonce avec récompense

Méthodes

---

makeRewardedVisible

makeRewardedVisible(): boolean

Affiche l'annonce avec récompense. Cette méthode ne doit pas être appelée tant que l'utilisateur n'a pas accepté de voir l'annonce.

Renvoie
boolean	Indique si l'annonce avec récompense a bien été diffusée.

---

googletag.events.RewardedSlotVideoCompletedEvent

Extends Event

Cet événement est déclenché lorsqu'une annonce vidéo avec récompense a fini d'être diffusée.

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

Exemple

JavaScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

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

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

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

Voir aussi

• Écouteurs d'événements d'annonce
• Afficher une annonce avec récompense

---

googletag.events.SlotOnloadEvent

Extends Event

Cet événement est déclenché lorsque l'iFrame de la création déclenche son événement de chargement. Lors de l'affichage d'annonces rich media en mode de rendu synchrone, aucune iFrame n'est utilisée. Par conséquent, aucun SlotOnloadEvent ne sera déclenché.

Propriétés
serviceName	Nom du service qui a déclenché l'événement. Hérité de la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété 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.
  }
});

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

---

googletag.events.SlotRenderEndedEvent

Extends Event

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

Propriétés
advertiserId	Référence annonceur de l'annonce affichée.
campaignId	ID de 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 par réservation affichée.
creativeTemplateId	ID du modèle de création de l'annonce par réservation affichée.
isBackfill	Indique si une annonce était une annonce de backfill.
isEmpty	Indique si une annonce a été renvoyée pour l'emplacement.
labelIds	Obsolète.
lineItemId	ID de l'élément de campagne de l'annonce par réservation affichée.
responseIdentifier	L'identifiant de réponse est un identifiant unique pour la réponse d'annonce.
serviceName	Nom du service qui a déclenché l'événement. Hérité de la propriété Event.serviceName
size	Indique la taille en pixels de la création affichée.
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété 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 l'annonce de réservation ou de remplissage affichée.
sourceAgnosticLineItemId	ID de l'élément de campagne de l'annonce de réservation ou de remplissage affichée.
yieldGroupIds	ID des groupes de rendement pour l'annonce de backfill 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.
  }
});

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

Propriétés

---

advertiserId

advertiserId: 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 affichées par des services autres que PubAdsService.

---

campaignId

campaignId: number

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

---

companyIds

companyIds: 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 par réservation et les créations affichées par des services autres que PubAdsService.

---

creativeId

creativeId: number

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

---

creativeTemplateId

creativeTemplateId: number

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

---

isBackfill

isBackfill: boolean

Indique si une annonce était une annonce de backfill. 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'emplacement. La valeur est true si aucune annonce n'a été renvoyée, sinon false.

---

labelIds

labelIds: number[]

Obsolète : ce champ n'est plus renseigné.

---

lineItemId

lineItemId: number

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

---

responseIdentifier

responseIdentifier: string

L'identifiant de réponse est un identifiant unique pour la réponse d'annonce. Cette valeur peut être utilisée pour identifier et bloquer l'annonce dans le Centre de vérification des annonces.

---

size

size: 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é, sinon false.

---

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number

ID de la création de l'annonce de réservation ou de remplissage affichée. La valeur est null si l'annonce n'est pas un backfill 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: number

ID de l'élément de campagne de l'annonce de réservation ou de remplissage affichée. La valeur est null si l'annonce n'est pas un backfill 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: number[]

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

---

googletag.events.SlotRequestedEvent

Extends 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 la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété 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.
  }
});

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

---

googletag.events.SlotResponseReceived

Extends Event

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

Propriétés
serviceName	Nom du service qui a déclenché l'événement. Hérité de la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété 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.
  }
});

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

---

googletag.events.SlotVisibilityChangedEvent

Extends Event

Cet événement est déclenché chaque fois que le pourcentage de la zone d'un espace publicitaire visible à l'écran 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 la propriété Event.serviceName
slot	Emplacement qui a déclenché l'événement. Hérité de la propriété 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.
  }
});

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

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 utilisé par GPT 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	Une interface pour 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 parties :

1. Une fonction de collecteur, qui renvoie un Promise qui se résout en un signal sécurisé.
2. 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");
  },
});

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 des 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 :

1. Une fonction de collecteur, qui renvoie un Promise qui se résout en un signal sécurisé.
2. Un 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 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é.

Exemple

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...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 des 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 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

Une interface pour gérer les signaux sécurisés.

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

Méthodes

---

clearAllCache

clearAllCache(): void

Efface du cache tous les signaux de tous les collecteurs.

Appeler cette méthode peut réduire la probabilité que des signaux soient inclus dans les demandes d'annonces pour la page vue actuelle et potentiellement pour les suivantes. Elle ne doit donc être appelée que lorsque l'état change de façon significative, comme lors d'événements indiquant un nouvel utilisateur (connexion, déconnexion, inscription, etc.).

---

push

push(provider: SecureSignalProvider): void

Ajoute un nouveau secureSignals.SecureSignalProvider au tableau des fournisseurs de signaux et lance le processus de génération de signaux.

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