Metodi del plug-in PhoneGap

Puoi usare i metodi di plug-in di PhoneGap iOS per eseguire diverse attività.

Nei file html in cui desideri usare il tracciamento, aggiungi quanto segue al tag <head>:

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

Metodi di configurazione

  • getPrivacyStatus

    Restituisce lo stato di privacy per l'utente corrente. Gli stati disponibili sono:

    • ADB.optedIn: gli hit vengono inviati immediatamente.

    • ADB.optedOut: gli hit vengono scartati.

    • ADB.optUnknownSe le marche temporali sono abilitate nella suite di rapporti, gli hit vengono salvati fino a quando lo stato di privacy non cambia in optedin (gli hit vengono inviati) o optedout (gli hit vengono scartati). Se le marche temporali non sono abilitate nella suite di rapporti, gli hit vengono eliminati fino alla modifica dello stato di privacy, quando l'utente acconsente (optedin).
      Il valore predefinito è impostato nel file ADBMobileConfig.json.

      • Di seguito è riportato un esempio di codice per questo metodo:

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

    Imposta lo stato di privacy per l'utente corrente su status. Puoi impostare uno dei valori seguenti:

    • ADB.optedIn: gli hit vengono inviati immediatamente.

    • ADB.optedOut: gli hit vengono scartati.

    • ADB.optUnknown - Se le marche temporali sono abilitate nella suite di rapporti, gli hit vengono salvati fino a quando lo stato di privacy non cambia in optedin (gli hit vengono inviati) o optedout (gli hit vengono scartati).

      Se le marche temporali non sono abilitate nella suite di rapporti, gli hit vengono eliminati fino alla modifica dello stato di privacy, quando l'utente acconsente (optedin).

    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Restituisce il valore "lifetime" del ciclo di vita dell'utente corrente. Il valore predefinito è 0.

    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Abilita (true) o disabilita (false) la visualizzazione delle informazioni di debug. Per impostazione predefinita, questa variabile è impostata su false.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.setDebugLogging(true);
      
  • getVersion

    Ottiene la versione della libreria.

    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Restituisce l'identificatore visitatore generato automaticamente. Si tratta di un ID visitatore univoco specifico per l’app, generato all’avvio iniziale dell’app e quindi memorizzato e utilizzato da quel momento in poi. L’ID viene mantenuto nei successivi aggiornamenti dell’app e rimosso quando l’app viene disinstallata.

    SUGGERIMENTO

    Se l'app viene aggiornata dall'SDK di Experience Cloud 3.x alla versione 4.x, l'ID visitatore precedente (personalizzato o generato in automatico) viene recuperato e memorizzato come identificatore utente personalizzato (vedi getUserIdentifier qui sotto). In tal modo i dati del visitatore vengono mantenuti da un aggiornamento all’altro dell’SDK. Per le nuove installazioni con l'SDK 4.x, l'identificatore dell'utente è null e viene utilizzato l'identificatore di tracciamento.

    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Se è stato impostato un identificatore personalizzato, restituisce l'identificatore utente personalizzato. In caso contrario restituisce null. Il valore predefinito è null.

    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Imposta l'identificatore utente su identifier.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.setUserIdentifier('testUser');
      
  • setPushIdentifier

    Imposta il token dispositivo per le notifiche push.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.setPushIdentifier(pushIdentifier,success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Imposta la preferenza per mantenere valida la sessione del ciclo di vita.

    IMPORTANTE

    Una chiamata keepLifecycleSessionAlive impedisce che l'app avvii una nuova sessione in seguito alla ripresa dopo l'esecuzione in background. Usa questo metodo solo se l'app si registra per le notifiche in background.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.keepLifecycleSessionAlive();
      
  • trackingSendQueuedHits

    Fa sì che la libreria invii tutti gli hit presenti in coda, a prescindere dalle opzioni di batch correnti.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.trackingSendQueuedHits();
      
  • trackingGetQueueSize

    Ottiene o imposta il numero di chiamate di tracciamento in attesa nella coda offline.

    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Rimuove dalla coda offline tutte le chiamate di tracciamento memorizzate.

    ATTENZIONE

    Da usare con cautela quando si cancella la coda manualmente; questa operazione non può essere annullata.

    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Indica all'SDK che la prossima ripresa dal background non rappresenta l'avvio di una nuova sessione, indipendentemente dal valore di timeout della sessione del ciclo di vita nel file di configurazione.

    IMPORTANTE

    Nota: questo metodo è destinato alle app che si registrano per le notifiche mentre sono in background, e dovrebbe essere invocato solo dal codice in esecuzione mentre l'app è in background.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.keepLifecycleSessionAlive();
      
  • collectLifecycleData

    Indica all'SDK che i dati del ciclo di vita devono essere raccolti per l'utilizzo in tutte le soluzioni dell'SDK. Per ulteriori informazioni, vedi Metriche del ciclo di vita.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.collectLifecycleData(); 
      

Metodi PII

  • collectPII

    Invia una richiesta di raccolta PII.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.collectPII(piiData,success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

Metodi di tracciamento

  • trackAdobeDeepLink

    Tiene traccia del click-through di un collegamento profondo (deep link) di Adobe.

    SUGGERIMENTO

    Se la chiamata del ciclo di vita è un evento di avvio, i dati del collegamento Adobe verranno aggiunti; in caso contrario viene inviata una chiamata aggiuntiva.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackAdobeDeepLink(deeplinkURL,success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Tiene traccia del click-through di un messaggio push.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackPushMessageClickthrough(userInfo,success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Tiene traccia del click-through di un messaggio di notifica locale.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackLocalNotificationClickThrough(userInfo,success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Tiene traccia dello stato di un'app con dati contestuali facoltativi. Gli stati sono le visualizzazioni disponibili nell'app, ad esempio home dashboard, app settings, cart e così via. Questi stati sono simili alle pagine di un sito Web e le chiamate trackState incrementano le visualizzazioni di pagina. cData è un oggetto JSON con coppie chiave-valore da inviare nei dati contestuali.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackState(stringstateName[,JSONcData]); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Tiene traccia di un'azione nell'applicazione. Le azioni sono gli eventi che avvengono nell'applicazione e che desideri misurare, come logins, banner taps, feed subscriptions e altre metriche.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackAction(stringaction[,JSONcData]);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Traccia un’azione che si è verificata nel background. In questo modo gli eventi del ciclo di vita non vengono attivati in determinati scenari.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackActionFromBackground(stringaction[,JSONcData]); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Invia le coordinate x e y correnti. Utilizza anche i punti di interesse definiti nel file ADBMobileConfig.json per determinare se la posizione fornita come parametro si trova nel raggio di riferimento di un POI. Se le coordinate correnti si trovano all'interno di un POI definito, una variabile di dati di contesto viene compilata e inviata insieme alla chiamata trackLocation.

    • Di seguito è riportata la sintassi per questo metodo:

       ADB.trackLocation(x,y[,JSONcData]);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Aggiunge al valore "lifetime" del ciclo di vita dell'utente un incremento pari a amount.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackLifetimeValueIncrease(amount[,JSONcData]);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Avvia un'azione temporizzata con il nome action. Se invochi questo metodo per un'azione già avviata, l'azione temporizzata precedente viene sovrascritta.

    SUGGERIMENTO

    Questa chiamata non invia un hit.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackTimedActionStart(action[,JSONcData]);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Passa i dati cData per aggiornare i dati contestuali associati all'azione action. I dati cData passati vengono aggiunti alla fine dei dati esistenti per l'azione, e li sovrascrivono se per l'azione è già definita la stessa chiave per action.

    SUGGERIMENTO

    Questa chiamata non invia un hit.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.trackTimedActionUpdate(Stringaction[,JSONcData]);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Termina un'azione temporizzata.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.trackTimedActionEnd("cartToCheckout");
      
  • trackingTimedActionExists

    Restituisce un valore che indica se un'azione temporizzata è in corso o meno.

    • Di seguito è riportata la sintassi per questo metodo:

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

Metodi di Target

  • targetLoadRequest

    Invia una richiesta al server di Target configurato e restituisce il valore stringa dell'offerta.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.targetLoadRequest(success,fail,name,defaultContent,parameters); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Invia una richiesta al server Target configurato.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.targetLoadOrderConfirmRequest(success,fail,name,orderId,orderTotal,productPurchaseId,parameters); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

      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

    Cancella i cookie di Target dall'archiviazione dei cookie condivisi.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.targetClearCookies();
      
  • targetLoadRequestWithNameWithLocationParameters

    Elabora la richiesta di un servizio Target.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.targetLoadRequestWithNameWithLocationParameters(success,fail,name,defaultContent,profileParameters,orderParameters,mboxParameters,requestLocationParameters
      ); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

      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

    Elabora la richiesta di un servizio Target.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.targetLoadRequestWithRequestName(success, fail, name, defaultContent, profileParameters, orderParameters, mboxParameters); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

      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

    Ottiene il valore del cookie SessionID restituito dal server Target per il visitatore corrente.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.targetSessionID(success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Ottiene il valore del cookie PcID restituito dal server Target per il visitatore corrente.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.targetPcID(success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Imposta l'ID visitatore personalizzato per Target.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.targetSetThirdPartyID(thirdPartyID,success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo gruppo:

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

    Ottiene l'ID visitatore personalizzato per Target.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.targetThirdPartyID(success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

Metodi di acquisizione

  • acquisitionCampaignStartForApp

    Consente agli sviluppatori di avviare una campagna di acquisizione app, come se l'utente avesse fatto clic su un collegamento. È utile per creare collegamenti di acquisizione manuali e per gestire direttamente il reindirizzamento all'App Store (ad esempio con SKStoreView).

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.acquisitionCampaignStartForApp(appId,data,success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.acquisitionCampaignStartForApp('0652024f-adcd-49f9-9bd7-2552a4564d2f',{'extraDataKey':'extraDataValue'},success,fail); 
      

Identificatore pubblicitario

Nel AppDelegate generato da Cordova, invoca [ADBMobile setAdvertisingIdentifier:] nel metodo delegate application:didFinishLaunchingWithOptions:. Per ulteriori informazioni, consulta Metodi di configurazione.

Metodi di Audience Manager

  • audienceGetVisitorProfile

    Ottiene il profilo del visitatore.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.audienceGetVisitorProfile();
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Restituisce l'identificatore DPUUID.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.audienceGetDpuuid(success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Restituisce l'identificatore DPID.

    • Di seguito è riportata la sintassi per questo metodo:

       ADB.audienceGetDpid(success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Imposta gli identificatori DPID e DPUUID.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.audienceSetDpidAndDpuuid(dpid,dpuuid,success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Elabora una richiesta del servizio Audience Manager.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.audienceSignalWithData(success,fail,data);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Ripristina l'identificatore UUID di Audience Manager ed elimina il profilo del visitatore corrente.

    • Di seguito è riportato un esempio di codice per questo metodo:

      ADB.audienceReset(); 
      

Metodi del servizio ID

  • visitorGetMarketingCloudId

    Restituisce l'Experience Cloud ID dal servizio ID.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.visitorGetMarketingCloudId(success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Sincronizza gli identificatori forniti con il servizio ID.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.visitorSyncIdentifiers(identifiers,success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Sincronizza gli identificatori forniti con il servizio ID visitatori.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.visitorSyncIdentifiersWithAuthenticationState(identifiers,authenticationState,success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Sincronizza con il servizio ID visitatori l'identificatore fornito.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.visitorSyncIdentifierWithType(identifierType,identifier,authenticationState,success,fail); 
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Aggiunge gli identificatori dei visitatori alla fine di un determinato URL.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.visitorAppendToURL(urlToAppend,success,fail);
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Restituisce tutti gli identificatori visitorIDs che sono stati sincronizzati.

    • Di seguito è riportata la sintassi per questo metodo:

      ADB.visitorGetIDs(success,fail)
      
    • Di seguito è riportato un esempio di codice per questo metodo:

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

In questa pagina