NowAnalyticsSDK-Schnittstelle – Android

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 7 Minuten Lesedauer

    • Die NowAnalyticsSDK- Schnittstelle bietet Funktionen, mit denen Sie Analytics-Eigenschaften, Anwendereinstellungen und Ereignisse zum Verwalten einer Sammlung von User Analytics-Daten konfigurieren können.

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

    NowAnalyticsSDK – addEvent(eventName: String)

    Fügt ein Anwendungsereignis hinzu, z. B. das Erreichen einer bestimmten Ebene oder eines bestimmten Bildschirms durch einen Benutzer. Diese Ereignisse werden im Dashboard in der Reihenfolge ihres Auftretens angezeigt.

    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 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. das Erreichen einer bestimmten Ebene oder eines bestimmten Bildschirms durch einen Benutzer, und ermöglicht das Festlegen benutzerdefinierter Eigenschaften für das Ereignis. Diese Ereignisse werden im Dashboard in der Reihenfolge ihres Auftretens angezeigt.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    eventName Zeichenfolge Name des hinzuzufügenden Ereignisses.
    Eigenschaften veränderbareZuordnung Schlüssel-Wert-Paare der anwenderdefinierten Eigenschaft für das Ereignis.

    Die Gesamtgröße von Ereignisname, Eigenschaftsschlüssel und Wert darf 300 Byte pro Eigenschaft nicht überschreiten. Eigenschaften, die diese Grenze überschreiten, werden ignoriert. Eigenschaftsschlüssel dürfen keine Punkte ('.') oder Dollars ('$') 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 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: String)

    Fügt eine anwenderdefinierte 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 anwenderdefinierte 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 Anwendereigenschaftenliste 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. 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 – konfigurieren(instanceURL: URL, konfigurierenCallbacks: KonfigurierenRückrufe?)

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

    Nach dem Aufrufen dieser Methode wird die tatsächliche Konfiguration aus der zugehörigen 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.
    Rückrufe konfigurieren Konfigurieren Sie Rückrufe Optional. Auszuführender Rückruf, wenn bei der Kommunikation mit der Instanz ServiceNow ein Fehler auftritt. Dieser Rückruf kann zu jedem Zeitpunkt und aus verschiedenen 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 Anwender.

    Diese Methode löscht auch den derzeit aktiven Anwender und deaktiviert die zukünftige Analytics-Nachverfolgung dieses Geräts.
    Hinweis:
    Diese Methode führt einen synchronen Aufruf an die SNAnalytics-Server durch. Es wird daher empfohlen, dies in einem 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öschen war erfolgreich.
    • „falsch“: Fehler beim Löschen. Ein Fehler kann auftreten, wenn die SNAnalytics-Server nicht erreicht werden können, z. B. wenn keine Verbindung 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 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 der Erfassung seiner Daten zugestimmt.
    • false: Der Anwender hat die Erfassung seiner Daten deaktiviert.

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird, um die Zustimmung des aktuellen Anwenders zur 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 zu inkrementierenden Anwendereigenschaft.
    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)

    Aktiviert 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 aktivieren.

    // 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 – entfernen Sie AnwenderProperty(propertyName: String)

    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. Ergebnisse
    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 NowAnalytics-Ereignisse wie Sitzungsänderungen und automatische Bildschirmerkennungen fest.

    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 von NowAnalytics bei Sitzungsereignissen benachrichtigt wird.
    • onNowAnalyticsScreenDetected: Wird aufgerufen, wenn NowAnalytics automatisch einen Bildschirm erkennt.
    • onNowAnalyticsSessionEnded: Wird nach dem Ende 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 den Start der Sitzung verhindern können.
    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 Analytics-Nachverfolgung fest.

    Tabelle : 24. Parameter
    Name Typ Beschreibung
    KonsensGiven Boolean Kennzeichnung, die die Einwilligung des aktuellen Anwenders zur Analytics-Nachverfolgung angibt.
    Gültige Werte:
    • „wahr“: Der Anwender hat der Nachverfolgung seiner Daten zugestimmt.
    • „falsch“: Der Anwender 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 Anwenders für die Analytics-Nachverfolgung festzulegen.

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

    NowAnalyticsSDK – setUserId(userId: String)

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

    Tabelle : 26. Parameter
    Name Typ Beschreibung
    userId Zeichenfolge Eindeutiger, anwendungsspezifischer Anwender-Bezeichner. 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 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 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 veränderbareZuordnung Schlüssel-Wert-Paare der festzulegenden Anwendereigenschaften.
    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 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: String, 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 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 Anwendereigenschaft.
    Wert Beliebig Wert, auf den die Anwendereigenschaft 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 Anwender auf „Administrator“ 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 Anwenderoberflä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. WillkommensBildschirm. 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 für die 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")