La coda dei comandi ga()
fornisce un'interfaccia per fare quasi tutto ciò che occorre fare con la libreria analytics.js.
Lo snippet di monitoraggio JavaScript definisce la funzione iniziale della coda dei comandi ga()
, pertanto può essere utilizzato 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. Al termine, i nuovi comandi inviati alla coda vengono eseguiti immediatamente.
Per ridurre il più possibile le dimensioni dello snippet di monitoraggio, la coda dei comandi ga()
è sovraccaricata per accettare argomenti in molti formati diversi. Questo documento descrive in dettaglio tutti i modi in cui è possibile richiamare la funzione di coda dei comandi ga()
.
Firma della funzione | |
---|---|
ga(command, [...fields], [fieldsObject]) |
Se richiami la funzione coda dei comandi |
ga(readyCallback) |
Se richiami la funzione di coda dei comandi Poiché i comandi vengono eseguiti solo dopo che la libreria analytics.js è stata completamente caricata, il motivo più comune per passare una funzione della coda di comandi è la funzione di callback per quando la libreria analytics.js è stata caricata e pronta. |
Aggiunta di comandi alla coda in corso...
Se richiami la funzione coda dei comandi ga()
con la firma della funzione seguente, i comandi verranno inviati alla coda per essere pianificati per l'esecuzione una volta caricata la 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 è composto 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 consentiti varia a seconda del metodo di comando chiamato. | |||||||||
fieldsObject |
Object |
no |
Un oggetto per specificare eventuali valori rimanenti non specificati in nessuno dei parametri Se un campo viene impostato sia in un parametro |
Consulta la documentazione di riferimento dei campi per la documentazione sui singoli campi.
Esempi
Consulta la sezione sui metodi di comando riportata di seguito per esempi di singoli comandi.
Pronto per la richiamata
Se richiami la funzione di coda dei comandi ga()
passando una funzione, verrà pianificata l'esecuzione della funzione passata nel punto successivo della coda.
Poiché i comandi vengono eseguiti solo dopo che la libreria analytics.js è stata completamente caricata, il motivo più comune per passare una funzione della coda di comandi è la funzione di callback per quando la libreria analytics.js è stata caricata e pronta.
Utilizzo
ga(readyCallback)
Parametri
Nome | Tipo | Obbligatorio | Descrizione |
---|---|---|---|
readyCallback |
Function |
yes |
Una funzione di callback da attivare quando la libreria è completamente caricata ed è pronta per l'interazione. La funzione viene richiamata con l'oggetto tracker predefinito come primo argomento. Se non è stato creato alcun tracker predefinito, il primo argomento è Nota: quando viene richiamata la funzione di callback, puoi utilizzare 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 comando
Di seguito è riportato un elenco di tutti i metodi che possono essere trasmessi alla coda di comando ga()
(esclusi i metodi plug-in).
create
Crea una nuova istanza di tracker con i campi specificati.
Utilizzo
ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);
Parametri
Consulta la documentazione di riferimento dei campi per la documentazione sui singoli campi.
Ritorni
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 in fieldsObject
, uniti ai campi attualmente memorizzati nel tracker.
Parametri
I campi che possono essere specificati dai parametri ...fields
variano a seconda del tipo di hit. Nella tabella seguente sono elencati i campi corrispondenti a ciascun tipo di hit. I tipi di hit non elencati non accettano i parametri ...fields
, ma 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 di riferimento dei campi per la documentazione sui singoli campi.
Ritorni
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 una singola coppia di campo e valore o un gruppo di coppie campo/valore su 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 di riferimento dei campi per la documentazione sui singoli campi.
Ritorni
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 da richiedere. 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 del plug-in al momento della creazione dell'istanza. |
Ritorni
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 comando 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 da tutte le chiamate require. |
pluginConstuctor |
Function |
yes | Una funzione costruttore che fornisce tutti i metodi e la logica 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');