Référence de classe GAI

Présentation

Classe de premier niveau Google Analytics pour iOS.

Fournit des fonctionnalités permettant de créer des outils de suivi et de définir des indicateurs de comportement.

Hérite du NSObject.

Méthodes des instances

(ID< GAITracker >)- trackerWithName:trackingId:
 Crée ou récupère une implémentation GAITracker avec le nom et l'ID de suivi spécifiés. Plus...
 
(ID< GAITracker >)- trackerWithTrackingId:
 Crée ou récupère une implémentation GAITracker dont le nom correspond à l'ID de suivi spécifié. Plus...
 
(void) - removeTrackerByName:
 Supprimez un traceur du dictionnaire des outils de suivi. Plus...
 
(void) - dispatch
 Transmet toutes les informations de suivi en attente. Plus...
 
(void) - dispatchWithConclusionHandler :
 Envoie la balise de suivi suivante dans la file d'attente, en appelant "completHandler" lorsque la balise de suivi a été envoyée (renvoi de kGAIDispatchGood) ou lorsqu'une erreur s'est produite (renvoi de kGAIDispatchError). Plus...
 

Méthodes de classe

(GAI *)+ sharedInstance
 Obtenez l'instance partagée de la classe Google Analytics pour iOS. Plus...
 

Propriétés

id< GAITracker >defaultTracker
 Pour plus de commodité, cette classe expose une instance de suivi par défaut. Plus...
 
id< GAILogger >logger
 GAILogger à utiliser. Plus...
 
BOOLoptOut
 Dans ce cas, aucune information de suivi n'est collectée. Le suivi des appels devient effectivement no-ops. Plus...
 
NSTimeIntervaldispatchInterval
 Si cette valeur est positive, les informations de suivi sont automatiquement envoyées toutes les secondes à dispatchInterval. Plus...
 
BOOLtrackUncaughtExceptions
 Lorsque ce paramètre est défini sur "true", le SDK enregistre le gestionnaire d'exceptions non interceptés actuellement enregistré, puis enregistre un gestionnaire d'exceptions non capturés qui suit les exceptions qui se sont produites à l'aide de defaultTracker. Plus...
 
BOOLdryRun
 Si la valeur est "YES", aucune information de suivi n'est envoyée. Plus...
 

Documentation sur les méthodes

+ (GAI *) sharedInstance

Obtenez l'instance partagée de la classe Google Analytics pour iOS.

- (id<GAITracker>) tracker Avec Nom: (NSString *) name
ID de suivi: (NSString *) trackingId

Crée ou récupère une implémentation GAITracker avec le nom et l'ID de suivi spécifiés.

Si l'outil de suivi pour le nom spécifié n'existe pas déjà, il est créé et renvoyé. Sinon, l'outil de suivi existant est renvoyé. Si l'outil de suivi existant pour le nom correspondant a un ID de suivi différent, cette méthode ne le modifie pas. Si defaultTracker n'est pas défini, il sera défini sur l'instance de traceur renvoyée ici.

Paramètres
nameNom de cet outil de suivi. Ce champ ne doit pas être nil ni vide.
trackingIDID de suivi à utiliser pour ce traceur. Elle doit se présenter au format UA-xxxxx-y.
Renvoie
GAITracker associé au nom spécifié. L'outil de suivi peut être utilisé pour envoyer des données de suivi à Google Analytics. La première fois que cette méthode est appelée avec un nom particulier, l'outil de suivi correspondant à ce nom est renvoyé, et les appels suivants portant le même nom renvoient la même instance. Il n'est pas nécessaire de conserver l'outil de suivi, car il est conservé en interne par la bibliothèque.

Si une erreur se produit ou si le nom n'est pas valide, cette méthode renvoie nil.

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

Crée ou récupère une implémentation GAITracker dont le nom correspond à l'ID de suivi spécifié.

Si l'outil de suivi pour le nom correspondant n'existe pas déjà, il est créé, son ID de suivi est défini sur |trackingId| et est renvoyé. Sinon, l'outil de suivi existant est renvoyé. Si l'outil de suivi existant pour le nom correspondant a un ID de suivi différent, cette méthode ne le modifie pas. Si defaultTracker n'est pas défini, il est défini sur l'instance de traceur renvoyée ici.

Paramètres
trackingIDID de suivi à utiliser pour ce traceur. Elle doit se présenter au format UA-xxxxx-y. Le nom du traceur sera identique à l'ID de suivi.
Renvoie
GAITracker associé à l'ID de suivi spécifié. L'outil de suivi peut être utilisé pour envoyer des données de suivi à Google Analytics. La première fois que cette méthode est appelée avec un ID de suivi spécifique, l'outil de suivi correspondant au nom correspondant est renvoyé, et les appels suivants avec le même ID de suivi renvoient la même instance. Il n'est pas nécessaire de conserver l'outil de suivi, car il est conservé en interne par la bibliothèque.

Si une erreur se produit ou si l'ID de suivi n'est pas valide, cette méthode renvoie nil.

- (void) removeTrackerByName: (NSString *) name

Supprimez un traceur du dictionnaire des outils de suivi.

S'il s'agit du coach électronique par défaut, efface également le traceur par défaut.

Paramètres
nameNom du traceur.
- envoi (vide)

Transmet toutes les informations de suivi en attente.

Notez que cela n'a aucune incidence sur le paramètre dispatchInterval et peut être utilisé avec l'envoi périodique.

- (void) dispatchWithCompletionHandler: (void(^)(GAIDispatchResult résultat)) completionHandler

Envoie la balise de suivi suivante dans la file d'attente, en appelant "completHandler" lorsque la balise de suivi a été envoyée (renvoi de kGAIDispatchGood) ou lorsqu'une erreur s'est produite (renvoi de kGAIDispatchError).

En l'absence de connexion réseau ou de données à envoyer, kGAIDispatchNoData est renvoyé.

Notez que l'appel de cette méthode avec une valeur non nulle (completeHandler) désactive l'envoi périodique. Vous pouvez réactiver l'envoi périodique en définissant le paramètre dispatchInterval sur une valeur positive lorsque l'application reprend en arrière-plan.

Appeler cette méthode avec nil completedHandler revient à appeler la fonction dispatch ci-dessus.

Cette méthode peut être utilisée pour récupérer des données en arrière-plan dans iOS 7.0 ou version ultérieure. Il est judicieux d'appeler cette méthode lorsque l'application se ferme afin de lancer l'envoi des informations de suivi non envoyées.

Paramètres
completionHandlerBloc à exécuter après une seule requête de distribution. Le paramètre GAIDispatchResult indique si l'envoi a réussi, s'il a généré une erreur ou s'il n'y a eu aucun appel.

Documentation sur la propriété

- (id<GAITracker>) defaultTracker
(lecture/écriture, non atomique, attribution)

Pour plus de commodité, cette classe expose une instance de suivi par défaut.

Ce paramètre est initialisé sur nil et sera défini sur le premier traceur instancié dans trackerWithTrackingId:. Vous pouvez la remplacer si vous le souhaitez.

La classe GAITrackedViewController utilisera par défaut cette instance de traceur.

- (id<GAILogger>) enregistreur
(lecture/écriture, non atomique, conserver)

GAILogger à utiliser.

- Désactivation de (BOOL)
(lecture/écriture, non atomique, attribution)

Dans ce cas, aucune information de suivi n'est collectée. Le suivi des appels devient effectivement no-ops.

Si cette règle est définie sur "True", toutes les informations en attente d'importation sont supprimées. La valeur de cet indicateur sera automatiquement conservée par le SDK. Les développeurs peuvent utiliser cet indicateur pour implémenter un paramètre de désactivation dans l'application, permettant aux utilisateurs de désactiver le suivi Google Analytics.

Il est défini sur NO la première fois que le SDK Google Analytics est utilisé sur un appareil, puis il est conservé.

- (NSTimeInterval) : dispatchInterval
(lecture/écriture, non atomique, attribution)

Si cette valeur est positive, les informations de suivi sont automatiquement envoyées toutes les secondes à dispatchInterval.

Sinon, les informations de suivi doivent être envoyées manuellement en appelant le service de distribution.

Par défaut, la valeur est 120, ce qui signifie que les informations de suivi doivent être envoyées automatiquement toutes les 120 secondes.

- (BOOL) trackUnCatchExceptions
(lecture/écriture, non atomique, attribution)

Lorsque ce paramètre est défini sur "true", le SDK enregistre le gestionnaire d'exceptions non interceptés actuellement enregistré, puis enregistre un gestionnaire d'exceptions non capturés qui suit les exceptions qui se sont produites à l'aide de defaultTracker.

Si defaultTracker n'est pas nil, cette fonction suivra l'exception sur le traceur et tentera d'envoyer les informations de suivi en attente pendant cinq secondes. Il appelle ensuite le gestionnaire d'exceptions précédemment enregistré, le cas échéant. Une fois redéfini sur "false", le gestionnaire d'exceptions non interceptés précédemment enregistré est restauré.

- (BOOL) dryRun
(lecture/écriture, non atomique, attribution)

Si la valeur est "YES", aucune information de suivi n'est envoyée.

La valeur par défaut est "NO".