Dokumentacja kolejki poleceń GA

Kolejka poleceń ga() zapewnia interfejs do niemal wszystkich działań związanych z biblioteką analytics.js.

Fragment kodu śledzenia JavaScript definiuje początkową funkcję kolejki poleceń ga(), więc można go używać jeszcze przed pełnym wczytaniem biblioteki analytics.js. Po wczytaniu biblioteki analytics.js elementy w kolejce poleceń są wykonywane w kolejności otrzymania. Nowe polecenia przekazane do kolejki są natychmiast wykonywane.

Aby fragment kodu śledzenia był jak najmniejszy, kolejka poleceń ga() jest przeciążona i może przyjmować argumenty w wielu różnych formatach. W tym dokumencie szczegółowo opisujemy wszystkie sposoby wywoływania funkcji kolejki poleceń ga().

Dodawanie poleceń do kolejki

Wywołanie funkcji kolejki poleceń ga() z poniższym podpisem funkcji spowoduje przekazanie poleceń do kolejki, które zostaną zaplanowane do wykonania po wczytaniu biblioteki.

Wykorzystanie

ga(command, [...fields], [fieldsObject])

Parametry

[trackerName.][pluginName:]methodName

W dokumentacji pól znajdziesz dokumentację poszczególnych pól.

Przykłady

W sekcji Metody poleceń poniżej znajdziesz przykłady poszczególnych poleceń.

Gotowe wywołanie zwrotne

Wywołanie funkcji kolejki poleceń ga() przez jej przekazanie spowoduje zaplanowanie wykonania przekazanej funkcji w następnym punkcie kolejki.

Ponieważ polecenia są wykonywane dopiero po pełnym wczytaniu biblioteki analytics.js, najczęstszą przyczyną przekazywania kolejki poleceń jest wywołanie zwrotne, gdy biblioteka analytics.js została wczytana i gotowa.

Wykorzystanie

ga(readyCallback)

Parametry

Przykłady

// Queues a tracker object for creation.
ga('create', 'UA-XXXXX-Y', 'auto');

// Once the tracker has been created, log the
// client ID to the console.
ga(function(tracker) {
  console.log(tracker.get('clientId'));
});

// Queues a named tracker object for creation.
ga('create', 'UA-XXXXX-Y', 'auto', 'myTracker');

// When there is no default tracker, the first
// argument of the ready callback is `undefined`.
ga(function(tracker) {
  console.log(tracker); // Logs `undefined`.
});

Szczegóły metody polecenia

Poniżej znajdziesz listę wszystkich metod, które można przekazać do kolejki poleceń ga() (oprócz metod wtyczek).

create

Tworzy nową instancję skryptu śledzenia z określonymi polami.

Wykorzystanie

ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);

Parametry

W dokumentacji pól znajdziesz dokumentację poszczególnych pól.

Zwroty

undefined

Przykłady

// Creates a default tracker for the Property UA-XXXXX-Y
// and uses automatic cookie domain configuration.
ga('create', 'UA-XXXXX-Y', 'auto');

// Creates a tracker with the name "myTracker" for the Property
// UA-XXXXX-Y, sets the cookieDomain to "example.com", and specifies
// a transport mechanism of "beacon".
ga('create', 'UA-XXXXX-Y', 'example.com', 'myTracker', {
  transport: 'beacon'
});

send

Wysyła działanie do Google Analytics.

Wykorzystanie

ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);

Wysyłane pola to wartości określone w parametrach ...fields i fieldsObject, scalone z polami przechowywanymi obecnie w tagu śledzenia.

Parametry

Pola, które można określić za pomocą parametrów ...fields, różnią się w zależności od typu działania. W tabeli poniżej znajdziesz pola odpowiadające poszczególnym typom działań. Niewymienione typy działań nie akceptują parametrów ...fields, a jedynie fieldsObject.

W dokumentacji pól znajdziesz dokumentację poszczególnych pól.

Zwroty

undefined

Przykłady

// Sends a pageview hit.
ga('send', 'pageview');

// Sends an event hit for the tracker named "myTracker" with the
// following category, action, and label, and sets the nonInteraction
// field value to true.
ga('send', 'event', 'link', 'click', 'http://example.com', {
  nonInteraction: true
});

set

Ustawia jedną parę pole i wartość lub grupę par pole/wartość w obiekcie śledzenia.

Wykorzystanie

// Sets a single field and value.
ga('[trackerName.]set', fieldName, fieldValue);

// Sets a group of field/value pairs.
ga('[trackerName.]set', fieldsObject);

Parametry

W dokumentacji pól znajdziesz dokumentację poszczególnych pól.

Zwroty

undefined

Przykłady

// Sets the page field to "/about.html".
ga('set', 'page', '/about.html');

// Sets the page field to "/about.html" and the title to "About".
ga('set', {
  page: '/about.html',
  title: 'About'
});

require

Wymaga wtyczki analytics.js.

Wykorzystanie

ga('[trackerName.]require', pluginName, [pluginOptions]);

Parametry

Zwroty

undefined

Przykład

// Requires the Enhanced Ecommerce plugin.
ga('require', 'ec');

// Requires the Advertising Features plugin
// named "myTracker" and override its default cookie name.
ga('myTracker.require', 'displayfeatures', {
  cookieName: 'display_features_cookie'
});

provide

Udostępnia wtyczkę analytics.js i jej metody do użycia z kolejką poleceń ga().

ga('provide', pluginName, pluginConstuctor);

Parametry

Przykład

// Defines a plugin constructor
function MyPlugin(tracker, options) {
  // ...
}

// Provides the plugin for use with the ga() command queue.
ga('provide', 'myplugin', MyPlugin);

remove

Usuwa obiekt śledzący.

Wykorzystanie

ga('[trackerName.]remove');

Przykłady

// Remove the default tracker.
ga('remove');

// Remove the  tracker named "myTracker".
ga('myTracker.remove');