Google Tag API-Referenz

Die Google Tag (gtag.js) API besteht aus der Funktion gtag(), wobei folgende Syntax:

gtag(<command>, <command parameters>);

• <command> ist einer der folgenden Befehle: <ph type="x-smartling-placeholder">
  </ph>
  • config
  • get
  • set
  • event
  • consent
• <command parameters> sind die Parameter, die Sie an gtag() übergeben können. Befehl variieren je nach Befehl. in der Befehlsreferenz, unten.

Sie können gtag()-Befehle überall auf Ihrer Seite aufrufen, werden unterhalb des Google-Tag-Snippets angezeigt. Informationen zum Hinzufügen des Snippets zu einem finden Sie in der Installationsanleitung.

Parameterbereich

Sie können Parameterwerte für einzelne Ereignisse festlegen, alle Ereignisse, die an einen spezifisch für <TARGET_ID> oder global für alle Ereignisse Dies wird durch die Verwendung von die Befehle event, config und set.

Parameterwerte, die in einem Bereich festgelegt sind, ändern die für denselben Bereich festgelegten Werte nicht in einem anderen Umfang. Im folgenden Beispiel führt der Befehl config den globalen Wert für campaign_id, der zuvor mit der set zugewiesen wurde, nicht ändern. . Nachdem beide Befehle ausgeführt wurden, ist der globale Wert von campaign_id immer noch '1234'.

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

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

Rangfolge der Parameter

Wenn demselben Parameter in unterschiedlichen Bereichen unterschiedliche Werte zugewiesen sind, wird ein einzelner Wert bei der Verarbeitung von Ereignissen verwendet. Parameterwerte für event hat Vorrang vor Parametern der Kategorie config und config -Parameter haben Vorrang vor Parametern mit globalem Geltungsbereich mit 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

Damit können Sie Zielen zusätzliche Konfigurationsinformationen hinzufügen. Dies ist normalerweise eine produktspezifische Konfiguration für ein Produkt, aber Sie müssen nur müssen Sie ihn einmal konfigurieren, wenn Sie sowohl Google Ads als auch Google Analytics verwenden.

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

<TARGET_ID> ist eine Kennung, mit der das Ziel für Treffer eindeutig identifiziert wird. etwa eine Google Analytics-Property oder ein Google Ads-Konto. <additional_config_info> steht für ein oder mehrere Parameter/Wert-Paare.

In diesem Beispiel wird ein Tag so konfiguriert, dass Daten an ein Google Ads-Konto gesendet werden:

gtag('config', 'TAG_ID');

Dabei ist „TAG_ID“. ist die Tag-ID für das Google-Tag.

Hier ist ein Beispiel, das zeigt, wie zusätzliche Konfigurationsinformationen gesendet werden mit dem ein Tag so konfiguriert wird, dass Daten an ein Analytics-Konto mit einem Parameter send_page_view, der den Wert false und einen groups-Wert übergibt -Parameter, der den Wert 'agency' übergibt.

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

get

Damit können Sie verschiedene Werte aus gtag.js abrufen, einschließlich der Werte, die mit den set-Befehl.

gtag('get', '<target>', '<field_name>', callback)

Argument	Typ	Beispiel	Beschreibung
<target>	string	G-XXXXXXXXXX	Das Ziel, von dem Werte abgerufen werden sollen.
<field_name>	FieldName	client_id	Der Name des abzurufenden Felds.
callback	Function	(field) => console.log(field)	eine Funktion, die mit dem angeforderten Feld aufgerufen wird, oder undefined, wenn es nicht festgelegt ist.

FieldName

Feldname kann der Name eines benutzerdefinierten Felds sein, das Sie mit der gtag('set') festlegen oder einem der folgenden Werte:

Feldname	Unterstützte Ziele
client_id	Google Analytics 4 Google Analytics und Universal Analytics
session_id	Google Analytics 4
gclid	Google Ads Floodlight

Hinweis :Wenn Sie den Befehl set mit diesen Feldnamen verwenden, wird der von Ihnen festgelegte Wert hat Vorrang.

Beispiele

Wert in einem Versprechen abbilden

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

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

Ereignis an das Measurement Protocol senden

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

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

Festgelegten Wert abrufen

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

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

set

Mit dem Befehl „set“ können Sie Parameter definieren, Folgeereignis auf der Seite.

Hinweis :Wir empfehlen, nach Möglichkeit die Befehle config oder event zu verwenden.

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

Sie können beispielsweise campaign freigeben. -Parameter, damit mehrere Tags auf derselben Seite darauf zugreifen können.

Im Beispiel unten sehen Sie, wie ein Kampagnenname und eine Kampagnen-ID für einen Black Friday festgelegt werden. Shopping-Veranstaltung. Da Sie set verwendet haben, werden alle anderen Tags, z. B. Mit GA4-Ereignis-Tags oder Google Ads-Remarketing-Tags kann auf diese Daten zugegriffen werden.

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

event

Verwenden Sie den Befehl event, um Ereignisdaten zu senden.

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

<event_name> ist entweder:

• Ein empfohlenes Ereignis. Jedes empfohlene Ereignis kann empfohlene Parameter.
• Ein benutzerdefiniertes Ereignis. Ein benutzerdefiniertes Ereignis ist ein beliebiger Ereignisname, mit beliebigen (d.h. benutzerdefinierten) Parametern. Siehe zum Beispiel Wie benutzerdefinierte Ereignisse in Google Analytics verwendet werden

<event_params> steht für ein oder mehrere Parameter/Wert-Paare. Jedes Paar wird durch einen Komma.

Der folgende event-Befehl löst das empfohlene Ereignis screen_view mit zwei Parameter: app_name und screen_name.

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

Wichtig :Das Google-Tag-Snippet muss oben auf derselben Seite event-Befehle verwenden, da sonst Ihre Daten nicht gesendet werden.

consent

Verwenden Sie den Befehl consent, um die Einwilligung zu konfigurieren.

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

Weitere Informationen Parameter konfiguriert werden.

<consent_arg> ist entweder 'default' oder 'update'. Mit 'default' wird Folgendes festgelegt: Standard-Einwilligungsparameter, die verwendet werden sollten, und 'update' wird verwendet, um diese Parameter aktualisieren, sobald ein Nutzer seine Einwilligung erteilt hat.

Folgende <consent_params> werden unterstützt:

Feldname	Zulässige Werte	Beschreibung
ad_storage	'granted' | 'denied'	Ermöglicht das Speichern von werbebezogenen Cookies wie Cookies (Web) oder Geräte-IDs (Apps)
ad_user_data	'granted' | 'denied'	Legt die Einwilligung für das Senden von Nutzerdaten zu Werbezwecken an Google fest.
ad_personalization	'granted' | 'denied'	Legt die Einwilligung für personalisierte Anzeigen fest
analytics_storage	'granted' | 'denied'	Ermöglicht das Speichern von Cookies (Web) oder App-IDs (Apps) für Analysen, z.B. Besuchsdauer.
wait_for_update	Beliebige positive Ganzzahl	Legt in Millisekunden fest, wie lange auf den Aufruf der Einwilligungsaktualisierung gewartet werden soll.