SDK API Guide

Définir l'identification de l'utilisateur

Définition de l'interface

• identifyAccount(user) ;
  • Description de l'interface :
    • Définit l'identification de l'utilisateur, comme un numéro de carte de membre.
  • Description des paramètres :
    • identity : L'identifiant de l'utilisateur.
    • completion : Le callback.

Exemple d'appel

              
                  let user = {completion: (code, message) => {}, identity: {"id": "value"}}
    window.MAInterface.identifyAccount(user)

            

Obtenir l'EUID

Définition de l'interface

• EUID()
  • Description de l'interface :
    • Obtient l'EUID de EngageLab MA.

Exemple d'appel

              
                  window.MAInterface.EUID((code, euid) => {
        console.log(code, euid)
    })

            

Définir les informations de contact de l'utilisateur

Définition de l'interface

• setUserContact(user)
  • Description de l'interface :
    • Permet de définir plusieurs moyens de contact simultanément. La clé représente le nom du moyen de contact, et la valeur représente sa valeur correspondante. Actuellement, 4 types de moyens de contact sont pris en charge : email, mobile_phone, landline_phone et whatsapp_phone.
  • Description des paramètres :
    • contacts : Les informations de contact de l'utilisateur.
    • completion : Le callback.

Exemple d'appel

              
                    let user = {
          completion: (code, message) => { },
          contacts: {}
       }
      user.contacts["Nom du moyen de contact"] = "Valeur du moyen de contact"   // Par exemple : mobile_phone = 18800000000
      window.MAInterface.setUserContact(user)

            

Définir les propriétés UTM

Définition de l'interface

• setUtmProperties(attrs:any)
  • Description de l'interface :
    • Les propriétés UTM sont des propriétés d'événement standard. Si les développeurs peuvent identifier quelle publicité a dirigé l'utilisateur vers l'App, il est recommandé de définir les informations UTM. Ce paramètre sera inclus lors du reporting des événements. Actuellement, les propriétés UTM pouvant être définies sont :
      • utm_source : La source de la campagne publicitaire.
      • utm_medium : Le support de la campagne publicitaire.
      • utm_term : Le terme de la campagne publicitaire.
      • utm_content : Le contenu de la campagne publicitaire.
      • utm_campaign : Le nom de la campagne publicitaire.
      • utm_id : L'ID de la campagne publicitaire.

Exemple d'appel

              
                 window.MAInterface.setUtmProperties({"utm_source": "value1"})

            

Définir les propriétés utilisateur

Définissez les valeurs des propriétés utilisateur. Si une propriété utilisateur n'existe pas, elle sera automatiquement créée en arrière-plan.

Écraser et mettre à jour les propriétés utilisateur

• setProperty(user, completion)
  • Description de l'interface :
    • Écrase et met à jour les valeurs des propriétés utilisateur.
    • Seules les dernières données transmises sont conservées, remplaçant les données historiques, comme le niveau d'adhésion de l'utilisateur.
    • Le contenu de ces propriétés utilisateur est stocké dans un objet. La clé est le nom de la propriété utilisateur et doit être une chaîne de caractères. La valeur est le contenu de la propriété utilisateur et prend en charge uniquement les types string, number et Array.
    • Actuellement, les éléments de la valeur de type Array doivent uniquement être des chaînes de caractères.
    • Si une propriété utilisateur existait déjà auparavant, elle sera écrasée ; si elle n'existe pas, elle sera créée.
  • Exemple d'appel :

              
                 window.MAInterface.setProperty({key: "value"}, (code, message) => {})

            

Incrémenter et mettre à jour les propriétés utilisateur

• increaseProperty(user, completion)
  • Description de l'interface :
    • Définit une incrémentation pour les valeurs des propriétés utilisateur.
    • Ajoute des valeurs à plusieurs propriétés utilisateur numériques. Toutes les données transmises sont cumulées, comme le montant de consommation cumulé.
    • Cette interface ne peut être utilisée que pour des propriétés utilisateur de type nombre, sinon elle sera ignorée. Si cette propriété utilisateur n'existait pas auparavant, la valeur initiale est considérée comme 0.
  • Exemple d'appel :

              
               window.MAInterface.increaseProperty({key: 1}, (code, message) => {})

            

Ajouter des propriétés utilisateur

• addProperty(key, content, completion)
  • Description de l'interface :
    • Ajoute des valeurs aux propriétés utilisateur.
    • Ajoute continuellement des éléments à cet ensemble. Les doublons sont supprimés lors du stockage en base de données. Si ABC existe déjà et que CD est ajouté, le résultat final sera ABCD, comme les actualités aimées par l'utilisateur.
    • Ajoute des valeurs à une propriété de type Array. Les éléments de l'Array doivent être des chaînes de caractères, sinon ils seront ignorés. Si la propriété utilisateur à ajouter n'existait pas auparavant, un Array vide sera initialisé.
  • Exemple d'appel :

              
               window.MAInterface.addProperty("key", ["value1", "value2"], (code, message) => {})

            

Supprimer des propriétés utilisateur

• removeProperty(key, content, completion)
  • Description de l'interface :
    • Supprime une ou plusieurs valeurs d'une propriété de type Array.
    • Supprime certaines valeurs d'une propriété de type Array. Les éléments de cet Array doivent être des chaînes de caractères, sinon ils seront ignorés. Si la propriété utilisateur à supprimer n'existait pas auparavant, il n'y aura aucun effet.
  • Exemple d'appel :

              
               window.MAInterface.removeProperty("key", ["value1", "value2"], (code, message) => {})

            

Supprimer des propriétés utilisateur

Définition de l'interface

• deleteProperty(key, completion)
  • Description de l'interface :
    • Supprime tout le contenu d'une propriété utilisateur.
    • Si cette propriété utilisateur n'existait pas auparavant, elle sera directement ignorée.

Exemple d'appel

              
               window.MAInterface.deleteProperty("key", (code, message) => {})

            

Définir le délai d'expiration de la session

Définition de l'interface

• setSessionTimeout(time)
  • Description de l'interface :
    • Définit le délai d'expiration de la session. Lorsque la page passe en arrière-plan, le délai d'expiration de la session démarre. Si le temps défini (par défaut : 30 minutes) est dépassé, la session prendra fin.

Exemple d'appel

              
               window.MAInterface.setSessionTimeout(60)

            

Définir la durée de consultation de la page

Définition de l'interface

• setPageStayTime(time)
  • Description de l'interface :
    • Définit la durée de consultation de la page.
    • Le chronométrage commence après l'accès à la page. Si l'utilisateur reste sur la page pendant time secondes sans la quitter, cet événement sera remonté.
    • Par défaut, les rapports sont effectués à 6 points temporels : 5 secondes, 30 secondes, 60 secondes, 2 minutes, 5 minutes et 10 minutes. Les développeurs peuvent appeler cette interface pour ajouter d'autres points temporels.

Exemple d'appel

              
               window.MAInterface.setPageStayTime(60)

            

Remonter des événements

Si un événement n'existe pas, il est remonté directement et il sera automatiquement créé en arrière-plan.

Définition de l'interface

• onEvent(event)
  • Description de l'interface :
    • Remonte un événement.
  • Description des paramètres :
    • event : L'événement à remonter. name est le nom de l'événement, et properties sont les informations de propriété de l'événement. La clé est le nom de la propriété, et la valeur est la valeur de la propriété.

Exemple d'appel

              
                 let event = {name: "name", properties: {key: "value"}}
    window.MAInterface.onEvent(event)