Universal Analytics (UA) dejará de estar disponible el 1 de julio de 2023, lo que significa que dejará de procesar datos. Las propiedades de Analytics 360 dejarán de funcionar el 1 de octubre de 2023. Migra a Google Analytics 4.

Referencia de la cola de comandos de Google Analytics

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

La cola de comandos de ga() proporciona una interfaz para realizar casi todo lo que necesitas hacer con la biblioteca analytics.js.

El fragmento de seguimiento de JavaScript define la función inicial de la cola de comandos de ga(), por lo que se puede usar incluso antes de que se cargue por completo la biblioteca analytics.js. Apenas se carga la biblioteca analytics.js, los elementos de la cola de comandos se ejecutan en el orden en que se recibieron. Una vez hecho esto, los nuevos comandos enviados a la cola se ejecutan de inmediato.

A fin de mantener el fragmento de seguimiento lo más pequeño posible, la cola de comandos de ga() se sobrecarga para aceptar argumentos en muchos formatos diferentes. En este documento, se detallan todas las formas en que se puede invocar la función de cola de comandos de ga().

Firma de la función
ga(command, [...fields], [fieldsObject])

Si invocas la siguiente función de la cola de comandos de ga() con la siguiente firma de función, se enviarán los comandos a la cola para que se programen su ejecución una vez que se cargue la biblioteca.

ga(readyCallback)

Si invocas la función ga() en la cola de comandos, se programará la ejecución de la función pasada en el siguiente punto de la cola.

Dado que los comandos solo se ejecutan después de que la biblioteca analytics.js está completamente cargada, el motivo más común para pasar la cola de comandos es que una función sea una devolución de llamada para cuando la biblioteca analytics.js esté cargada y lista.

Agrega comandos a la cola

Si invocas la siguiente función de la cola de comandos de ga() con la siguiente firma de función, se enviarán los comandos a la cola para que se programen su ejecución una vez que se cargue la biblioteca.

Uso

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

Parámetros

Nombre Tipo Obligatorio Descripción
command string

Un identificador que representa el comando para agregar a la cola. El identificador se compone de tres partes (las primeras dos son opcionales):

[trackerName.][pluginName:]methodName
trackerName El nombre del rastreador en el que se invocará el comando programado. Si no se especifica un nombre de seguimiento, se invoca al comando en el monitor predeterminado.
pluginName El nombre de un complemento analytics.js que se requiere Si se especifica pluginName, methodName debe ser un método proporcionado por el complemento.
methodName El nombre del método que se programará para ejecutarse. Si no especificas un nombre de complemento, este método debe ser uno de los métodos de comando que se enumeran a continuación.
...fields * no Uno o más parámetros de conveniencia opcionales para especificar rápidamente campos comunes. La cantidad y los campos específicos permitidos varían según el método de comando que se llame.
fieldsObject Object no

Un objeto para especificar los valores restantes no especificados en ninguno de los parámetros fields.

Si se configura un campo en un parámetro fields y un fieldsObject, se usará el valor en fieldsObject.

Consulta la referencia de campos para ver la documentación de los campos individuales.

Ejemplos

Consulta la sección de métodos de comando a continuación para ver ejemplos de comandos individuales.

Devolución de llamada lista

Si invocas la función ga() en la cola de comandos, se programará la ejecución de la función pasada en el siguiente punto de la cola.

Dado que los comandos solo se ejecutan después de que la biblioteca analytics.js está completamente cargada, el motivo más común para pasar la cola de comandos es que una función sea una devolución de llamada para cuando la biblioteca analytics.js esté cargada y lista.

Uso

ga(readyCallback)

Parámetros

Nombre Tipo Obligatorio Descripción
readyCallback Function

Una función de devolución de llamada que se invoca cuando la biblioteca está completamente cargada y lista para interactuar. La función se invoca con el objeto de seguimiento predeterminado como primer argumento. Si no se creó una herramienta de seguimiento predeterminada, el primer argumento es undefined.

Nota: Cuando se invoca la función de devolución de llamada, todos los métodos de objeto ga están disponibles para su uso.

Ejemplos

// 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`.
});

Detalles del método de comando

La siguiente es una lista de todos los métodos que se pueden pasar a la cola de comandos de ga() (excepto los métodos de complementos).

create

Crea una nueva instancia de seguimiento con los campos especificados.

Uso

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

Parámetros

Consulta la referencia de campos para ver la documentación de los campos individuales.

Resultado que se muestra

undefined

Ejemplos

// 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

Envía un hit a Google Analytics.

Uso

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

Los campos que se envían son los valores especificados en los parámetros ...fields y fieldsObject, combinados con los campos almacenados actualmente en la herramienta de seguimiento.

Parámetros

Los campos que pueden especificarse mediante los parámetros ...fields varían según el tipo de hit. En la siguiente tabla, se enumeran los campos que corresponden a cada tipo de hit. Los tipos de hits que no están incluidos no aceptan parámetros ...fields, solo fieldsObject.

Tipo de hit ...fields
pageview page
event eventCategory, eventAction, eventLabel, eventValue
social socialNetwork, socialAction, socialTarget
timing timingCategory, timingVar, timingValue, timingLabel

Consulta la referencia de campos para ver la documentación de los campos individuales.

Resultado que se muestra

undefined

Ejemplos

// 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

Establece un solo par de campo y valor o un grupo de pares de campo/valor en un objeto de seguimiento.

Uso

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

Parámetros

Consulta la referencia de campos para ver la documentación de los campos individuales.

Resultado que se muestra

undefined

Ejemplos

// 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

Requiere un complemento analytics.js.

Uso

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

Parámetros

Nombre Tipo Obligatorio Descripción
pluginName string Es el nombre del complemento que se requerirá. Nota: Si el complemento no es un complemento analytics.js oficial, se debe proporcionar en otra parte de la página.
pluginOptions Object no Un objeto de inicialización que se pasará al constructor del complemento en el momento de la creación de la instancia.

Resultado que se muestra

undefined

Ejemplo

// 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

Proporciona un complemento analytics.js y sus métodos para usarlo con la cola de comandos de ga().

ga('provide', pluginName, pluginConstuctor);

Parámetros

Nombre Tipo Obligatorio Descripción
pluginName string Es el nombre del complemento que se proporciona. El nombre que se use debe ser el mismo que usan las llamadas a require.
pluginConstuctor Function Una función de constructor que proporciona toda la lógica y los métodos del complemento. Este constructor se invocará con el objeto pluginsOptions especificado en el método require.

Ejemplo

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

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

remove

Quita un objeto de seguimiento.

Uso

ga('[trackerName.]remove');

Ejemplos

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