Riferimento alla coda di comando ga

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.

Nota: gli snippet di monitoraggio JavaScript consentono di rinominare la funzione coda dei comandi ga(). In questo caso, assicurati che il codice copiato da questo sito faccia riferimento al nuovo nome.

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() con la firma della funzione seguente, i comandi verranno inviati alla coda per essere pianificati per l'esecuzione una volta caricata la libreria.
ga(readyCallback)	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.

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 trackerName Il nome del tracker su cui richiamare il comando pianificato. Se non viene specificato alcun nome del tracker, il comando viene richiamato sul tracker predefinito. pluginName Il nome di un plug-in analytics.js che è stato richiesto. Se pluginName è specificato, methodName deve essere un metodo fornito dal plug-in. methodName Il nome del metodo di cui pianificare l'esecuzione. Se non specifichi un nome plug-in, questo metodo deve essere uno dei metodi di comando elencati di seguito.
...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 fields. Se un campo viene impostato sia in un parametro fields che in fieldsObject, verrà utilizzato il valore in fieldsObject.

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 è undefined. Nota: quando viene richiamata la funzione di callback, puoi utilizzare tutti i metodi dell'oggetto ga.

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

Importante: non puoi specificare il nome di un tracker nella parte relativa al metodo della chiamata di creazione. Ad esempio, ga('myTracker.create', 'UA-XXXXX-Y`) non funziona.

Per ulteriori informazioni sulla creazione di tracker, leggi la guida per la creazione di tracker.

---

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.

Nota: i valori specificati in ...fields e fieldsObject vengono inviati con l'hit corrente, ma non vengono memorizzati nell'oggetto tracker. Usa il metodo set per aggiornare un 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
});

Per ulteriori informazioni sull'invio degli hit, consulta la guida sull'invio di dati a Google Analytics.

---

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

Per ulteriori informazioni su come aggiornare i tracker, leggi la guida per recuperare e impostare i dati dei tracker.

---

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

Per ulteriori informazioni su come richiedere i plug-in analytics.js, consulta la guida sull'utilizzo dei plug-in.

---

provide

Fornisce un plug-in analytics.js e i relativi metodi da utilizzare con la coda di comando ga().

ga('provide', pluginName, pluginConstuctor);

Nota: a differenza della maggior parte dei metodi di coda ga(), il valore non accetta un nome di tracker.

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

Per ulteriori informazioni su come fornire i plug-in analytics.js, leggi la guida alla scrittura dei plug-in.

---

remove

Rimuove un oggetto tracker.

Utilizzo

ga('[trackerName.]remove');

Esempi

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

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