Show Menu
SUJETS×

ADBMobile.cs methods

Méthodes de configuration

  • CollectLifecycleData
    Indique au SDK que les données du cycle de vie doivent être collectées pour être utilisées à l’échelle de toutes les solutions dans le SDK. Pour en savoir plus, voir la section Mesures de cycle de vie .
    • Voici la syntaxe de cette méthode :
      public static void CollectLifecycleData();
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.CollectLifecycleData(); 
      
      
  • EnableLocalNotifications (iOS seulement)
    Permet d’activer les notifications locales dans l’application.
    • Voici la syntaxe de cette méthode :
      public static void EnableLocalNotifications();
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.EnableLocalNotifications(); 
      
      
  • GetDebugLogging
    Renvoie la préférence de consignation de débogage actuelle. La valeur par défaut est false .
    • Voici la syntaxe de cette méthode :
      public static bool GetDebugLogging();
      
      
    • Voici l’exemple de code pour cette méthode :
      var debugEnabled = ADBMobile.GetDebugLogging();
      
      
  • GetLifetimeValue
    Renvoie la valeur du cycle de vie de l’utilisateur actuel.
    • Voici la syntaxe de cette méthode :
      public static double GetLifetimeValue();
      
      
    • Voici l’exemple de code pour cette méthode :
      var lifetimeValuea = ADBMobile.GetLifetimeValue();
      
      
  • GetPrivacyStatus
    Renvoie la représentation d’énumération de l’état de confidentialité pour l’utilisateur actuel.
    • MOBILE_PRIVACY_STATUS_OPT_IN : Les accès sont envoyés immédiatement.
    • MOBILE_PRIVACY_STATUS_OPT_OUT : Hits are discarded.
    • MOBILE_PRIVACY_STATUS_UNKNOWN  : si le suivi hors ligne est activé, les accès sont enregistrés jusqu’à ce que l’état de confidentialité soit défini sur inclusion (les accès sont envoyés) ou sur exclusion (les accès sont ignorés).
      Si le suivi hors ligne n’est pas activé, les accès sont ignorés jusqu’à ce que l’état de confidentialité soit défini sur inclusion (opt-in). La valeur par défaut est définie dans le fichier ADBMobileConfig.json .
    • Voici la syntaxe de cette méthode :
      public static ADBPrivacyStatus GetPrivacyStatus();
      
      
    • Voici l’exemple de code pour cette méthode :
      var privacyStatus = ADBMobile.GetPrivacyStatus();
      
      
  • GetUserIdentifier
    Renvoie un identifiant d’utilisateur personnalisé si un identifiant personnalisé a été défini. Renvoie une valeur nulle si aucun identifiant personnalisé n’est défini. La valeur par défaut est null .
    • Voici la syntaxe de cette méthode :
      public static string GetUserIdentifier();
      
      
    • Voici l’exemple de code pour cette méthode :
      var userId = ADBMobile.GetUserIdentifier(); 
      
      
  • GetVersion
    Obtient la version de la bibliothèque.
    • Voici la syntaxe de cette méthode :
      public static string GetVersion();
      
      
    • Voici l’exemple de code pour cette méthode :
      var version = ADBMobile.GetVersion();
      
      
  • KeepLifecycleSessionAlive (iOS seulement)
    Indique au SDK que la prochaine reprise depuis l’arrière-plan ne doit pas commencer une nouvelle session, quelle que soit la valeur de temporisation de la session du cycle de vie dans le fichier de configuration.
    Cette méthode est conçue pour être utilisée pour les applications qui s’inscrivent aux notifications en arrière-plan et qui doivent uniquement être appelées à partir du code qui s’exécute pendant que votre application est en arrière-plan.
    • Voici la syntaxe de cette méthode :
      public static void KeepLifecycleSessionAlive(); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.KeepLifecycleSessionAlive(); 
      
      
  • PauseCollectingLifecycleData (Android seulement)
    Indique au SDK que l’application est suspendue, de sorte que les mesures de cycle de vie sont correctement calculées. Par exemple, en cas de suspension, collecte un horodatage afin de déterminer la durée de la session précédente. Ceci définit également un indicateur de sorte que le cycle de vie sache correctement que l’application n’a pas planté. Pour en savoir plus, voir la section Mesures de cycle de vie .
    • Voici la syntaxe de cette méthode :
      public static void PauseCollectingLifecycleData();
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.PauseCollectingLifecycleData(); 
      
      
  • SetContext (Android seulement)
    Indicates to the SDK that it should set its application context from the UnityPlayer's current activity.
    • Voici la syntaxe de cette méthode :
      public static void SetContext();
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.SetContext(); 
      
      
  • SetDebugLogging
    Définit la préférence de consignation de débogage à activer.
    • Voici la syntaxe de cette méthode :
      public static void SetDebugLogging (bool enabled); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.SetDebugLogging(true); 
      
      
  • SetPrivacyStatus
    Définit l’état de confidentialité pour l’utilisateur actuel. Valeurs possibles :
    • MOBILE_PRIVACY_STATUS_OPT_IN : Hits are sent immediately.
    • MOBILE_PRIVACY_STATUS_OPT_OUT : Les accès sont ignorés.
    • MOBILE_PRIVACY_STATUS_UNKNOWN  : si le suivi hors ligne est activé, les accès sont enregistrés jusqu’à ce que l’état de confidentialité soit défini sur inclusion (opt-in ; alors les accès sont envoyés) ou sur exclusion (opt-out ; les accès sont ignorés). Si le suivi hors ligne n’est pas activé, les accès sont ignorés jusqu’à ce que l’état de confidentialité soit défini sur inclusion (opt-in).
    • Voici la syntaxe de cette méthode :
      public static void SetPrivacyStatus(ADBPrivacyStatusstatus); 
      
      
    • Voici l’exemple de code pour cette syntaxe :
      ADBMobile.SetPrivacyStatus(ADBMobile.ADBPrivacyStatus.MOBILE_PRIVACY_STATUS_OPT_IN);
      
      
  • SetUserIdentifier
    Définit l’identifiant d’utilisateur sur userId.
    • Voici la syntaxe de cette méthode :
      public static void SetUserIdentifier(string userId); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.SetUserIdentifier("myCustomUserId"); 
      
      

Méthodes Analytics

  • GetTrackingIdentifier
    Récupère l’identifiant de suivi des analyses.
    • Voici la syntaxe de cette méthode :
      public static string GetTrackingIdentifier();
      
      
    • Voici l’exemple de code pour cette méthode :
      var trackingId = ADBMobile.GetTrackingIdentifier(); 
      
      
  • TrackState
    Contrôle l’état d’une application avec les données contextuelles facultatives. Les états sont les vues disponibles dans l’application, par exemple « écran de titre », « niveau 1 », « pause », etc. Ces états sont semblables aux pages d’un site web ; les appels TrackState incrémentent les pages vues.
    If state is empty, it displays as app name app version (build) in reports. Si vous voyez cette valeur dans les rapports, veillez à définir state dans chaque appel TrackState .
    Il s’agit du seul appel de suivi qui incrémente les pages vues.
    • Voici la syntaxe de cette méthode :
      public static void TrackState(string state, Dictionary<string, object> cdata);
      
      
    • Voici l’exemple de code pour cette méthode :
      var contextData = new Dictionary<string, object>); 
      contextData.Add ("user", "jim");
      ADBMobile.TrackState("title screen", contextData);
      
      
  • TrackAction
    Effectue le suivi d’une action dans l’application. Les actions sont les événements qui se produisent dans l’application et que vous souhaitez mesurer, par exemple « décès », « niveau atteint », « abonnements aux flux » et autres mesures.
    If you have code that might run while the app is in the background (for example, a background data retrieval), use trackActionFromBackground instead.
    • Voici la syntaxe de cette méthode :
      public static void TrackAction(string action, Dictionary<string, object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackAction("level gained", null); 
      
      
  • TrackActionFromBackground (iOS seulement)
    Effectue le suivi d’une action survenue en arrière-plan. Ceci empêche les événements de cycle de vie de se déclencher dans certains scénarios.
    Cette méthode ne doit être appelée que dans le code qui s’exécute pendant que votre application est en arrière-plan.
    • Voici la syntaxe de cette méthode :
      public static void TrackActionFromBackground(string action, Dictionary<string,object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackActionFromBackground("majorLocationChange", null);
      
      
  • TrackLocation
    Envoie les coordonnées de latitude et de longitude actuelles. Utilise également les points ciblés définis dans le fichier ADBMobileConfig.json pour déterminer si l’emplacement fourni comme paramètre se trouve dans l’un de vos points ciblés. Si les coordonnées actuelles se trouvent dans un point ciblé défini, une variable de données contextuelles est renseignée et envoyée avec l’appel TrackLocation.
    • Voici la syntaxe de cette méthode :
      public static void TrackLocation(float latValue, float lonValue, Dictionary<string, object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackLocation(28.418649, -81.581324, null); 
      
      
  • TrackBeacon
    Effectue un suivi quand un utilisateur entre à proximité d’une balise.
    • Voici la syntaxe de cette méthode :
      public static void TrackBeacon(int major, int minor, string uuid, ADBBeaconProximity proximity, Dictionary<string, object> cdata); 
      
      
  • TrackingClearCurrentBeacon
    Efface les données de balise une fois qu’un utilisateur n’est plus à proximité de la balise.
    • Voici la syntaxe de cette méthode :
      public static void TrackingClearCurrentBeacon(); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackingClearCurrentBeacon();
      
      
  • TrackLifetimeValueIncrease
    Ajoute une quantité à la valeur de durée de vie de l’utilisateur.
    • Voici la syntaxe de cette méthode :
      public static void TrackLifetimeValueIncrease(double amount, Dictionary<string, object> cdata);
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackLifetimeValueIncrease(5, null); 
      
      
  • TrackTimedActionStart
    Commence une action minutée par l’action du nom. Si vous appelez cette méthode pour une action qui a déjà commencé, l’action minutée précédente est écrasée.
    Cet appel n’envoie pas d’accès.
    • Voici la syntaxe de cette méthode :
      public static void TrackTimedActionStart(string action, Dictionary<string,object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackTimedActionStart("level2", null);
      
      
  • TrackTimedActionUpdate
    Transmet des données afin de mettre à jour les données contextuelles associées à l’action donnée. Les données transmises sont annexées aux données existantes pour l’action donnée et remplacent les données si la même clé est déjà définie pour l’action.
    Cet appel n’envoie pas d’accès.
    • Voici la syntaxe de cette méthode :
      public static void TrackTimedActionUpdate(string action, Dictionary<string, object> cdata); 
      
      
    • Voici l’exemple de code pour cette méthode :
      var contextData = new Dictionary<string, object>; 
      contextData.Add("checkpoint", "1:32"); 
         ADBMobile.TrackTimedActionUpdate("level2", contextData);
      
      
  • TrackTimedActionEnd
    Termine une action minutée.
    • Voici la syntaxe de cette méthode :
      public static void TrackTimedActionEnd(string action); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackTimedActionEnd("level2"); 
      
      
  • TrackingTimedActionExists
    Renvoie si une action minutée est ou non en cours.
    • Voici la syntaxe de cette méthode :
      public static bool TrackingTimedActionExists(string action); 
      
      
    • Voici l’exemple de code pour cette méthode :
       var level2InProgress = ADBMobile.TrackingTimedActionExists("level2"); 
      
      
  • TrackingSendQueuedHits
    Force la bibliothèque à envoyer tous les accès dans la file d’attente hors ligne, peu importe le nombre d’accès déjà dans la file d’attente.
    • Voici la syntaxe de cette méthode :
      public static void TrackingSendQueuedHits();
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackingSendQueuedHits(); 
      
      
  • TrackingClearQueue
    Efface tous les accès de la file d’attente hors ligne.
    • Voici la syntaxe de cette méthode :
      public static void TrackingClearQueue();
      
      
    • Voici l’exemple de code pour cette méthode :
      ADBMobile.TrackingClearQueue(); 
      
      
  • TrackingGetQueueSize
    Récupère le nombre d’accès actuellement dans la file d’attente hors ligne.
    • Voici la syntaxe de cette méthode :
      public static int TrackingGetQueueSize();
      
      
    • Voici l’exemple de code pour cette méthode :
      var queueSize = ADBMobile.TrackingGetQueueSize();
      
      

Méthodes d’ID Experience Cloud

  • GetMarketingCloudID
    Récupère l’Experience Cloud ID du service d’identification.
    • Voici la syntaxe de cette méthode :
      public static string GetMarketingCloudID(); 
      
      
    • Voici l’exemple de code pour cette méthode :
      var mcid = ADBMobile.GetMarketingCloudID();
      
      
  • VisitorSyncIdentifiers
    Avec l’identifiant Experience Cloud, vous pouvez définir d’autres identifiants de client à associer à chaque visiteur. L’API visiteur accepte plusieurs identifiants de client pour le même visiteur, ainsi qu’un identifiant de type Client, afin de séparer la portée des différents identifiants de client. Cette méthode correspond aux identifiants setCustomerID dans la bibliothèque JavaScript.
    • Voici la syntaxe de cette méthode :
      public static void VisitorSyncIdentifiers(Dictionary<string, object> identifiers); 
      
      
    • Voici l’exemple de code pour cette méthode :
      var ids = new Dictionary<string, object> (); 
      ids.Add ("player1", "jimbob"); 
      ADBMobile.VisitorSyncIdentifiers(ids);