Dokumentacja API tagu Google

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

gtag(<command>, <command parameters>);
  • <command> to jedno z tych poleceń:
  • <command parameters> to parametry, które możesz przekazać do gtag(). Parametry polecenia różnią się w zależności od polecenia. Zapoznaj się z dokumentacją poleceń.

Polecenia gtag() możesz wywoływać w dowolnym miejscu na stronie, o ile znajdują 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 zrobić za pomocą poleceń event, config i set.

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

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

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

Priorytet parametrów

Jeśli do tego samego parametru w różnych zakresach są przypisane różne wartości, podczas przetwarzania zdarzeń używana jest tylko jedna wartość. Wartości parametrów o zakresie event będą miały pierwszeństwo przed parametrami o zakresie config, a parametry config będą miały pierwszeństwo przed parametrami o zakresie globalnym, które używają 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 celów dodatkowych informacji o konfiguracji. Zwykle jest to konfiguracja dotycząca 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>});

Najważniejsze informacje o <TARGET_ID>:

  • <TARGET_ID> w poleceniu gtag('config', <TARGET_ID>, ...) to identyfikator tagu, który wskazuje, dokąd gtag.js ma wysyłać dane zdarzenia. Może to być miejsce docelowe, np. usługa w Google Analytics, konto Google Ads, konfiguracja Floodlight lub tag Google, który ma wiele miejsc docelowych.

  • Identyfikator tagu, np. GT-XXXXXX, G-XXXXXX lub AW-YYYYYY, to identyfikator tagu Google. Dodajesz ten identyfikator do kodu witryny, aby wczytywać tag Google.

  • Pojedynczy tag Google (identyfikowany przez identyfikator tagu) można skonfigurować tak, aby wysyłał dane do wielu miejsc docelowych. Chociaż niektóre identyfikatory tagów mogą wyglądać identycznie jak identyfikatory miejsc docelowych, np. G-XXXXXX w przypadku usługi w Google Analytics lub AW-YYYYYY w przypadku konta Google Ads, parametr <TARGET_ID> w poleceniu config odnosi się do konkretnego wystąpienia tagu Google wczytanego na stronie.

  • Polecenie gtag('config', ...) konfiguruje działanie tagu Google powiązanego z określonym <TARGET_ID>. Chociaż identyfikator tagu zawarty w skrypcie src zwykle wczytuje tag Google, w poleceniu gtag('config') możesz użyć dowolnego prawidłowego identyfikatora tagu powiązanego z Twoim kontem.

  • Z jednym tagiem Google może być powiązanych wiele identyfikatorów tagu, często z powodu scalania tagów. Aby wczytać tag Google, możesz użyć w parametrze skryptu src dowolnego z tych powiązanych identyfikatorów.

  • Jeśli wysyłasz dane do wielu miejsc docelowych lub używasz wielu tagów, w skrypcie src musisz umieścić tylko jeden fragment kodu tagu Google z jednym identyfikatorem tagu. Następnie dodaj polecenie gtag('config') dla każdego dodatkowego identyfikatora tagu lub miejsca docelowego.

<additional_config_info> to co najmniej 1 para parametr-wartość.

Ten przykład konfiguruje tag, 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, i 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)
Argument Typ Przykład Opis
<target> string G-XXXXXXXXXX

Wartość docelowa, z której mają być pobierane wartości.
<field_name> FieldName client_id Nazwa pola do pobrania.
callback Function (field) => console.log(field)

Funkcja, która będzie wywoływana z odpowiednim polem lub pozostanie undefined, jeśli nie zostało ono ustawione.

FieldName

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

Nazwa pola Obsługiwane cele
client_id
  • Google Analytics 4
session_id
  • Google Analytics 4
session_number
  • Google Analytics 4
gclid
  • Google Ads
  • Floodlight

Przykłady

Pobieranie 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 definiowanie 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 były dostępne dla wielu tagów na tej samej stronie.

W przykładzie poniżej pokazujemy, jak ustawić nazwę i identyfikator kampanii na potrzeby wydarzenia zakupowego w Czarny Piątek. Ponieważ używasz set, wszystkie inne tagi, np. tagi zdarzeń GA4 lub tagi remarketingu w 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 zdarzeń, używaj polecenia event.

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

<event_name> to:

<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'
});

Aby skonfigurować zgodę, użyj polecenia consent.

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

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

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

Obsługiwane są te <consent_params>:

Nazwa pola Dozwolone wartości Opis
ad_storage 'granted' | 'denied' Umożliwia przechowywanie danych, np. plików cookie (w internecie) lub identyfikatorów urządzeń (w aplikacjach), związanych z reklamami.
ad_user_data 'granted' | 'denied' Określa stan zgody na wysyłanie danych użytkownika do Google w celach reklamowych.
ad_personalization 'granted' | 'denied' Określa stan zgody na reklamy spersonalizowane.
analytics_storage 'granted' | 'denied' Umożliwia przechowywanie danych, np.plików cookie (witryna) lub identyfikatorów aplikacji (aplikacje), dotyczących statystyk, np. czasu trwania wizyty.
wait_for_update dowolna dodatnia liczba całkowita, Ustawia czas oczekiwania na wywołanie funkcji aktualizacji uzyskiwania zgody (w milisekundach).