Documentation de référence de l'API de la balise Google

L'API de la balise Google (gtag.js) comprend une seule fonction, gtag(), avec la syntaxe suivante:

gtag(<command>, <command parameters>);
  • <command> est l'une des commandes suivantes :
  • <command parameters> sont les paramètres que vous pouvez transmettre à gtag(). Les paramètres de commande varient en fonction de la commande. Reportez-vous à la documentation de référence sur les commandes ci-dessous.

Vous pouvez appeler des commandes gtag() n'importe où sur votre page, à condition qu'elles apparaissent sous l'extrait de code de la balise Google. Pour savoir comment ajouter l'extrait à une page, consultez le guide d'installation.

Champ d'application du paramètre

Vous pouvez limiter les valeurs des paramètres à des événements individuels, à tous les événements envoyés à un <TARGET_ID> spécifique ou à tous les événements de manière globale. Pour ce faire, utilisez les commandes event, config et set.

Les valeurs de paramètre définies dans un champ d'application ne modifient pas celles définies pour le même paramètre dans un champ d'application différent. Dans l'exemple ci-dessous, la commande config ne modifie pas la valeur globale de campaign_id précédemment attribuée à l'aide de la commande set. Une fois les deux commandes exécutées, la valeur globale de campaign_id reste toujours '1234'.

// Set global campaign ID
gtag('set', { 'campaign_id': '1234' });

// Set campaign ID for <TARGET_ID>
gtag('config','<TARGET_ID>', { 'campaign_id': 'ABCD' });

Priorité des paramètres

Si différentes valeurs sont attribuées au même paramètre dans des champs d'application différents, une seule valeur est utilisée lors du traitement des événements. Les valeurs de paramètres dont la portée est définie sur event prévalent sur les paramètres dont la portée est définie sur config. Les paramètres config sont prioritaires sur les paramètres dont le champ d'application est global à l'aide de set.

// Set campaign information at the global scope
gtag('set', { 'campaign_name': 'Black Friday Sale' });

// Set currency for <TARGET_ID1> to 'USD'
gtag('config','<TARGET_ID1>', { 'currency': 'USD' });

// Process a conversion event with currency: 'GBP'
gtag('event','conversion', { 'currency': 'GBP', 'send_to': '<TARGET_ID1>' });

// Process a conversion event with currency: 'EUR'
gtag('event','conversion');

// Process a conversion event with currency: 'USD'
gtag('event','conversion', { 'send_to': '<TARGET_ID1>' });

config

Permet d'ajouter des informations de configuration supplémentaires aux cibles. Il s'agit généralement d'une configuration spécifique à un produit, mais vous ne devez la configurer qu'une seule fois si vous utilisez à la fois Google Ads et Google Analytics.

gtag('config', '<TARGET_ID>', {<additional_config_info>});

<TARGET_ID> est un identifiant qui identifie de manière unique la cible pour les appels, comme une propriété Google Analytics ou un compte Google Ads. <additional_config_info> correspond à une ou plusieurs paires paramètre/valeur.

Dans l'exemple ci-dessous, une balise permet de configurer une balise pour envoyer des données à un compte Google Ads:

gtag('config', 'TAG_ID');

où "TAG_ID" correspond à l'ID de la balise pour la balise Google.

Pour vous montrer comment envoyer des informations de configuration supplémentaires, voici un exemple qui configure une balise pour envoyer des données à un compte Analytics avec un paramètre send_page_view qui transmet la valeur false et un paramètre groups qui transmet la valeur 'agency'.

gtag('config', 'TAG_ID', {
  'send_page_view': false,
  'groups': 'agency'
});

get

Permet d'obtenir différentes valeurs à partir de gtag.js, y compris les valeurs définies à l'aide de la commande set.

gtag('get', '<target>', '<field_name>', callback)
Argument Type Exemple Description
<target> string G-XXXXXXXXXX

Cible à partir de laquelle récupérer les valeurs.

<nom_champ> FieldName client_id Nom du champ à obtenir.
rappel Function (field) => console.log(field)

Fonction qui sera appelée avec le champ demandé, ou undefined si ce champ n'est pas défini.

FieldName

Le nom du champ peut être le nom d'un champ personnalisé que vous définissez à l'aide de la commande gtag('set') ou l'une des valeurs suivantes:

Nom du champ Cibles compatibles
client_id
  • Google Analytics 4
  • Google Analytics Universal Analytics
session_id
  • Google Analytics 4
gclid
  • Google Ads
  • Floodlight

Exemples

Créer une promesse de valeur

const gclidPromise = new Promise(resolve => {
  gtag('get', 'DC-XXXXXXXX', 'gclid', resolve)
});

gclidPromise.then((gclid) => {
  // Do something with gclid...
})

Envoyer un événement au protocole de mesure

gtag('get', 'G-XXXXXXXXXX', 'client_id', (clientID) => {
  sendOfflineEvent(clientID, "tutorial_begin")
});

function sendOfflineEvent(clientID, eventName, eventData) {
  // Send necessary data to your server...
}

Obtenir une valeur que vous avez définie

gtag('set', {campaign_name: 'Spring_Sale'});

gtag('get', 'G-XXXXXXXXXX', 'campaign_name', (campaign_name) => {
  // Do something with currency value you set earlier.
})

set

La commande set vous permet de définir les paramètres qui seront associés à chaque événement ultérieur sur la page.

gtag('set', {<parameter-value-pair>, <parameter-value-pair>});

Par exemple, vous pouvez partager les paramètres de campagne afin que plusieurs tags puissent y accéder sur la même page.

L'exemple ci-dessous montre comment définir un nom et un ID de campagne pour un événement Shopping lors du Black Friday. Comme vous avez utilisé set, toutes les autres balises (par exemple, les tags d'événement GA4 ou les balises de remarketing Google Ads) peuvent accéder à ces données.

gtag('set', 'campaign', {
  'id': 'abc',
  'source': 'google',
  'name': 'black_friday_promotion',
  'term': 'running+shoes',
});

event

Utilisez la commande event pour envoyer des données d'événement.

gtag('event', '<event_name>', {<event_params>});

<event_name> est soit:

<event_params> correspond à une ou plusieurs paires paramètre/valeur. Chaque paire séparée par une virgule.

La commande event suivante déclenche l'événement recommandé screen_view avec deux paramètres: app_name et screen_name.

gtag('event', 'screen_view', {
  'app_name': 'myAppName',
  'screen_name': 'Home'
});

Utilisez la commande consent pour configurer le consentement.

gtag('consent', {<consent_arg>}, {<consent_params>});

Pour en savoir plus sur le comportement configuré par ces paramètres, consultez la section Consentement dans le centre d'aide.

<consent_arg> correspond aux 'default' ou 'update'. 'default' permet de définir les paramètres de consentement par défaut à utiliser, tandis que 'update' permet de mettre à jour ces paramètres une fois qu'un utilisateur indique son consentement.

Les <consent_params> suivants sont compatibles:

Nom du champ Valeurs autorisées Description
ad_storage 'granted' | 'denied' Permet le stockage, comme les cookies (Web) ou les identifiants d'appareils (applications), liés à la publicité.
ad_user_data 'granted' | 'denied' Définit le consentement pour l'envoi de données utilisateur à Google à des fins publicitaires.
ad_personalization 'granted' | 'denied' Définit le consentement pour la publicité personnalisée.
analytics_storage 'granted' | 'denied' Permet le stockage lié à l'analyse, comme les cookies (Web) ou les identifiants d'applications (applications), comme la durée des visites.
wait_for_update tout entier positif Définit le délai d'attente, en millisecondes, avant un appel de mise à jour du consentement.