Dokumentacja API tagu Google

Interfejs API tagu Google (gtag.js) składa się z jednej funkcji gtag() o tej składni:

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

• <command> to jedno z tych poleceń:
  • config
  • get
  • set
  • event
  • consent
• <command parameters> to parametry, które możesz przekazać do gtag(). Parametry polecenia różnią się w zależności od polecenia. Więcej informacji znajdziesz w sekcji dotyczącej poleceń poniżej.

Polecenia gtag() możesz wywoływać w dowolnym miejscu na stronie, o ile pojawiają się one poniżej fragmentu kodu tagu Google. Aby dowiedzieć się, jak dodać fragment kodu do strony, zapoznaj się z przewodnikiem instalacji.

Zakres parametru

Wartości parametrów możesz ograniczyć do poszczególnych zdarzeń, wszystkich zdarzeń wysyłanych do określonego <TARGET_ID> lub globalnie do wszystkich zdarzeń. Można to osiągnąć za pomocą poleceń event, config i set.

Wartości parametrów ustawione w jednym zakresie nie modyfikują wartości ustawionych dla tego samego parametru w innym zakresie. W przykładzie poniżej polecenie config nie modyfikuje globalnej wartości campaign_id przypisanej wcześniej za pomocą polecenia set. Po wykonaniu obu poleceń globalna wartość campaign_id pozostanie '1234'.

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

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

Priorytet parametru

Jeśli w różnych zakresach do tego samego parametru są przypisane różne wartości, podczas przetwarzania zdarzeń używana jest tylko jedna wartość. Wartości parametrów w zakresie event mają pierwszeństwo przed parametrami w zakresie config, a parametry config mają pierwszeństwo przed parametrami w zakresie globalnym, czyli 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

Umożliwia dodawanie do miejsc docelowych dodatkowych informacji o konfiguracji. Jest to zwykle konfiguracja konkretnej usługi, ale jeśli używasz zarówno Google Ads, jak i Google Analytics, musisz ją skonfigurować tylko raz.

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

<TARGET_ID> to identyfikator, który jednoznacznie identyfikuje miejsce docelowe danych, np. usługę w Google Analytics lub konto Google Ads. <additional_config_info> to co najmniej 1 para parametr-wartość.

Ten przykład konfiguruje tag tak, aby wysyłał dane na konto Google Ads:

gtag('config', 'TAG_ID');

gdzie „TAG_ID” to identyfikator tagu tagu Google.

Aby pokazać, jak wysyłać dodatkowe informacje o konfiguracji, podajemy przykład, w którym tag jest skonfigurowany tak, aby wysyłać dane na konto Analytics z parametrem send_page_view, który przekazuje wartość false, oraz parametrem groups, który przekazuje wartość 'agency'.

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

get

Umożliwia pobieranie z gtag.js różnych wartości, m.in. ustawianych za pomocą polecenia set.

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

FieldName

Nazwa pola może być nazwą pola niestandardowego ustawionego za pomocą polecenia gtag('set') lub jedną z tych wartości:

Przykłady

Przekazywanie wartości do obiektu Promise

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

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

Wysyłanie zdarzenia do Measurement Protocol

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

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

Uzyskiwanie ustawionej wartości

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

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

set

Polecenie set umożliwia zdefiniowanie parametrów, które będą powiązane z każdym kolejnym zdarzeniem na stronie.

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

Możesz na przykład udostępniać parametry kampanii, aby wiele tagów na tej samej stronie miało do nich dostęp.

Poniższy przykład pokazuje ustawianie nazwy i identyfikatora kampanii na potrzeby wydarzenia zakupowego z okazji Black Friday. Ponieważ używasz set, wszystkie inne tagi, np. tagi zdarzeń GA4 lub tagi remarketingowe Google Ads, mogą uzyskiwać dostęp do tych danych.

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

event

Aby wysyłać dane o zdarzeniach, używaj polecenia event.

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

<event_name> może być:

• Zalecane zdarzenie. Każde zalecane zdarzenie może przyjmować zalecane parametry.
• zdarzenie niestandardowe. Zdarzenie niestandardowe to dowolna nazwa zdarzenia, którą wymyślisz, oraz dowolne parametry. Więcej informacji znajdziesz w artykule Konfigurowanie zdarzeń.

<event_params> to co najmniej 1 para parametr-wartość. Każda para jest oddzielona przecinkiem.

To polecenie event wywołuje zalecane zdarzenie screen_view z 2 parametrami: app_name i screen_name.

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

consent

Aby skonfigurować wyrażanie zgody, użyj polecenia consent.

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

Więcej informacji o zachowaniu, które konfigurują te parametry, znajdziesz w sekcji Zgoda użytkownika w Centrum pomocy.

<consent_arg> to 'default' lub 'update'. 'default' służy do ustawiania domyślnych parametrów zgody, które mają być używane, a 'update' służy do aktualizowania tych parametrów, gdy użytkownik wskaże swoją zgodę.

Obsługiwane są te <consent_params>: