Odniesienie do kolejki poleceń GA

Kolejka poleceń ga() zapewnia interfejs prawie do wszystkiego, co musisz zrobić z biblioteką analytics.js.

Fragment kodu śledzenia JavaScript definiuje początkową funkcję kolejki poleceń ga(), więc można z niej skorzystać jeszcze przed wczytaniem biblioteki analytics.js. Gdy tylko biblioteka analytics.js zostanie wczytana, elementy w kolejce poleceń są wykonywane w kolejności ich otrzymania. Gdy to zrobisz, nowe polecenia przekazywane do kolejki będą wykonywane natychmiast.

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().

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

Wywołanie funkcji kolejki polecenia ga() z poniższym podpisem funkcji spowoduje przekazanie do niej poleceń w celu zaplanowania wykonania po wczytaniu biblioteki.

ga(readyCallback)

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

Polecenia są wykonywane dopiero po pełnym wczytaniu biblioteki analytics.js, dlatego najczęstszą przyczyną przekazywania kolejki poleceń jest wywołanie zwrotne dotyczące wczytania i przygotowania biblioteki analytics.js.

Dodawanie poleceń do kolejki

Wywołanie funkcji kolejki polecenia ga() z poniższym podpisem funkcji spowoduje przekazanie do niej poleceń w celu zaplanowania wykonania po wczytaniu biblioteki.

Wykorzystanie

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

Parametry

Nazwa Typ Wymagany Opis
command string Tak

Identyfikator polecenia, które trzeba dodać do kolejki. Identyfikator składa się z 3 części (dwie pierwsze są opcjonalne):

[trackerName.][pluginName:]methodName
trackerName Nazwa elementu śledzącego, który wywoła zaplanowane polecenie. Jeśli nie podasz nazwy trackera, polecenie będzie wywoływane na domyślnym trackerze.
pluginName Nazwa wymaganej wtyczki analytics.js. Jeśli określisz pluginName, właściwość methodName musi być metodą podaną przez wtyczkę.
methodName Nazwa metody, która ma zostać wykonana. Jeśli nie określisz nazwy wtyczki, musi to być jedna z metod poleceń wymienionych poniżej.
...fields * nie Jeden lub więcej opcjonalnych parametrów wygodnych do szybkiego określenia typowych pól. Liczba dozwolonych i konkretnych pól zależy od wywoływanej metody polecenia.
fieldsObject Object nie

Obiekt do określania pozostałych wartości, które nie zostały określone w żadnym z parametrów fields.

Jeśli pole jest ustawione zarówno w parametrze fields, jak i fieldsObject, zostanie użyta wartość z pola fieldsObject.

Szczegóły znajdziesz w dokumentacji pól.

Przykłady

Zapoznaj się z poniższą sekcją Metody poleceń.

Gotowe do oddzwonienia

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

Polecenia są wykonywane dopiero po pełnym wczytaniu biblioteki analytics.js, dlatego najczęstszą przyczyną przekazywania kolejki poleceń jest wywołanie zwrotne dotyczące wczytania i przygotowania biblioteki analytics.js.

Wykorzystanie

ga(readyCallback)

Parametry

Nazwa Typ Wymagany Opis
readyCallback Function Tak

Funkcja wywołania zwrotnego, która ma zostać wywołana, gdy biblioteka jest w pełni załadowana i gotowa do interakcji. Funkcja jest wywoływana z domyślnym obiektem śledzenia jako pierwszym argumentem. Jeśli nie utworzono domyślnego trackera, pierwszy argument to undefined.

Uwaga: po wywołaniu funkcji wywołania zwrotnego można używać wszystkich metod obiektów ga.

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 przekazywać do kolejki poleceń ga() (z wyjątkiem metod wtyczek).

create

Tworzy nową instancję trackera z określonymi polami.

Wykorzystanie

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

Parametry

Szczegóły znajdziesz w dokumentacji pól.

Zwraca

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 aktualnie zapisanymi w trackerze.

Parametry

Pola, które można określać za pomocą parametrów ...fields, zależą od typu działania. W tabeli poniżej znajdziesz pola odpowiadające poszczególnym typom działań. Rodzaje działań, które nie są wymienione na liście, nie akceptują parametrów ...fields. Są to tylko fieldsObject.

Typ działania ...fields
pageview page
event eventCategory, eventAction, eventLabel, eventValue
social socialNetwork, socialAction, socialTarget
timing timingCategory, timingVar, timingValue, timingLabel

Szczegóły znajdziesz w dokumentacji pól.

Zwraca

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 parę pól i wartości lub grupę par pola/wartości 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

Szczegóły znajdziesz w dokumentacji pól.

Zwraca

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

Nazwa Typ Wymagany Opis
pluginName string Tak Nazwa wtyczki, która jest wymagana. Uwaga: jeśli wtyczka nie jest oficjalną wtyczka analytics.js, należy ją udostępnić w innym miejscu na stronie.
pluginOptions Object nie Obiekt inicjowania, który zostanie przekazany do konstruktora wtyczek po wystąpieniu instancji.

Zwraca

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

Nazwa Typ Wymagany Opis
pluginName string Tak Nazwa udostępnianej wtyczki. Musi być to ta sama nazwa, która jest używana w przypadku wszystkich wymagań wywołań.
pluginConstuctor Function Tak Funkcja konstruktora udostępnia wszystkie metody i metody powiązane z wtyczkami. Ten konstruktor zostanie wywołany za pomocą obiektu pluginsOptions określonego w metodzie rerell.

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 z trackera.

Wykorzystanie

ga('[trackerName.]remove');

Przykłady

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