Interface du Kit de développement logiciel (SDK) Now Analytics : Android

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

Kit de développement logiciel (SDK) Now Analytics : 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
Néant

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) NowAnalyticsAdd Event(eventName : chaîne, propriétés : MutableMap<String, Any>)

Ajoute un événement d’application, par exemple un utilisateur atteignant 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 signes de point ('.') ou de dollar ('$'), si c’est le cas, elles sont tronquées. Les chaînes sont encodées en UTF-8. Types de valeurs pris en charge : Entier Double Flottant Chaîne URL Booléen Date

Tableau 5. Renvoie
Type	Description
Néant

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

Kit de développement logiciel (SDK) Now Analytics : addScreenAction(actionName : chaîne)

Ajoute une action personnalisée. Ces actions s’affichent 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
Néant

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

Kit de développement logiciel (SDK) Now Analytics : appendToUserProperty(propertyName : chaîne, élément : chaîne)

Ajoute l’élément spécifié à la liste des propriétés d’utilisateur spécifiée.

Tableau 8. Paramètres
Nom	Type	Description
Propertyname	Chaîne	Nom de la propriété 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
Néant

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

Kit de développement logiciel (SDK) NowAnalyticsNow : configure(instanceURL : URL, configureCallbacks : ConfigureCallbacks ?)

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

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

Tableau 10. Paramètres
Nom	Type	Description
URL d’instance	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
Néant

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

Kit de développement logiciel (SDK) NowAnalyticsNow : deleteCurrentUserData()

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

Cette méthode annule également la définition de l’utilisateur actif actuel et désactive cet appareil du suivi des analyses futures.

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

Kit de développement logiciel (SDK) Now Analytics : getTrackingConsent()

Renvoie la réponse de consentement de l’utilisateur actuel au suivi d’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 d’analyse.

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

Kit de développement logiciel (SDK) Now Analytics : incUserProperty(propertyName : chaîne, valeur : double)

Incrémente ou décrémente la valeur de la propriété numérique spécifiée par 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é. Saisissez une valeur négative pour décrémenter la valeur.

Tableau 17. Renvoie
Type	Description
Néant

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)

Kit de développement logiciel (SDK) NowAnalyticsNow Analytics : installJavascriptInterface(webView : WebView)

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

Tableau 18. Paramètres
Nom	Type	Description
Webview	WKWebView	{@link android.webkit.WebView} à joindre.

Tableau 19. Renvoie
Type	Description
Néant

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)

Kit de développement logiciel (SDK) Now Analytics : removeUserProperty(propertyName : String)

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é utilisateur à supprimer.

Tableau 21. Renvoie
Type	Description
Néant

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

Kit de développement logiciel (SDK) NowAnalytics : setListener(nowAnalyticsListener : NowAnalyticsListener ?)

Définit un écouteur sur les événements NowAnalytics 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 (en anglais seulement)	NowAnalyticsListener	Interface que NowAnalytics notifie pour les événements de session. onNowAnalyticsScreenDetected : appelé 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ébut d’une session, ce qui vous permet d’empêcher le démarrage de la session.

Tableau 23. Renvoie
Type	Description
Néant

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

Kit de développement logiciel (SDK) NowAnalyticsNow Analytics : setTrackingConsent(consentGiven : booléen)

Définit la réponse de consentement de l’utilisateur actuel au suivi d’analyse.

Tableau 24. Paramètres
Nom	Type	Description
consentementdonné	Booléen	Marqueur qui indique le consentement de l’utilisateur actuel au suivi de l’analyse. Valeurs valides : true : l’utilisateur a consenti au suivi de ses données. false : l’utilisateur a choisi de ne pas faire suivre ses données.

Tableau 25. Renvoie
Type	Description
Néant

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

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

Kit de développement logiciel (SDK) NowAnalyticsNow Analytics : setUserId(userId : chaîne)

Définit l’identificateur d’utilisateur spécifique à l’application. Transmettez Nil pour déconnecter l’utilisateur actuel.

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

Tableau 27. Renvoie
Type	Description
Néant

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

Kit de développement logiciel (SDK) Now Analytics : 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 Kit de développement logiciel (SDK) NowAnalyticsNow Analytics : setUserId(userId : chaîne) fonction.

Tableau 28. Paramètres
Nom	Type	Description
UserProperties (propriétés de l’utilisateur)	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 Null

Tableau 29. Renvoie
Type	Description
Néant

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

Kit de développement logiciel (SDK) NowAnalyticsNow Analytics : setUserProperty(propertyName : String, propertyValue : Any)

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.