Adobe Mobile-Klasse und Methodenreferenz

Klassen und Methoden, die von der BlackBerry-Bibliothek bereitgestellt werden.

Das SDK unterstützt derzeit Adobe Analytics, und die Methoden sind je nach Lösung in separaten Klassen unterteilt.

SDK-Einstellungen

  • getPrivacyStatus

    Gibt die Enum-Darstellung für den Datenschutzstatus des aktuellen Benutzers zurück.

    • ADBMobilePrivacyStatusOptIn - Treffer werden sofort gesendet.

    • ADBMobilePrivacyStatusOptOut - Treffer werden verworfen.

    • ADBMobilePrivacyStatusUnknown - Wenn Ihre Report Suite zeitstempelfähig ist, werden Treffer gespeichert, bis der Datenschutzstatus in "opt-in"(Zugriffe werden dann gesendet) oder "opt-out"(Zugriffe werden dann verworfen) geändert wird. Wenn für Ihre Report Suite keine Zeitstempel aktiviert sind, werden die Treffer verworfen, bis der Datenschutzstatus zu „optedin“ geändert wird.

      Der Standardwert wird in der Datei ADBMobileConfig.json festgelegt.

    • Hier finden Sie die Syntax für diese Methode:

      static ADBMobilePrivacyStatus getPrivacyStatus();
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADBMobilePrivacyStatus privacyStatus = ADBMobile::getPrivacyStatus();
      
  • setPrivacyStatus

    Legt für den aktuellen Benutzer den Datenschutzstatus status fest. Die folgenden Werte sind zulässig:

    • ADBMobilePrivacyStatusOptIn: Treffer werden umgehend gesendet.

    • ADBMobilePrivacyStatusOptOut: werden Treffer verworfen.

    • ADBMobilePrivacyStatusUnknown - Wenn Ihre Report Suite zeitstempelfähig ist, werden die Treffer gespeichert, bis der Datenschutzstatus in "opt-in"(Zugriffe werden gesendet) oder "opt-out"(Zugriffe werden dann verworfen) geändert wird. Wenn für Ihre Report Suite keine Zeitstempel aktiviert sind, werden die Treffer verworfen, bis der Datenschutzstatus zu „optedin“ geändert wird.

    • Hier finden Sie die Syntax für diese Methode:

      static void setPrivacyStatus(ADBMobilePrivacyStatus status);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADBMobile::setPrivacyStatus(ADBMobilePrivacyStatusOptIn);
      
  • getUserIdentifier

    Gibt die Benutzer-ID zurück, sofern eine benutzerdefinierte ID festgelegt wurde. Returns null if a custom identifier is not set. Der Standardwert lautet null.

    • Hier finden Sie die Syntax für diese Methode:

      static QString getUserIdentifier();
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      QString userId = ADBMobile::getUserIdentifier(); 
      
  • setUserIdentifier

    Legt die Benutzerkennung auf identifier fest.

    • Hier finden Sie die Syntax für diese Methode:

      static void setUserIdentifier(QString identifier);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ADBMobile::setUserIdentifier("billybob");
      
  • getDebugLogging

    Gibt die aktuelle Vorgabe für die Debug-Protokollierung zurück. Der Standardwert lautet false.

    • Hier finden Sie die Syntax für diese Methode:

      static bool getDebugLogging();
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

       bool debugging = ADBMobile::getDebugLogging(); 
      
  • setDebugLogging

    Legt die Debug-Protokollierungseinstellung auf debugLogging fest.

    • Hier finden Sie die Syntax für diese Methode:

      static void setDebugLogging(bool debugLogging);
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

        ADBMobile::setDebugLogging(true); 
      
  • collectLifecycleData

    Gibt dem SDK gegenüber an, dass Lebenszyklusdaten für die Nutzung aller Lösungen im SDK erfasst werden sollen. Weitere Informationen finden Sie unter Lebenszyklusmetriken.

    • Hier finden Sie die Syntax für diese Methode:

      static void collectLifecycleData();
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

      ApplicationUI::ApplicationUI(bb::cascades::Application *app):  QObject(app)  { 
      //... 
      ADBMobile::collectLifecycleData(); 
      }
      

Analytics-Methoden

Jede dieser Methoden wird zum Senden von Daten in Ihre Adobe Analytics Report Suite verwendet.

  • trackState

    Verfolgt einen App-Status mit optionalen Kontextdaten. Statusangaben sind die Ansichten, die in Ihrer App verfügbar sind, z. B. "Home Dashboard", "App-Einstellungen", "Warenkorb"usw. Diese Statusangaben sind mit den Seiten in einer Website vergleichbar, und trackState-Aufrufe inkrementieren die Seitenansichten.

    TIPP

    Dies ist der einzige Verfolgungsaufruf, bei dem die Seitenansichten inkrementiert werden.

    • Hier finden Sie die Syntax für diese Methode:

      static void trackState(QString state, QHash<QString, QString> contextData = QHash<QString, QString>()); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

         ADBMobile::trackState("loginScreen", null);
      
  • trackAction

    Verfolgt eine Aktion in der App. Actions are the things that happen in your app that you want to measure, such as "logons", "banner taps", "feed subscriptions", and other metrics.

    • Hier finden Sie die Syntax für diese Methode:

      static void trackAction(QString action, QHash<QString, QString> contextData = QHash<QString, QString>()); 
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

        ADBMobile::trackAction("heroBannerTouched", null); 
      
  • trackLocation

    Sendet die aktuellen XY-Koordinaten. Ersetzen Sie Ereignis durch das Ereignis, das vom Abonnenten von BPS empfangen wird.

    • Hier finden Sie die Syntax für diese Methode:

      static void trackLocation(bps_event_t *geoEvent, QHash<QString, QString> contextData = QHash<QString, QString> ());
      
    • Hier finden Sie ein Code-Beispiel für diese Methode:

        ADBMobile::trackLocation(event, null);
      

ADBMobileConfig.json Referenz zur Konfigurationsdatei

The ADBMobileConfig.json file must be placed in the assets folder.

  • rsids

    (Erforderlich) Eine oder mehrere Report Suites zum Empfang von Analytics-Daten. Mehrere Report Suite-IDs sollten durch Kommata getrennt werden, wobei kein Leerzeichen dazwischen steht.

    Im Folgenden finden Sie das Codebeispiel für diese Variable:

    "rsids" : "rsid"
    
    "rsids" : "rsid1,rsid2"
    
  • server

    (Erforderlich). Analytics-Server. Diese Variable sollte mit der Serverdomäne aufgefüllt werden, und zwar ohne das Protokollpräfix https:// oder https://. Das Protokollpräfix wird automatisch von der Bibliothek auf Basis der ssl Variablen verarbeitet. Wenn ssl auf true gesetzt ist, wird eine sichere Verbindung zu diesem Server hergestellt. Wenn ssl auf false gesetzt ist, wird eine nicht sichere Verbindung zu diesem Server hergestellt.

  • charset

    Definiert den Zeichensatz, den Sie für die an Analytics gesendeten Daten verwenden. Der Zeichensatz wird verwendet, um eingehende Daten zum Speichern und Reporting in das UTF-8-Format umzuwandeln.

  • ssl

    Aktiviert (true) oder deaktiviert (false) das Senden von Messungsdaten über SSL (HTTPS). Der Standardwert lautet false.

  • offlineEnabled

    When enabled (true), hits are queued while the device is offline and sent later when the device is online. Für Ihre Report Suite müssen Zeitstempel aktiviert sein, um die Offline-Verfolgung zu nutzen.

    TIPP

    If timestamps are enabled on your report suite, your offlineEnabled configuration property must be true. Wenn Zeitstempel nicht für Ihre Report Suite aktiviert sind, offlineEnabled muss die Konfigurationseigenschaft „false“ lauten. Wenn dies nicht ordnungsgemäß konfiguriert ist, gehen Daten verloren. Wenn Sie sich nicht sicher sind, ob Zeitstempel für Ihre Report Suite aktiviert sind, wenden Sie sich bitte an Enterprise Support.

    If you are currently reporting AppMeasurement data to a report suite that also collects data from JavaScript, you might need to set up a separate report suite for mobile data, or include a custom timestamp on all JavaScript hits using the s.timestamp variable.

    Der Standardwert lautet false.

  • lifecycleTimeout

    Specifies the length of time, in seconds, that must elapse between app launches before the launch is considered a new session. Dieses Time-out gilt auch, wenn Ihre Anwendung in den Hintergrund gestellt und reaktiviert wird. Die Zeit, die Ihre App im Hintergrund ist, ist nicht in der Sitzungslänge enthalten.

    Der Standardwert ist 300 Sekunden.

  • batchLimit

    Maximale Anzahl der in der Warteschlange gespeicherten Treffer. Der Standardwert ist 0 (Keine Begrenzung).

  • privacyDefault

    • optedin: Treffer werden umgehend gesendet.

    • optedout: werden Treffer verworfen.

    • optunknown - If your report suite is timestamp-enabled, hits are saved until the privacy status changes to opt-in (then hits are sent) or opt-out (then hits are discarded).

      Wenn für Ihre Report Suite keine Zeitstempel aktiviert sind, werden die Treffer verworfen, bis der Datenschutzstatus zu „optedin“ geändert wird.
      Diese Variable legt nur den Ausgangswert fest. If this value is ever set or changed in code, then the new value is used going forward until it is changed, or the app is uninstalled and then reinstalled.

    Der Standardwert lautet optedin.

The following is an example of an ADBMobileConfig.json file:

{ 
    "version" : "1.0", 
    "analytics" : { 
        "rsids" : "coolApp", 
        "server" : "my.CoolApp.com", 
        "charset" : "UTF-8", 
        "ssl" : true, 
        "offlineEnabled" : true, 
        "lifecycleTimeout" : 5, 
        "privacyDefault" : "optedin", 
    } 
}

Auf dieser Seite