La coda dei comandi ga()
offre un'interfaccia per la gestione quasi di tutto ciò che devi fare con la libreria analytics.js.
Lo snippet di monitoraggio JavaScript definisce la funzione iniziale di coda di comando ga()
, in modo che possa essere utilizzata anche prima che la libreria analytics.js sia completamente caricata. Non appena la libreria analytics.js viene caricata, gli elementi nella coda di comando vengono eseguiti nell'ordine in cui sono stati ricevuti. Fatto questo, i nuovi comandi inseriti nella coda vengono eseguiti immediatamente.
Per ridurre al minimo lo snippet di monitoraggio, la coda dei comandi ga()
è sovraccaricata in modo da accettare argomenti in molti formati diversi. Questo documento descrive tutti i vari modi in cui è possibile richiamare la funzione di coda di comando ga()
.
Firma della funzione | |
---|---|
ga(command, [...fields], [fieldsObject]) |
Se richiami la funzione di coda di comando |
ga(readyCallback) |
Richiamare la funzione di coda di comando Poiché i comandi vengono eseguiti solo dopo il completo caricamento della libreria analytics.js, il motivo più comune per passare la coda di comando a una funzione è un callback per quando la libreria analytics.js è caricata e pronta. |
Aggiunta di comandi alla coda
Se richiami la funzione di coda di comando ga()
con la seguente firma di funzione, i comandi verranno inseriti nella coda da pianificare per l'esecuzione dopo il caricamento della libreria.
Utilizzo
ga(command, [...fields], [fieldsObject])
Parametri
Nome | Tipo | Obbligatorio | Descrizione | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
command |
string |
yes |
Un identificatore che rappresenta il comando da aggiungere alla coda. L'identificatore è costituito da tre parti (le prime due sono facoltative): [trackerName.][pluginName:]methodName
|
|||||||||
...fields |
* |
no | Uno o più parametri di convenienza facoltativi per specificare rapidamente i campi comuni. Il numero di campi specifici e consentiti varia a seconda del metodo di comando da chiamare. | |||||||||
fieldsObject |
Object |
no |
Un oggetto per specificare i valori rimanenti non specificati in nessuno dei parametri Se un campo è impostato sia in un parametro |
Consulta la documentazione sui campi per la documentazione dei singoli campi.
Esempi
Consulta la sezione Metodi di comando di seguito per alcuni esempi di singoli comandi.
callback pronto
Richiamare la funzione di coda di comando ga()
passandola per programmare una funzione passata per l'esecuzione nel punto successivo della coda.
Poiché i comandi vengono eseguiti solo dopo il completo caricamento della libreria analytics.js, il motivo più comune per passare la coda di comando a una funzione è un callback per quando la libreria analytics.js è caricata e pronta.
Utilizzo
ga(readyCallback)
Parametri
Nome | Tipo | Obbligatorio | Descrizione |
---|---|---|---|
readyCallback |
Function |
yes |
Una funzione di callback da attivare quando la libreria viene caricata completamente e pronta per essere utilizzata. La funzione viene richiamata con l'oggetto tracker predefinito come primo argomento. Se non è stato creato un tracker predefinito, il primo argomento è Nota: quando viene richiamata la funzione di callback, tutti i metodi dell'oggetto
|
Esempi
// 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`. });
Dettagli metodo di comando
Di seguito è riportato un elenco di tutti i metodi che possono essere passati alla coda dei comandi ga()
(esclusi i metodi dei plug-in).
create
Crea una nuova istanza del tracker con i campi specificati.
Utilizzo
ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);
Parametri
Consulta la documentazione sui campi per la documentazione dei singoli campi.
Restituisce
undefined
Esempi
// 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
Invia un hit a Google Analytics.
Utilizzo
ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);
I campi inviati sono i valori specificati nei parametri ...fields
e fieldsObject
, uniti ai campi attualmente memorizzati sul tracker.
Parametri
I campi che possono essere specificati dai parametri ...fields
variano a seconda del tipo di hit. La seguente tabella elenca i campi che corrispondono a ciascun tipo di hit. I tipi di hit non elencati non accettano parametri ...fields
, solo fieldsObject
.
Tipo di hit | ...fields |
---|---|
pageview |
page |
event |
eventCategory , eventAction , eventLabel , eventValue |
social |
socialNetwork , socialAction , socialTarget |
timing |
timingCategory , timingVar , timingValue , timingLabel |
Consulta la documentazione sui campi per la documentazione dei singoli campi.
Restituisce
undefined
Esempi
// 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
Imposta un campo singolo e una coppia valore o un gruppo di coppie campo/valore in un oggetto tracker.
Utilizzo
// Sets a single field and value. ga('[trackerName.]set', fieldName, fieldValue);
// Sets a group of field/value pairs. ga('[trackerName.]set', fieldsObject);
Parametri
Consulta la documentazione sui campi per la documentazione dei singoli campi.
Restituisce
undefined
Esempi
// 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
Richiede un plug-in analytics.js.
Utilizzo
ga('[trackerName.]require', pluginName, [pluginOptions]);
Parametri
Nome | Tipo | Obbligatorio | Descrizione |
---|---|---|---|
pluginName |
string |
yes | Il nome del plug-in necessario. Nota: se il plug-in non è un plug-in analytics.js ufficiale, deve essere fornito altrove nella pagina. |
pluginOptions |
Object |
no | Un oggetto di inizializzazione che verrà passato al costruttore plug-in al momento dell'istanza. |
Restituisce
undefined
Esempio
// 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
Fornisce un plug-in analytics.js e i relativi metodi da utilizzare con la coda di comandi ga()
.
ga('provide', pluginName, pluginConstuctor);
Parametri
Nome | Tipo | Obbligatorio | Descrizione |
---|---|---|---|
pluginName |
string |
yes | Il nome del plug-in fornito. Il nome utilizzato deve essere lo stesso utilizzato per tutte le chiamate request. |
pluginConstuctor |
Function |
yes | Una funzione costruttore fornisce la logica e i metodi del plug-in. Questo costruttore verrà richiamato con l'oggetto pluginsOptions specificato nel metodo require. |
Esempio
// Defines a plugin constructor function MyPlugin(tracker, options) { // ... } // Provides the plugin for use with the ga() command queue. ga('provide', 'myplugin', MyPlugin);
remove
Rimuove un oggetto tracker.
Utilizzo
ga('[trackerName.]remove');
Esempi
// Remove the default tracker. ga('remove');
// Remove the tracker named "myTracker". ga('myTracker.remove');