Ce document de référence utilise la notation TypeScript pour décrire les types. Le tableau suivant fournit une brève explication par exemple.
Expression de type | |
---|---|
string |
Type de chaîne primitive. |
string[] |
Type de tableau, où les valeurs ne peuvent être que des chaînes. |
number | string |
Type d'union, où la valeur peut être un nombre ou une chaîne. |
Array<number | string> |
Type de tableau, où les valeurs sont de type complexe (union). |
[number, string] |
Type de tuple, où la valeur est un tableau à deux éléments devant contenir un nombre et une chaîne dans cet ordre. |
Slot |
Un type d'objet, dont la valeur est une instance de googletag.Slot . |
() => void |
Type de fonction sans arguments définis ni valeur renvoyée. |
Pour en savoir plus sur les types et les expressions de type compatibles, consultez la <ph type="x-smartling-placeholder"></ph> Manuel TypeScript
Annotations de type
Le signe deux-points après une variable, un nom de paramètre, un nom de propriété ou une signature de fonction indique et l'annotation de type. Les annotations de type décrivent les types de l'élément situé à gauche des deux-points que vous pouvez accepter ou renvoyer. Le tableau suivant présente des exemples d'annotations de type que vous pouvez voir dans cette référence.
Annotation de type | |
---|---|
param: string |
Indique que param accepte ou renvoie une valeur de chaîne. Cette syntaxe est utilisée
pour les variables, les paramètres, les propriétés et les types de renvois.
|
param?: number | string |
Indique que param est facultatif, mais accepte un nombre ou une chaîne
si spécifié. Cette syntaxe est utilisée pour les paramètres et les propriétés.
|
...params: Array<() => void> |
Indique que params est un
<ph type="x-smartling-placeholder"></ph>
paramètre "rest"
qui accepte les fonctions. Les paramètres REST acceptent un nombre illimité de valeurs
type spécifié.
|
Définitions de type
Types | |
---|---|
|
SingleSize | MultiSize
|
Une configuration de taille valide pour un emplacement, qui peut être une ou plusieurs tailles. |
|
|
SingleSize[]
|
Liste de tailles uniques valides. |
|
|
"fluid" | ["fluid"]
|
Tailles nommées qu'un espace publicitaire peut avoir. Dans la plupart des cas, la taille est un rectangle de taille fixe, mais dans certains cas, nous avons besoin d'autres types de spécifications de taille. Seules les tailles nommées suivantes sont valides:
|
|
|
SingleSizeArray | NamedSize
|
Taille unique valide pour un espace publicitaire. |
|
|
[number, number]
|
Tableau de deux nombres représentant [largeur, hauteur]. |
|
|
[SingleSizeArray, GeneralSize]
|
Un mappage entre la taille de la fenêtre d'affichage et les tailles des annonces. Utilisé pour les annonces responsives. |
|
|
SizeMapping[]
|
Liste des mappages de taille. |
|
|
"unhideWindow" | "navBar"
|
Déclencheurs d'annonces interstitielles compatibles. |
|
|
"disablePersonalization"
|
Traitements de confidentialité acceptés par les éditeurs. |
|
|
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
|
Taxonomies compatibles pour les signaux fournis par l'éditeur (PPS). |
|
|
BidderSignalProvider | PublisherSignalProvider
|
Interface permettant de renvoyer un signal sécurisé pour un enchérisseur ou un fournisseur spécifique. Vous devez indiquer |
Types d'énumérations
Enums | |
---|---|
googletag.enums.OutOfPageFormat
|
Formats hors page acceptés par GPT
|
googletag.enums.TrafficSource
|
Sources de trafic acceptées par GPT.
|
googletag.enums.OutOfPageFormat
-
Formats hors page acceptés par GPT
-
- Voir aussi
googletag.enums.TrafficSource
-
Sources de trafic acceptées par GPT.
-
- Voir aussi
-
Valeurs ORGANIC
Saisie directe d'une URL, recherche sur un site ou téléchargement d'applicationPURCHASED
Trafic redirigé à partir de propriétés non détenues (activité acquise ou incitée).
googletag
Espace de noms global utilisé par Google Publisher Tag pour son API.
Récapitulatif des variables | |
---|---|
apiReady
|
Indique que l'API GPT est chargée et prête à être appelée.
|
cmd
|
Référence à la file d'attente de commandes pour l'exécution asynchrone des appels GPT.
|
pubadsReady
|
Indicateur indiquant que
PubAdsService est activé, chargé et entièrement opérationnel.
|
secureSignalProviders
|
Référence au tableau des fournisseurs de signaux sécurisés.
|
Résumé de la fonction | |
---|---|
companionAds
|
Renvoie une référence à
CompanionAdsService .
|
defineOutOfPageSlot
|
Construit un espace publicitaire hors page avec le chemin d'accès au bloc d'annonces donné.
|
defineSlot
|
Construit un espace publicitaire avec un chemin et une taille de bloc d'annonces donnés, puis l'associe à l'ID d'un élément div sur la page qui contiendra l'annonce.
|
destroySlots
|
Détruit les espaces publicitaires donné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'emplacements d'afficher l'emplacement.
|
enableServices
|
Active tous les services GPT définis pour les espaces publicitaires sur la page.
|
getVersion
|
Affiche 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 maintenant.
|
setConfig
|
Définit les options de configuration générales de la page.
|
sizeMapping
|
Crée un objet
SizeMappingBuilder .
|
googletagapiReady
-
apiReady: boolean | undefined
-
Indique 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'asynchrone 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 leur exécution est garantie une fois l'API configurée. -
- Exemple
-
JavaScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
JavaScript (ancien)
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
TypeScript
if (window.googletag && googletag.apiReady) { // GPT API can be called safely. }
googletagcmd
-
cmd: Array<(this: typeof globalThis) => void> | CommandArray
-
Référence à la file d'attente de commandes globale pour l'exécution asynchrone des appels liés à GPT.
La variablegoogletag.cmd
est initialisée sur un tableau JavaScript vide par la syntaxe du tag GPT sur la page.cmd.push
est la méthodeArray.push
standard qui ajoute un élément à la fin du tableau. Une fois le code JavaScript de GPT chargé, il examine le tableau et exécute toutes les fonctions dans l'ordre. Le script remplace ensuitecmd
par un objetCommandArray
dont la méthode push est définie pour exécuter l'argument 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 laissant le navigateur continuer à afficher la page. -
- Exemple
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (ancien)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
googletagpubadsReady
-
pubadsReady: boolean | undefined
-
Indicateur indiquant que
PubAdsService
est activé, chargé et entièrement opérationnel. Cette propriété sera simplementundefined
jusqu'à ce queenableServices
soit appelé et quePubAdsService
soit chargé et initialisé. -
googletagsecureSignalProviders
-
secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
-
Référence au tableau des fournisseurs de signaux sécurisés.
Le tableau des fournisseurs de signaux sécurisés accepte une séquence de fonctions générant des signaux et les appelle dans l'ordre. Elle vise à remplacer un tableau standard qui est utilisé pour mettre en file d'attente les fonctions générant des signaux qui seront appelées une fois le tag GPT chargé. -
- Exemple
-
JavaScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
JavaScript (ancien)
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { return Promise.resolve("signal"); }, });
TypeScript
window.googletag = window.googletag || { cmd: [] }; googletag.secureSignalProviders = googletag.secureSignalProviders || []; googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { return Promise.resolve("signal"); }, });
- Voir aussi
googletagcompanionAds
-
companionAds(): CompanionAdsService
-
Renvoie une référence à
CompanionAdsService
. -
-
Renvoie CompanionAdsService
Le service Annonces associées.
googletagdefineOutOfPageSlot
-
defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
-
Construit un espace publicitaire hors page avec le chemin d'accès au bloc d'annonces indiqué.
Pour les annonces hors page personnalisées,div
correspond à l'ID de l'élément div qui contiendra l'annonce. Pour en savoir plus, consultez l'article sur les créations hors page.
Pour les annonces hors page gérées par GPT,div
est un OutOfPageFormat compatible. -
- Exemple
-
JavaScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
JavaScript (ancien)
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
TypeScript
// Define a custom out-of-page ad slot. googletag.defineOutOfPageSlot("/1234567/sports", "div-1"); // Define a GPT managed web interstitial ad slot. googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
- Voir aussi
-
Paramètres adUnitPath: string
Chemin d'accès complet au bloc d'annonces avec le code de réseau et le code du bloc d'annonces.div?: string | OutOfPageFormat
ID de l'élément div qui contiendra ce bloc d'annonces ou ce format OutOfPageFormat. -
Renvoie Slot | null
Emplacement nouvellement créé, ounull
si aucun espace ne peut être créé.
googletagdefineSlot
-
defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
-
Construit un espace publicitaire avec un chemin et une taille de bloc d'annonces donnés, puis l'associe à l'ID d'un élément div sur la page qui contiendra l'annonce.
-
- Exemple
-
JavaScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
JavaScript (ancien)
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
- Voir aussi
-
Paramètres adUnitPath: string
Chemin d'accès complet au bloc d'annonces avec le code de 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.div?: string
ID de l'élément div qui contiendra ce bloc d'annonces. -
Renvoie Slot | null
Emplacement nouvellement créé, ounull
si aucun espace ne peut être créé.
googletagdestroySlots
-
destroySlots(slots?: Slot[]): boolean
-
Détruit les espaces publicitaires donnés, en supprimant de GPT tous les objets et références associés à ces espaces. Cette API n'est pas compatible avec les emplacements de renvoi et associés.
En appelant cette API sur un espace publicitaire, l'annonce est effacée et l'objet de l'espace publicitaire est supprimé de l'état interne géré par GPT. L'appel d'autres fonctions sur l'objet Emplacement entraîne un comportement non défini. Notez que le navigateur peut toujours ne pas libérer la mémoire associée à cet emplacement si une référence à celui-ci est gérée par la page de l'éditeur. En appelant cette API, vous pouvez réutiliser l'élément div associé à cet espace publicitaire.
En particulier, la destruction d'un espace a pour effet de supprimer l'annonce de la page vue longue durée de GPT. Les futures demandes ne seront donc pas influencées par les obstacles ou les exclusions réciproques impliquant cette annonce. Si cette fonction n'est pas appelée avant la suppression de l'élément div d'un espace publicitaire de la page, le comportement de cette fonction n'est pas défini. -
- Exemple
-
JavaScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
JavaScript (ancien)
// The calls to construct an ad and display contents. var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
TypeScript
// The calls to construct an ad and display contents. const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to destroy only slot1. googletag.destroySlots([slot1]); // This call to destroy both slot1 and slot2. googletag.destroySlots([slot1, slot2]); // This call to destroy all slots. googletag.destroySlots();
-
Paramètres 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
dans le cas contraire.
googletagdisablePublisherConsole
-
disablePublisherConsole(): void
-
Désactive la Console Google pour les éditeurs.
-
- Voir aussi
googletagdisplay
-
display(divOrSlot: string | Element | Slot): void
-
Indique aux services d'emplacements d'afficher l'emplacement. Chaque espace publicitaire ne doit être affiché qu'une seule fois par page. Tous les espaces publicitaires doivent être définis et associés à un service avant d'être affichés. L'appel d'affichage ne doit pas avoir lieu tant que l'élément n'est pas présent dans le DOM. Pour ce faire, la méthode habituelle consiste à la 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 l'élément div. -
- Exemple
-
JavaScript
googletag.cmd.push(() => { googletag.display("div-1"); });
JavaScript (ancien)
googletag.cmd.push(function () { googletag.display("div-1"); });
TypeScript
googletag.cmd.push(() => { googletag.display("div-1"); });
- Voir aussi
-
Paramètres divOrSlot: string | Element | Slot
Soit l'ID de l'élément div contenant l'espace publicitaire ou l'élément div, soit l'objet de l'espace publicitaire. Si un élément div est fourni, il doit comporter un attribut "id" qui correspond à l'ID transmis àdefineSlot
.
googletagenableServices
-
enableServices(): void
-
Active tous les services GPT définis pour les espaces publicitaires sur la page.
-
googletaggetVersion
-
getVersion(): string
-
Affiche la version actuelle de GPT.
-
- Voir aussi
-
Renvoie string
Chaîne de la version GPT en cours d'exécution.
googletagopenConsole
-
openConsole(div?: string): void
-
Ouvre la Console Google pour les éditeurs.
-
- Exemple
-
JavaScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
JavaScript (ancien)
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
TypeScript
// Calling with div ID. googletag.openConsole("div-1"); // Calling without div ID. googletag.openConsole();
- Voir aussi
-
Paramètres div?: string
Un ID div d'espace publicitaire. Cette valeur est facultative. Lorsqu'elle est fournie, la Console pour les éditeurs tente de s'ouvrir pour afficher les détails de l'espace publicitaire spécifié.
googletagpubads
-
pubads(): PubAdsService
-
Renvoie une référence à
PubAdsService
. -
-
Renvoie PubAdsService
Le service Annonces de l'éditeur
googletagsetAdIframeTitle
-
setAdIframeTitle(title: string): void
-
Définit le titre de tous les iFrames de conteneur d'annonces créés par
PubAdsService
à partir de maintenant. -
- Exemple
-
JavaScript
googletag.setAdIframeTitle("title");
JavaScript (ancien)
googletag.setAdIframeTitle("title");
TypeScript
googletag.setAdIframeTitle("title");
-
Paramètres title: string
Nouveau titre pour tous les iFrames de conteneur d'annonces.
googletagsetConfig
-
setConfig(config: PageSettingsConfig): void
-
Définit les options de configuration générales de la page.
-
-
Paramètres config: PageSettingsConfig
googletagsizeMapping
-
sizeMapping(): SizeMappingBuilder
-
Crée un objet
SizeMappingBuilder
. -
- Voir aussi
-
Renvoie SizeMappingBuilder
Un nouveau compilateur.
googletagCommandArray
Le tableau de commandes accepte une séquence de fonctions et les appelle dans l'ordre. Il vise à remplacer un tableau standard qui est utilisé pour mettre en file d'attente les fonctions à appeler une fois le tag GPT chargé.
Récapitulatif sur la méthode | |
---|---|
push
|
Exécute dans l'ordre la séquence de fonctions spécifiées dans les arguments.
|
push
-
push(...f: Array<(this: typeof globalThis) => void>): number
-
Exécute dans l'ordre la séquence de fonctions spécifiées dans les arguments.
-
- Exemple
-
JavaScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
JavaScript (ancien)
googletag.cmd.push(function () { googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads()); });
TypeScript
googletag.cmd.push(() => { googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads()); });
-
Paramètres ...f: Array<(this: typeof globalThis) => void>
Fonction JavaScript à exécuter. La liaison d'exécution sera toujoursglobalThis
. Envisagez de transmettre une fonction fléchée pour conserver la valeurthis
du contexte lexical englobant. -
Renvoie number
Nombre de commandes traitées jusqu'à présent. Cette valeur est compatible avec la valeur renvoyée parArray.push
(la longueur actuelle du tableau).
googletagCompanionAdsService
Extensions
du service Annonces associées. Ce service est utilisé par les annonces vidéo pour diffuser des annonces associées.
Récapitulatif sur la méthode | |
---|---|
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
|
getSlots
|
Obtenez la liste des emplacements associés à ce service.
Hérité de
|
removeEventListener
|
Supprime un écouteur précédemment enregistré.
Hérité de
|
setRefreshUnfilledSlots
|
Détermine si les espaces publicitaires associés qui n'ont pas été remplis seront automatiquement remplis.
|
- Voir aussi
setRefreshUnfilledSlots
-
setRefreshUnfilledSlots(value: boolean): void
-
Détermine si les espaces publicitaires associés qui n'ont pas été remplis seront automatiquement remplis.
Cette méthode peut être appelée plusieurs fois au cours de la durée de vie d'une page afin d'activer et de désactiver le remplissage. Seuls les emplacements qui sont également enregistrés avecPubAdsService
seront remplis. En raison de restrictions imposées par nos règles, cette méthode n'est pas conçue pour remplir les espaces publicitaires vides associés lors de la diffusion d'une vidéo Ad Exchange. -
- Exemple
-
JavaScript
googletag.companionAds().setRefreshUnfilledSlots(true);
JavaScript (ancien)
googletag.companionAds().setRefreshUnfilledSlots(true);
TypeScript
googletag.companionAds().setRefreshUnfilledSlots(true);
-
Paramètres value: boolean
true
pour remplir automatiquement les espaces publicitaires non remplis etfalse
pour les laisser tels quels.
googletagPrivacySettingsConfig
Objet de configuration pour les paramètres de confidentialité.
Récapitulatif de la propriété | |
---|---|
childDirectedTreatment
|
Indique si la page doit être traitée comme étant destinée aux enfants.
|
limitedAds
|
Active la diffusion en mode annonces limitées afin de répondre aux besoins de conformité réglementaire des éditeurs.
|
nonPersonalizedAds
|
Active la diffusion en mode annonces non personnalisées afin de répondre aux besoins de conformité réglementaire des éditeurs.
|
restrictDataProcessing
|
Permet l'exécution de la diffusion en mode de traitement restreint afin de répondre aux besoins de conformité réglementaire des éditeurs.
|
trafficSource
|
Indique si les demandes représentent du trafic acheté ou généré par les résultats naturels.
|
underAgeOfConsent
|
Indique s'il faut marquer les demandes d'annonces comme provenant d'utilisateurs n'ayant pas atteint l'âge minimal requis.
|
- Voir aussi
childDirectedTreatment
-
childDirectedTreatment: null | boolean
-
Indique si la page doit être traitée comme étant destinée aux enfants. Définissez la valeur sur
null
pour effacer la configuration. -
limitedAds
-
limitedAds: boolean
-
Active la diffusion en mode annonces limitées afin de répondre aux besoins de conformité réglementaire des éditeurs.
Vous pouvez demander à 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 version 2.0 du TCF de l'IAB ;
- Manuellement, en définissant la valeur de ce champ sur
true
.
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, });
JavaScript (ancien)
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
TypeScript
// Manually enable limited ads serving. // GPT must be loaded from the limited ads URL to configure this setting. googletag.pubads().setPrivacySettings({ limitedAds: true, });
- Voir aussi
nonPersonalizedAds
-
nonPersonalizedAds: boolean
-
Active la diffusion en mode annonces non personnalisées afin de répondre aux besoins de conformité réglementaire des éditeurs.
-
restrictDataProcessing
-
restrictDataProcessing: boolean
-
Permet l'exécution de la diffusion en mode de traitement restreint afin de répondre aux besoins de conformité réglementaire des éditeurs.
-
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 cette règle n'est pas configurée, la source de trafic est définie par défaut sur
undefined
dans les rapports. -
- Exemple
-
JavaScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
JavaScript (ancien)
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
TypeScript
// Indicate requests represent organic traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.ORGANIC, }); // Indicate requests represent purchased traffic. googletag.pubads().setPrivacySettings({ trafficSource: googletag.enums.TrafficSource.PURCHASED, });
underAgeOfConsent
-
underAgeOfConsent: null | boolean
-
Indique s'il faut marquer les demandes d'annonces comme provenant d'utilisateurs n'ayant pas atteint l'âge minimal requis. Définissez la valeur sur
null
pour effacer la configuration. -
googletagPubAdsService
Extensions
Publisher Ads. Ce service permet d'extraire et de diffuser des annonces à partir de votre compte Google Ad Manager.
Récapitulatif sur la méthode | |
---|---|
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
|
clear
|
Supprime les annonces des espaces publicitaires donnés et les remplace par un contenu vide.
|
clearCategoryExclusions
|
Efface tous les libellés d'exclusion de catégories d'annonces au niveau de la page.
|
clearTargeting
|
Efface les paramètres de ciblage personnalisé pour une clé spécifique ou pour toutes les clés.
|
collapseEmptyDivs
|
Active le repli des éléments div de l'espace publicitaire de sorte qu'ils n'occupent pas d'espace sur la page lorsqu'il n'y a aucune annonce à afficher.
|
disableInitialLoad
|
Désactive les demandes d'annonces lors du chargement de la page, mais autorise les demandes d'annonces via 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
|
Active le chargement différé dans GPT, tel que défini par l'objet de configuration.
|
enableSingleRequest
|
Active le mode de demande simple pour récupérer plusieurs annonces en même temps.
|
enableVideoAds
|
Indique à GPT que des annonces vidéo seront présentes sur la page.
|
get
|
Renvoie la valeur de l'attribut AdSense associé à la clé donnée.
|
getAttributeKeys
|
Renvoie les clés d'attribut définies sur ce service.
|
getSlots
|
Obtenez la liste des emplacements associés à ce service.
Hérité de
|
getTargeting
|
Renvoie un paramètre de ciblage personnalisé au niveau du service qui a été défini.
|
getTargetingKeys
|
Affiche la liste de toutes les clés de ciblage personnalisé au niveau du service qui ont été définies.
|
isInitialLoadDisabled
|
Indique si les demandes initiales d'annonces ont été désactivées avec succès par un appel
PubAdsService.disableInitialLoad précédent.
|
refresh
|
Extrait et affiche de nouvelles annonces pour certains espaces publicitaires de la page ou pour l'ensemble de ceux-ci.
|
removeEventListener
|
Supprime un écouteur précédemment enregistré.
Hérité de
|
set
|
Définit des valeurs d'attributs AdSense applicables à tous les espaces publicitaires dans le service Annonces d'éditeur.
|
setCategoryExclusion
|
Définit une exclusion de catégorie d'annonces au niveau de la page pour le nom du libellé donné.
|
setCentering
|
Active et désactive le centrage horizontal des annonces.
|
setForceSafeFrame
|
Configure si l'affichage de toutes les annonces de la page doit être forcé à l'aide d'un conteneur SafeFrame.
|
setLocation
|
Transmet des informations de localisation à partir de sites Web qui vous permettent de cibler des zones géographiques spécifiques avec vos éléments de campagne.
|
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'ID fourni par l'éditeur.
|
setSafeFrameConfig
|
Définit les préférences de configuration des cadres SafeFrame au niveau de la page.
|
setTargeting
|
Définit pour une clé donnée des paramètres de ciblage personnalisés qui s'appliquent à tous les espaces publicitaires du service Annonces d'éditeur.
|
setVideoContent
|
Définit les informations sur le contenu vidéo à envoyer avec les demandes d'annonces à des fins de ciblage et d'exclusion de contenu.
|
updateCorrelator
|
Modifie le corrélateur envoyé avec les demandes d'annonces, ce qui lance une nouvelle page vue.
|
clear
-
clear(slots?: Slot[]): boolean
-
Supprime les annonces des espaces publicitaires donnés et les remplace par un contenu vide. Les espaces publicitaires seront marqués comme non récupérés.
En particulier, le fait d'effacer un espace a pour effet de supprimer l'annonce de la page vue longue durée de GPT. Les futures demandes ne seront donc pas influencées par les obstacles ou les exclusions réciproques impliquant cette annonce. -
- Exemple
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
JavaScript (ancien)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to clear only slot1. googletag.pubads().clear([slot1]); // This call to clear both slot1 and slot2. googletag.pubads().clear([slot1, slot2]); // This call to clear all slots. googletag.pubads().clear();
-
Paramètres slots?: Slot[]
Tableau des espaces publicitaires à effacer. Le tableau est facultatif. tous les emplacements seront effacés s'il n'est pas spécifié. -
Renvoie boolean
Renvoietrue
si les emplacements ont été effacés, etfalse
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 opération est utile si vous souhaitez actualiser l'emplacement.
-
- Exemple
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
JavaScript (ancien)
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. googletag.pubads().setCategoryExclusion("AirlineAd"); // Make ad requests. No ad with 'AirlineAd' label will be returned. // Clear category exclusions so all ads can be returned. googletag.pubads().clearCategoryExclusions(); // Make ad requests. Any ad can be returned.
- Voir aussi
-
Renvoie PubAdsService
Objet de service sur lequel la méthode a été appelée.
clearTargeting
-
clearTargeting(key?: string): PubAdsService
-
Efface les paramètres de ciblage personnalisé pour une clé spécifique ou pour toutes les clés.
-
- Exemple
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
JavaScript (ancien)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().setTargeting("fruits", "apple"); googletag.pubads().clearTargeting("interests"); // Targeting 'colors' and 'fruits' are still present, while 'interests' // was cleared. googletag.pubads().clearTargeting(); // All targeting has been cleared.
- Voir aussi
-
Paramètres key?: string
Clé du paramètre de ciblage. Cette clé est facultative. S'il n'est pas spécifié, tous les paramètres de ciblage seront supprimés. -
Renvoie PubAdsService
Objet de service sur lequel la méthode a été appelée.
collapseEmptyDivs
-
collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
-
Active le repli des éléments div de l'espace publicitaire de sorte qu'ils n'occupent pas d'espace sur la page lorsqu'il n'y a aucune annonce à afficher. Ce mode doit être défini avant l'activation du service.
-
Paramètres collapseBeforeAdFetch?: boolean
Indique si les espaces publicitaires doivent être réduits avant même que les annonces ne soient récupérées. Ce paramètre est facultatif. Si aucune valeur n'est fournie,false
est utilisé comme valeur par défaut. -
Renvoie boolean
Renvoietrue
si le mode de réduction de l'élément div est activé etfalse
s'il est impossible d'activer ce mode, car la méthode a été appelée après l'activation du service.
disableInitialLoad
-
disableInitialLoad(): void
-
Désactive les demandes d'annonces lors du chargement de la page, mais autorise les demandes d'annonces via un appel
PubAdsService.refresh
. Vous devez définir cette valeur avant l'activation du service. Vous devez utiliser le mode asynchrone. sinon il sera impossible de demander des annonces avecrefresh
.
display
-
display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
-
Crée et affiche un espace publicitaire avec le chemin d'accès et la taille du bloc d'annonces indiqués. Cette méthode ne fonctionne pas avec le mode de demande simple.
Remarque:Lorsque cette méthode est appelée, un instantané de l'état de l'espace publicitaire et de la page est créé pour assurer la cohérence lors de l'envoi de la demande d'annonce et de l'affichage de la réponse. Toutes les modifications apportées à l'état de l'espace publicitaire ou de la page après l'appel de cette méthode (y compris le ciblage, les paramètres de confidentialité, les cadres SafeFrame, etc.) ne s'appliqueront qu'aux requêtesdisplay()
ourefresh()
ultérieures. -
- Exemple
-
JavaScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
JavaScript (ancien)
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
TypeScript
googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
- Voir aussi
-
Paramètres adUnitPath: string
Chemin d'accès au bloc d'annonces de l'espace publicitaire à afficher.size: GeneralSize
Largeur et hauteur de l'emplacement.div?: string | Element
Soit l'ID de l'élément div contenant l'espace publicitaire, soit l'élément div lui-même.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 l'architecture de demande simple ne fonctionne que si tous les emplacements se trouvent en dehors de la marge d'extraction. -
- Exemple
-
JavaScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
JavaScript (ancien)
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
TypeScript
googletag.pubads().enableLazyLoad({ // Fetch slots within 5 viewports. fetchMarginPercent: 500, // Render slots within 2 viewports. renderMarginPercent: 200, // Double the above values on mobile. mobileScaling: 2.0, });
- Voir aussi
-
Paramètres config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
L'objet de configuration permet de personnaliser le comportement différé. Les configurations omises utiliseront 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 d'extraction, définissez la valeur sur-1
.fetchMarginPercent
Distance minimale de la fenêtre d'affichage actuelle pour laquelle un emplacement doit se trouver avant la récupération de l'annonce, sous la forme d'un pourcentage de la taille de la fenêtre d'affichage. La valeur 0 correspond à "lorsque l'espace publicitaire entre dans la fenêtre d'affichage", "100" à "à une distance d'une fenêtre d'affichage", et ainsi de suite.renderMarginPercent
La distance minimale d'un emplacement par rapport à la fenêtre d'affichage actuelle avant d'afficher une annonce. Cela permet le préchargement de l'annonce, mais attend l'affichage et le téléchargement d'autres sous-ressources. Cette valeur fonctionne commefetchMarginPercent
et est exprimée en pourcentage de la fenêtre d'affichage.mobileScaling
Multiplicateur appliqué aux marges sur les appareils mobiles. Cela permet de faire varier les marges sur mobile par rapport à ordinateur. Par exemple, la valeur 2,0 multiplie toutes les marges par 2 sur les appareils mobiles, ce qui augmente la distance minimale d'un emplacement avant l'extraction et l'affichage.
enableSingleRequest
-
enableSingleRequest(): boolean
-
Active le mode de demande simple pour récupérer plusieurs annonces en même temps. Cette opération nécessite que tous les espaces publicitaires d'annonces d'éditeur soient définis et ajoutés à PubAdsService avant l'activation du service. Le mode de demande simple doit être défini avant l'activation du service.
-
Renvoie boolean
Renvoietrue
si le mode de demande simple a été activé etfalse
s'il est impossible d'activer ce mode, car la méthode a été appelée après l'activation du service.
enableVideoAds
-
enableVideoAds(): void
-
Indique à GPT que des annonces vidéo seront présentes sur la page. Cela permet d'appliquer des contraintes d'exclusion réciproque sur les annonces display et vidéo. Si le contenu vidéo est connu, appelez
PubAdsService.setVideoContent
pour pouvoir utiliser l'exclusion de contenu avec les annonces display. -
get
-
get(key: string): null | string
-
Renvoie la valeur de l'attribut AdSense associé à la clé donnée.
-
- Exemple
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (ancien)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().get("adsense_background_color"); // Returns '#FFFFFF'.
- Voir aussi
-
Paramètres key: string
Nom de l'attribut à rechercher. -
Renvoie null | string
Valeur actuelle de la clé d'attribut ounull
si la clé n'est pas présente.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Renvoie les clés d'attribut définies sur ce service.
-
- Exemple
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (ancien)
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF"); googletag.pubads().set("adsense_border_color", "#AABBCC"); googletag.pubads().getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Renvoie string[]
Tableau de 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é au niveau du service qui a été défini.
-
- Exemple
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
JavaScript (ancien)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().getTargeting("interests"); // Returns ['sports']. googletag.pubads().getTargeting("age"); // Returns [] (empty array).
-
Paramètres key: string
Clé de ciblage à rechercher. -
Renvoie string[]
Valeurs associées à cette clé, ou tableau vide en l'absence de clé de ce type.
getTargetingKeys
-
getTargetingKeys(): string[]
-
Affiche la liste de toutes les clés de ciblage personnalisé au niveau du service qui ont été définies.
-
- Exemple
-
JavaScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
JavaScript (ancien)
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
TypeScript
googletag.pubads().setTargeting("interests", "sports"); googletag.pubads().setTargeting("colors", "blue"); googletag.pubads().getTargetingKeys(); // Returns ['interests', 'colors'].
-
Renvoie string[]
Tableau de clés de ciblage. L'ordre n'est pas défini.
isInitialLoadDisabled
-
isInitialLoadDisabled(): boolean
-
Indique si les demandes initiales d'annonces ont été désactivées avec succès par un appel
PubAdsService.disableInitialLoad
précédent. -
-
Renvoie boolean
Renvoietrue
si un appel précédent àPubAdsService.disableInitialLoad
a abouti,false
dans les autres cas.
refresh
-
refresh(slots?: null | Slot[], options?: { changeCorrelator: boolean }): void
-
Extrait et affiche de nouvelles annonces pour certains espaces publicitaires de la page ou pour l'ensemble de ceux-ci. Ne fonctionne qu'en mode d'affichage asynchrone.
Pour que l'espace publicitaire fonctionne de manière appropriée dans tous les navigateurs, l'appel de la méthoderefresh
doit être précédé d'un appel à la méthodedisplay
de l'espace publicitaire. Si l'appel àdisplay
est omis, l'actualisation peut avoir un comportement inattendu. Si vous le souhaitez, vous pouvez utiliser la méthodePubAdsService.disableInitialLoad
pour empêcherdisplay
de récupérer une annonce.
L'actualisation d'un espace supprime l'ancienne annonce de la page vue longue durée de GPT. Les futures demandes ne seront donc pas influencées par les obstacles ou les exclusions réciproques impliquant cette annonce. -
- Exemple
-
JavaScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
JavaScript (ancien)
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1"); googletag.display("div-1"); var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2"); googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
TypeScript
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!; googletag.display("div-1"); const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!; googletag.display("div-2"); // This call to refresh fetches a new ad for slot1 only. googletag.pubads().refresh([slot1]); // This call to refresh fetches a new ad for both slot1 and slot2. googletag.pubads().refresh([slot1, slot2]); // This call to refresh fetches a new ad for each slot. googletag.pubads().refresh(); // This call to refresh fetches a new ad for slot1, without changing // the correlator. googletag.pubads().refresh([slot1], { changeCorrelator: false }); // This call to refresh fetches a new ad for each slot, without // changing the correlator. googletag.pubads().refresh(null, { changeCorrelator: false });
- Voir aussi
-
Paramètres slots?: null | Slot[]
Emplacements à actualiser. Le tableau est facultatif. Si aucune valeur n'est spécifiée, tous les emplacements sont actualisés.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 serveurs publicitaires conservent cette valeur de corrélateur pendant une courte période (actuellement pendant 30 secondes, mais il est susceptible d'être modifié), de sorte que les demandes reçues à proximité d'un même corrélateur soient 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 sur la page et qui n'est associée à aucun délai d'expiration.
set
-
set(key: string, value: string): PubAdsService
-
Définit des valeurs pour les attributs AdSense qui s'appliquent à tous les espaces publicitaires dans le service Annonces d'éditeur.
Si vous appelez cette méthode plusieurs fois pour la même clé, les valeurs précédemment définies pour cette clé seront ignorées. Toutes les valeurs doivent être définies avant d'appelerdisplay
ourefresh
. -
- Exemple
-
JavaScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
JavaScript (ancien)
googletag.pubads().set("adsense_background_color", "#FFFFFF");
TypeScript
googletag.pubads().set("adsense_background_color", "#FFFFFF");
- Voir aussi
-
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 du libellé donné.
-
- Exemple
-
JavaScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
JavaScript (ancien)
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
TypeScript
// Label = AirlineAd. googletag.pubads().setCategoryExclusion("AirlineAd");
- Voir aussi
-
Paramètres categoryExclusion: string
Libellé d'exclusion de catégorie d'annonces à ajouter. -
Renvoie PubAdsService
Objet de service sur lequel la méthode a été appelée.
setCentering
-
setCentering(centerAds: boolean): void
-
Active et désactive le centrage horizontal des annonces. Le centrage est désactivé par défaut. Dans l'ancienne version de gpt_mobile.js, le centrage est activé par défaut.
Cette méthode doit être appelée avant d'appelerdisplay
ourefresh
, car seules les annonces demandées après avoir appelé cette méthode seront centrées. -
- Exemple
-
JavaScript
// Make ads centered. googletag.pubads().setCentering(true);
JavaScript (ancien)
// Make ads centered. googletag.pubads().setCentering(true);
TypeScript
// Make ads centered. googletag.pubads().setCentering(true);
-
Paramètres centerAds: boolean
true
pour centrer les annonces etfalse
pour les aligner à gauche.
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
-
Détermine si toutes les annonces de la page doivent s'afficher d'office à l'aide d'un conteneur SafeFrame.
Gardez à l'esprit les points suivants lorsque vous utilisez cette API:- Ce paramètre ne s'appliquera qu'aux prochaines demandes d'annonces effectuées pour les espaces publicitaires respectifs.
- Le paramètre au niveau de l'espace publicitaire, s'il est spécifié, prévaut toujours sur 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 est toujours affichée à l'aide d'un conteneur SafeFrame, quel que soit le choix effectué dans l'interface utilisateur de Google Ad Manager. - Toutefois, si elle est définie sur
false
ou si elle n'est pas spécifiée, l'annonce sera affichée à l'aide d'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 prudence, car elle peut avoir un impact sur le comportement des créations qui tentent de dépasser de leurs iFrames ou qui sont affichées directement sur la page d'un éditeur.
-
- Exemple
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (ancien)
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will be opted-out of the page-level force // SafeFrame instruction. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setForceSafeFrame(false) .addService(googletag.pubads()); // The following slot will have SafeFrame forced. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Voir aussi
-
Paramètres forceSafeFrame: boolean
true
pour forcer l'affichage de toutes les annonces de la page dans des cadres SafeFrame etfalse
pour définir le paramètre précédent sur "false". Le fait de définir cette valeur surfalse
alors qu'il n'a pas été spécifié précédemment ne change rien. -
Renvoie PubAdsService
Objet de service sur lequel la fonction a été appelée.
setLocation
-
setLocation(address: string): PubAdsService
-
Transmet des informations de localisation à partir de sites Web qui vous permettent de cibler des zones géographiques spécifiques avec vos éléments de campagne.
-
- Exemple
-
JavaScript
// Postal code: googletag.pubads().setLocation("10001,US");
JavaScript (ancien)
// Postal code: googletag.pubads().setLocation("10001,US");
TypeScript
// Postal code: googletag.pubads().setLocation("10001,US");
-
Paramètres address: string
Adresse au format libre. -
Renvoie PubAdsService
Objet de service sur lequel la méthode a été appelée.
setPrivacySettings
-
setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
-
Permet de configurer tous les paramètres de confidentialité à partir d'une seule API à l'aide d'un objet de configuration.
-
- Exemple
-
JavaScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
JavaScript (ancien)
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
TypeScript
googletag.pubads().setPrivacySettings({ restrictDataProcessing: true, }); // Set multiple privacy settings at the same time. googletag.pubads().setPrivacySettings({ childDirectedTreatment: true, underAgeOfConsent: true, }); // Clear the configuration for childDirectedTreatment. googletag.pubads().setPrivacySettings({ childDirectedTreatment: null, });
- Voir aussi
-
Paramètres privacySettings: PrivacySettingsConfig
Objet contenant la configuration des paramètres de confidentialité. -
Renvoie PubAdsService
Objet de service sur lequel la fonction a été appelée.
setPublisherProvidedId
-
setPublisherProvidedId(ppid: string): PubAdsService
-
Définit la valeur de l'ID fourni par l'éditeur.
-
- Exemple
-
JavaScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
JavaScript (ancien)
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
TypeScript
googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
- Voir aussi
-
Paramètres ppid: string
ID alphanumérique fourni par l'éditeur. Le nom doit comporter entre 32 et 150 caractères. -
Renvoie PubAdsService
Objet de service sur lequel la méthode a été appelée.
setSafeFrameConfig
-
setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
-
Définit les préférences de configuration des cadres SafeFrame au niveau de la page. Toutes les clés non reconnues dans l'objet de configuration seront ignorées. L'ensemble de la configuration sera ignoré si une valeur non valide est transmise pour une clé reconnue.
Si elles sont spécifiées, ces préférences au niveau de la page seront remplacées par des préférences au niveau de l'emplacement. -
- Exemple
-
JavaScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (ancien)
googletag.pubads().setForceSafeFrame(true); var pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; var slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); const pageConfig = { allowOverlayExpansion: true, allowPushExpansion: true, sandbox: true, }; const slotConfig = { allowOverlayExpansion: false }; googletag.pubads().setSafeFrameConfig(pageConfig); // The following slot will not allow for expansion by overlay. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig(slotConfig) .addService(googletag.pubads()); // The following slot will inherit the page level settings, and hence // would allow for expansion by overlay. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Voir aussi
-
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 pour une clé donnée des paramètres de ciblage personnalisés qui s'appliquent à tous les espaces publicitaires du service Annonces d'éditeur. Si vous appelez cette méthode plusieurs fois pour la même clé, les anciennes valeurs seront remplacées. Ces clés sont définies dans votre compte Google Ad Manager.
-
- Exemple
-
JavaScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
JavaScript (ancien)
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
TypeScript
// Example with a single value for a key. googletag.pubads().setTargeting("interests", "sports"); // Example with multiple values for a key inside in an array. googletag.pubads().setTargeting("interests", ["sports", "music"]);
- Voir aussi
-
Paramètres key: string
Clé du paramètre de ciblage.value: string | string[]
Valeur du paramètre de ciblage ou tableau de valeurs. -
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 sont automatiquement activées lorsque cette méthode est appelée. Pour
videoContentId
etvideoCmsId
, utilisez les valeurs fournies au service d'ingestion de contenu de Google Ad Manager. -
Paramètres videoContentId: string
ID du contenu de la vidéo.videoCmsId: string
ID dans le CMS de la vidéo.
updateCorrelator
-
updateCorrelator(): PubAdsService
-
Modifie le corrélateur envoyé avec les demandes d'annonces, ce qui lance une nouvelle page vue. Le corrélateur est le même pour toutes les demandes d'annonces provenant d'une page vue, et il est unique pour toutes les pages vues. Ne s'applique qu'au mode asynchrone.
Remarque:Cela n'a aucun effet sur la page vue de longue durée de GPT, qui reflète automatiquement les annonces réellement sur la page et qui n'a pas de délai d'expiration. -
- Exemple
-
JavaScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
JavaScript (ancien)
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
TypeScript
// Assume that the correlator is currently 12345. All ad requests made // by this page will currently use that value. // Replace the current correlator with a new correlator. googletag.pubads().updateCorrelator(); // The correlator will now be a new randomly selected value, different // from 12345. All subsequent ad requests made by this page will use // the new value.
-
Renvoie PubAdsService
Objet de service sur lequel la fonction a été appelée.
googletagResponseInformation
Objet représentant une seule réponse d'annonce.
Récapitulatif de la propriété | |
---|---|
advertiserId
|
Référence de l'annonceur.
|
campaignId
|
Identifiant de la campagne.
|
creativeId
|
Identifiant de la création.
|
creativeTemplateId
|
ID du modèle de l'annonce.
|
lineItemId
|
Identifiant de l'élément de campagne.
|
- Voir aussi
advertiserId
-
advertiserId: null | number
-
Référence de l'annonceur.
-
campaignId
-
campaignId: null | number
-
Identifiant de la campagne.
-
creativeId
-
creativeId: null | number
-
Identifiant de la création.
-
creativeTemplateId
-
creativeTemplateId: null | number
-
ID du modèle de l'annonce.
-
lineItemId
-
lineItemId: null | number
-
Identifiant de l'élément de campagne.
-
googletagRewardedPayload
Objet représentant la récompense associée à une annonce avec récompense
Récapitulatif de la propriété | |
---|---|
amount
|
Nombre d'éléments inclus dans la récompense.
|
type
|
Type d'élément inclus dans la récompense (par exemple, "pièce").
|
- Voir aussi
amount
-
amount: number
-
Nombre d'éléments inclus dans la récompense.
-
type
-
type: string
-
Type d'élément inclus dans la récompense (par exemple, "pièce").
-
googletagSafeFrameConfig
Objet de configuration pour les conteneurs SafeFrame.
Récapitulatif de la propriété | |
---|---|
allowOverlayExpansion
|
Indique si les cadres SafeFrame doivent permettre au contenu de l'annonce de se développer en se superposant au contenu de la page.
|
allowPushExpansion
|
Indique si les cadres SafeFrame doivent permettre au contenu de l'annonce de se développer en transférant le contenu de la page.
|
sandbox
|
Indique si SafeFrame doit utiliser l'attribut sandbox HTML5 pour empêcher la navigation de premier niveau sans interaction de l'utilisateur.
|
useUniqueDomain
|
Obsolète.
Indique si les cadres SafeFrame doivent utiliser des sous-domaines aléatoires pour les créations de réservation.
|
- Voir aussi
allowOverlayExpansion
-
allowOverlayExpansion: boolean
-
Indique si les cadres SafeFrame doivent permettre au contenu de l'annonce de se développer en se superposant au contenu de la page.
-
allowPushExpansion
-
allowPushExpansion: boolean
-
Indique si les cadres SafeFrame doivent permettre au contenu de l'annonce de se développer en transférant le contenu de la page.
-
sandbox
-
sandbox: boolean
-
Indique si SafeFrame doit utiliser l'attribut sandbox HTML5 pour empêcher la navigation de premier niveau sans interaction de l'utilisateur. La seule valeur valide est
true
(ne peut pas être forcée surfalse
). Notez que l'attribut sandbox désactive les plug-ins (par exemple, Flash). -
useUniqueDomain
-
useUniqueDomain: null | boolean
-
Indique si les cadres SafeFrame doivent 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.
<ph type="x-smartling-placeholder">
googletagService
Classe de service de base contenant les méthodes communes à tous les services.
Récapitulatif sur la méthode | |
---|---|
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é.
|
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:
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. } });
JavaScript (ancien)
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", function (event) { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { if (event.slot === targetSlot) { // Slot specific logic. } });
TypeScript
// 1. Adding an event listener for the PubAdsService. googletag.pubads().addEventListener("slotOnload", (event) => { console.log("Slot has been loaded:"); console.log(event); }); // 2. Adding an event listener with slot specific logic. // Listeners operate at service level, which means that you cannot add // a listener for an event for a specific slot only. You can, however, // programmatically filter a listener to respond only to a certain ad // slot, using this pattern: const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { if (event.slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
-
Paramètres eventType: K
Chaîne représentant le type d'événement généré par GPT. Les types d'événements sont sensibles à la casse.listener: (arg: EventTypeMap[K]) => void
Fonction qui accepte un seul argument d'objet d'événement. -
Renvoie Service
Objet de service sur lequel la méthode a été appelée.
getSlots
removeEventListener
-
removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (event: EventTypeMap[K]) => void): void
-
Supprime un écouteur précédemment enregistré.
-
- Exemple
-
JavaScript
googletag.cmd.push(() => { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
JavaScript (ancien)
googletag.cmd.push(function () { // Define a new ad slot. googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. var onViewableListener = function (event) { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(function () { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
TypeScript
googletag.cmd.push(() => { // Define a new ad slot. googletag .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")! .addService(googletag.pubads()); // Define a new function that removes itself via removeEventListener // after the impressionViewable event fires. const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => { googletag.pubads().removeEventListener("impressionViewable", onViewableListener); setTimeout(() => { googletag.pubads().refresh([event.slot]); }, 30000); }; // Add onViewableListener as a listener for impressionViewable events. googletag.pubads().addEventListener("impressionViewable", onViewableListener); googletag.enableServices(); });
-
Paramètres eventType: K
Chaîne représentant le type d'événement généré par GPT. Les types d'événements sont sensibles à la casse.listener: (event: EventTypeMap[K]) => void
Fonction qui accepte un seul argument d'objet d'événement.
googletagSizeMappingBuilder
Compilateur pour les objets de spécification de mappage de taille. Cet outil de création est fourni pour vous aider à créer facilement des spécifications de taille.
Récapitulatif sur la méthode | |
---|---|
addSize
|
Ajoute la mise en correspondance d'un tableau de taille unique (représentant la fenêtre d'affichage) à un tableau de tailles simples ou multiples représentant l'emplacement.
|
build
|
Crée une spécification de carte de taille à partir des mappages ajoutés à ce compilateur.
|
- Voir aussi
addSize
-
addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
-
Ajoute la mise en correspondance d'un tableau de taille unique (représentant la fenêtre d'affichage) à un tableau de tailles simples ou multiples représentant l'emplacement.
-
- Exemple
-
JavaScript
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 640x480 .build(); // Mapping 2 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], []) .addSize([640, 480], [120, 60]) .addSize([0, 0], []) .build(); // Mapping 2 will not show any ads for the following viewport sizes: // [1024, 768] > size >= [980, 690] and // [640, 480] > size >= [0, 0]
JavaScript (ancien)
// Mapping 1 googletag .sizeMapping() .addSize([1024, 768], [970, 250]) .addSize([980, 690], [728, 90]) .addSize([640, 480], "fluid") .addSize([0, 0], [88, 31]) // All viewports < 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(): null | SizeMappingArray
-
Crée une spécification de mappage de taille à partir des mappages ajoutés à ce compilateur.
Si des mappages non valides ont été fournis, cette méthode renvoienull
. Sinon, elle renvoie une spécification au format correct à transmettre àSlot.defineSizeMapping
.
Remarque: Le comportement du compilateur après avoir appelé cette méthode n'est pas défini. -
-
Renvoie null | SizeMappingArray
Résultat généré par ce compilateur. Peut être "null" si des mappages de tailles non valides ont été fournis.
googletagSlot
"Espace" est un objet représentant un espace publicitaire unique sur une page.
Récapitulatif sur la méthode | |
---|---|
addService
|
Ajoute un
Service à cet emplacement.
|
clearCategoryExclusions
|
Efface tous les libellés d'exclusion de catégories d'annonces au niveau de l'espace publicitaire pour cet espace.
|
clearTargeting
|
Efface certains paramètres de ciblage au niveau de l'espace publicitaire, ou tous les paramètres personnalisés pour cet espace.
|
defineSizeMapping
|
Définit un tableau de mappages allant d'une taille minimale de fenêtre d'affichage à la taille d'emplacement pour cet emplacement.
|
get
|
Renvoie la valeur de l'attribut AdSense associé à la clé donnée pour cet espace.
|
getAdUnitPath
|
Affiche le chemin complet du bloc d'annonces, avec le code de réseau et le chemin du bloc d'annonces.
|
getAttributeKeys
|
Renvoie la liste des clés d'attribut définies sur cet emplacement.
|
getCategoryExclusions
|
Affiche les libellés d'exclusion de catégories d'annonces pour cet espace publicitaire.
|
getResponseInformation
|
Affiche les informations de réponse d'annonce.
|
getSlotElementId
|
Renvoie l'ID de l'espace publicitaire
div fourni lors de sa définition.
|
getTargeting
|
Affiche un paramètre de ciblage personnalisé spécifique défini pour cet espace publicitaire.
|
getTargetingKeys
|
Affiche la liste de toutes les clés de ciblage personnalisé définies pour cet espace publicitaire.
|
set
|
Définit une valeur pour un attribut AdSense de cet espace publicitaire.
|
setCategoryExclusion
|
Définit un libellé d'exclusion de catégorie d'annonces au niveau de l'espace publicitaire.
|
setClickUrl
|
Définit l'URL de suivi des clics vers laquelle les utilisateurs sont redirigés après avoir cliqué sur l'annonce.
|
setCollapseEmptyDiv
|
Détermine si l'espace
div doit être masqué lorsqu'il n'y a aucune annonce.
|
setConfig
|
Définit les options de configuration générales de cet emplacement.
|
setForceSafeFrame
|
Configure si l'affichage des annonces de cet espace doit être forcé à l'aide d'un conteneur SafeFrame.
|
setSafeFrameConfig
|
Définit les préférences au niveau de l'emplacement pour la configuration des cadres SafeFrame.
|
setTargeting
|
Définit un paramètre de ciblage personnalisé pour cet espace publicitaire.
|
updateTargetingFromMap
|
Définit des paramètres de ciblage personnalisés pour cet espace publicitaire, à partir d'un mappage clé-valeur dans un objet JSON.
|
addService
-
Ajoute un
Service
à cet emplacement. -
- Exemple
-
JavaScript
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
JavaScript (ancien)
googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());
TypeScript
googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
- Voir aussi
-
Paramètres service: Service
Service à ajouter. -
Renvoie Slot
Objet d'emplacement sur lequel la méthode a été appelée.
clearCategoryExclusions
-
clearCategoryExclusions(): Slot
-
Efface tous les libellés d'exclusion de catégories d'annonces au niveau de l'espace pour cet espace.
-
- Exemple
-
JavaScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
JavaScript (ancien)
// Set category exclusion to exclude ads with 'AirlineAd' labels. var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
TypeScript
// Set category exclusion to exclude ads with 'AirlineAd' labels. const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads()); // Make an ad request. No ad with 'AirlineAd' label will be returned // for the slot. // Clear category exclusions so all ads can be returned. slot.clearCategoryExclusions(); // Make an ad request. Any ad can be returned for the slot.
-
Renvoie Slot
Objet d'emplacement sur lequel la méthode a été appelée.
clearTargeting
-
clearTargeting(key?: string): Slot
-
Efface certains paramètres de ciblage au niveau de l'espace publicitaire, ou tous les paramètres personnalisés pour cet espace.
-
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .setTargeting("color", "red") .addService(googletag.pubads()); slot.clearTargeting("color"); // Targeting 'allow_expandable' and 'interests' are still present, // while 'color' was cleared. slot.clearTargeting(); // All targeting has been cleared.
- Voir aussi
-
Paramètres key?: string
Clé du paramètre de ciblage. Cette clé est facultative. S'il n'est pas spécifié, tous les paramètres de ciblage seront supprimés. -
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 allant d'une taille minimale de fenêtre d'affichage à la 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);
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); var mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); const mapping = googletag .sizeMapping() .addSize([100, 100], [88, 31]) .addSize( [320, 400], [ [320, 50], [300, 50], ] ) .build(); slot.defineSizeMapping(mapping!);
- Voir aussi
-
Paramètres sizeMapping: SizeMappingArray
Tableau de mappages de tailles. Vous pouvez utiliserSizeMappingBuilder
pour la créer. Chaque mappage de taille est un tableau de deux éléments:SingleSizeArray
etGeneralSize
. -
Renvoie Slot
Objet d'emplacement sur lequel la méthode a été appelée.
get
-
get(key: string): null | string
-
Renvoie la valeur de l'attribut AdSense associé à la clé donnée pour cet espace. Pour afficher les attributs de niveau de service hérités par cet emplacement, utilisez
PubAdsService.get
. -
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads()); slot.get("adsense_background_color"); // Returns '#FFFFFF'.
- Voir aussi
-
Paramètres key: string
Nom de l'attribut à rechercher. -
Renvoie null | string
Valeur actuelle de la clé d'attribut ounull
si la clé n'est pas présente.
getAdUnitPath
-
getAdUnitPath(): string
-
Affiche le chemin complet du bloc d'annonces, avec le code de réseau et le chemin du bloc d'annonces.
-
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getAdUnitPath(); // Returns '/1234567/sports'.
-
Renvoie string
Chemin du bloc d'annonces.
getAttributeKeys
-
getAttributeKeys(): string[]
-
Renvoie la liste des clés d'attribut définies sur cet emplacement. Pour afficher les clés des attributs de niveau de service dont a hérité cet emplacement, utilisez
PubAdsService.getAttributeKeys
. -
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .set("adsense_border_color", "#AABBCC") .addService(googletag.pubads()); slot.getAttributeKeys(); // Returns ['adsense_background_color', 'adsense_border_color'].
-
Renvoie string[]
Tableau de clés d'attribut. L'ordre n'est pas défini.
getCategoryExclusions
-
getCategoryExclusions(): string[]
-
Affiche les libellés d'exclusion de catégories d'annonces pour cet espace publicitaire.
-
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .setCategoryExclusion("TrainAd") .addService(googletag.pubads()); slot.getCategoryExclusions(); // Returns ['AirlineAd', 'TrainAd'].
-
Renvoie string[]
Libellés d'exclusion de catégorie d'annonces pour cet espace publicitaire ou tableau vide si aucun n'a été défini.
getResponseInformation
-
getResponseInformation(): null | ResponseInformation
-
Affiche les informations de réponse d'annonce. Cette valeur est basée sur la dernière réponse d'annonce pour l'espace publicitaire. Si cette méthode est appelée alors que l'espace ne contient pas d'annonce,
null
est renvoyé. -
-
Renvoie null | ResponseInformation
Dernières informations de réponse d'annonce, ounull
si l'espace ne contient aucune annonce.
getSlotElementId
-
getSlotElementId(): string
-
Renvoie l'ID de l'espace publicitaire
div
fourni lors de sa définition. -
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); slot.getSlotElementId(); // Returns 'div'.
-
Renvoie string
ID de l'emplacementdiv
.
getTargeting
-
getTargeting(key: string): string[]
-
Affiche un paramètre de ciblage personnalisé spécifique défini pour cet espace publicitaire. Les paramètres de ciblage au niveau du service ne sont pas inclus.
-
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .addService(googletag.pubads()); slot.getTargeting("allow_expandable"); // Returns ['true']. slot.getTargeting("age"); // Returns [] (empty array).
-
Paramètres key: string
Clé de ciblage à rechercher. -
Renvoie string[]
Valeurs associées à cette clé, ou tableau vide en l'absence de clé de ce type.
getTargetingKeys
-
getTargetingKeys(): string[]
-
Affiche la liste de toutes les clés de ciblage personnalisé définies pour cet espace publicitaire. Les clés de ciblage au niveau du service ne sont pas incluses.
-
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setTargeting("allow_expandable", "true") .setTargeting("interests", ["sports", "music"]) .addService(googletag.pubads()); slot.getTargetingKeys(); // Returns ['interests', 'allow_expandable'].
-
Renvoie string[]
Tableau de clés de ciblage. L'ordre n'est pas défini.
set
-
set(key: string, value: string): Slot
-
Définit une valeur pour un attribut AdSense de cet espace publicitaire. Les valeurs définies au niveau du service pour cette clé seront ignorées.
Si vous appelez cette méthode plusieurs fois pour la même clé, les valeurs précédemment définies pour cette clé seront ignorées. Toutes les valeurs doivent être définies avant d'appelerdisplay
ourefresh
. -
- Exemple
-
JavaScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
JavaScript (ancien)
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div") .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
TypeScript
// Setting an attribute on a single ad slot. googletag .defineSlot("/1234567/sports", [160, 600], "div")! .set("adsense_background_color", "#FFFFFF") .addService(googletag.pubads());
- Voir aussi
-
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.
-
- Exemple
-
JavaScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
JavaScript (ancien)
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div") .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
TypeScript
// Label = AirlineAd googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setCategoryExclusion("AirlineAd") .addService(googletag.pubads());
- Voir aussi
-
Paramètres categoryExclusion: string
Libellé d'exclusion de catégorie d'annonces à 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 sont redirigés après avoir cliqué sur l'annonce.
Les serveurs Google Ad Manager continuent d'enregistrer 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 ultérieurs écrasent la valeur. Cela ne fonctionne que pour les demandes non associées à l'architecture de demande simple. -
- Exemple
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
JavaScript (ancien)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setClickUrl("http://www.example.com?original_click_url=") .addService(googletag.pubads());
-
Paramètres value: string
URL de 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
-
Détermine si l'espace
div
doit être masqué lorsqu'il n'y a aucune annonce. Cette option remplace les paramètres au niveau du service. -
- Exemple
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
JavaScript (ancien)
googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2") .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setCollapseEmptyDiv(true, true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // when the page is loaded, before ads are requested. googletag .defineSlot("/1234567/sports", [160, 600], "div-2")! .setCollapseEmptyDiv(true) .addService(googletag.pubads()); // The above will cause the div for this slot to be collapsed // only after GPT detects that no ads are available for the slot.
- Voir aussi
-
Paramètres collapse: boolean
Indique si l'espace publicitaire doit être réduit si aucune annonce n'est renvoyée.collapseBeforeAdFetch?: boolean
Indique s'il faut réduire l'espace avant même qu'une annonce ne soit récupérée. Ignoré si la réduction n'est pastrue
. -
Renvoie Slot
Objet d'emplacement sur lequel la méthode a été appelée.
setConfig
-
setConfig(slotConfig: SlotSettingsConfig): void
-
Définit les options de configuration générales de cet emplacement.
-
-
Paramètres slotConfig: SlotSettingsConfig
Objet de configuration
setForceSafeFrame
-
setForceSafeFrame(forceSafeFrame: boolean): Slot
-
Détermine si les annonces de cet espace doivent être affichées d'office à l'aide d'un conteneur SafeFrame.
Gardez à l'esprit les points suivants lorsque vous utilisez cette API:- Ce paramètre ne s'appliquera qu'aux prochaines demandes d'annonces effectuées pour les espaces publicitaires respectifs.
- Le paramètre au niveau de l'espace publicitaire, s'il est spécifié, prévaut toujours sur 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 est toujours affichée à l'aide d'un conteneur SafeFrame, quel que soit le choix effectué dans l'interface utilisateur de Google Ad Manager. - Toutefois, si elle est définie sur
false
ou si elle n'est pas spécifiée, l'annonce sera affichée à l'aide d'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 prudence, car elle peut avoir un impact sur le comportement des créations qui tentent de dépasser de leurs iFrames ou qui sont affichées directement sur la page d'un éditeur.
-
- Exemple
-
JavaScript
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
JavaScript (ancien)
googletag .defineSlot("/1234567/sports", [160, 600], "div") .setForceSafeFrame(true) .addService(googletag.pubads());
TypeScript
googletag .defineSlot("/1234567/sports", [160, 600], "div")! .setForceSafeFrame(true) .addService(googletag.pubads());
- Voir aussi
-
Paramètres forceSafeFrame: boolean
true
pour forcer l'affichage de toutes les annonces de cet espace publicitaire dans des cadres SafeFrame etfalse
pour désactiver un paramètre au niveau de la page (le cas échéant). Si vous définissez cette règle surfalse
lorsqu'elle n'est pas spécifiée au niveau de la page, cela ne change rien. -
Renvoie Slot
Objet d'emplacement sur lequel la méthode a été appelée.
setSafeFrameConfig
-
setSafeFrameConfig(config: null | SafeFrameConfig): Slot
-
Définit les préférences au niveau de l'emplacement pour la configuration des cadres SafeFrame. Toutes les clés non reconnues dans l'objet de configuration seront ignorées. L'ensemble de la configuration sera ignoré si une valeur non valide est transmise pour une clé reconnue.
Si ces préférences définies au niveau de l'emplacement sont spécifiées, elles remplacent les préférences définies au niveau de la page. -
- Exemple
-
JavaScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
JavaScript (ancien)
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1") .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
TypeScript
googletag.pubads().setForceSafeFrame(true); // The following slot will have a sandboxed safeframe that only // disallows top-level navigation. googletag .defineSlot("/1234567/sports", [160, 600], "div-1")! .setSafeFrameConfig({ sandbox: true }) .addService(googletag.pubads()); // The following slot will inherit page-level settings. googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads()); googletag.display("div-1"); googletag.display("div-2");
- Voir aussi
-
Paramètres config: null | 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 publicitaire. Si vous appelez cette méthode plusieurs fois pour la même clé, les anciennes valeurs seront remplacées. Les valeurs définies ici remplaceront les paramètres de ciblage définis au niveau du service. Ces clés sont définies dans votre compte Google Ad Manager.
-
- Exemple
-
JavaScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
JavaScript (ancien)
var slot = googletag .defineSlot("/1234567/sports", [160, 600], "div") .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
TypeScript
const slot = googletag .defineSlot("/1234567/sports", [160, 600], "div")! .addService(googletag.pubads()); // Example with a single value for a key. slot.setTargeting("allow_expandable", "true"); // Example with multiple values for a key inside in an array. slot.setTargeting("interests", ["sports", "music"]);
- Voir aussi
-
Paramètres key: string
Clé du paramètre de ciblage.value: string | string[]
Valeur du paramètre de ciblage ou tableau de valeurs. -
Renvoie Slot
Objet d'emplacement sur lequel la méthode a été appelée.
updateTargetingFromMap
-
updateTargetingFromMap(map: { [adUnitPath: string]: string | string[] }): Slot
-
Définit des paramètres de ciblage personnalisés pour cet espace publicitaire, à partir d'un mappage clé-valeur dans un objet JSON. Cela revient à appeler
Slot.setTargeting
pour toutes les clés-valeurs de l'objet. Ces clés sont définies dans votre compte Google Ad Manager.
Remarques:- En cas d'écrasement, seule la dernière valeur est conservée.
- Si la valeur est un tableau, toute valeur précédente sera écrasée, et non fusionnée.
- Les valeurs définies ici remplaceront les paramètres de ciblage définis au niveau du service.
-
- Exemple
-
JavaScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
JavaScript (ancien)
var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div"); slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
TypeScript
const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!; slot.updateTargetingFromMap({ color: "red", interests: ["sports", "music", "movies"], });
-
Paramètres map: { [adUnitPath: string]: string | string[] }
Mappage clé:valeur du paramètre de ciblage. -
Renvoie Slot
Objet d'emplacement sur lequel la méthode a été appelée.
.
googletag, configAdExpansionConfig
Paramètres permettant de contrôler l'expansion des annonces.
Récapitulatif de la propriété | |
---|---|
enabled
|
Indique si l'expansion des annonces est activée ou désactivée.
|
- Exemple
-
JavaScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
JavaScript (ancien)
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
TypeScript
// Enable ad slot expansion across the entire page. googletag.setConfig({ adExpansion: { enabled: true }, });
enabled
-
enabled: boolean
-
Indique si l'expansion des annonces est activée ou désactivée.
Cette valeur remplace la valeur par défaut configurée dans Google Ad Manager.
.
googletag, configComponentAuctionConfig
Objet représentant une enchère à un seul composant dans une enchère publicitaire sur l'appareil.
Récapitulatif de la propriété | |
---|---|
auctionConfig
|
Objet de configuration de la mise aux enchères pour cette enchère de composant.
|
configKey
|
Clé de configuration associée à cette enchère de composant.
|
auctionConfig
-
auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: { [buyer: string]: number }, perBuyerGroupLimits: { [buyer: string]: number }, perBuyerSignals: { [buyer: string]: unknown }, perBuyerTimeouts: { [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }
-
Objet de configuration de la mise aux enchères pour cette enchère du composant.
Si cette valeur est définie surnull
, toute configuration existante pour l'enchèreconfigKey
spécifiée sera supprimée. -
- Exemple
-
JavaScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
JavaScript (ancien)
var componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]); // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
TypeScript
const componentAuctionConfig = { // Seller URL should be https and the same as decisionLogicUrl's origin seller: "https://testSeller.com", decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js", interestGroupBuyers: ["https://example-buyer.com"], auctionSignals: { auction_signals: "auction_signals" }, sellerSignals: { seller_signals: "seller_signals" }, perBuyerSignals: { // listed on interestGroupBuyers "https://example-buyer.com": { per_buyer_signals: "per_buyer_signals", }, }, }; const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!; // To add configKey to the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: componentAuctionConfig, }, ], }); // To remove configKey from the component auction: auctionSlot.setConfig({ componentAuction: [ { configKey: "https://testSeller.com", auctionConfig: null, }, ], });
- Voir aussi
configKey
-
configKey: string
-
Clé de configuration associée à cette enchère du composant.
Cette valeur ne doit pas être vide et doit être unique. Si deux objetsComponentAuctionConfig
partagent la même valeur configKey, le dernier à définir écrase les configurations précédentes. -
.
googletag, configInterstitialConfig
Objet définissant le comportement d'un espace publicitaire interstitiel unique.
Récapitulatif de la propriété | |
---|---|
triggers
|
Configuration du déclencheur interstitiel pour cette annonce interstitielle.
|
triggers
-
triggers: Partial<Record<InterstitialTrigger, boolean>>
-
Configuration du déclencheur interstitiel pour cette annonce interstitielle.
Si vous définissez la valeur d'un déclencheur interstitiel surtrue
, il sera activé, mais pas surfalse
. Elles remplaceront 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, }, }, });
JavaScript (ancien)
// Define a GPT managed web interstitial ad slot. var interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL ); // Enable optional interstitial triggers. // Change this value to false to disable. var enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
TypeScript
// Define a GPT managed web interstitial ad slot. const interstitialSlot = googletag.defineOutOfPageSlot( "/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL )!; // Enable optional interstitial triggers. // Change this value to false to disable. const enableTriggers = true; interstitialSlot.setConfig({ interstitial: { triggers: { navBar: enableTriggers, unhideWindow: enableTriggers, }, }, });
- Voir aussi
.
googletag, configPageSettingsConfig
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
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
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, });
Récapitulatif de la propriété | |
---|---|
adExpansion
|
Paramètres permettant de contrôler l'expansion des annonces.
|
adYield
|
Paramètre permettant de contrôler si GPT doit générer le thread JS lors de l'affichage des créations.
|
pps
|
Paramètres permettant de contrôler les signaux fournis par l'éditeur (PPS).
|
privacyTreatments
|
Paramètres permettant de contrôler les traitements de confidentialité des éditeurs.
|
adExpansion
-
adExpansion: null | AdExpansionConfig
-
Paramètres permettant de contrôler l'expansion des annonces.
-
adYield
-
adYield: null | "DISABLED" | "ENABLED_ALL_SLOTS"
-
Paramètre permettant de contrôler si GPT doit afficher le thread JS lors de l'affichage des créations.
GPT ne donnera un résultat que pour les navigateurs compatibles avec l'API Scheduler.postTask.
Valeurs acceptées:null
(par défaut): GPT renvoie le thread JS pour les espaces publicitaires situés en dehors de la fenêtre d'affichage.ENABLED_ALL_SLOTS
: GPT génère le thread JS pour tous les espaces publicitaires, qu'ils se trouvent ou non dans la fenêtre d'affichage.DISABLED
: GPT ne génère pas le fil de discussion JS.
-
- Exemple
-
JavaScript
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
JavaScript (ancien)
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
TypeScript
// Disable yielding. googletag.setConfig({ adYield: "DISABLED" }); // Enable yielding for all slots. googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); // Enable yielding only for slots outside of the viewport (default). googletag.setConfig({ adYield: null });
- Voir aussi
pps
-
pps: null | PublisherProvidedSignalsConfig
-
Paramètres permettant de contrôler les signaux fournis par l'éditeur (PPS).
-
privacyTreatments
-
privacyTreatments: null | PrivacyTreatmentsConfig
-
Paramètres permettant de contrôler les traitements de confidentialité des éditeurs.
-
.
googletag, configPrivacyTreatmentsConfig
Paramètres permettant de contrôler les traitements de confidentialité des éditeurs.
Récapitulatif de la propriété | |
---|---|
treatments
|
Tableau des traitements de confidentialité à activer pour les éditeurs.
|
treatments
-
treatments: "disablePersonalization"[]
-
Tableau des traitements de confidentialité à activer pour les éditeurs.
-
- Exemple
-
JavaScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
JavaScript (ancien)
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
TypeScript
// Disable personalization across the entire page. googletag.setConfig({ privacyTreatments: { treatments: ["disablePersonalization"] }, });
.
googletag, configPublisherProvidedSignalsConfig
Objet de configuration des signaux fournis par l'éditeur (PPS).
Récapitulatif de la propriété | |
---|---|
taxonomies
|
Un objet contenant des mappages de Taxonomy.
|
- Exemple
-
JavaScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
JavaScript (ancien)
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
TypeScript
googletag.setConfig({ pps: { taxonomies: { IAB_AUDIENCE_1_1: { values: ["6", "626"] }, // '6' = 'Demographic | Age Range | 18-20' // '626' = 'Interest | Sports | Darts' IAB_CONTENT_2_2: { values: ["48", "127"] }, // '48' = 'Books and Literature | Fiction' // '127' = 'Careers | Job Search' }, }, });
- Voir aussi
taxonomies
-
taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
-
Un objet contenant des mappages de Taxonomy.
-
.
googletag, configSlotSettingsConfig
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 même 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, });
Récapitulatif de la propriété | |
---|---|
adExpansion
|
Paramètres permettant de contrôler l'expansion des annonces.
|
componentAuction
|
Tableau d'enchères de composants à inclure dans les enchères publicitaires sur l'appareil.
|
interstitial
|
Paramètres permettant de contrôler le comportement de l'espace publicitaire pour les interstitiels.
|
adExpansion
-
adExpansion: AdExpansionConfig
-
Paramètres permettant de contrôler l'expansion des annonces.
-
componentAuction
-
componentAuction: ComponentAuctionConfig[]
-
Tableau d'enchères de composants à inclure dans les enchères publicitaires sur l'appareil.
-
interstitial
-
interstitial: InterstitialConfig
-
Paramètres permettant de contrôler le comportement de l'espace publicitaire pour les interstitiels.
-
.
googletag, configTaxonomyData
Objet contenant les valeurs d'une seule taxonomie.
Récapitulatif de la propriété | |
---|---|
values
|
Liste de valeurs de taxonomie.
|
values
-
values: string[]
-
Liste de valeurs de taxonomie.
-
.
googletag, eventsEvent
de base pour tous les événements GPT Tous les événements GPT ci-dessous comportent les champs suivants.
Récapitulatif de la propriété | |
---|---|
serviceName
|
Nom du service qui a déclenché l'événement.
|
slot
|
Emplacement qui a déclenché l'événement.
|
- Voir aussi
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, eventsEventTypeMap
Il s'agit d'un pseudo-type qui mappe un nom d'événement au type d'objet d'événement correspondant pour Service.addEventListener
et Service.removeEventListener
. Elle n'est documentée qu'à des fins de référence et de sûreté du typage.
Récapitulatif de la propriété | |
---|---|
impressionViewable
|
Alias de
events.ImpressionViewableEvent .
|
rewardedSlotClosed
|
Alias de
events.RewardedSlotClosedEvent .
|
rewardedSlotGranted
|
Alias de
events.RewardedSlotGrantedEvent .
|
rewardedSlotReady
|
Alias de
events.RewardedSlotReadyEvent .
|
slotOnload
|
Alias de
events.SlotOnloadEvent .
|
slotRenderEnded
|
Alias de
events.SlotRenderEndedEvent .
|
slotRequested
|
Alias de
events.SlotRequestedEvent .
|
slotResponseReceived
|
Alias de
events.SlotResponseReceived .
|
slotVisibilityChanged
|
Alias de
events.SlotVisibilityChangedEvent .
|
impressionViewable
-
impressionViewable: ImpressionViewableEvent
-
Alias de
events.ImpressionViewableEvent
. -
rewardedSlotClosed
-
rewardedSlotClosed: RewardedSlotClosedEvent
-
Alias de
events.RewardedSlotClosedEvent
. -
rewardedSlotGranted
-
rewardedSlotGranted: RewardedSlotGrantedEvent
-
Alias de
events.RewardedSlotGrantedEvent
. -
rewardedSlotReady
-
rewardedSlotReady: RewardedSlotReadyEvent
-
Alias de
events.RewardedSlotReadyEvent
. -
slotOnload
-
slotOnload: SlotOnloadEvent
-
Alias de
events.SlotOnloadEvent
. -
slotRenderEnded
-
slotRenderEnded: SlotRenderEndedEvent
-
Alias de
events.SlotRenderEndedEvent
. -
slotRequested
-
slotRequested: SlotRequestedEvent
-
Alias de
events.SlotRequestedEvent
. -
slotResponseReceived
-
slotResponseReceived: SlotResponseReceived
-
Alias de
events.SlotResponseReceived
. -
slotVisibilityChanged
-
slotVisibilityChanged: SlotVisibilityChangedEvent
-
Alias de
events.SlotVisibilityChangedEvent
. -
.
googletag, eventsImpressionViewableEvent
Extensions
Cet événement est déclenché lorsqu'une impression devient visible, selon les critères Active View.
Récapitulatif de la propriété | |
---|---|
serviceName
|
Nom du service qui a déclenché l'événement.
Hérité de
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
- Exemple
-
JavaScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called when an impression becomes viewable. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", function (event) { var slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an impression becomes viewable. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("impressionViewable", (event) => { const slot = event.slot; console.log("Impression for slot", slot.getSlotElementId(), "became viewable."); if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
.
googletag, eventsRewardedSlotClosedEvent
Extensions
Cet événement est déclenché lorsqu'un espace publicitaire avec récompense est fermé par l'utilisateur. Elle peut se déclencher avant ou après l'octroi d'une récompense. Pour déterminer si une récompense a été accordée, utilisez plutôt events.RewardedSlotGrantedEvent
.
Récapitulatif de la propriété | |
---|---|
serviceName
|
Nom du service qui a déclenché l'événement.
Hérité de
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
- Exemple
-
JavaScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called when the user closes a rewarded ad slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the user closes a rewarded ad slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotClosed", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed."); if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
.
googletag, eventsRewardedSlotGrantedEvent
Extensions
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 de la récompense ne soient remplis, cet événement ne se déclenche pas.
Récapitulatif de la propriété | |
---|---|
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
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
- Exemple
-
JavaScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called whenever a reward is granted for a // rewarded ad. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", function (event) { var _a, _b; var slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type); console.log( "Reward amount:", (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount ); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever a reward is granted for a // rewarded ad. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotGranted", (event) => { const slot = event.slot; console.group("Reward granted for slot", slot.getSlotElementId(), "."); // Log details of the reward. console.log("Reward type:", event.payload?.type); console.log("Reward amount:", event.payload?.amount); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
payload
-
payload: null | RewardedPayload
-
Objet contenant des informations sur la récompense accordée.
-
.
googletag, eventsRewardedSlotReadyEvent
Extensions
Cet événement se déclenche lorsqu'une annonce avec récompense est prête à être diffusée. L'éditeur doit proposer à l'utilisateur la possibilité de voir l'annonce avant de la diffuser.
Récapitulatif de la propriété | |
---|---|
serviceName
|
Nom du service qui a déclenché l'événement.
Hérité de
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
Récapitulatif sur la méthode | |
---|---|
makeRewardedVisible
|
Affiche l'annonce avec récompense.
|
- Exemple
-
JavaScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called when a rewarded ad slot becomes ready to be // displayed. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", function (event) { var slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. var userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a rewarded ad slot becomes ready to be // displayed. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("rewardedSlotReady", (event) => { const slot = event.slot; console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed."); // Replace with custom logic. const userHasConsented = true; if (userHasConsented) { event.makeRewardedVisible(); } if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
makeRewardedVisible
-
makeRewardedVisible(): void
-
Affiche l'annonce avec récompense. Cette méthode ne doit pas être appelée tant que l'utilisateur n'a pas autorisé le visionnage de l'annonce.
-
.
googletag, eventsSlotOnloadEvent
Extensions
Cet événement est déclenché lorsque l'iFrame de la création déclenche son événement de chargement. Lors de l'affichage des annonces rich media en mode d'affichage synchronisé, aucun iFrame n'est utilisé. Par conséquent, aucun SlotOnloadEvent
ne sera déclenché.
Récapitulatif de la propriété | |
---|---|
serviceName
|
Nom du service qui a déclenché l'événement.
Hérité de
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
- Exemple
-
JavaScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called when a creative iframe load event fires. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", function (event) { var slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a creative iframe load event fires. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotOnload", (event) => { const slot = event.slot; console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded."); if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
.
googletag, eventsSlotRenderEndedEvent
Extensions
Cet événement est déclenché lorsque le code de la création est injecté dans un emplacement. Cet événement se produira avant l'extraction des ressources de la création. Il est donc possible que la création ne soit pas encore visible. Si vous souhaitez savoir quand toutes les ressources de création d'un emplacement ont été chargées, utilisez plutôt events.SlotOnloadEvent
.
Récapitulatif de la propriété | |
---|---|
advertiserId
|
Référence annonceur de l'annonce affichée.
|
campaignId
|
ID de la campagne de l'annonce affichée.
|
companyIds
|
Identifiants des entreprises qui enchérissent sur l'annonce de remplissage affichée.
|
creativeId
|
ID de la création de l'annonce de réservation affichée.
|
creativeTemplateId
|
ID du modèle de création de l'annonce par réservation affichée.
|
isBackfill
|
Indique si une annonce est une annonce de remplissage.
|
isEmpty
|
Indique si une annonce a été renvoyée pour l'espace publicitaire.
|
labelIds
|
ID des libellés de l'annonce affichée.
|
lineItemId
|
ID de l'élément de campagne de l'annonce de réservation affichée.
|
serviceName
|
Nom du service qui a déclenché l'événement.
Hérité de
|
size
|
Indique la taille en pixels de la création affichée.
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
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 remplissage affichée.
|
- Exemple
-
JavaScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called when a slot has finished rendering. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", function (event) { var slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when a slot has finished rendering. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRenderEnded", (event) => { const slot = event.slot; console.group("Slot", slot.getSlotElementId(), "finished rendering."); // Log details of the rendered ad. console.log("Advertiser ID:", event.advertiserId); console.log("Campaign ID:", event.campaignId); console.log("Company IDs:", event.companyIds); console.log("Creative ID:", event.creativeId); console.log("Creative Template ID:", event.creativeTemplateId); console.log("Is backfill?:", event.isBackfill); console.log("Is empty?:", event.isEmpty); console.log("Label IDs:", event.labelIds); console.log("Line Item ID:", event.lineItemId); console.log("Size:", event.size); console.log("Slot content changed?", event.slotContentChanged); console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId); console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId); console.log("Yield Group IDs:", event.yieldGroupIds); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
advertiserId
-
advertiserId: null | number
-
Référence annonceur de l'annonce affichée. La valeur est de
null
pour les emplacements vides, les annonces de remplissage et les créations affichées par des services autres quePubAdsService
. -
campaignId
-
campaignId: null | number
-
ID de la campagne de l'annonce affichée. La valeur est de
null
pour les emplacements vides, les annonces de remplissage et les créations affichées par des services autres quePubAdsService
. -
companyIds
-
companyIds: null | number[]
-
Identifiants des entreprises qui enchérissent sur l'annonce de remplissage affichée. La valeur est
null
pour les emplacements vides, les annonces de réservation et les créations affichées par des services autres quePubAdsService
. -
creativeId
-
creativeId: null | number
-
ID de la création de l'annonce de réservation affichée. La valeur est de
null
pour les emplacements vides, les annonces de remplissage et les créations affichées par des services autres quePubAdsService
. -
creativeTemplateId
-
creativeTemplateId: null | number
-
ID du modèle de création de l'annonce de réservation affichée. La valeur est de
null
pour les emplacements vides, les annonces de remplissage et les créations affichées par des services autres quePubAdsService
. -
isBackfill
-
isBackfill: boolean
-
Indique si une annonce est une annonce de remplissage. La valeur est
true
si l'annonce est une annonce de remplissage, etfalse
dans le cas contraire. -
isEmpty
-
isEmpty: boolean
-
Indique si une annonce a été renvoyée pour l'espace publicitaire. La valeur est
true
si aucune annonce n'a été renvoyée, etfalse
dans le cas contraire. -
labelIds
-
labelIds: null | number[]
-
ID des libellés de l'annonce affichée. La valeur est de
null
pour les emplacements vides, les annonces de remplissage et les créations affichées par des services autres quePubAdsService
. -
lineItemId
-
lineItemId: null | number
-
ID de l'élément de campagne de l'annonce de réservation affichée. La valeur est de
null
pour les emplacements vides, les annonces de remplissage et les créations affichées par des services autres quePubAdsService
. -
size
-
size: null | string | number[]
-
Indique la taille en pixels de la création affichée. Exemple :
[728, 90]
La valeur estnull
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é, etfalse
dans le cas contraire. -
sourceAgnosticCreativeId
-
sourceAgnosticCreativeId: null | number
-
ID de la création de l'annonce de réservation ou de remplissage affichée. La valeur est
null
si l'annonce ne correspond pas à une réservation ni à une annonce de remplissage d'élément de campagne, ou si la création est affichée par des services autres quePubAdsService
. -
sourceAgnosticLineItemId
-
sourceAgnosticLineItemId: null | 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 ne correspond pas à une réservation ni à une annonce de remplissage d'élément de campagne, ou si la création est affichée par des services autres quePubAdsService
. -
yieldGroupIds
-
yieldGroupIds: null | number[]
-
ID des groupes de rendement pour l'annonce de remplissage affichée. La valeur est
null
pour les emplacements vides, les annonces de réservation et les créations affichées par des services autres quePubAdsService
. -
.
googletag, eventsSlotRequestedEvent
Extensions
Cet événement est déclenché lorsqu'une annonce a été demandée pour un espace publicitaire spécifique.
Récapitulatif de la propriété | |
---|---|
serviceName
|
Nom du service qui a déclenché l'événement.
Hérité de
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
- Exemple
-
JavaScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", function (event) { var slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when the specified service issues an ad // request for a slot. Each slot will fire this event, even though they // may be batched together in a single request if single request // architecture (SRA) is enabled. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotRequested", (event) => { const slot = event.slot; console.log("Slot", slot.getSlotElementId(), "has been requested."); if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
.
googletag, eventsSlotResponseReceived
Extensions
Cet événement est déclenché lorsqu'une réponse d'annonce est reçue pour un espace publicitaire spécifique.
Récapitulatif de la propriété | |
---|---|
serviceName
|
Nom du service qui a déclenché l'événement.
Hérité de
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
- Exemple
-
JavaScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called when an ad response has been received // for a slot. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", function (event) { var slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called when an ad response has been received // for a slot. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotResponseReceived", (event) => { const slot = event.slot; console.log("Ad response for slot", slot.getSlotElementId(), "received."); if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
.
googletag, eventsSlotVisibilityChangedEvent
Extensions
Cet événement est déclenché dès que le pourcentage affiché à l'écran de la zone d'un espace publicitaire change. L'événement est limité et ne se déclenchera pas plus d'une fois toutes les 200 ms.
Récapitulatif de la propriété | |
---|---|
inViewPercentage
|
Pourcentage visible de la zone de l'annonce.
|
serviceName
|
Nom du service qui a déclenché l'événement.
Hérité de
|
slot
|
Emplacement qui a déclenché l'événement.
Hérité de
|
- Exemple
-
JavaScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
JavaScript (ancien)
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", function (event) { var slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", "".concat(event.inViewPercentage, "%")); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
TypeScript
// This listener is called whenever the on-screen percentage of an // ad slot's area changes. const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]); googletag.pubads().addEventListener("slotVisibilityChanged", (event) => { const slot = event.slot; console.group("Visibility of slot", slot.getSlotElementId(), "changed."); // Log details of the event. console.log("Visible area:", `${event.inViewPercentage}%`); console.groupEnd(); if (slot === targetSlot) { // Slot specific logic. } });
- Voir aussi
inViewPercentage
-
inViewPercentage: number
-
Pourcentage visible de la zone de l'annonce. La valeur doit être un nombre compris entre 0 et 100.
-
.
googletag, secureSignalsBidderSignalProvider
Affiche un signal sécurisé pour un enchérisseur spécifique.
Un fournisseur de signaux sécurisés d'enchérisseur se compose de deux parties:
- Une fonction de collecteur, qui renvoie un
Promise
qui renvoie un signal sécurisé - Un
id
qui identifie l'enchérisseur associé au signal.
secureSignals.PublisherSignalProvider
.
Récapitulatif de la propriété | |
---|---|
collectorFunction
|
.
|
id
|
Identifiant unique du collecteur associé à ce signal sécurisé, tel qu'il est enregistré dans Google Ad Manager.
|
- Exemple
-
JavaScript
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (ancien)
// id is provided googletag.secureSignalProviders.push({ id: "collector123", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// id is provided googletag.secureSignalProviders!.push({ id: "collector123", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Voir aussi
collectorFunction
-
collectorFunction: () => Promise<string>
-
id
-
id: string
-
Identifiant unique du collecteur associé à ce signal sécurisé, tel qu'il est enregistré dans Google Ad Manager.
-
.
googletag, secureSignalsPublisherSignalProvider
Renvoie un signal sécurisé pour un éditeur spécifique.
Un fournisseur de signaux d'éditeur se compose de deux parties:
- Une fonction de collecteur, qui renvoie un
Promise
qui renvoie un signal sécurisé networkCode
qui identifie l'éditeur associé au signal.
secureSignals.BidderSignalProvider
.
Récapitulatif de la propriété | |
---|---|
collectorFunction
|
.
|
networkCode
|
Code de réseau (tel qu'il apparaît dans le chemin du bloc d'annonces) de l'éditeur associé à ce signal sécurisé.
|
- Exemple
-
JavaScript
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
JavaScript (ancien)
// networkCode is provided googletag.secureSignalProviders.push({ networkCode: "123456", collectorFunction: function () { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
TypeScript
// networkCode is provided googletag.secureSignalProviders!.push({ networkCode: "123456", collectorFunction: () => { // ...custom signal generation logic... return Promise.resolve("signal"); }, });
- Voir aussi
collectorFunction
-
collectorFunction: () => Promise<string>
-
networkCode
-
networkCode: string
-
Code de réseau (tel qu'il apparaît dans le chemin du bloc d'annonces) de l'éditeur associé à ce signal sécurisé.
-
.
googletag, secureSignalsSecureSignalProvidersArray
Interface permettant de gérer les signaux sécurisés.
Récapitulatif sur la méthode | |
---|---|
clearAllCache
|
Efface tous les signaux de tous les collecteurs du cache.
|
push
|
Ajoute un nouveau
secureSignals.SecureSignalProvider au tableau des fournisseurs de signaux et lance le processus de génération du signal.
|
clearAllCache
-
clearAllCache(): void
-
Efface du cache tous les signaux pour tous les collecteurs.
L'appel de cette méthode peut réduire la probabilité que des signaux soient inclus dans les demandes d'annonces pour les pages vues actuelles et potentiellement ultérieures. De ce fait, elle ne doit être appelée que lorsque des changements d'état significatifs se produisent, tels que des événements indiquant un nouvel utilisateur (connexion, déconnexion, inscription, etc.). -
push
-
push(provider: SecureSignalProvider): void
-
Ajoute un nouveau
secureSignals.SecureSignalProvider
au tableau des fournisseurs de signaux et lance le processus de génération du signal. -
-
Paramètres provider: SecureSignalProvider
ObjetsecureSignals.SecureSignalProvider
à ajouter au tableau.