NowAnalyticsService-Protokoll – iOS

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

    • Das NowAnalyticsService- Protokoll stellt Funktionen bereit, mit denen Sie Analytics-Eigenschaften, Anwendereinstellungen und Ereignisse für die Verwaltung der Sammlung von User Analytics-Daten konfigurieren können.

    Ein Objekt, das diesem Protokoll entspricht, wird von SharedAnalyticsService zurückgegeben. Verwenden Sie ihn in Ihrer Anwendung, um API-Aufrufe durchzuführen.

    Tabelle : 1. Anforderungen
    Name Typ Beschreibung
    verfolgungZustimmung Boolean Kennzeichnung, die angibt, ob der Anwender der Analytics-Nachverfolgung für das zugeordnete Gerät zugestimmt hat. Standardmäßig sind Geräte deaktiviert. Wenn Sie diesen Wert explizit auf „ false “ festlegen, werden laufende Sitzungen sofort beendet und die lokal aufgezeichneten Daten gelöscht.
    Gültige Werte:
    • „wahr“: Der Anwender hat der Nachverfolgung von Analytics-Daten auf diesem Gerät zugestimmt.
    • „falsch“: Dem Anwender wurde die Datenverfolgung verweigert.

    NowAnalyticsService – addEvent(named eventName: Zeichenfolge, mit Eigenschaften: [Zeichenfolge: Beliebig]?)

    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.

    Diese Ereignisse werden in Ihrem Analytics-Dashboard angezeigt.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    namens eventName Zeichenfolge Name des hinzuzufügenden Ereignisses.
    mit Eigenschaften Array Optional. Schlüssel-Wert-Paare der anwenderdefinierten Eigenschaft für das Ereignis. Eigenschaftsschlüssel dürfen die Zeichen Punkt ('.') und Dollar ('$') nicht enthalten. Sie werden gekürzt.
    Unterstützte Werttypen:
    • Datum
    • NSNull
    • NSNumber
    • Zeichenfolgen
    • URL
    Hinweis:
    Die Gesamtgröße von eventName, des Eigenschaftsschlüssels und des Werts darf 300 Byte (pro Ereignis) nicht überschreiten. Zeichenfolgen sind UTF-8-codiert. Ereignisse, die diese Grenze überschreiten, werden ignoriert.
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein Ereignis „Erfolgreiche Anmeldung“ und ein Ereignis „Fall öffnen“ mit Eigenschaften hinzugefügt werden.

    // Add event with properties
NowAnalytics.sharedAnalyticsService.addEvent(
  named: "Open Case", with: ["Screen Name": "Case",
                             "Case Number": "123",
                             "Case Priority": 5
])

    NowAnalyticsService – addScreenAction(named actionName: String)

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

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    benannt actionName Zeichenfolge Name der Aktion, die dem Bildschirm hinzugefügt werden soll, z. B. MyButtonClick.

    Maximale Länge: 256 UTF-8 Byte
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    Keine 

    // Add event
NowAnalytics.sharedAnalyticsService.addEvent(named: "Successful Login")

    NowAnalyticsService – appendToUserProperty(named propertyName: String, listItem: String)

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

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    namens propertyName Zeichenfolge Name der Anwendereigenschaftenliste, an die listItem angehängt werden soll.
    listItem Zeichenfolge Listenelement, das an die Eigenschaft angehängt werden soll.
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Keine 

    // Append handled case to list
NowAnalytics.sharedAnalyticsService.appendToUserProperty(named: "Case Identifiers", listItem: "TASK-1")

    NowAnalyticsService – löschenCurrentUserData(Abschluss: @escaping ((_ Erfolg: Bool) -> Void))

    Löscht alle Analytics-Daten, die dem aktuellen Anwender zugeordnet sind. Diese Methode löscht auch den aktuell aktiven Anwender und deaktiviert die zukünftige Nachverfolgung dieses Geräts.

    Um den aktuellen Benutzer festzulegen, verwenden Sie die Methode „setUserId() “.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Abschluss @escaping ((_ erfolgreich: Boolesch) -> Ungültig) Abschluss-Handler, der ausgeführt werden soll, nachdem die Analytics-Daten gelöscht wurden.
    Rückgabewerte für Abschluss-Handler:
    • Erfolg: Gibt den booleschen Wert „true“ zurück.
    • Fehler: ungültig – Ein Fehler kann auftreten, wenn die Appsee-Server nicht erreicht werden können, z. B. wenn keine Konnektivität vorhanden ist. Wenn ein Fehler auftritt, wiederholen Sie die -Methode.
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    Keine 

    // Delete user data
NowAnalytics.sharedAnalyticsService.deleteCurrentUserData(completion: { (success) -> Void in
  if success {
    // deletion succeeded
  } else {
    // deletion failed
  }
})

    NowAnalyticsService – incUserProperty(named propertyName: String, by value: Int)

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

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    namens propertyName Zeichenfolge Name der zu inkrementierenden Anwendereigenschaft.
    nach Wert Ganzzahl Wert, um den die Eigenschaft erhöht werden soll. Geben Sie einen negativen Wert ein, um den Wert zu verringern.
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    Keine 

    // Increment the "Cases Handled" count
NowAnalytics.sharedAnalyticsService.incUserProperty(named: "Cases Handled", by: 2)

    NowAnalyticsService – installJavascriptInterface(into webView: WKWebView)

    Aktiviert den Aufruf der Methoden in der SNAnalytics()- API aus einem WebView mit JavaScript.

    Diese Methode gibt ein in JavaScript verfügbares SNMobileAnalytics -Objekt zurück, das die nativen Methoden verfügbar macht.

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    webView WKWebView Webansichtsobjekt, in das die JavaScript-Schnittstelle eingefügt werden soll.
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    Objekt SNMobileAnalytics 

    // Register JS object inside the web page
// This will create an object named 'SNMobileAnalytics' on JS that will have 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}))
NowAnalytics.sharedAnalyticsService.installJavascriptInterface(into: webView)

    NowAnalyticsService – entfernenUserProperty(named propertyName: Zeichenfolge)

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

    Um den aktuellen Benutzer festzulegen, verwenden Sie die Methode „setUserId() “.

    Tabelle : 14. Parameter
    Name Typ Beschreibung
    namens propertyName Zeichenfolge Name der zu löschenden Anwendereigenschaft.
    Tabelle : 15. Ergebnisse
    Typ Beschreibung
    Keine 

    // Remove unnecessary property
NowAnalytics.sharedAnalyticsService.removeUserProperty(named: "Temp Cases")

    NowAnalyticsService – setDelegate(_ delegierter: NowAnalyticsServiceDelegate?)

    Legt eine schwache Referenz für einen Delegierten fest, der Benachrichtigungen erhalten soll.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    Delegierter NowAnalyticsServiceDelegierter Optional. Objekt, das den Verweis auf die Delegiertenklasse enthält.
    // Register delegate
private var analyticsDelegate = NowAnalyticsDelegate()  // Keep ref of delegate
NowAnalytics.sharedAnalyticsService.setDelegate(analyticsDelegate)
    Tabelle : 17. Ergebnisse
    Typ Beschreibung
    Keine

    In diesem Beispiel wird gezeigt, wie eine Delegiertenklasse für NowAnalyticsServiceDelegatedefiniert wird.

    // Define a delegate class for NowAnalyticsServiceDelegate
class NowAnalyticsDelegate: NowAnalytics.NowAnalyticsServiceDelegate {
  func nowAnalyticsSessionShouldStart() -> Bool {
    // Session is about to start, return true to allow session to start
    return true
  }

  func nowAnalyticsSessionDidStart(_ sessionId: String) {
    // Session was started
  }

  func nowAnalyticsSessionShouldEnd(_ sessionId: String) -> Bool {
    // Session is about to end, return true to allow session to end
    return true
  }

  func nowAnalyticsSessionDidEnd(_ sessionId: String) {
    // Session was ended
  }

  func nowAnalyticsDidDetectScreen(_ screenName: String) -> String? {
    // Example of skipping specific screen detection
    if (screenName == "LoginViewController") {
      return nil
    }

    // Example of appending a prefix for every screen detected
    return "MyApp_" + screenName
  }
}

// Register delegate
private var analyticsDelegate = NowAnalyticsDelegate()  // Keep ref of delegate
NowAnalytics.sharedAnalyticsService.setDelegate(analyticsDelegate)

    NowAnalyticsService – setUserId(_ userId: Zeichenfolge?)

    Legt die Anwender-ID der Anwendung für den aktuellen Anwender fest. Übergeben Sie nil, um den aktuellen Anwender abzumelden.

    Tabelle : 18. Parameter
    Name Typ Beschreibung
    userId Zeichenfolge Optional. Anwendungsspezifischer Benutzerbezeichner.

    Um den aktuellen Anwender abzumelden, übergeben Sie nil.

    Die Anwender-ID darf keine HTML-Tags oder personenbezogenen Daten wie Name, E-Mail-Adresse oder Telefonnummer enthalten.

    Maximale Länge: 256 UTF-8 Byte
    Tabelle : 19. Ergebnisse
    Typ Beschreibung
    Keine 

    // Add several properties at once
NowAnalytics.sharedAnalyticsService.setUserProperties([
  "Cases Handled": 100,
  "Last Login": Date(),
  "Is Remote": true,
  "Profile URL": URL(string: "https://www.servicenow.com")!
])

    NowAnalyticsService – setUserProperties(_ userProperties: [Zeichenfolge: Beliebig])

    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.

    Sie müssen die Funktion „setUserId()“ aufrufen, bevor Sie diese Funktion aufrufen.

    Tabelle : 20. Parameter
    Name Typ Beschreibung
    userProperties Array Schlüssel-Wert-Paare der festzulegenden Anwendereigenschaften.
    Unterstützte Werttypen:
    • NSNumber
    • Zeichenfolgen
    • Datum
    • URL
    • NSNull

    Schlüssel darf keine Punkte ('.') oder Dollarzeichen ('$') enthalten.

    Maximale Länge:
    • Schlüssel: 256 Zeichen
    • Wert: 1.000 Zeichen
    Tabelle : 21. Ergebnisse
    Typ Beschreibung
    Keine 

    import NowAnalytics

// Initialize the Analytics SDK
NowAnalytics.configure(for: URL(string: "https://my.instance.service-now.com")!)

// Enable tracking consent
NowAnalytics.sharedAnalyticsService.trackingConsent = true

// Set User Id for proper identification
NowAnalytics.sharedAnalyticsService.setUserId("John Doe")

// Set the "Role" property of the user to "Admin"
NowAnalytics.sharedAnalyticsService.setUserProperty(named: "Role", with: "Admin")

// Add several properties at once
NowAnalytics.sharedAnalyticsService.setUserProperties([
    "Cases Handled": 100,
    "Last Login": Date(),
    "Is Remote": true,
    "Profile URL": URL(string: "https://www.servicenow.com")!
])

    NowAnalyticsService – setUserProperty(named propertyName: String, with value: Any?)

    Legt die angegebene Eigenschaft mit dem angegebenen Wert für den aktuellen Anwender fest. Sie können jede Eigenschaft definieren, die für Ihre Anwendung sinnvoll ist.

    Sie müssen die Funktion „setUserId()“ aufrufen, bevor Sie diese Funktion aufrufen.

    Tabelle : 22. Parameter
    Name Typ Beschreibung
    namens propertyName Zeichenfolge Name der festzulegenden Anwendereigenschaft. Darf keine Punkte ('.') oder Dollar ('$') enthalten.

    Maximale Länge: 256 Zeichen
    mit Wert Beliebig Wert, auf den die Anwendereigenschaft festgelegt werden soll.
    Unterstützte Werttypen:
    • Datum
    • NSNull
    • NSNumber
    • Zeichenfolgen
    • URL

    Maximale Länge: 1.000 Zeichen
    Tabelle : 23. Ergebnisse
    Typ Beschreibung
    Keine 

    // Set the "Role" property of the user to "Admin"
NowAnalytics.sharedAnalyticsService.setUserProperty(named: "Role", with: "Admin")

    NowAnalyticsService – startScreen(named screenName: String)

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

    Rufen Sie diese Methode nach der Methode viewDidAppear(_:) auf.

    Tabelle : 24. 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.

    Maximale Länge: 256 UTF-8 Byte
    Tabelle : 25. Ergebnisse
    Typ Beschreibung
    Keine 

    // Mark the appearance starting time of a screen
// This method should be usually called from the viewDidAppear
NowAnalytics.sharedAnalyticsService.startScreen(named: "WelcomeScreen")