Descripción general
Clase de nivel superior de iOS para Google Analytics.
Proporciona medios para crear objetos de seguimiento y configurar las marcas de comportamiento.
Hereda NSObject.
Métodos de instancia | |
(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: |
Elimina un objeto de seguimiento del diccionario de los objetos de este tipo. Más... | |
(void) | - dispatch |
Envía la información de seguimiento pendiente. Más... | |
(void) | - dispatchWithCompletionHandler: |
Envía el siguiente beacon de seguimiento de la cola; para ello, llama a completionHandler cuando se ha enviado el beacon de seguimiento (se devuelve kGAIDispatchGood) o se ha producido un error (se devuelve kGAIDispatchError). Más... | |
Métodos de clase | |
(GAI *) | + sharedInstance |
Obtiene la instancia compartida de la clase de Google Analytics para iOS. Más... | |
Propiedades | |
id< GAITracker > | defaultTracker |
Para que resulte más cómodo, esta clase expone una instancia de objeto de seguimiento predeterminado. Más... | |
id< GAILogger > | logger |
El objeto GAILogger que se usará. Más... | |
BOOL | optOut |
Cuando tiene el valor true, no se recopilará información de seguimiento. Las llamadas de seguimiento dejarán de estar activas. Más... | |
NSTimeInterval | dispatchInterval |
Si el valor es positivo, la información de seguimiento se enviará automáticamente según la frecuencia en segundos que se indique en dispatchInterval. Más... | |
BOOL | trackUncaughtExceptions |
Cuando se configura como true, el SDK registrará el controlador de excepción no interceptada que se haya registrado actualmente y, a continuación, registrará un controlador de este tipo que realiza el seguimiento de las excepciones que se han producido con defaultTracker. Más... | |
BOOL | dryRun |
Cuando se configura como "YES", no se enviará ninguna información de seguimiento. Más... | |
Documentación de métodos
+ (GAI *) sharedInstance |
Obtiene la instancia compartida de la clase de Google Analytics para iOS.
- (id<GAITracker>) trackerWithName: | (NSString *) | name | |
trackingId: | (NSString *) | trackingId | |
Crea o recupera una implementación de GAITracker con el nombre y el ID de seguimiento especificados.
Si el objeto de seguimiento con el nombre especificado no existe, se creará y se devolverá; de lo contrario, se devolverá el objeto de seguimiento actual. Si un objeto de seguimiento con el nombre correspondiente tiene un ID de seguimiento distinto, este método no cambia su ID. Si no hay configurado un objeto defaultTracker, se configurará como la instancia de objeto de seguimiento devuelta aquí.
- Parámetros
-
name Nombre del objeto de seguimiento. No debe ser nil
ni estar vacío.trackingID ID de seguimiento que se utiliza para este objeto. Debe tener el formato UA-xxxxx-y
.
- Devuelve
- Un objeto GAITracker asociado con el nombre especificado. El objeto de seguimiento se puede usar para enviar datos de seguimiento a Google Analytics. La primera vez que se llama a este método con un determinado nombre, se devolverá el objeto de seguimiento que tenga ese nombre y las llamadas con el mismo nombre devolverán la misma instancia. No es necesario retener el objeto de seguimiento porque lo retendrá la biblioteca internamente.
Si se produce un error o el nombre no es válido, este método devolverá nil
.
- (id<GAITracker>) trackerWithTrackingId: | (NSString *) | trackingId |
Crea o recupera una implementación de GAITracker con un nombre igual al ID de seguimiento especificado.
Si el objeto de seguimiento con el nombre correspondiente no existe, se creará, su ID de seguimiento se configurará como el valor de trackingId y se devolverá; de lo contrario, se devolverá el objeto de seguimiento actual. Si un objeto de seguimiento con el nombre correspondiente tiene un ID de seguimiento distinto, este método no cambia su ID. Si no hay configurado un objeto defaultTracker, se configurará como la instancia de objeto de seguimiento devuelta aquí.
- Parámetros
-
trackingID ID de seguimiento que se utiliza para este objeto. Debe tener el formato UA-xxxxx-y
. El nombre del objeto de seguimiento será el mismo que el valor de trackingID.
- Devuelve
- Un objeto GAITracker asociado con el objeto trackingID especificado. El objeto de seguimiento se puede usar para enviar datos de seguimiento a Google Analytics. La primera vez que se llama a este método con un determinado objeto trackingId, se devolverá el objeto de seguimiento con el nombre correspondiente y las llamadas con el mismo nombre devolverán la misma instancia. No es necesario retener el objeto de seguimiento porque lo retendrá la biblioteca internamente.
Si se produce un error o el objeto trackingId no es válido, este método devolverá nil
.
- (void) removeTrackerByName: | (NSString *) | name |
Elimina un objeto de seguimiento del diccionario de los objetos de este tipo.
Si es el objeto de seguimiento predeterminado, también lo borra.
- Parámetros
-
name Nombre del objeto de seguimiento.
- (void) dispatch |
Envía la información de seguimiento pendiente.
No afecta a dispatchInterval y se puede usar conjuntamente con el envío periódico.
- (void) dispatchWithCompletionHandler: | (void(^)(GAIDispatchResult result)) | completionHandler |
Envía el siguiente beacon de seguimiento de la cola; para ello, llama a completionHandler cuando se ha enviado el beacon de seguimiento (se devuelve kGAIDispatchGood) o se ha producido un error (se devuelve kGAIDispatchError).
Si no hay conexión de red o no hay datos para enviar, se devuelve kGAIDispatchNoData.
Llamar a este método con un objeto completionHandler cuyo valor sea distinto de nil inhabilita el envío periódico, que se puede volver a habilitar configurando dispatchInterval como un valor positivo cuando la aplicación reanude su funcionamiento desde el segundo plano.
Llamar a este método con un completionHandler cuyo valor sea nil es lo mismo que llamar al envío indicado anteriormente.
Este método se puede usar para recopilar datos en segundo plano en iOS 7.0 o posterior. Es aconsejable llamarlo cuando finalice la aplicación para iniciar el envío de la información de seguimiento que no se haya enviado.
- Parámetros
-
completionHandler Bloque que se ejecutará después de una solicitud de envío individual. El parámetro GAIDispatchResult indica si el envío se ha realizado correctamente, ha tenido un error o no había hits para enviar.
Documentación de la propiedad
|
(readwrite, nonatomic, assign) |
Para que resulte más cómodo, esta clase expone una instancia de objeto de seguimiento predeterminado.
Se inicializa en nil
y se configurará como el primer objeto de seguimiento cuya instancia se crea en trackerWithTrackingId:. Se puede anular según se desee.
De forma predeterminada, la clase GAITrackedViewController usará esta instancia de objeto de seguimiento.
|
(readwrite, nonatomic, assign) |
Cuando tiene el valor true, no se recopilará información de seguimiento. Las llamadas de seguimiento dejarán de estar activas.
Si se establece en true, toda la información que se encuentra pendiente de subida se suprimirá. El SDK mantendrá el valor de esta marca. Los programadores pueden usar esta marca para implementar una configuración de inhabilitación en la aplicación que permita a los usuarios desactivar el seguimiento de Google Analytics.
Se configura como NO
la primera vez que se usa el SDK de Google Analytics en un dispositivo y se mantiene posteriormente.
|
(readwrite, nonatomic, assign) |
Si el valor es positivo, la información de seguimiento se enviará automáticamente según la frecuencia en segundos que se indique en dispatchInterval.
De lo contrario, la información de seguimiento se debe enviar manualmente llamando a dispatch.
De forma predeterminada, este valor se configura como 120
, lo que indica que la información de seguimiento se debe enviar automáticamente cada 120 segundos.
|
(readwrite, nonatomic, assign) |
Cuando se configura como true, el SDK registrará el controlador de excepción no interceptada que se haya registrado actualmente y, a continuación, registrará un controlador de este tipo que realiza el seguimiento de las excepciones que se han producido con defaultTracker.
Si el valor de defaultTracker no es nil
, la función realizará el seguimiento de la excepción en el objeto de seguimiento e intentará enviar la información de seguimiento pendiente durante cinco segundos. Después, llamará al controlador de excepciones registrado, si hubiera alguno. Cuando se vuelve a configurar el valor como false, se restaurará el controlador de excepciones no interceptadas que se ha registrado anteriormente.
|
(readwrite, nonatomic, assign) |
Cuando se configura como "YES", no se enviará ninguna información de seguimiento.
El valor predeterminado es "NO".