Interface NowAnalyticsSDK : Android

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 8 minutes de lecture

    • L’interface du Kit de développement logiciel (SDK) Now AnalyticsSDK fournit des fonctions qui vous permettent de configurer les propriétés d’analyse, les paramètres utilisateur et les événements pour la gestion d’une collection de données d’analyse utilisateur.

    Tableau 1. Propriétés
    Nom Type Description
    configuration Configuration Now ServiceConfiguration Configuration à associer au service.

    NowAnalyticsSDK : addEvent(eventName : chaîne)

    Ajoute un événement d’application, par exemple lorsqu’un utilisateur atteint un niveau ou un écran spécifique. Ces événements apparaissent sur le tableau de bord dans l’ordre dans lequel ils se sont produits.

    Tableau 2. Paramètres
    Nom Type Description
    eventName nommé Chaîne Nom de l’événement à ajouter.
    Tableau 3. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour ajouter un événement d’application.

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

    Kit de développement logiciel (SDK) NowAnalytics : addEvent(eventName : String, props : MutableMap<String, Any>)

    Ajoute un événement d’application, par exemple lorsqu’un utilisateur atteint un niveau ou un écran spécifique, et active la définition de propriétés personnalisées sur l’événement. Ces événements apparaissent sur le tableau de bord dans l’ordre dans lequel ils se sont produits.

    Tableau 4. Paramètres
    Nom Type Description
    eventName Chaîne Nom de l’événement à ajouter.
    propriétés MutableMap (en anglais seulement) Paires clé-valeur de propriété personnalisées pour l’événement.

    La taille totale du nom d’événement, de la clé de propriété et de la valeur ne peut pas dépasser 300 octets par propriété. Les propriétés qui dépassent cette limite sont ignorées. Les clés de propriété ne doivent pas contenir de signe de point (« . ») ou de dollar (« $ »), si c’est le cas, elles sont tronquées. Les chaînes sont codées en UTF-8.

    Types de valeurs pris en charge :
    • Entier
    • Double
    • Flottant
    • Chaîne
    • URL
    • Booléen
    • Date
    Tableau 5. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour ajouter un événement d’application qui inclut des propriétés personnalisées pour l’événement.

    // 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 : chaîne)

    Ajoute une action personnalisée. Ces actions apparaissent dans le tableau de bord de l’utilisateur dans le cadre des données de session et décrivent un changement d’écran dans une application.

    Tableau 6. Paramètres
    Nom Type Description
    actionName Chaîne Nom de l’action à ajouter à l’écran, par exemple MyButtonClick.
    Tableau 7. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour ajouter une action personnalisée à l’écran actuel.

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

    NowAnalyticsSDK : appendToUserProperty(propertyName : chaîne, élément : chaîne)

    Ajoute l’élément spécifié à la liste de propriétés de l’utilisateur spécifié.

    Tableau 8. Paramètres
    Nom Type Description
    propertyName Chaîne Nom de la propriété d’utilisateur à laquelle ajouter l’élément de liste.
    élément Chaîne Élément de liste à ajouter à la propriété.
    Tableau 9. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour ajouter un ticket à la liste spécifiée.

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

    NowAnalyticsSDK : configure(instanceURL : URL, configureCallbacks : ConfigureCallbacks ?)

    Configure l’URL d’instance spécifiée ServiceNow et les rappels à Now Analytics.

    Une fois que cette méthode est appelée, la configuration réelle est extraite de l’instance associée ServiceNow et synchronisée automatiquement.

    Tableau 10. Paramètres
    Nom Type Description
    instanceURL URL URL de l’instance ServiceNow à associer au service NowAnalyticfs.
    configureCallbacks ConfigureCallbacks Facultatif. Rappel à exécuter en cas d’erreur de communication à l’instance ServiceNow . Ce rappel peut être appelé à tout moment et peut être appelé plusieurs fois pour plusieurs raisons.
    Tableau 11. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour configurer l’instance spécifiée.

    // 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()

    Supprime toutes les données locales et distantes de l’utilisateur actuel.

    Cette méthode annule également l’utilisateur actif actuel et désinscrit cet appareil du suivi d’analyse futur.
    Remarque :
    Cette méthode effectue un appel synchrone aux serveurs SNAnalytics. Il est donc recommandé de l’effectuer sur un filetage latéral.
    Tableau 12. Paramètres
    Nom Type Description
    Aucun
    Tableau 13. Renvoie
    Type Description
    Booléen Marqueur indiquant si la suppression a réussi.
    Valeurs possibles :
    • true : la suppression a réussi.
    • false : échec de la suppression. Une défaillance peut se produire si les serveurs SNAnalytics ne sont pas accessibles, par exemple en l’absence de connectivité. La méthode doit être réessayée.

    L’exemple de code suivant montre comment appeler cette fonction pour supprimer les données de l’utilisateur actuel.

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

    NowAnalyticsSDK : getTrackingConsent()

    Renvoie la réponse de consentement de l’utilisateur actuel au suivi de l’analyse.

    Tableau 14. Paramètres
    Nom Type Description
    Aucun
    Tableau 15. Renvoie
    Type Description
    Booléen Marqueur indiquant si l’utilisateur actuel a consenti à ce que ses données soient collectées.
    Valeurs possibles :
    • true : l’utilisateur a accepté que ses données soient collectées.
    • false : l’utilisateur s’est désabonné de la collecte de ses données.

    L’exemple de code suivant montre comment appeler cette fonction pour demander la réponse de consentement de l’utilisateur actuel au suivi analytique.

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

    NowAnalyticsSDK : incUserProperty(propertyName : chaîne, valeur : double)

    Incrémente ou diminue la valeur de la propriété numérique spécifiée de la valeur spécifiée.

    Tableau 16. Paramètres
    Nom Type Description
    propertyName Chaîne Nom de la propriété utilisateur à incrémenter.
    valide Double Valeur d’incrémentation de la propriété. Entrez une valeur négative pour décrémenter la valeur.
    Tableau 17. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction.

    // 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)

    Active l’appel des méthodes javaScript.SNMobileAnalytics à partir d’un {@link android.webkit.WebView}, à l’aide de JavaScript.

    Tableau 18. Paramètres
    Nom Type Description
    webView WKWebView (en anglais seulement) Le {@link android.webkit.WebView} auquel joindre
    Tableau 19. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour activer l’appel des méthodes javaScript.SNMobileAnalytics.

    // 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 : chaîne)

    Supprime la propriété spécifiée pour l’utilisateur actuel.

    Tableau 20. Paramètres
    Nom Type Description
    propertyName Chaîne Nom de la propriété de l’utilisateur à supprimer.
    Tableau 21. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour supprimer la propriété « Tickets temporaires ».

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

    NowAnalyticsSDK : setListener(nowAnalyticsListener : NowAnalyticsListener ?)

    Définit un écouteur sur les événements Now Analytics tels que les changements de session et les détections automatiques d’écran.

    Remarque :
    Chaque fois que vous appelez cette méthode, l’écouteur est remplacé.
    Tableau 22. Paramètres
    Nom Type Description
    nowAnalyticsListener NowAnalyticsListener Interface que NowAnalytics notifie pour les événements de session.
    • onNowAnalyticsScreenDetected : appelée lorsque NowAnalytics détecte automatiquement un écran.
    • onNowAnalyticsSessionEnded : appelé après la fin d’une session.
    • onNowAnalyticsSessionEnding : appelé juste avant la fin d’une session, ce qui vous permet d’empêcher la session de se terminer.
    • onNowAnalyticsSessionStarted : appelé lorsqu’une session a démarré.
    • onNowAnalyticsSessionStarting : appelé juste avant le démarrage d’une session, ce qui vous permet d’empêcher le démarrage de la session.
    Tableau 23. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour définir NowAnalyticsListener().

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

    NowAnalyticsSDK : setTrackingConsent(consentGiven : booléen)

    Définit la réponse de consentement de l’utilisateur actuel sur le suivi analytique.

    Tableau 24. Paramètres
    Nom Type Description
    consentDonné Booléen Marqueur indiquant le consentement de l’utilisateur actuel au suivi analytique.
    Valeurs valides :
    • true : l’utilisateur a consenti au suivi de ses données.
    • false : l’utilisateur a choisi de ne pas que ses données soient suivies.
    Tableau 25. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour définir la réponse de consentement de l’utilisateur actuel sur le suivi de l’analyse.

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

    NowAnalyticsSDK : setUserId(userId : chaîne)

    Définit l’identificateur d’utilisateur propre à l’application. Transmettez nil pour déconnecter l’utilisateur actuel.

    Tableau 26. Paramètres
    Nom Type Description
    userId Chaîne Identificateur d’utilisateur unique propre à l’application. Cet identificateur est utilisé pour regrouper les rapports relatifs à cet utilisateur dans le tableau de bord.
    Tableau 27. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour définir l’identificateur d’utilisateur spécifique à l’application sur « John Doe ».

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

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

    Définit plusieurs propriétés avec les valeurs spécifiées pour l’utilisateur actuel. Les propriétés peuvent être tout ce que vous souhaitez suivre sur le tableau de bord pour un utilisateur.

    Pour définir l’utilisateur actuel, appelez la NowAnalyticsSDK : setUserId(userId : chaîne) fonction.

    Tableau 28. Paramètres
    Nom Type Description
    UserProperties (en anglais seulement) MutableMap (en anglais seulement) Paires clé-valeur des propriétés utilisateur à définir.
    Types de valeurs pris en charge :
    • Numéro
    • Chaînes
    • Date
    • URL
    • Zéro
    Tableau 29. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour définir plusieurs propriétés pour l’utilisateur actuel.

    // 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 : chaîne, propertyValue : tout)

    Définit la propriété spécifiée avec la valeur spécifiée pour l’utilisateur actuel. Les propriétés peuvent être tout ce que vous souhaitez suivre sur le tableau de bord pour un utilisateur.

    Pour définir l’utilisateur actuel, appelez la NowAnalyticsSDK : setUserId(userId : chaîne) fonction.

    Tableau 30. Paramètres
    Nom Type Description
    propertyName Chaîne Nom de la propriété utilisateur à définir.
    valide N'importe lequel Valeur sur laquelle définir la propriété d’utilisateur.
    Types de valeurs pris en charge :
    • Numéro
    • Chaînes
    • Date
    • URL
    • Zéro
    Tableau 31. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour définir la propriété « Rôle » sur « Administrateur » pour l’utilisateur actuel.

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

    NowAnalyticsSDK : startScreen(screenName : chaîne)

    Consigne l’heure à laquelle l’écran associé apparaît pour la première fois dans l’interface utilisateur.

    Vous appelez généralement cette méthode à partir de la méthode onResume() de l’activité.

    Tableau 32. Paramètres
    Nom Type Description
    screenName nommé Chaîne Nom de l’écran pour lequel journaliser l’heure de début, par exemple WelcomeScreen. Il peut s’agir de tout ce que vous souhaitez définir comme un écran et afficher/regrouper sur un tableau de bord d’analyse.
    Tableau 33. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction pour définir l’heure de début de l’affichage du « WelcomeScreen ».

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