Méthodes du module externe PhoneGap

Vous pouvez utiliser les méthodes du module externe Android PhoneGap pour réaliser diverses tâches.

Dans les fichiers html pour lesquels vous voulez utiliser le suivi, ajoutez le code ci-après à la balise <head> :

<script type="text/javascript" charset="utf-8" src="ADB_Helper.js"></script>

Méthodes de configuration

  • getPrivacyStatus

    Renvoie l’état de confidentialité pour l’utilisateur actuel.

    Vous trouverez ci-dessous les états disponibles :

    • ADB.optedIn : Les accès sont envoyés immédiatement.

    • ADB.optedOut : Les accès sont ignorés.

    • ADB.optUnknown : Si la suite de rapports prend en charge l’horodatage, les accès sont enregistrés jusqu’à ce que l’état de confidentialité devienne « inclusion » (les accès sont envoyés) ou « exclusion » (les accès sont ignorés). Si la suite de rapports ne prend pas en charge l’horodatage, 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 l’exemple de code pour cette méthode :

      getPrivacyStatus(function (value) { myTempVal = value; }, function () {myTempVal = null;}); 
      
  • setPrivacyStatus

    Définit l’état de confidentialité pour l’utilisateur actuel sur status.

    Vous pouvez définir l’un des états suivants :

    • ADB.optedIn : Les accès sont envoyés immédiatement.

    • ADB.optedOut : Les accès sont ignorés.

    • ADB.optUnknown : Si la suite de rapports prend en charge l’horodatage, les accès sont enregistrés jusqu’à ce que l’état de confidentialité devienne « inclusion » (les accès sont envoyés) ou « exclusion » (les accès sont ignorés). Si la suite de rapports ne prend pas en charge l’horodatage, les accès sont ignorés jusqu’à ce que l’état de confidentialité soit défini sur « inclusion ».

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

      ADB.setPrivacyStatus('ADB.optedIn');
      
  • getLifetimeValue

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

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

      ADB.getLifetimeValue(function (value) { myTempVal = value }, function () { myTempVal = null; }); 
      
  • setDebugLogging

    Active (true) ou désactive (false) l’affichage des informations de débogage. Par défaut, cette variable est définie sur false.

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

      ADB.setDebugLogging(true);
      
  • getVersion

    Obtient la version de la bibliothèque.

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

      ADB.getVersion(function (value) { versionNum = value }, function () { versionNum = 1.0;});
      
  • trackingIdentifier

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

    Il s’agit d’un ID de visiteur unique propre à l’application, qui est généré lors du lancement initial de l’application et qui est stocké et utilisé à partir de ce moment. Cet identifiant est conservé entre les mises à niveau de l’application et supprimé lorsque l’application est désinstallée.

    CONSEIL

    Si l’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é comme identifiant d’utilisateur personnalisé. Pour plus d’informations, voir getUserIdentifier ci-dessous. Cet identifiant conserve les données des visiteurs d’une mise à niveau à l’autre du SDK.

    Pour les nouvelles installations sur le SDK 4.x, l’identifiant de l’utilisateur a la valeur null et l’identifiant de suivi est utilisé.

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

      ADB.trackingIdentifier(function (value) { myTempVal = value; }, function () { myTempVal = null; }); 
      
  • getUserIdentifier

    Si un identifiant utilisateur de client a été défini, renvoie cet identifiant ; si l’identifiant n’a pas été défini, renvoie la valeur null. La valeur par défaut est null.

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

      getUserIdentifier(function(value) { myTempVal = value; }, function () { myTempVal = null; });
      
  • setUserIdentifier

    Définit l’identifiant d’utilisateur sur identifier.

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

      ADB.setUserIdentifier('testUser');
      
  • setPushIdentifier

    Définit le jeton d’appareil pour les notifications Push.

    getUserIdentifier(function (value) { myTempVal = value; }, function () { myTempVal = null; });
    
    • Voici la syntaxe de cette méthode :

      ADB.setPushIdentifier(pushIdentifier, success, fail);
      
    • Voici l’exemple de code pour cette méthode :

      ADB.setPushIdentifier('test_push_identifier',function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • keepLifecycleSessionAlive

    Définit la préférence d’une session de cycle de vie persistante.

    IMPORTANT

    L’appel de keepLifecycleSessionAlive empêche l’application de lancer une nouvelle session la prochaine fois qu’elle est reprise en arrière-plan. Utilisez cette méthode seulement si votre application est enregistrée pour les notifications en arrière-plan.

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

      ADB.keepLifecycleSessionAlive(); 
      
  • trackingSendQueuedHits

    Force la bibliothèque à envoyer tous les accès mis en file d’attente, quelles que soient les options de lot en cours.

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

      ADB.trackingSendQueuedHits();
      
  • trackingGetQueueSize

    Obtient ou définit le nombre d’appels de suivi stockés dans la file d’attente hors ligne.

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

      ADB.trackingGetQueueSize(function (value) { myTempVal = value;}, function () { myTempVal = null;}); 
      
  • trackingClearQueue

    Supprime tous les appels de suivi stockés de la file d’attente hors ligne.

    AVERTISSEMENT

    Soyez prudent lorsque vous effacez manuellement la file d’attente, car cette opération ne peut pas être annulée.

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

      ADB.trackingClearQueue(function (value) { myTempVal = value; }, function () { myTempVal = null; }); 
      

Méthodes PII

  • collectPII

    Envoie une demande de collecte PII.

    • Voici la syntaxe de cette méthode :
    ADB.collectPII(piiData,success, fail);
    
    • Voici l’exemple de code pour cette méthode :

      ADB.collectPII({'k1':'v1','k2':'v2','k3':'v3'}, function (value) { alert('success') },function (value) { alert('fail') ;});
      

Méthodes de suivi

  • trackAdobeDeepLink

    Effectue le suivi d’un clic publicitaire de lien profond Adobe.

    CONSEIL

    Si l’appel du cycle de vie est un événement de lancement, les données de lien Adobe sont ajoutées ; sinon un appel supplémentaire est envoyé.

    • Voici la syntaxe de cette méthode :

      ADB.trackAdobeDeepLink(deeplinkURL, success, fail); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.trackAdobeDeepLink('xyz-deeplink-url',function (value) { alert('success'); },function (value) { alert('fail') }); 
      
  • trackState

    Contrôle l’état d’une application avec les données contextuelles facultatives. Les états sont les affichages disponibles dans l’application, par exemple home dashboard, app settings, cart, etc. Ces états sont semblables aux pages d’un site web ; les appels trackState incrémentent les pages vues.

    cData : objet JSON avec des paires clé-valeur à envoyer dans les données contextuelles.

    • Voici la syntaxe de cette méthode :

      ADB.trackState(string stateName[,JSON cData]);
      
    • Voici des exemples de code pour cette méthode :

        ADB.trackState("login&amp;nbsp;page"); 
      
        ADB.trackState("login page", {"user":"john","remember":"true"});
      
  • trackAction

    Effectue le suivi d’une action dans votre application. Les actions incluent logins, banner taps, feed subscriptions, ainsi que d’autres actions qui se produisent dans l’application et que vous souhaitez mesurer.

    • Voici la syntaxe de cette méthode :

      ADB.trackAction(string action[,JSON cData]); 
      
    • Voici des exemples de code pour cette méthode :

        ADB.trackAction("login");
      
        ADB.trackAction("login", {"user":"john","remember":"true"}); 
      
  • trackLocation

    Envoie les coordonnées x et y 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 contextuelle est renseignée et envoyée avec l’appel trackLocation.

    • Voici la syntaxe de cette méthode :

      ADB.trackLocation(x, y[,JSON cData]); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.trackLocation('40.431596', '-111.893713'); 
      
  • trackLifetime​ValueIncrease

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

    • Voici la syntaxe de cette méthode :

      ADB.trackLifetimeValueIncrease(amount[,JSON cData]); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.trackLifetimeValueIncrease('10.01'); 
      
  • trackTimed​ActionStart

    Commence une minutée par le nom actionaction.

    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 :

      ADB.trackTimedActionStart(action[,JSON cData]);
      
    • Voici l’exemple de code pour cette méthode :

      ADB.trackTimedActionStart("cartToCheckout"); 
      
  • trackTimed​ActionUpdate

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

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

    • Voici la syntaxe de cette méthode :

      ADB.trackTimedActionUpdate(String action[,JSON cData]);
      
    • Voici l’exemple de code pour cette méthode :

      ADB.trackTimedActionUpdate("cartToCheckout",{'SampleContextDataKey3':'SampleContextDataVal3','SampleContextDataKey4':'SampleContextDataVal4'});
      
  • trackTimed​ActionEnd

    Termine une action minutée.

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

      ADB.trackTimedActionEnd("cartToCheckout"); 
      
  • trackingTimedActionExists

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

    • Voici la syntaxe de cette méthode :

      ADB.trackingTimedActionExists(function (value) { myTempVal = value }, function () { myTempVal = null; }); 
      

Méthodes de balise

  • trackBeacon

    Effectue un suivi quand un utilisateur entre à proximité d’une balise.

    • Voici la syntaxe de cette méthode :

      ADB.trackBeacon(uuid, major, minor, proximity, cData) 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.trackBeacon('2F234454-CF6D-4A0F-ADF2-F4911BA9FFA6', 1, 2, 
      ADB.beaconUnknown, {'hp':'hp_val','hp.company':'adobe'}
      
  • clearCurrentBeacon

    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 :

      ADB.clearCurrentBeacon(success, fail)
      
    • Voici l’exemple de code pour cette méthode :

      ADB.clearCurrentBeacon(); 
      

Méthodes Target

  • targetLoadRequest

    Envoie une demande au serveur Target configuré et renvoie la valeur de chaîne de l’offre.

    • Voici la syntaxe de cette méthode :

      ADB.targetLoadRequest(success, fail, name, defaultContent, parameters);
      
    • Voici l’exemple de code pour cette méthode :

      ADB.targetLoadRequest(function&nbsp;(value)
      {myTempVal = value }, function () { myTempVal = null;},'bannerOffer', 'none', {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}); 
      
  • targetLoadOrderConfirmRequest

    Envoie une demande au serveur Target configuré.

    • Voici la syntaxe de cette méthode :

      ADB.targetLoadOrderConfirmRequest(success, fail name orderId, orderTotal, productPurchaseId, parameters); 
      
    • Voici la syntaxe de cette méthode :

      ADB.targetLoadRequest(function (value) { myTempVal = value }
      , function ()
      { myTempVal = null; } 
      , 'name' 'orderId' 'total', 'purchaseId',
      {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}
      ); 
      
  • targetClearCookies

    Efface les cookies Target du stockage des cookies partagé.

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

      ADB.targetClearCookies(); 
      
  • targetLoadRequestWithNameWithLocationParameters

    Traite une demande de service Target.

    • Voici la syntaxe de cette méthode :

      ADB.targetLoadRequestWithNameWithLocationParameters(
        success, fail, name, defaultContent, profileParameters, orderParameters, mboxParameters requestLocationParameters
        ); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.targetLoadRequestWithNameWithLocationParameters  (function () { alert('success'); }, function () { alert('fail'); }, ;'bannerOffer', 'none', {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}, {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'},{'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'},{'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'});
      
  • targetLoadRequestWithName

    Traite une demande de service Target.

    • Voici la syntaxe de cette méthode :

      ADB.targetLoadRequestWithRequestName(success, fail, name, defaultContent, profileParameters, orderParameters, mboxParameters);
      
    • Voici l’exemple de code pour cette méthode :

      ADB.targetLoadRequestWithName(
      function (value){ // handle target success} ,
      function() { // handle target failure }, 
      "mboxName",
      "defaultContent",
      {"profileParameters":"profileParametervalues"}
      {"orderId" : "32FGJ4XK" , "orderTotal" : "123.33" , "purchasedProductIds":"[46,34]" }
      {"mboxParameters":"mboxParametersvalues"}
      );
      
  • targetSessionID

    Obtient la valeur du cookie SessionID renvoyée pour ce visiteur par le serveur Target.

    • Voici la syntaxe de cette méthode :

      ADB.targetSessionID (success, fail); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.targetSessionID(function (value) { alert(value) },function (value){ alert('fail'); });  
      
  • targetPcID

    Obtient la valeur du cookie PcID renvoyée pour le visiteur par le serveur Target.

    • Voici la syntaxe de cette méthode :

      ADB.targetPcID (success, fail); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.targetPcID(function  (value) { alert(value) },function (value) { alert('fail'); });
      
  • targetSetThirdPartyID

    Définit l’identifiant visiteur personnalisé pour Target.

    • Voici la syntaxe de cette méthode :

      ADB.targetSetThirdPartyID(thirdPartyID, success, fail); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.targetSetThirdPartyID('test-third-party-id' function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • targetThirdPartyID

    Obtient l’identifiant visiteur personnalisé pour Target.

    • Voici la syntaxe de cette méthode :

      ADB.targetThirdPartyID(success, fail);
      
    • Voici un exemple de code pour cette méthode :

       ADB.targetThirdPartyID(function (value) { alert(value); },function (value) { alert('fail')__;});
      

Méthodes d’acquisition

  • acquisitionCampaignStartForApp

    Envoie une demande au serveur Target configuré et renvoie la valeur de chaîne de l’offre.

    • Voici la syntaxe de cette méthode :

      ADB.acquisitionCampaignStartForApp(appId, data, success, fail); 
      
    • Voici des exemples de code pour cette méthode :

      ADB.acquisitionCampaignStartForApp("appId", {‘key’:‘value’}, function() {…}, function() {…}));
      
      ADB.acquisitionCampaignStartForApp("appId", {‘key’:‘value’});  
      

Identifiant de publicité

Dans l’activité principale générée par Cordova, appelez Config.submitAdvertisingIdentifierTask() dans la méthode onResume(). Pour plus d’informations, voir Méthodes de configuration.

Méthodes Audience Manager

  • audienceGetVisitorProfile

    Obtient le profil du visiteur.

    • Voici la syntaxe de cette méthode :

      ADB.audienceGetVisitorProfile(); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.audienceGetVisitorProfile(function(value) { profile = value;}, function() { profile = null; }); 
      
  • audienceGetDpuuid

    Renvoie le DPUUID.

    • Voici la syntaxe de cette méthode :

      ADB.audienceGetDpuuid(success fail);
      
    • Voici l’exemple de code pour cette méthode :

      ADB.audienceGetDpuuid(function(value) { dpuuid = value;}, function(){dpuuid = null; }); 
      
  • audienceGetDpid

    Renvoie le DPID.

    • Voici la syntaxe de cette méthode :

      ADB.audienceGetDpid(success, fail);
      
    • Voici l’exemple de code pour cette méthode :

      ADB.audienceGetDpid(function(value){dpid = value;}, function() {dpid =  null;}); 
      
  • audienceSetDpidAndDpuuid

    Définit les DPID et DPUUID.

    • Voici la syntaxe de cette méthode :

      ADB.audienceSetDpidAndDpuuid(dpid, dpuuid, success, fail); 
      
    • Voici des exemples de code pour cette méthode :

      ADB.audienceSetDpidAndDpuuid(‘dpid’, ‘dpuuid’, function() {…}, function(){…};
      
      ADB.audienceSetDpidAndDpuuid(‘dpid’, ‘dpuuid’); 
      
  • audienceSignalWithData

    Traite une demande de service Audience Manager.

    • Voici la syntaxe de cette méthode :

      ADB.audienceSignalWithData(success, fail, data);
      
    • Voici des exemples de code pour cette méthode :

       ADB.audienceSignalWithData(function() {}, function() {} {‘key1’: ’value1’ ‘key2’: ‘value2’}); 
      
      ADB.audienceSignalWithData({‘key1’: ’value1’, ‘key2’:‘value2’}); 
      
  • audienceReset

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

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

      ADB.audienceReset();
      

Méthodes du service d’identification

  • visitorGetMarketingCloudId

    Renvoie l’Experience Cloud ID du service d’identification.

    • Voici la syntaxe de cette méthode :

      ADB.visitorGetMarketingCloudId(success, fail); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.visitorGetMarketingCloudId(function (value) { mcid = value;},function (){ mcid = null;});
      
  • visitorSyncIdentifiers

    Synchronise les identifiants fournis avec le service d’identification.

    • Voici la syntaxe de cette méthode :

      ADB.visitorSyncIdentifiers(identifiers, success, fail); 
      
    • Voici des exemples de code pour cette méthode :

      ADB.visitorSyncIdentifiers({‘key_id_1’:’value_id_1’}, function() {…}, function() {…}));
      
      ADB.visitorSyncIdentifiers({‘key_id_1’: ‘value_id_1’});  
      
  • visitorSyncIdentifiersWithAuthenticationState

    Synchronise les identifiants fournis au service d’identification.

    • Voici la syntaxe de cette méthode :

      ADB.visitorSyncIdentifiersWithAuthenticationState
      (identifiers, authenticationState, success, fail); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.visitorSyncIdentifiersWithAuthenticationState({'k1':'v1','k2':'v2','k3':'v3'}, ADB.mobileVisitorAuthenticationStateAuthenticated, function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • visitorSyncIdentifierWithType

    Synchronise l’identifiant fourni au service d’identification.

    • Voici la syntaxe de cette méthode :

      ADB.visitorSyncIdentifierWithType(identifierType, identifier authenticationState, success, fail); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.visitorSyncIdentifierWithType('test-identifier-type', 'test-identifier', ADB.mobileVisitorAuthenticationStateAuthenticated, function (value) { alert('success') },function (value) { alert('fail'); }); 
      
  • visitorAppendToURL

    Ajoute les identifiants visiteur à l’URL donnée.

    • Voici la syntaxe de cette méthode :

       ADB.visitorAppendToURL(urlToAppend, success, fail); 
      
    • Voici l’exemple de code pour cette méthode :

      ADB.visitorAppendToURL('test_visitor_url', function (value) alert(value);},'');
      
  • visitorGetIDs

    Renvoie tous les visitorID qui ont été synchronisés.

    • Voici la syntaxe de cette méthode :

      ADB.visitorGetIDs (success, fail);
      
    • Voici l’exemple de code pour cette méthode :

      ADB.visitorGetIDs(function (value) { alert(value); },function (value) { alert('fail') ;}); 
      

Sur cette page