GAI-Klassenreferenz

Überblick

Google Analytics-Klasse für iOS (oberste Ebene).

Bietet Möglichkeiten zum Erstellen von Trackern und Setzen von Verhaltenskennzeichen.

Übernimmt NSObject.

Instanzmethoden

(id< GAITracker >)trackerWithName:trackingId:
 Erstellt oder ruft eine GAITracker-Implementierung mit dem angegebenen Namen und der angegebenen Tracking-ID ab. Mehr...
 
(id< GAITracker >)trackerWithTrackingId:
 Erstellt oder ruft eine GAITracker-Implementierung ab, deren Name der angegebenen Tracking-ID entspricht. Mehr...
 
(void) removeTrackerByName:
 Entferne einen Tracker aus dem Tracker-Wörterbuch. Mehr...
 
(void) - Versand
 Sendet alle ausstehenden Tracking-Informationen. Mehr...
 
(void) dispatchWithcompleteHandler:
 Schaltet das nächste Tracking-Beacon in der Warteschlange aus und ruft AbschlussHandler auf, wenn das Tracking-Beacon gesendet wurde (kGAIDispatchGood wird zurückgegeben) oder ein Fehler zurückgegeben (kGAIDispatchError). Mehr...
 

Klassenmethoden

(GAI *)+ sharedInstance
 Rufen Sie die freigegebene Instanz der Klasse Google Analytics für iOS ab. Mehr...
 

Eigenschaften

id< GAITracker >defaultTracker
 Der Einfachheit halber stellt diese Klasse eine Standard-Tracker-Instanz bereit. Mehr...
 
id< GAILogger >logger
 Der zu verwendende GAILogger. Mehr...
 
BOOLoptOut
 Ist dies der Fall, werden keine Tracking-Informationen gesammelt. Tracking-Anrufe führen also praktisch zu einem managementfreien Vorgang. Mehr...
 
NSTimeIntervaldispatchInterval
 Wenn dieser Wert positiv ist, werden Tracking-Informationen automatisch alle dispatchInterval Sekunden gesendet. Mehr...
 
BOOLtrackUncaughtExceptions
 Wenn dieser Parameter auf „true“ gesetzt ist, zeichnet das SDK den aktuell registrierten nicht abgefangenen Ausnahme-Handler auf und registriert dann einen nicht abgefangenen Ausnahme-Handler, der die mit „defaultTracker“ aufgetretenen Ausnahmen verfolgt. Mehr...
 
BOOLdryRun
 Lautet die Antwort JA, werden keine Informationen zur Sendungsverfolgung gesendet. Mehr...
 

Methodendokumentation

+ (GAI *) sharedInstance

Rufen Sie die freigegebene Instanz der Klasse Google Analytics für iOS ab.

- (id<GAITracker>) trackerWithName: (NSString *) name
Tracking-ID: (NSString *) trackingId

Erstellt oder ruft eine GAITracker-Implementierung mit dem angegebenen Namen und der angegebenen Tracking-ID ab.

Wenn der Tracker für den angegebenen Namen noch nicht vorhanden ist, wird er erstellt und zurückgegeben. Andernfalls wird der vorhandene Tracker zurückgegeben. Wenn der vorhandene Tracker für den jeweiligen Namen eine andere Tracking-ID hat, wird sie mit dieser Methode nicht geändert. Wenn defaultTracker nicht festgelegt ist, wird es auf die hier zurückgegebene Tracker-Instanz gesetzt.

Parameter
nameDer Name dieses Trackers. Darf nicht nil oder leer sein.
trackingIDDie Tracking-ID, die für diesen Tracker verwendet werden soll. Er sollte das Format UA-xxxxx-y haben.
Returns
Ein GAITracker, der dem angegebenen Namen zugeordnet ist. Mithilfe des Trackers können Tracking-Daten an Google Analytics gesendet werden. Wenn diese Methode zum ersten Mal mit einem bestimmten Namen aufgerufen wird, wird der Tracker für diesen Namen zurückgegeben, und nachfolgende Aufrufe mit demselben Namen geben dieselbe Instanz zurück. Es ist nicht erforderlich, den Tracker zu behalten, da er intern von der Bibliothek aufbewahrt wird.

Wenn ein Fehler auftritt oder der Name ungültig ist, gibt diese Methode nil zurück.

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

Erstellt oder ruft eine GAITracker-Implementierung ab, deren Name der angegebenen Tracking-ID entspricht.

Ist der Tracker für den jeweiligen Namen noch nicht vorhanden, wird er erstellt, seine Tracking-ID wurde auf |trackingId| gesetzt und er wird zurückgegeben. Andernfalls wird der vorhandene Tracker zurückgegeben. Wenn der vorhandene Tracker für den jeweiligen Namen eine andere Tracking-ID hat, wird sie mit dieser Methode nicht geändert. Wenn defaultTracker nicht festgelegt ist, wird es auf die hier zurückgegebene Tracker-Instanz gesetzt.

Parameter
trackingIDDie Tracking-ID, die für diesen Tracker verwendet werden soll. Er sollte das Format UA-xxxxx-y haben. Der Name des Trackers ist mit der Tracking-ID identisch.
Returns
Ein GAITracker, der der angegebenen Tracking-ID zugeordnet ist. Mithilfe des Trackers können Tracking-Daten an Google Analytics gesendet werden. Beim ersten Aufruf dieser Methode mit einer bestimmten Tracking-ID wird der Tracker für den entsprechenden Namen zurückgegeben. Bei nachfolgenden Aufrufen mit derselben Tracking-ID wird dieselbe Instanz zurückgegeben. Es ist nicht erforderlich, den Tracker zu behalten, da er intern von der Bibliothek aufbewahrt wird.

Wenn ein Fehler auftritt oder die Tracking-ID ungültig ist, gibt diese Methode nil zurück.

- (void) removeTrackerByName: (NSString *) name

Entferne einen Tracker aus dem Tracker-Wörterbuch.

Wenn es der Standard-Tracker ist, wird auch der Standard-Tracker gelöscht.

Parameter
nameDer Name des Trackers.
- (void) Versand

Sendet alle ausstehenden Tracking-Informationen.

Beachten Sie, dass dies keine Auswirkungen auf dispatchInterval hat und in Verbindung mit der regelmäßigen Weiterleitung verwendet werden kann.

– (void) dispatchWithCompleteHandler: (void(^)(GAIDispatchResult-Ergebnis)) completionHandler

Schaltet das nächste Tracking-Beacon in der Warteschlange aus und ruft AbschlussHandler auf, wenn das Tracking-Beacon gesendet wurde (kGAIDispatchGood wird zurückgegeben) oder ein Fehler zurückgegeben (kGAIDispatchError).

Wenn keine Netzwerkverbindung besteht oder keine Daten zum Senden vorhanden sind, wird kGAIDispatchNoData zurückgegeben.

Beachten Sie, dass durch das Aufrufen dieser Methode mit einem nicht null-completeHandler die regelmäßige Weiterleitung deaktiviert wird. Sie können die regelmäßige Weiterleitung wieder aktivieren, indem Sie dispatchInterval auf eine positive Zahl setzen, wenn die App im Hintergrund fortgesetzt wird.

Der Aufruf dieser Methode mit einem Null-Abschluss-Handler entspricht dem Aufruf der obigen Weiterleitung.

Diese Methode kann unter iOS 7.0 oder höher zum Abrufen von Hintergrunddaten verwendet werden. Es empfiehlt sich, diese Methode beim Beenden der Anwendung aufzurufen, um die Übermittlung von nicht übermittelten Tracking-Informationen zu starten.

Parameter
completionHandlerDer Block, der nach einer einzelnen Weiterleitungsanfrage ausgeführt werden soll. Der Parameter GAIDispatchResult gibt an, ob die Weiterleitung erfolgreich war, einen Fehler aufgetreten ist oder keine Treffer gesendet werden musste.

Property-Dokumentation

- (id<GAITracker>) defaultTracker
(lesen/schreiben, nicht atomar, zuweisen)

Der Einfachheit halber stellt diese Klasse eine Standard-Tracker-Instanz bereit.

Es wird auf nil initialisiert und auf den ersten Tracker festgelegt, der in „trackerWithTrackingId:“ instanziiert wird. Er kann bei Bedarf überschrieben werden.

Die Klasse GAITrackedViewController verwendet standardmäßig diese Tracker-Instanz.

- (id<GAILogger>) Logger
(lesen/schreiben, nicht atomar, beibehalten)

Der zu verwendende GAILogger.

– (BOOL) OptOut
(lesen/schreiben, nicht atomar, zuweisen)

Ist dies der Fall, werden keine Tracking-Informationen gesammelt. Tracking-Anrufe führen also praktisch zu einem managementfreien Vorgang.

Wenn die Richtlinie auf „true“ gesetzt ist, werden alle Informationen gelöscht, deren Upload aussteht. Der Wert dieses Flags wird automatisch vom SDK beibehalten. Entwickler können dieses Flag optional verwenden, um eine Deaktivierungseinstellung in der App zu implementieren, mit der Nutzer das Google Analytics-Tracking deaktivieren können.

Dieser Wert ist bei der ersten Verwendung des Google Analytics SDK auf einem Gerät auf NO gesetzt und wird danach beibehalten.

– (NSTimeInterval) dispatchInterval
(lesen/schreiben, nicht atomar, zuweisen)

Wenn dieser Wert positiv ist, werden Tracking-Informationen automatisch alle dispatchInterval Sekunden gesendet.

Andernfalls müssen die Informationen zur Sendungsverfolgung manuell durch den Anruf bei der Weiterleitung gesendet werden.

Die Standardeinstellung ist 120, was bedeutet, dass Tracking-Informationen automatisch alle 120 Sekunden gesendet werden sollen.

- (BOOL) trackUncaughtExceptions
(lesen/schreiben, nicht atomar, zuweisen)

Wenn dieser Parameter auf „true“ gesetzt ist, zeichnet das SDK den aktuell registrierten nicht abgefangenen Ausnahme-Handler auf und registriert dann einen nicht abgefangenen Ausnahme-Handler, der die mit „defaultTracker“ aufgetretenen Ausnahmen verfolgt.

Wenn der Standard-Tracker nicht nil ist, erfasst diese Funktion die Ausnahme auf dem Tracker und versucht 5 Sekunden lang, alle ausstehenden Tracking-Informationen zu senden. Anschließend wird der zuvor registrierte Ausnahme-Handler aufgerufen, falls vorhanden. Wird sie auf „false“ zurückgesetzt, wird der zuvor registrierte nicht abgefangene Ausnahme-Handler wiederhergestellt.

- (BOOL) DryRun
(lesen/schreiben, nicht atomar, zuweisen)

Lautet die Antwort JA, werden keine Informationen zur Sendungsverfolgung gesendet.

Die Standardeinstellung ist „Nein“.