Méthodes TVJS

Cette section répertorie les méthodes TVJS fournies par la bibliothèque tvOS.

Méthodes de configuration

  • version

    Renvoie la version actuelle de la bibliothèque Adobe Mobile.

    • Voici la syntaxe de cette méthode :

      version()
      
    • Voici l’exemple de code pour cette méthode :

      var sdkVersion = ADBMobile.version();
      
    • Retours : String

  • privacyStatus

    Renvoie la représentation NSUInteger de l’énumération de l’état de confidentialité pour l’utilisateur actuel :

    Voici les options disponibles :

    • ADBMobilePrivacyStatusOptIn : les accès sont immédiatement envoyés.

    • ADBMobilePrivacyStatusOptOut : les accès sont ignorés.

    • ADBMobilePrivacyStatusUnknown : 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. La valeur par défaut est définie dans le fichier ADBMobileConfig.json.

    • Voici la syntaxe de cette méthode :

      privacyStatus()
      
    • Voici l’exemple de code pour cette méthode :

      var privacyStatus = ADBMobile.privacyStatus();
      
    • Retours : Number

  • setPrivacyStatus

    Définit l’état de confidentialité de l’utilisateur actuel sur l’une des valeurs suivantes :

    • ADBMobilePrivacyStatusOptIn : les accès sont immédiatement envoyés.
    • ADBMobilePrivacyStatusOptOut : les accès sont ignorés.
    • ADBMobilePrivacyStatusUnknown : 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.

    • Voici la syntaxe de cette méthode :

      setPrivacyStatus(privacyStatus)
      
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.setPrivacyStatus(ADBMobilePrivacyStatusOptIn);
      
  • lifetimeValue

    Renvoie la valeur du cycle de vie de l’utilisateur actuel. La valeur par défaut est 0.

    • Voici la syntaxe de cette méthode :

      lifetimeValue()
      
    • Voici l’exemple de code pour cette méthode :

      var ltv = ADBMobile.lifetimeValue();
      
    • Retours : Number

  • userIdentifier

    Renvoie l’identifiant d’utilisateur si un identifiant personnalisé a été défini. Renvoie une valeur nil si aucun identifiant personnalisé n’est défini. La valeur par défaut est de nil

    IMPORTANT

    Si votre application est mise à niveau du SDK Experience Cloud 3.x vers 4.x, l’identifiant visiteur précédent (personnalisé ou généré automatiquement) est récupéré et stocké en tant qu’identifiant utilisateur personnalisé. Ceci permet de conserver les données visiteur entre les différentes mises à niveau du SDK. Pour les nouvelles installations sur le SDK 4.x, l’identifiant utilisateur est nil tant qu’il n’a pas été défini.

    • Voici la syntaxe de cette méthode :

      userIdentifier()
      
    • Voici l’exemple de code pour cette méthode :

      var uid = ADBMobile.userIdentifier();
      
    • Retours : String

  • setUserIdentifier

    Définit l’identifiant d’utilisateur.

    • Voici la syntaxe de cette méthode :

      setUserIdentifier(userId)
      
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.setUserIdentifier(‘myUserId’);
      
    • Renvoie : S/O

    • Paramètre : userID

      • Type : String
      • Nouvel identifiant de cet utilisateur.
  • setAdvertisingIdentifier

    Définit l’IDFA dans le SDK et, s’il a été défini dans le SDK, l’IDFA est envoyé dans le cycle de vie. L’IDFA est également accessible dans Signals (Postbacks).

    IMPORTANT

    Vous devez récupérer l’IDFA d’API Apple uniquement si vous utilisez un service publicitaire. Si vous récupérez l’IDFA, mais ne l’utilisez pas correctement, il est possible que votre application soit rejetée.

    • Voici la syntaxe de cette méthode :

      setAdvertisingIdentifier(idfa)
      
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.setAdvertisingIdentifier(‘myIdfa’);
      
    • Renvoie : S/O

    • Paramètre : idfa

      • Type : String
      • IDFA récupéré d’un API Apple.
  • setDebugLogging

    Définit la préférence de journalisation de débogage.

    • Voici la syntaxe de cette méthode :

      setDebugLogging(logging)
      
    • Voici l’exemple de code pour cette méthode :

      `ADBMobile.setDebugLogging(true);
      
    • Renvoie : S/O

    • Paramètres : logging

      • Type : Bool
      • Valeur indiquant si le SDK Adobe doit se connecter à la console de débogage.

Méthodes Analytics

  • trackStateData

    Contrôle l’état d’une application avec les données contextuelles facultatives. Les états correspondent aux affichages disponibles dans votre application : tableau de bord d’accueil, paramètres d’application, panier, etc. Ces états sont semblables aux pages d’un site web ; les appels trackState incrémentent les pages vues.

    Si l’état est vide, il est présenté comme app name app version (build) dans les rapports. Si vous voyez cette valeur dans les rapports, veillez à définir l’état dans chaque appel trackState.

    CONSEIL

    Il s’agit du seul appel de suivi qui incrémente les pages vues.

    • Voici la syntaxe de cette méthode :

      trackStateData(stateName [, contextData])
      
      • Renvoie : S/O
      • Paramètre : stateName
        • Type : String
        • Nom d’état de la page
      • Paramètre : contextData
        • Type : objet
        • Données contextuelles supplémentaires pour cet accès.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.trackStateData(‘homepage’, {‘userid’:12345});
      
  • trackActionData

    Effectue le suivi d’une action dans votre application. Les actions sont les événements qui se produisent dans votre application et que vous souhaitez mesurer, par exemple les connexions, les appuis sur la bannière, les abonnements aux flux, etc.

    • Voici la syntaxe de cette méthode :

      trackActionData(actionName [, contextData])
      
      • Renvoie : S/O
      • Paramètres : actionName
        • Type : String
        • Nom de l’action suivie.
      • Paramètre : contextData
        • Type : objet
        • Données contextuelles supplémentaires pour cet accès.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.trackActionData(‘likeClicked’, {‘imageName’:’funnyKitty’});
      
  • trackLocationWithLatLonData

    Envoie les coordonnées de latitude et de longitude actuelles.

    Utilise en outre les points ciblés (POI) 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 :

      trackLocationWithLatLonData(lat, lon [, contextData]);
      
      • Renvoie : S/O
      • Paramètre : lat
        • Type : nombre
        • Latitude de l’emplacement.
      • Paramètre : lon
        • Type : nombre
        • Longitude de l’emplacement.
      • Paramètre : contextData
        • Type : objet
        • Données contextuelles supplémentaires pour cet accès.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.trackLocationWithLatLonData(43.36, -116.12, null);
      
  • trackLifetimeValueIncreaseJsData

    Ajoute une quantité à la valeur de durée de vie de l’utilisateur.

    • Voici la syntaxe de cette méthode :

      trackLifetimeValueIncreaseJsData(increaseAmount)
      
      • Renvoie : S/O
      • Paramètre : increaseAmount
        • Type : nombre
        • Quantité à ajouter à la valeur de durée de vie actuelle de l’utilisateur.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.trackLifetimeValueIncreaseJsData(5);
      
  • trackTimedActionStartData

    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.

    CONSEIL

    Cet appel n’envoie pas d’accès.

    • Voici la syntaxe de cette méthode :

      trackTimedActionStartData(name [, contextData])
      
      • Renvoie : S/O
      • Paramètre : name
        • Type : String
        • Nom de l’action minutée en cours de démarrage.
      • Paramètre : contextData
        • Type : objet
        • Données contextuelles supplémentaires pour cet accès.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.trackTimedActionStartData(‘level1’, {‘userId’:42423});
      
  • trackTimedActionUpdateData

    Transmet les données pour mettre à jour les données contextuelles associées à l’action donnée.

    Les données transmises sont ajoutées aux données existantes pour l’action donnée et, si la même clé est déjà définie pour cette action, les données sont écrasées.

    CONSEIL

    Cet appel n’envoie pas d’accès.

    • Voici la syntaxe de cette méthode :

      trackTimedActionUpdateData(name [, contextData])
      
      • Renvoie : S/O
      • Paramètre : name
        • Type : String
        • Nom de l’action minutée en cours de mise à jour.
      • Paramètre : contextData
        • Type : objet
        • Données contextuelles supplémentaires pour cet accès.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.trackTimedActionUpdateData(‘level1’);
      
  • trackTimedActionEndJsLogic

    Termine une action minutée.

    Si vous fournissez une fonction de rappel, vous pouvez accéder aux valeurs temporelles finales. Si aucun rappel n’est fourni ou si le rappel renvoie true, le SDK Adobe envoie automatiquement un accès. Lorsque que false est renvoyé par le rappel, l’accès de l’action minutée est supprimé.

    • Voici la syntaxe de cette méthode :

      trackTimedActionEndJsLogic(name [, callback])
      
      • Renvoie : S/O

      • Paramètres : name

        • Type : String
        • Nom de l’action minutée en cours d’interruption
      • Paramètre : callback

        • Type : function(inAppDuration, totalDuration, data)

        • Méthode de rappel qui aura inAppDuration (nombre), totalDuration (nombre), et data (objet de données contextuelles) dans ses paramètres.

          Vous pouvez empêcher l’envoi de l’accès final par le SDK en renvoyant false dans votre fonction de rappel.

      • Voici l’exemple de code pour cette méthode :

        ADBMobile.trackTimedActionEndJsLogic(‘level1’, 
        function(inAppDuration, totalDuration, data) {
            // do something with final values
            return true;
            });
        
  • trackingTimedActionExistsJs

    Renvoie si une action minutée est ou non en cours.

    • Voici la syntaxe de cette méthode :

      trackingTimedActionExistsJs(name)
      
      • Renvoie : Bool
      • Paramètre : name
        • Type : String
        • Nom de l’action minutée pour laquelle vous devez vérifier l’existence.
    • Voici l’exemple de code pour cette méthode :

      var actionExists = ADBMobile.trackTimedActionExistsJs(‘level1’);
      
  • trackingIdentifier

    Renvoie l’identifiant visiteur généré automatiquement.

    Il s’agit d’un ID de visiteur unique propre à l’application, généré par les serveurs d’Adobe. Si les serveurs d’Adobe ne peuvent pas être atteints au moment de la génération, l’identifiant est généré à l’aide du CFUUID d’Apple. La valeur est générée au lancement initial et stockée et utilisée à partir de ce point. Cet identifiant est conservé entre les mises à niveau de l’application, est enregistré et restauré pendant le processus de sauvegarde de l’application standard et est supprimé lorsque l’application est désinstallée.

    CONSEIL

    Si votre application est mise à niveau du SDK Experience Cloud 3.x vers 4.x, l’identifiant visiteur précédent (personnalisé ou généré automatiquement) est récupéré et stocké en tant qu’identifiant utilisateur personnalisé. Ceci permet de conserver les données visiteur entre les différentes mises à niveau du SDK. Pour les nouvelles installations sur le SDK 4.x, l’identifiant utilisateur est nil et l’identifiant de suivi est utilisé. Pour plus d’informations, voir la ligne userIdentifier ci-dessous.

    • Voici la syntaxe de cette méthode :

      trackingIdentifier()
      
      • Retours : String
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var trackingId = ADBMobile.trackingIdentifier();
      
  • 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 :

      trackingSendQueuedHits()
      
      • Renvoie : S/O
      • Paramètres : aucun
    • 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 :

      trackingClearQueue()
      
      • Renvoie : S/O
      • Paramètres : aucun
    • 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 :

      trackingGetQueueSize()
      
      • Renvoie : nombre
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var queueSize = ADBMobile.trackingGetQueueSize();
      

Méthodes Audience Manager

  • audienceVisitorProfile

    Renvoie le dernier profil du visiteur obtenu.

    Renvoie null si aucun signal n’a encore été envoyé. Le profil du visiteur est enregistré dans NSUserDefaults pour un accès facile à l’échelle de plusieurs lancements de votre application.

    • Voici la syntaxe de cette méthode :

      audienceVisitorProfile()
      
      • Renvoie : objet
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var profile = ADBMobile.audienceVisitorProfile();
      
  • audienceDpid

    Renvoie le DPID en cours.

    • Voici la syntaxe de cette méthode :

      audienceDpid()
      
      • Renvoie : String
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var dpid = ADBMobile.audienceDpid();
      
  • audienceDpuuid

    Renvoie le DPUUID en cours.

    • Voici la syntaxe de cette méthode :

      audienceDpuuid()
      
      • Retours : String
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var dpuuid = ADBMobile.audienceDpuuid();
      
  • audienceSetDpidDpuuid

    Définit le dpid et le dpuuid qui, une fois définis, sont envoyés avec chaque signal.

    • Voici la syntaxe de cette méthode :

      audienceSetDpidDpuuid(dpid, dpuuid)
      
      • Renvoie : S/O
      • Paramètre : dpid
        • Type : String
        • Identifiant du fournisseur de données Audience Manager.
      • Paramètre : dpuuid
        • Type : String
        • Identifiant pour la combinaison utilisateur / fournisseur de données.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.audienceSetDpidDpuuid(‘myDpid’, ‘userDpuuid’);
      
  • audienceSignalWithDataJsCallback

    Envoie à Audience Manager un signal avec des caractéristiques et récupère les segments correspondants renvoyés dans un rappel.

    • Voici la syntaxe de cette méthode :

      audienceSignalWithDataJsCallback(traits [, callback])
      
      • Paramètre : traits
        • Type : objet
        • Dictionnaire Caractéristiques pour cet utilisateur.
      • Paramètre : callback
        • Type : function(profil)
        • Profil renvoyé par Audience Manager dans le paramètre de la fonction de rappel.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.audienceSignalWithDataJsCallback({‘trait’:’something’}, 
      function(profile) {
          //do something with the user’s segments found in profile
           });
      
  • audienceReset

    Réinitialise l’UUID d’Audience Manager et purge le profil du visiteur actuel.

    • Voici l’exemple de code pour cette méthode :

      audienceReset()
      
      • Renvoie : S/O
      • Paramètre : Aucun
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.audienceReset();
      

Méthodes du service d’identification

  • visitorMarketingCloudID

    Récupère l’Experience Cloud ID du service d’identification.

    • Voici la syntaxe de cette méthode :

      visitorMarketingCloudID()
      
      • Renvoie : String
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var mcid = ADBMobile.visitorMarketingCloudID();
      
  • visitorSyncIdentifiers

    En plus de l’Experience Cloud ID, vous pouvez définir d’autres identifiants de client à associer à chaque visiteur. L’API visiteur accepte plusieurs identifiants de client pour un 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 setCustomerIDs dans la bibliothèque JavaScript.

    • Voici la syntaxe de cette méthode :

      visitorSyncIdentifiers(identifiers)
      
      • Renvoie : S/O

      • Paramètre : identifiers

        • Type : Object
        • Identifiants à synchroniser avec le service d’identification pour cet utilisateur.
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.visitorSyncIdentifiers({‘idType’:’idValue’});
      
  • visitorSyncIdentifiersAuthenticationState

    Synchronise les identifiants fournis au service d’identification.

    • Voici la syntaxe de cette méthode :

      visitorSyncIdentifiersAuthenticationState(identifiers, authState)
      
      • Renvoie : S/O
      • Paramètres : identifiers
        • Type : Object
        • Identifiants à synchroniser avec le service d’identification pour cet utilisateur.
      • Paramètre : authState
        • Type : ADBMobileVisitorAuthenticationState
        • État d’authentification de l’utilisateur et valeurs possibles :
          • ADBMobileVisitorAuthenticationStateUnknown
          • ADBMobileVisitorAuthenticationStateAuthenticated
          • ADBMobileVisitorAuthenticationStateLoggedOut
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.visitorSyncIdentifiersAuthenticationState({'myIdType':'valueForUser'}, ADBMobileVisitorAuthenticationStateLoggedOut)
      
  • visitorSyncIdentifierWithTypeIdentifierAuthenticationState

    Synchronise le type d’identifiant et la valeur fournis au service d’identification.

    • Voici la syntaxe de cette méthode :

      visitorSyncIdentifierWithTypeIdentifierAuthenticationState(idType, identifier, authState)
      
      • Renvoie : S/O
      • Paramètre : idType
        • Type : String
        • Type d’identifiant que vous synchronisez.
      • Paramètre : identifier
        • Type : String
        • Valeur de l’identifiant que vous synchronisez.
      • Paramètre : authState
        • Type : ADBMobileVisitorAuthenticationState
          État d’authentification de l’utilisateur. Valeurs possibles :
          • ADBMobileVisitorAuthenticationStateUnknown
          • ADBMobileVisitorAuthenticationStateAuthenticated
          • ADBMobileVisitorAuthenticationStateLoggedOut
    • Voici l’exemple de code pour cette méthode :

      ADBMobile.visitorSyncIdentifierWithTypeIdentifierAuthenticationState('myIdType', 'valueForUser', 
      ADBMobileVisitorAuthenticationStateAuthenticated);
      
  • visitorGetIDsJs

    Récupère une matrice d’objets ADBVisitorID en lecture seule. Le code ci-après est un exemple d’objet VisitorID :

    {
        idType: "abc",
        authenticationState: 1, 
        identifier: "123"
    }
    
    • Voici la syntaxe de cette méthode :

      visitorGetIDsJs()
      
      • Retours : Array [Object]

      • Paramètres : aucun

    • Voici l’exemple de code pour cette méthode :

      var myVisitorIds = ADBMobile.visitorGetIDsJs();
      

Méthodes Target

  • targetThirdPartyID

    Renvoie l’identifiant tiers.

    • Voici la syntaxe de cette méthode :

      targetThirdPartyID()
      
      • Retours : String
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var thirdPartyID = ADBMobile.targetThirdPartyID();
      
  • targetSetThirdPartyID

    Définit l’identifiant tiers.

    • Voici la syntaxe de cette méthode :

      targetSetThirdPartyID(thirdPartyID)
      
      • Renvoie : S/O
      • Paramètres : thirdPartyID
        • Type : String
        • Identifiant tiers à utiliser pour les demandes cibles.
    • Voici l’exemple de code pour cette méthode :

    ADBMobile.targetSetThirdPartyID(‘thirdPartyID’);
    
  • targetPcID

    Renvoie le PcID.

    • Voici la syntaxe de cette méthode :

      targetPcID()
      
      • Retours : String
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var pcID = ADBMobile.targetPcID();
      
  • targetSessionID

    Renvoie l’ID de session.

    • Voici la syntaxe de cette méthode :

      targetSessionID()
      
      • Retours : String
      • Paramètres : aucun
    • Voici l’exemple de code pour cette méthode :

      var sessionID = ADBMobile.targetSessionID();
      

Sur cette page