Referencia de la clase de GAI

Descripción general

Es la clase de nivel superior de iOS de Google Analytics.

Brinda recursos para crear segmentos y establecer marcas de comportamiento.

Hereda NSObject.

Métodos de instancias

(id< GAITracker >)- trackerWithName:trackingId:
 Crea o recupera una implementación de GAITracker con el nombre y el ID de seguimiento especificados. Más...
 
(id< GAITracker >)- trackerWithTrackingId:
 Crea o recupera una implementación de GAITracker con un nombre igual al ID de seguimiento especificado. Más...
 
(void) - removeTrackerByName:
 Quita un dispositivo de rastreo del diccionario. Más...
 
(void) - envío
 Despacha toda la información de seguimiento pendiente. Más...
 
(void) - dispatchWithFinishedHandler:
 Despacha la siguiente baliza de seguimiento de la cola y llama a completeHandler cuando se haya enviado la baliza de seguimiento (que muestra kGAIDispatchGood) o cuando se produce un error (se muestra kGAIDispatchError). Más...
 

Métodos de clase

(GAI *)+ sharedInstance
 Obtén la instancia compartida de la clase de Google Analytics para iOS. Más...
 

Propiedades

id< GAITracker >defaultTracker
 Para mayor comodidad, esta clase expone una instancia de rastreador predeterminada. Más...
 
id< GAILogger >logger
 El GAILogger que se usará. Más...
 
BOOLoptOut
 Si esto es así, no se recopilará información de seguimiento; las llamadas de seguimiento se convertirán en no-ops. Más...
 
NSTimeIntervaldispatchInterval
 Si este valor es positivo, la información de seguimiento se enviará automáticamente cada segundo de dispatchInterval. Más...
 
BOOLtrackUncaughtExceptions
 Cuando se configura como true, el SDK registrará el controlador de excepciones no detectadas actualmente registrado y, luego, registrará un controlador de excepciones no detectadas que realiza un seguimiento de las excepciones que se produjeron con defaultTracker. Más...
 
BOOLdryRun
 Si la respuesta es "SÍ", no se enviará información de seguimiento. Más...
 

Documentación de métodos

+ (GAI *) sharedInstance

Obtén la instancia compartida de la clase de Google Analytics para iOS.

- (id<GAITracker>) rastreadorWithName: (NSString *) name
ID de seguimiento: (NSString *) trackingId

Crea o recupera una implementación de GAITracker con el nombre y el ID de seguimiento especificados.

Si el rastreador para el nombre especificado no existe, se creará y se mostrará; de lo contrario, se devolverá el existente. Si el dispositivo de seguimiento existente para el nombre correspondiente tiene un ID de seguimiento diferente, este método no cambia ese ID. Si no se establece defaultTracker, se establecerá en la instancia de seguimiento que se muestra aquí.

Parámetros
nameEl nombre de este monitor. No debe estar nil ni estar vacío.
trackingIDEl ID de seguimiento que se debe usar para este dispositivo de seguimiento. Debe tener el formato UA-xxxxx-y.
Devuelve
Es un GAITracker asociado con el nombre especificado. El rastreador se puede usar para enviar datos de seguimiento a Google Analytics. La primera vez que se llama a este método con un nombre particular, se muestra la herramienta de seguimiento con ese nombre, y las llamadas posteriores con el mismo nombre mostrarán la misma instancia. No es necesario conservar el segmento, ya que la biblioteca lo retendrá de forma interna.

Si se produce un error o el nombre no es válido, este método mostrará nil.

- (id<GAITracker>) trackerWithTrackingId: (NSString *) trackingId

Crea o recupera una implementación de GAITracker con un nombre igual al ID de seguimiento especificado.

Si todavía no existe el dispositivo de seguimiento para el nombre correspondiente, se crea su ID de seguimiento establecido en |trackingId| y se muestra; de lo contrario, se devuelve el existente. Si el dispositivo de seguimiento existente para el nombre correspondiente tiene un ID de seguimiento diferente, este método no cambia ese ID. Si no se establece defaultTracker, se establece en la instancia de seguimiento que se muestra aquí.

Parámetros
trackingIDEl ID de seguimiento que se debe usar para este dispositivo de seguimiento. Debe tener el formato UA-xxxxx-y. El nombre del dispositivo de seguimiento será el mismo que el ID de seguimiento.
Devuelve
Es un GAITracker asociado con el ID de seguimiento especificado. El rastreador se puede usar para enviar datos de seguimiento a Google Analytics. La primera vez que se llame a este método con un ID de seguimiento específico, se mostrará el rastreador con el nombre correspondiente y las llamadas posteriores con el mismo ID de seguimiento mostrarán la misma instancia. No es necesario conservar el segmento, ya que la biblioteca lo retendrá de forma interna.

Si se produce un error o si el ID de seguimiento no es válido, este método mostrará el valor nil.

- (void) removeTrackerByName: (NSString *) name

Quita un dispositivo de rastreo del diccionario.

Si es el dispositivo de seguimiento predeterminado, también se borra el predeterminado.

Parámetros
nameEs el nombre del dispositivo de rastreo.
- envío (void)

Despacha toda la información de seguimiento pendiente.

Ten en cuenta que esto no tiene ningún efecto en dispatchInterval y se puede usar junto con envíos periódicos.

- (void) dispatchWithCompletionHandler: (void(^)(resultado GAIDispatchResult)) completionHandler

Despacha la siguiente baliza de seguimiento de la cola y llama a completeHandler cuando se haya enviado la baliza de seguimiento (que muestra kGAIDispatchGood) o cuando se produce un error (se muestra kGAIDispatchError).

Si no hay conexión de red o no hay datos para enviar, se muestra kGAIDispatchNoData.

Ten en cuenta que si se llama a este método con un elemento CompleteHandler que no es nulo, se inhabilitan los envíos periódicos. Para volver a habilitar el envío periódico, configura dispatchInterval en un número positivo cuando se reanuda la app en segundo plano.

Llamar a este método con un autocompletado con un valor nulo es igual a llamar al despacho anterior.

Este método se puede usar para recuperar datos en segundo plano en iOS 7.0 o versiones posteriores. Sería inteligente llamar a este método cuando se cierre la solicitud para iniciar el envío de cualquier información de seguimiento no enviada.

Parámetros
completionHandlerEl bloque que se ejecutará después de una única solicitud de envío. El parámetro GAIDispatchResult indica si el envío se realizó correctamente, si tuvo un error o no tuvo hits para enviar.

Documentación de la propiedad

- (id<GAITracker>) defaultTracker
(lectura y escritura, no atómico, asignación)

Para mayor comodidad, esta clase expone una instancia de rastreador predeterminada.

Se inicializa en nil y se establecerá en el primer rastreador que se cree en TrackWithTrackingId:. Se puede anular según lo desees.

La clase GAITrackedViewController usará, de forma predeterminada, esta instancia de seguimiento.

- (id<GAILogger>) registrador
(lectura y escritura, no atómico, retención)

El GAILogger que se usará.

- Inhabilitación (BOOL)
(lectura y escritura, no atómico, asignación)

Si esto es así, no se recopilará información de seguimiento; las llamadas de seguimiento se convertirán en no-ops.

Si se establece como verdadera, se borrará toda la información pendiente de carga. El SDK conservará automáticamente el valor de esta marca. De manera opcional, los desarrolladores pueden usar esta marca para implementar una configuración de inhabilitación en la app que permita a los usuarios inhabilitar el seguimiento de Google Analytics.

Se establece en NO la primera vez que se usa el SDK de Google Analytics en un dispositivo y se conserva después.

- (NSTimeInterval) dispatchInterval
(lectura y escritura, no atómico, asignación)

Si este valor es positivo, la información de seguimiento se enviará automáticamente cada segundo de dispatchInterval.

De lo contrario, la información de seguimiento se debe enviar de forma manual llamando al equipo de despacho.

De forma predeterminada, el valor es 120, lo que indica que la información de seguimiento se debe enviar automáticamente cada 120 segundos.

- (BOOL) trackUn detectedExceptions
(lectura y escritura, no atómico, asignación)

Cuando se configura como true, el SDK registrará el controlador de excepciones no detectadas actualmente registrado y, luego, registrará un controlador de excepciones no detectadas que realiza un seguimiento de las excepciones que se produjeron con defaultTracker.

Si defaultTracker no es nil, esta función realizará un seguimiento de la excepción en el dispositivo de seguimiento y tratará de despachar la información de seguimiento pendiente durante 5 segundos. Luego, llamará al controlador de excepciones registrado previamente, si lo hay. Cuando se vuelve a establecer como falso, se restablece el controlador de excepciones no detectadas que se registró previamente.

- Ejecución de prueba (BOOL)
(lectura y escritura, no atómico, asignación)

Si la respuesta es "SÍ", no se enviará información de seguimiento.

La configuración predeterminada es "NO".