NowAnalyticsSDK-Schnittstelle – Android

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 7 Minuten Lesedauer

    • Die NowAnalyticsSDK- Schnittstelle bietet Funktionen, mit denen Sie Analyseeigenschaften, Benutzereinstellungen und Events für die Verwaltung einer Sammlung von Benutzeranalysedaten konfigurieren können.

    Tabelle : 1. Eigenschaften
    Name Typ Beschreibung
    konfigurieren NowServiceConfiguration Konfiguration, die dem Service zugeordnet werden soll.

    NowAnalyticsSDK – addEvent(eventName: String)

    Fügt ein Anwendungsereignis hinzu, z. B. wenn ein Benutzer eine bestimmte Ebene oder einen bestimmten Bildschirm erreicht. Diese Events werden im Dashboard in der Reihenfolge angezeigt, in der sie aufgetreten sind.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    namens eventName Zeichenfolge Name des hinzuzufügenden Ereignisses.
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um ein Anwendungs-Event hinzuzufügen.

    // Add event
NowAnalyticsSDK.getAnalyticsService().addEvent("Successful Login")

    NowAnalyticsSDK – addEvent(eventName: String, props: MutableMap<String, Any> )

    Fügt ein Anwendungsereignis hinzu, z. B. wenn ein Benutzer eine bestimmte Ebene oder einen bestimmten Bildschirm erreicht, und ermöglicht die Einstellung benutzerdefinierter Eigenschaften für das Ereignis. Diese Events werden im Dashboard in der Reihenfolge angezeigt, in der sie aufgetreten sind.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    eventName Zeichenfolge Name des hinzuzufügenden Ereignisses.
    Eigenschaften MutableMap Schlüssel-Wert-Paare der benutzerdefinierten Eigenschaft für das Event.

    Die Gesamtgröße aus Ereignisname, Eigenschaftsschlüssel und Wert darf 300 Byte pro Eigenschaft nicht überschreiten. Eigenschaften, die diese Grenze überschreiten, werden ignoriert. Eigenschaftsschlüssel dürfen keine Punkt- ('.') oder Dollarzeichen ('$') enthalten. Andernfalls werden sie gekürzt. Zeichenfolgen sind UTF-8-codiert.

    Unterstützte Werttypen:
    • Ganzzahl
    • Doppelt
    • Gleitkommazahl
    • Zeichenfolge
    • URL
    • Boolean
    • Datum
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um ein Anwendungs-Event hinzuzufügen, das benutzerdefinierte Eigenschaften für das Event enthält.

    // Add event with properties
NowAnalyticsSDK.getAnalyticsService().addEvent("Open Case",
  mutableMapOf(
    "Screen Name" to "Case",
    "Case Number" to 123,
    "Case Priority" to 5
  )
)

    NowAnalyticsSDK – addScreenAction(actionName: String)

    Fügt eine benutzerdefinierte Aktion hinzu. Diese Aktionen werden im Benutzer-Dashboard als Teil der Sitzungsdaten angezeigt und beschreiben einen Bildschirmwechsel in einer Anwendung.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    actionName Zeichenfolge Name der Aktion, die dem Bildschirm hinzugefügt werden soll, z. B. MyButtonClick.
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um dem aktuellen Bildschirm eine benutzerdefinierte Aktion hinzuzufügen.

    // Add a custom action to the current screen
NowAnalyticsSDK.getAnalyticsService().addScreenAction("MyButtonClick")

    NowAnalyticsSDK – appendToUserProperty(propertyName: String, item: String)

    Hängt das angegebene Element an die angegebene Benutzereigenschaftenliste an.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    propertyName Zeichenfolge Name der Benutzereigenschaft, an die das Listenelement angehängt werden soll.
    Element Zeichenfolge Listenelement, das an die Eigenschaft angehängt werden soll.
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um einen Fall an die angegebene Liste anzuhängen.

    // Append handled case to list
NowAnalyticsSDK.getAnalyticsService().appendToUserProperty("Case Identifiers", "TASK-1")

    NowAnalyticsSDK –configure(instanceURL: URL,configureCallbacks: KonfigurierenCallbacks?)

    Konfiguriert die angegebene Instanz-URL ServiceNow und Rückrufe an NowAnalytics.

    Nach dem Aufruf dieser Methode wird die tatsächliche Konfiguration aus der zugeordneten Instanz ServiceNow abgerufen und automatisch synchronisiert.

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    instanceURL URL URL der Instanz ServiceNow, die dem NowAnalyticfs-Service zugeordnet werden soll.
    konfigurierenRückrufe Konfigurieren Sie Rückrufe Optional. Rückruf, der ausgeführt werden soll, wenn ein Fehler bei der Kommunikation mit der Instanz ServiceNow auftritt. Dieser Rückruf kann zu jedem Zeitpunkt und aus mehreren Gründen mehrmals aufgerufen werden.
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die angegebene Instanz zu konfigurieren.

    // Init NowAnalytics after NowSDK is initialized
NowAnalyticsSDK.getAnalyticsService().configure(URL("https://my.instance.service-now.com"),
  // Optional - pass callback
  object: ConfigureCallbacks {
    override fun onFail(e: Exception) {
      // configuration failed
    }

    override fun onSuccess() {
      // configuration succeeded
    }
  }
)

    NowAnalyticsSDK – deleteCurrentUserData()

    Löscht alle lokalen und Remote-Daten für den aktuellen Benutzer.

    Diese Methode hebt auch die Festlegung des aktuellen aktiven Benutzers auf und verhindert, dass dieses Gerät zukünftige Analysen nachverfolgt.
    Hinweis:
    Diese Methode führt einen synchronen Aufruf an die SNAnalytics-Server durch. Es wird daher empfohlen, dies in einem Seiten-Thread durchzuführen.
    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob der Löschvorgang erfolgreich war.
    Mögliche Werte:
    • true: Der Löschvorgang war erfolgreich.
    • false: Fehler beim Löschen. Ein Fehler kann auftreten, wenn die SNAnalytics-Server nicht erreichbar sind, z. B. wenn keine Konnektivität besteht. Die Methode muss wiederholt werden.

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Daten des aktuellen Benutzers zu löschen.

    // Delete user data
NowAnalyticsSDK.getAnalyticsService().deleteCurrentUserData()

    NowAnalyticsSDK – getTrackingConsent()

    Gibt die Einwilligungsantwort des aktuellen Benutzers an die Analytics-Nachverfolgung zurück.

    Tabelle : 14. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 15. Ergebnisse
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob der aktuelle Benutzer der Erfassung seiner Daten zugestimmt hat.
    Mögliche Werte:
    • true: Benutzer stimmt der Erfassung seiner Daten zu.
    • false: Benutzer hat die Erfassung seiner Daten abgelehnt.

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Einwilligungsantwort des aktuellen Benutzers für die Analytics-Nachverfolgung anzufordern.

    // Get the current user tracking consent value
val curUserConsent = NowAnalytics.sharedAnalyticsService.getTrackingConsent()

    NowAnalyticsSDK – incUserProperty(propertyName: String, value: Double)

    Erhöht oder verringert den Wert der angegebenen numerischen Eigenschaft um den angegebenen Wert.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    propertyName Zeichenfolge Name der zu erhöhenden Benutzereigenschaft.
    Wert Doppelt Wert, um den die Eigenschaft erhöht werden soll. Geben Sie einen negativen Wert ein, um den Wert zu verringern.
    Tabelle : 17. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    // Increment numeric_property_name by one
NowAnalyticsSDK.getAnalyticsService().incUserProperty("numeric_property_name", 1.0)

// Decrement numeric_property_name by one
NowAnalyticsSDK.getAnalyticsService().incUserProperty("numeric_property_name", -1.0)

    NowAnalyticsSDK – installJavascriptInterface(webView: WebView)

    Ermöglicht den Aufruf von javaScript.SNMobileAnalytics-Methoden aus einem {@link android.webkit.WebView} mit JavaScript.

    Tabelle : 18. Parameter
    Name Typ Beschreibung
    webView WKWebView Das {@link android.webkit.WebView}, an das angehängt werden soll.
    Tabelle : 19. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um den Aufruf von javaScript.SNMobileAnalytics-Methoden zu ermöglichen.

    // Register JS object inside the web page
// This creates an object called 'SNMobileAnalytics' on JS that has the following methods:
// SNMobileAnalytics.setUserId(userId)                 
//   example: SNMobileAnalytics.setUserId("John Doe")
// SNMobileAnalytics.startScreen(screenName)
//   example: SNMobileAnalytics.startScreen("WelcomeScreen")
// SNMobileAnalytics.addScreenAction(actionName)
//   example: SNMobileAnalytics.addScreenAction("MyButtonClick")
// SNMobileAnalytics.addEvent(eventName, properties)
//   example: SNMobileAnalytics.addEvent("Successful Login")
//                                                               
SNMobileAnalytics.addEvent("Successful Login", JSON.stringify({"Screen Name": "Case", "Case Number": "123", "Case Priority": 5}))
NowAnalyticsSDK.getAnalyticsService().installJavascriptInterface(webView)

    NowAnalyticsSDK – removeUserProperty(propertyName: String)

    Löscht die angegebene Eigenschaft für den aktuellen Benutzer.

    Tabelle : 20. Parameter
    Name Typ Beschreibung
    propertyName Zeichenfolge Name der zu löschenden Benutzereigenschaft.
    Tabelle : 21. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Eigenschaft „Temp Cases“ zu entfernen.

    // Remove unnecessary property
NowAnalyticsSDK.getAnalyticsService().removeUserProperty("Temp Cases")

    NowAnalyticsSDK – setListener(nowAnalyticsListener: NowAnalyticsListener?)

    Legt einen Listener für NowAnalytics-Events fest, z. B. Sitzungsänderungen und automatische Bildschirmerkennungen.

    Hinweis:
    Jedes Mal, wenn Sie diese Methode aufrufen, wird der Listener überschrieben.
    Tabelle : 22. Parameter
    Name Typ Beschreibung
    nowAnalytics​Listener NowAnalytics​Listener Die Schnittstelle, die NowAnalytics für Sitzungsereignisse benachrichtigt.
    • onNowAnalyticsScreenDetected: Wird aufgerufen, wenn NowAnalytics einen Bildschirm automatisch erkennt.
    • onNowAnalyticsSessionEnded: Wird nach Beendigung einer Sitzung aufgerufen.
    • onNowAnalyticsSessionEnding: Wird kurz vor dem Ende einer Sitzung aufgerufen, sodass Sie verhindern können, dass die Sitzung beendet wird.
    • onNowAnalyticsSessionStarted: Wird aufgerufen, wenn eine Sitzung gestartet wurde.
    • onNowAnalyticsSessionStarting: Wird kurz vor dem Start einer Sitzung aufgerufen, sodass Sie verhindern können, dass die Sitzung gestartet wird.
    Tabelle : 23. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um NowAnalyticsListener() festzulegen.

    // From anywhere in the code you can register the delegate
NowAnalyticsSDK.getAnalyticsService().setListener(NowAnalyticsListener())

    NowAnalyticsSDK – setTrackingConsent(consentGiven: Boolean)

    Legt die Einwilligungsantwort des aktuellen Anwenders für die Analytics-Nachverfolgung fest.

    Tabelle : 24. Parameter
    Name Typ Beschreibung
    einwilligung gegeben Boolean Kennzeichnung, die die Einwilligung des aktuellen Benutzers zur Nachverfolgung von Analysen angibt.
    Gültige Werte:
    • true: Benutzer hat der Nachverfolgung seiner Daten zugestimmt.
    • false: Benutzer hat die Nachverfolgung seiner Daten deaktiviert.
    Tabelle : 25. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Einwilligungsantwort des aktuellen Benutzers für die Analytics-Nachverfolgung festzulegen.

    // Enable tracking consent
NowAnalyticsSDK.getAnalyticsService().setTrackingConsent(true)

    NowAnalyticsSDK – setUserId(userId: String)

    Legt den anwendungsspezifischen Benutzerbezeichner fest. Übergeben Sie nil, um den aktuellen Benutzer abzumelden.

    Tabelle : 26. Parameter
    Name Typ Beschreibung
    userId Zeichenfolge Eindeutiger anwendungsspezifischer Benutzerbezeichner. Dieser Bezeichner wird verwendet, um Berichte für diesen Benutzer im Dashboard zusammenzufassen.
    Tabelle : 27. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um den anwendungsspezifischen Benutzerbezeichner auf „John Doe“ festzulegen.

    // Set User Id for proper identification
NowAnalyticsSDK.getAnalyticsService().setUserId("John Doe")

    NowAnalyticsSDK – setUserProperties(userProperties: MutableMap<String, Any> )

    Legt mehrere Eigenschaften mit den angegebenen Werten für den aktuellen Benutzer fest. Eigenschaften können alles sein, was Sie im Dashboard für einen Benutzer nachverfolgen möchten.

    Um den aktuellen Benutzer festzulegen, rufen Sie die Funktion NowAnalyticsSDK – setUserId(userId: String) auf.

    Tabelle : 28. Parameter
    Name Typ Beschreibung
    userProperties MutableMap Schlüssel-Wert-Paare der festzulegenden Benutzereigenschaften.
    Unterstützte Werttypen:
    • Nummer
    • Zeichenfolgen
    • Datum
    • URL
    • NULL
    Tabelle : 29. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um mehrere Eigenschaften für den aktuellen Benutzer festzulegen.

    // Add several properties at once
NowAnalyticsSDK.getAnalyticsService().setUserProperties(
  mutableMapOf(
    "Cases Handled" to 100,
    "Last Login" to Date(),
    "Is Remote" to true,
    "Profile URL" to URL("https://www.servicenow.com")
  )
)

    NowAnalyticsSDK – setUserProperty(propertyName: String, propertyValue: Any)

    Legt die angegebene Eigenschaft mit dem angegebenen Wert für den aktuellen Benutzer fest. Eigenschaften können alles sein, was Sie im Dashboard für einen Benutzer nachverfolgen möchten.

    Um den aktuellen Benutzer festzulegen, rufen Sie die Funktion NowAnalyticsSDK – setUserId(userId: String) auf.

    Tabelle : 30. Parameter
    Name Typ Beschreibung
    propertyName Zeichenfolge Name der festzulegenden Benutzereigenschaft.
    Wert Beliebig Wert, auf den die Benutzereigenschaft festgelegt werden soll.
    Unterstützte Werttypen:
    • Nummer
    • Zeichenfolgen
    • Datum
    • URL
    • NULL
    Tabelle : 31. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Eigenschaft „Rolle“ für den aktuellen Benutzer auf „Admin“ festzulegen.

    // Set the "Role" property of the user to "Admin"
NowAnalyticsSDK.getAnalyticsService().setUserProperty("Role", "Admin")

    NowAnalyticsSDK – startScreen(screenName: String)

    Protokolliert die Zeit, zu der der zugehörige Bildschirm zum ersten Mal in der Benutzeroberfläche angezeigt wird.

    Normalerweise rufen Sie diese Methode über die onResume()- Methode der Aktivität auf.

    Tabelle : 32. Parameter
    Name Typ Beschreibung
    namens screenName Zeichenfolge Name des Bildschirms, für den die Startzeit protokolliert werden soll, z. B. „WelcomeScreen“. Dies kann alles sein, was Sie als Bildschirm definieren und in einem Analytics-Dashboard anzeigen/zusammenfassen möchten.
    Tabelle : 33. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Startzeit der Anzeige des „WelcomeScreen“ festzulegen.

    // Mark the appearance starting time of a screen
// This method should be usually called from the onResume() method
NowAnalyticsSDK.getAnalyticsService().startScreen("WelcomeScreen")