Référence

Paramètres

Description des paramètres au niveau de la page

Ces paramètres ne doivent être spécifiés qu'une seule fois par page. Ils s'appliquent à tous les blocs de la page.

Obligatoire

Paramètres Description et exemples
adPage Obligatoire lorsque l'utilisateur accède à la page de résultats suivante ou précédente.

Le paramètre adPage spécifie la page de résultats sur laquelle les annonces sont diffusées. Ce paramètre est utilisé lorsque les utilisateurs naviguent au-delà de la première page des résultats de recherche. Par exemple, si cinq annonces sont demandées et que le paramètre adPage est défini sur 2, les annonces renvoyées seront la deuxième page de cinq annonces.

pubId Obligatoire
Il s'agit de votre ID client AdSense. Votre pubId est la partie de votre ID client qui suit "partner-". Par exemple, si votre ID client est "partner-test-property", votre pubId est "test-property". Il s'agit du protocole standard pour les annonces pour les recherches personnalisées.

Exemple :

'pubId' : 'test-property'

query Obligatoire
Requête de recherche saisie par l'utilisateur. La valeur du paramètre de requête ne doit pas être encodée.

Exemples :

'query' : 'flowers'
'query' : 'black & decker'
'query' : myQuery // myQuery is a variable containing the search query

resultsPageBaseUrl Obligatoire lorsque la page contient des blocs de recherche associée.
Spécifie l'URL de la page de résultats de recherche sur laquelle la requête de recherche correspond au terme de recherche associée sur lequel l'utilisateur a cliqué. resultsPageBaseUrl peut inclure ses propres paramètres, à l'exception de la requête de recherche qui sera ajoutée automatiquement.

Exemple :

'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2'

styleId Obligatoire
Spécifie l'ID du style de recherche personnalisée à appliquer à l'annonce ou aux blocs de recherche associée sur la page. En savoir plus sur l'utilisation de styles de recherche personnalisés Notez que si le styleId est défini pour une requête, le style s'affiche pour les annonces et les recherches associées, et les anciens paramètres de style sont ignorés. Si le styleId n'est pas spécifié dans la requête, un style système par défaut sera affiché.

Exemple :

'styleId': '1234567890'

Facultatif

Paramètres Description et exemples
linkTarget Facultatif
Indique si un clic sur une annonce s'ouvre dans la même fenêtre ou dans une nouvelle. La valeur par défaut est "_top". Ce paramètre peut également être utilisé au niveau du bloc d'annonces.
  • '_top' S'ouvre dans la même fenêtre.
  • '_blank' S'ouvre dans une nouvelle fenêtre.

Exemple :

'linkTarget' : '_blank'

maxTermLength Facultatif
Spécifie le nombre maximal de caractères d'un terme de recherche associée, y compris les espaces. Aucun maximum si ce nombre n'est pas défini.

Exemple :

'maxTermLength' : 50

referrerAdCreative Facultatif
Si un utilisateur accède à votre page de contenu qui contient un bloc de recherche associée en cliquant sur une annonce ou un lien sur un autre site Web, et que vous contrôlez cette annonce ou ce lien, ce paramètre doit être défini sur le texte de la création de cette annonce ou de ce lien tel quel.

Les consignes suivantes s'appliquent à l'utilisation de ce paramètre:

  • Ce paramètre ne doit être fourni que dans une requête de recherche associée pour les pages de contenu. Il sera ignoré pour toutes les autres requêtes.
  • Il ne doit être utilisé que pour le trafic que vous générez intentionnellement à partir d'autres sites Web. Il ne doit jamais être utilisé pour le trafic généré par les résultats naturels.
  • Il peut inclure la ligne de titre et/ou la description de l'annonce ou de la création associée.
  • Ce champ n'est pas sensible à la casse.
  • Il accepte un encodage UTF-8 valide. Les caractères Unicode et les caractères diacritiques sont acceptés.
  • Google peut utiliser ou ignorer le paramètre que vous envoyez. Son utilisation peut avoir une incidence sur la sélection et le classement des termes.

Exemples :

'referrerAdCreative': 'search for ads related to dental implants'

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'

resultsPageQueryParam Facultatif
Spécifie le nom du paramètre d'URL pour la requête de recherche sur la page de résultats de recherche. S'il n'est pas spécifié, la valeur par défaut est "q".

Exemple :

'resultsPageQueryParam' : 'query'

terms Facultatif
Ce paramètre vous permet de fournir une liste de vos propres termes de recherche associée séparés par une virgule à renvoyer avec une requête de recherche associée. Toutefois, Google peut ou non utiliser les termes fournis ici.

Exemples :

'terms' : 'cars rental, flight ticket'

Paramètres de configuration

Paramètres Description et exemples
adsafe Facultatif
Spécifie les règles de filtrage que Google doit appliquer aux annonces correspondant à la requête de recherche. Voici les paramètres valides pour AdSafe et l'impact de chaque valeur sur les annonces renvoyées :
  • 'high' entraîne la diffusion d'annonces tous publics. Ce paramètre ne permet pas la diffusion d'annonces à caractère sexuel ou non adaptées à tous publics.
  • 'medium' Renvoie des annonces tous publics et non adaptées à tous publics. Ce paramètre ne permet pas la diffusion d'annonces à caractère sexuel.
  • 'low' Renvoie tous les types d'annonces.

Par défaut, adsafe est défini sur "élevé".

Exemple :

'adsafe': 'medium'

adtest Facultatif
Le paramètre adtest permet d'indiquer qu'une demande d'annonces est un test. Lorsque le paramètre adtest est associé à la valeur on, Google traite la demande comme un test, ne comptabilise pas les impressions d'annonces et ne suit pas les résultats des clics.

Lorsque le paramètre adtest est défini sur on, vous ne générez aucun revenu.

Utilisez ce paramètre pour effectuer des tests, mais pas dans les systèmes de production. Sinon, vous ne serez pas rémunéré pour les annonces diffusées.

La valeur par défaut du paramètre adtest est "off".

Exemple :

'adtest' : 'on'

channel Facultatif
Vous pouvez inclure un critère AdSense pour les recherches afin d'effectuer le suivi des performances de différentes pages. Utilisez l'ID de chaîne unique créé dans votre compte AdSense ou par votre responsable de compte technique. Pour en savoir plus sur les chaînes, cliquez ici.

S'il y a plusieurs critères, vous devez les séparer par le symbole "+".

Exemples :

'channel' :  'testA'  
'channel' :  'testA+testB'  

hl Facultatif
Ce paramètre identifie la langue que les annonces demandées ou les recherches associées doivent cibler. La valeur par défaut est en.

Tous les codes de langue de l'API AdWords sont acceptés.

Remarque : Les annonceurs indiquent les langues ciblées par leurs annonces. Si vous incluez ce paramètre dans votre demande, Google diffuse uniquement les annonces ciblées sur cette langue ou sur toutes les langues. Cela ne signifie pas pour autant que le texte d'annonce apparaîtra dans la langue spécifiée.

Il est recommandé de définir le paramètre hl sur la langue principale de la page à partir de laquelle il est envoyé.

Exemples :

'hl' : 'es'

ie Facultatif

Le paramètre ie définit le schéma d'encodage des caractères à utiliser pour interpréter la chaîne de requête.

La valeur ie par défaut est utf-8..

Valeur Nom standard Langues acceptées
latin1 ISO-8859-1 Europe occidentale (allemand, anglais, catalan, danois, espagnol, finnois, français, indonésien, italien, néerlandais, norvégien, portugais, suédois)
latin2 ISO-8859-2 Europe de l'Est (croate, hongrois, polonais, roumain, serbe, slovaque, slovène, tchèque)
latin3 ISO-8859-3  
latin4 ISO-8859-4 Pays baltes (estonien, letton, lituanien)
cyrillic ISO-8859-5 Bulgare, russe
arabic ISO-8859-6  
grecque ISO-8859-7 Grec
hebrew ISO-8859-8 Hébreu
latin5 ISO-8859-9  
latin6 ISO-8859-10 Islandais
euc-jp EUC-JP Japonais
euc-kr EUC-KR Coréen
sjis Shift_JIS Japonais
big5 Big5 Chinois traditionnel
gb GB2312 Chinois simplifié
utf-8 UTF-8 Toutes
oe Facultatif

Le paramètre oe définit le schéma d'encodage des caractères que Google doit utiliser pour encoder le texte des annonces. Bien que cela soit techniquement facultatif, il est recommandé de transmettre une valeur à ce paramètre.

La valeur oe par défaut est utf-8..

Valeur Nom standard Langues acceptées
latin1 ISO-8859-1 Europe occidentale (allemand, anglais, catalan, danois, espagnol, finnois, français, indonésien, italien, néerlandais, norvégien, portugais, suédois)
latin2 ISO-8859-2 Europe de l'Est (croate, hongrois, polonais, roumain, serbe, slovaque, slovène, tchèque)
latin3 ISO-8859-3  
latin4 ISO-8859-4 Pays baltes (estonien, letton, lituanien)
cyrillic ISO-8859-5 Bulgare, russe
arabic ISO-8859-6  
grecque ISO-8859-7 Grec
hebrew ISO-8859-8 Hébreu
latin5 ISO-8859-9  
latin6 ISO-8859-10 Islandais
euc-jp EUC-JP Japonais
euc-kr EUC-KR Coréen
sjis Shift_JIS Japonais
gb GB2312 Chinois simplifié
utf-8 UTF-8 Toutes
ivt Bientôt disponible au cours du 1er trimestre 2024
Facultatif
Ce paramètre vous permet de fournir une valeur booléenne qui informe Google que vous souhaitez autoriser les annonces qui utilisent un cookie "trafic incorrect" et un stockage local pour le trafic autorisé et non autorisé.
  • true Lorsque ce paramètre n'est pas présent ou que vous le définissez sur "true", nous définissons un cookie "trafic incorrect uniquement" et utilisons le stockage local pour le trafic autorisé uniquement.
  • false Lorsque vous définissez ce paramètre sur "false", nous définissons un cookie réservé au trafic incorrect et utilisons le stockage local pour le trafic autorisé et non autorisé.

Par défaut, l'IVT est défini sur "true".

Exemple :

'ivt': false

Description des paramètres au niveau du bloc d'annonces

Ces paramètres ont un impact sur la façon dont chaque bloc d'annonces est présenté à l'internaute. Vous pouvez définir chaque paramètre individuellement pour chaque bloc d'annonces.

Obligatoire

Paramètres Description et exemples
container Obligatoire
ID du conteneur d'annonces vide <div> dans lequel l'annonce doit apparaître.

Exemple :

'container' : 'afscontainer1'

maxTop Obligatoire lorsque le bloc d'annonces est au-dessus des résultats de recherche.

Utilisez ce paramètre pour spécifier le nombre d'annonces à diffuser dans le bloc d'annonces supérieur.

Remarque: Ce paramètre remplace le paramètre "number". Ce bloc d'annonces doit être suffisamment large pour que la première ligne des annonces ne passe pas à la ligne suivante. L'utilisation du paramètre maxTop à un autre emplacement de la page constitue un non-respect des règles.

Exemple :

'maxTop' : 4
width Obligatoire
Spécifie la largeur en pixels de l'annonce ou du bloc de recherche associée.

Exemple :

'width' : '700px'
'width' : 700

Paramètres de configuration

Paramètres Description et exemples
adLoadedCallback Facultatif
Spécifie une fonction JavaScript à appeler lorsque les annonces ou les recherches associées ont été chargées, ou lorsqu'aucune annonce ni recherche associée n'est diffusée. Le paramètre doit être défini sur une fonction de rappel JavaScript que vous implémentez et qui permet d'effectuer une action une fois l'appel d'annonce terminé.

La fonction de rappel utilise les paramètres suivants:

containerName Nom du conteneur de l'annonce ou du bloc de recherche associée.
adsLoaded Défini sur "true" lorsqu'il y a au moins une annonce ou un terme de recherche associée à afficher, et sur "false" lorsqu'aucune annonce ni recherche associée n'est renvoyée.
isExperimentVariant Défini sur "true" si un test de style personnalisé est en cours et que la variante du test est choisie pour afficher les annonces.
callbackOptions Objet JSON contenant les champs suivants :
termPositions : pour un bloc de recherche associée, contient une map<string,int> des termes fournis par l'éditeur à une position zéro indexation de ces termes dans la réponse. Si un terme est fourni, mais pas renvoyé, il n'apparaîtra pas dans la carte.

Remarque: Veuillez tester votre fonction de rappel pour vous assurer qu'elle ne génère pas d'erreurs, en particulier celles susceptibles d'interférer avec le chargement de votre page.

Exemple de rappel JavaScript :

var adblock1 = {
  'container' : 'adblock1_div_id',
  'adLoadedCallback' : function(containerName, adsLoaded,
    isExperimentVariant, callbackOptions) {
    if (adsLoaded) {
       try {
         // most likely do nothing
       } catch (e) {
         alert ("Error in callback function");
         // Do something to handle error gracefully
       }
    } else {
       // as you always do when there is no ad coverage from Google
    }
  }
};
      

number Facultatif
Nombre d'annonces à diffuser dans ce bloc. La valeur par défaut est "2".

Exemple :

'number' : 4

relatedSearches Facultatif
Nombre de recherches associées à afficher dans ce bloc. Si aucune valeur n'est spécifiée, la valeur par défaut est 0.

Exemple :

'relatedSearches' : 4