NowAnalyticsSDK-Schnittstelle – Android

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 7 Minuten Lesedauer

    • Die NowAnalyticsSDK Die Schnittstelle bietet Funktionen, mit denen Sie Analytics-Eigenschaften, Anwendereinstellungen und Ereignisse für die Verwaltung einer Sammlung von Anwender-Analytics-Daten konfigurieren können.

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

    NowAnalyticsSDK – addEvent(eventName: Zeichenfolge)

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

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Benannter eventName Zeichenfolge Name des hinzuzufügenden Ereignisses.
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    Keine

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

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

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

    Fügt ein Anwendungsereignis hinzu, z. B. ein Anwender, der eine bestimmte Ebene oder einen bestimmten Bildschirm erreicht, und aktiviert die Einstellung anwenderdefinierter Eigenschaften für das Ereignis. Diese Ereignisse 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 Anwenderdefinierte Eigenschaft – Schlüssel-Wert-Paare für das Ereignis.

    Die Gesamtgröße des Ereignisnamens, des Eigenschaftsschlüssels und des Werts darf 300 Byte pro Eigenschaft nicht überschreiten. Eigenschaften, die diesen Grenzwert überschreiten, werden ignoriert. Eigenschaftsschlüssel dürfen keinen Punkt („.“) enthalten. Oder Dollarzeichen („$“), wenn ja, werden sie gekürzt. Zeichenfolgen sind UTF-8-codiert.

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

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um ein Anwendungsereignis hinzuzufügen, das anwenderdefinierte Eigenschaften für das Ereignis 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: Zeichenfolge)

    Fügt eine anwenderdefinierte Aktion hinzu. Diese Aktionen werden im Anwender-Dashboard als Teil der Sitzungsdaten angezeigt und beschreiben eine Bildschirmänderung in einer Anwendung.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    actionName Zeichenfolge Name der Aktion, die dem Bildschirm hinzugefügt werden soll, z. B. MyButtonKlicken Sie auf .
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    Keine

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

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

    NowAnalyticsSDK – appendToUserProperty(propertyName: Zeichenfolge, Element: Zeichenfolge)

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

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    propertyName Zeichenfolge Name der Anwendereigenschaft, an die das Listenelement angehängt werden soll.
    Element Zeichenfolge Listenelement, das an die Eigenschaft angehängt werden soll.
    Tabelle : 9. Rückgaben
    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: ConfigureCallbacks?)

    Konfiguriert den angegebenen ServiceNow Instanz-URL und Rückrufe auf NowAnalytics.

    Sobald diese Methode aufgerufen wurde, wird die tatsächliche Konfiguration aus dem zugehörigen abgerufen ServiceNow Instanz und automatisch synchronisiert.

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Instanz-URL URL URL von ServiceNow Instanz, die dem NowAnalyticfs-Service zugeordnet werden soll.
    KonfigurierenRückrufe ConfigureCallbacks Optional. Rückruf, der ausgeführt werden soll, wenn bei der Kommunikation mit dem ein Fehler auftritt ServiceNow Instanz. Dieser Rückruf kann jederzeit aufgerufen werden und kann aus mehreren Gründen mehrmals aufgerufen werden.
    Tabelle : 11. Rückgaben
    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 Anwender.

    Diese Methode hebt auch die Festlegung des aktuell aktiven Anwenders auf und deaktiviert dieses Gerät aus der Nachverfolgung zukünftiger Analytics.
    Hinweis:
    Diese Methode führt einen synchronen Aufruf der SNAnalytics-Server durch. Es wird daher empfohlen, dies für einen Seiten-Thread auszufü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:
    • Wahr: Löschung war erfolgreich.
    • Falsch: Fehler beim Löschen. Ein Fehler kann auftreten, wenn die SNAnalytics-Server nicht erreicht werden können, z. B. wenn keine Konnektivität vorhanden ist. Die Methode sollte wiederholt werden.

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

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

    NowAnalyticsSDK – getTrackingConsent()

    Gibt die Einwilligungsantwort des aktuellen Anwenders 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 Anwender der Erfassung seiner Daten zugestimmt hat.
    Mögliche Werte:
    • Wahr: Der Anwender hat zugestimmt, dass seine Daten erfasst werden.
    • Falsch: Anwender hat die Erfassung seiner Daten deaktiviert.

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

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

    NowAnalyticsSDK – incUserProperty(propertyName: Zeichenfolge, Wert: Doppelt)

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

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    propertyName Zeichenfolge Name der Anwendereigenschaft, die erhöht werden soll.
    Wert Doppelt Wert, um den die Eigenschaft erhöht werden soll. Geben Sie einen negativen Wert ein, um den Wert zu verringern.
    Tabelle : 17. Rückgaben
    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)

    Aktiviert den Aufruf von JavaScript.SNMobileAnalytics-Methoden aus einem {@Link android.Webkit.WebView} mit JavaScript.

    Tabelle : 18. Parameter
    Name Typ Beschreibung
    Webansicht WKWebView Der {@Link android.Webkit.WebView}, an den angehängt werden soll.
    Tabelle : 19. Rückgaben
    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: Zeichenfolge)

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

    Tabelle : 20. Parameter
    Name Typ Beschreibung
    propertyName Zeichenfolge Name der zu löschenden Anwendereigenschaft.
    Tabelle : 21. Rückgaben
    Typ Beschreibung
    Keine

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

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

    NowAnalyticsSDK – setListener(nowAnalyticsListener: NowAnalyticsListener?)

    Legt einen Listener für die Ereignisse von NowAnalytics 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, über die NowAnalytics über Sitzungsereignisse benachrichtigt.
    • OnNowAnalyticsScreenDetected: Wird aufgerufen, wenn NowAnalytics automatisch einen Bildschirm erkennt.
    • OnNowAnalyticsSessionEnded: Wird nach dem Ende einer Sitzung aufgerufen.
    • OnNowAnalyticsSessionEnding: Wird kurz vor dem Abschluss 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. Rückgaben
    Typ Beschreibung
    Keine

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

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

    NowAnalyticsSDK – setTrackingConsent(consentGiven: Boolescher Wert)

    Legt die Einwilligungsantwort des aktuellen Anwenders auf die Analytics-Nachverfolgung fest.

    Tabelle : 24. Parameter
    Name Typ Beschreibung
    EinwilligungGiven Boolean Kennzeichnung, die die Zustimmung des aktuellen Anwenders zur Nachverfolgung von Analytics angibt.
    Gültige Werte:
    • Wahr: Der Anwender hat der Nachverfolgung seiner Daten zugestimmt.
    • Falsch: Anwender hat die Nachverfolgung seiner Daten deaktiviert.
    Tabelle : 25. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Einwilligungsantwort des aktuellen Anwenders auf die Analytics-Nachverfolgung festzulegen.

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

    NowAnalyticsSDK – setUserId(userid: Zeichenfolge)

    Legt den anwendungsspezifischen Anwenderbezeichner fest. Übergeben Sie null, um den aktuellen Anwender abzumelden.

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

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um den anwendungsspezifischen Anwenderbezeichner 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 Anwender fest. Eigenschaften können alles sein, was Sie im Dashboard für einen Anwender nachverfolgen möchten.

    Um den aktuellen Anwender festzulegen, rufen Sie auf NowAnalyticsSDK – setUserId(userid: Zeichenfolge) Funktion.

    Tabelle : 28. Parameter
    Name Typ Beschreibung
    Anwendereigenschaften MutableMap Schlüssel-Wert-Paare der festzulegenden Anwendereigenschaften.
    Unterstützte Werttypen:
    • Anzahl
    • Zeichenfolgen
    • Datum
    • URL
    • Null
    Tabelle : 29. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um mehrere Eigenschaften für den aktuellen Anwender 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: Zeichenfolge, propertyValue: Beliebig)

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

    Um den aktuellen Anwender festzulegen, rufen Sie auf NowAnalyticsSDK – setUserId(userid: Zeichenfolge) Funktion.

    Tabelle : 30. Parameter
    Name Typ Beschreibung
    propertyName Zeichenfolge Name der festzulegenden Anwendereigenschaft.
    Wert Beliebig Wert, auf den die Anwendereigenschaft festgelegt werden soll.
    Unterstützte Werttypen:
    • Anzahl
    • Zeichenfolgen
    • Datum
    • URL
    • Null
    Tabelle : 31. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Eigenschaft „role“ für den aktuellen Anwender auf „Administrator“ festzulegen.

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

    NowAnalyticsSDK – startScreen(Screenname: Zeichenfolge)

    Protokolliert den Zeitpunkt, zu dem der zugehörige Bildschirm erstmals in der Anwenderoberfläche angezeigt wird.

    Sie rufen diese Methode normalerweise aus der Aktivität auf OnResume() Methode.

    Tabelle : 32. Parameter
    Name Typ Beschreibung
    Benannter 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/aggregieren möchten.
    Tabelle : 33. Rückgaben
    Typ Beschreibung
    Keine

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

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