Google Tag API-Referenz

Die Google-Tag-API (gtag.js) besteht aus einer einzigen Funktion, gtag(), mit der folgenden Syntax:

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

• <command> ist einer der folgenden Befehle:
  • config
  • get
  • set
  • event
  • consent
• <command parameters> sind die Parameter, die Sie an gtag() übergeben können. Die Befehlsparameter variieren je nach Befehl. Weitere Informationen finden Sie in der Befehlsreferenz unten.

Sie können gtag()-Befehle überall auf Ihrer Seite aufrufen, sofern sie unter dem Google-Tag-Snippet stehen. Weitere Informationen zum Hinzufügen des Snippets auf einer Seite

Parameterbereich

Sie können Parameterwerte auf einzelne Ereignisse, alle Ereignisse, die an eine bestimmte <TARGET_ID> gesendet werden, oder global auf alle Ereignisse eingrenzen. Dies wird durch die Verwendung der Befehle event, config und set erreicht.

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

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

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

Parameterpriorität

Wenn demselben Parameter in verschiedenen Bereichen unterschiedliche Werte zugewiesen werden, wird bei der Verarbeitung von Ereignissen nur ein Wert verwendet. Parameterwerte, die auf event beschränkt sind, haben Vorrang vor Parametern, die auf config beschränkt sind. config-Parameter haben Vorrang vor Parametern, die global mit set beschränkt sind.

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

Ermöglicht es Ihnen, Zielen zusätzliche Konfigurationsinformationen hinzuzufügen. Das ist in der Regel eine produktspezifische Konfiguration für ein Produkt. Wenn Sie jedoch sowohl Google Ads als auch Google Analytics verwenden, müssen Sie sie nur einmal konfigurieren.

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

<TARGET_ID> ist eine Kennung, mit der das Ziel für Zugriffe eindeutig identifiziert wird, z. B. eine Google Analytics-Property oder ein Google Ads-Konto. <additional_config_info> ist 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“ die Tag-ID für das Google-Tag.

Im folgenden Beispiel wird gezeigt, wie zusätzliche Konfigurationsinformationen gesendet werden. Ein Tag wird so konfiguriert, dass Daten an ein Analytics-Konto gesendet werden. Dabei wird ein send_page_view-Parameter mit dem Wert false und ein groups-Parameter mit dem Wert 'agency' übergeben.

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

get

Hiermit können Sie verschiedene Werte aus gtag.js abrufen – einschließlich Werten, die mit dem Befehl set festgelegt wurden.

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

FieldName

Der Feldname kann der Name eines benutzerdefinierten Felds sein, das Sie mit dem Befehl gtag('set') festgelegt haben, oder einer der folgenden Werte:

Beispiele

Wert in ein Promise einfügen

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

Einen von Ihnen 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, die mit jedem nachfolgenden Ereignis auf der Seite verknüpft werden.

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

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

Im Beispiel unten wird gezeigt, wie ein Kampagnenname und eine Kampagnen-ID für ein Shopping-Event am Black Friday festgelegt werden. Da Sie set verwendet haben, können alle anderen Tags, z. B. GA4-Ereignis-Tags oder Google Ads-Remarketing-Tags, auf diese Daten zugreifen.

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. Für jedes empfohlene Ereignis können empfohlene Parameter verwendet werden.
• Ein benutzerdefiniertes Ereignis. Ein benutzerdefiniertes Ereignis ist ein beliebiger Ereignisname, den Sie sich ausdenken, mit beliebigen Parametern. Weitere Informationen finden Sie unter Ereignisse einrichten.

<event_params> ist ein oder mehrere Parameter/Wert-Paare. Jedes Paar wird durch ein Komma getrennt.

Mit dem folgenden event-Befehl wird das empfohlene Ereignis screen_view mit zwei Parametern ausgelöst: app_name und screen_name.

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

consent

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

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

Weitere Informationen zum Verhalten, das mit diesen Parametern konfiguriert wird, finden Sie in der Hilfe unter Einwilligung.

<consent_arg> ist entweder 'default' oder 'update'. Mit 'default' werden die Standardparameter für die Einwilligung festgelegt, die verwendet werden sollen. Mit 'update' werden diese Parameter aktualisiert, sobald ein Nutzer seine Einwilligung erteilt.

Die folgenden <consent_params> werden unterstützt: