Metodi TVJS

Elenco dei metodi TVJS forniti dalla libreria tvOS.

Metodi di configurazione

  • version

    Restituisce la versione corrente della libreria Adobe Mobile.

    • Di seguito è riportata la sintassi per questo metodo:

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

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

  • privacyStatus

    Restituisce la rappresentazione NSUInteger dello stato di privacy enum per l’utente corrente.

    Di seguito sono riportate le opzioni disponibili:

    • ADBMobilePrivacyStatusOptIn: gli hit vengono inviati immediatamente.

    • ADBMobilePrivacyStatusOptOut: gli hit vengono scartati.

    • ADBMobilePrivacyStatusUnknown: se è abilitato il tracciamento offline, gli hit vengono salvati finché lo stato di privacy non cambia in optedin (gli hit vengono inviati) o in optedout (gli hit vengono scartati).

      Se il tracciamento offline non è abilitato, gli hit vengono scartati finché lo stato di privacy non cambia in optedin. Il valore predefinito è impostato nel file ADBMobileConfig.json.

    • Di seguito è riportata la sintassi per questo metodo:

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

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

  • setPrivacyStatus

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

    • ADBMobilePrivacyStatusOptIn: gli hit vengono inviati immediatamente.
    • ADBMobilePrivacyStatusOptOut: gli hit vengono scartati.
    • ADBMobilePrivacyStatusUnknown: se è abilitato il tracciamento offline, gli hit vengono salvati finché lo stato di privacy non cambia in optedin (gli hit vengono inviati) o in optedout (gli hit vengono scartati).

    Se il tracciamento offline non è abilitato, gli hit vengono scartati finché lo stato di privacy non cambia in optedin.

    • Di seguito è riportata la sintassi per questo metodo:

      setPrivacyStatus(privacyStatus)
      
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADBMobile.setPrivacyStatus(ADBMobilePrivacyStatusOptIn);
      
  • lifetimeValue

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

    • Di seguito è riportata la sintassi per questo metodo:

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

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

  • userIdentifier

    Restituisce l'identificatore utente se è stato impostato un identificatore personalizzato. Restituisce nil se non è impostato alcun identificatore personalizzato. Il valore predefinito è nil.

    IMPORTANTE

    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. 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 è nil finché non viene impostato.

    • Di seguito è riportata la sintassi per questo metodo:

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

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

  • setUserIdentifier

    Imposta l'identificatore dell'utente.

    • Di seguito è riportata la sintassi per questo metodo:

      setUserIdentifier(userId)
      
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADBMobile.setUserIdentifier(‘myUserId’);
      
    • Restituisce: N/D

    • Parametro: userID

      • Tipo: string
      • Nuovo identificatore per questo utente.
  • setAdvertisingIdentifier

    Imposta l’identificatore IDFA nell’SDK e, se è stato impostato nell’SDK, l’identificatore IDFA viene inviato nel ciclo di vita. È inoltre possibile accedervi in Segnali (Postback).

    IMPORTANTE

    Recupera l'identificatore IDFA dall'API di Apple solo se utilizzi un servizio di annunci. Se recuperi l'identificatore IDFA e non lo utilizzi correttamente, l'app potrebbe venire rifiutata.

    • Di seguito è riportata la sintassi per questo metodo:

      setAdvertisingIdentifier(idfa)
      
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADBMobile.setAdvertisingIdentifier(‘myIdfa’);
      
    • Restituisce: N/D

    • Parametro: idfa

      • Tipo: String
      • IDFA recuperato dell'API di Apple.
  • setDebugLogging

    Restituisce la preferenza di accesso di debug.

    • Di seguito è riportata la sintassi per questo metodo:

      setDebugLogging(logging)
      
    • Di seguito è riportato un esempio di codice per questo metodo:

      `ADBMobile.setDebugLogging(true);
      
    • Restituisce: N/D

    • Parametri: logging

      • Tipo: Bool
      • Valore che indica se Adobe SDK dovrebbe registrare nella console di debug.

Metodi di Analytics

  • trackStateData

    Tiene traccia dello stato di un'app con dati contestuali facoltativi. Gli stati sono le visualizzazioni disponibili nell'app, ad esempio dashboard iniziale, impostazioni dell'app, carrello e così via. Questi stati sono simili alle pagine di un sito Web e le chiamate trackState incrementano le visualizzazioni di pagina.

    Se lo stato è vuoto, nei rapporti viene visualizzato come app name app version (build). Se trovi questo valore nei rapporti, assicurati che in ogni chiamata trackState sia impostato il valore state.

    SUGGERIMENTO

    Questa è l'unica chiamata di tracciamento che incrementa le visualizzazioni pagina.

    • Di seguito è riportata la sintassi per questo metodo:

      trackStateData(stateName [, contextData])
      
      • Restituisce: N/D
      • Parametro: stateName
        • Tipo: String
        • Nome dello stato della pagina
      • Parametro: contextData
        • Tipo: oggetto
        • Dati contestuali aggiuntivi per l’hit.
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Tiene traccia di un'azione nell'applicazione. Le azioni sono gli eventi che avvengono nell'applicazione e che desideri misurare, come accessi, tap sui banner, abbonamenti ai feed e altre metriche.

    • Di seguito è riportata la sintassi per questo metodo:

      trackActionData(actionName [, contextData])
      
      • Restituisce: N/D
      • Parametri: actionName
        • Tipo: string
        • Nome dell’azione da tracciare.
      • Parametro: contextData
        • Tipo: oggetto
        • Dati contestuali aggiuntivi per l’hit.
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Invia le coordinate di latitudine e longitudine correnti.

    Utilizza anche i punti di interesse (POI) definiti nel file ADBMobileConfig.json per determinare se la posizione fornita come parametro si trova all'interno di un POI. Se le coordinate correnti si trovano in 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:

      trackLocationWithLatLonData(lat, lon [, contextData]);
      
      • Restituisce: N/D
      • Parametro: lat
        • Tipo: numero
        • Latitudine della posizione.
      • Parametro: lon
        • Tipo: numero
        • Longitudine della posizione.
      • Parametro: contextData
        • Tipo: oggetto
        • Dati contestuali aggiuntivi per l’hit.
    • Di seguito è riportato un esempio di codice per questo metodo:

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

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

    • Di seguito è riportata la sintassi per questo metodo:

      trackLifetimeValueIncreaseJsData(increaseAmount)
      
      • Restituisce: N/D
      • Parametro: increaseAmount
        • Tipo: numero
        • Importo da aggiungere al valore del ciclo di vita corrente dell’utente.
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADBMobile.trackLifetimeValueIncreaseJsData(5);
      
  • trackTimedActionStartData

    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:

      trackTimedActionStartData(name [, contextData])
      
      • Restituisce: N/D
      • Parametro: name
        • Tipo: string
        • Nome dell’azione temporizzata da avviare.
      • Parametro: contextData
        • Tipo: oggetto
        • Dati contestuali aggiuntivi per l’hit.
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Passa i dati per aggiornare i dati contestuali associati all’azione in questione.

    I dati passati vengono aggiunti alla fine dei dati esistenti per l’azione in questione e li sovrascrivono se per l’azione è già definita la stessa chiave.

    SUGGERIMENTO

    Questa chiamata non invia un hit.

    • Di seguito è riportata la sintassi per questo metodo:

      trackTimedActionUpdateData(name [, contextData])
      
      • Restituisce: N/D
      • Parametro: name
        • Tipo: string
        • Nome dell’azione temporizzata da aggiornare.
      • Parametro: contextData
        • Tipo: oggetto
        • Dati contestuali aggiuntivi per l’hit.
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADBMobile.trackTimedActionUpdateData(‘level1’);
      
  • trackTimedActionEndJsLogic

    Termina un'azione temporizzata.

    Se fornisci una funzione di callback, puoi accedere ai valori temporali finali. Se non viene fornito alcun callback, o se il callback restituisce true, l’SDK di Adobe invia automaticamente un hit. Se restituisce false, l'hit dell'azione temporizzata viene eliminato.

    • Di seguito è riportata la sintassi per questo metodo:

      trackTimedActionEndJsLogic(name [, callback])
      
      • Restituisce: N/D

      • Parametri: name

        • Tipo: string
        • Nome dell’azione temporizzata da terminare
      • Parametro: callback

        • Tipo: function(inAppDuration, totalDuration, data)

        • Metodo di callback i cui parametri conterranno il inAppDuration (numero), il totalDuration (numero) e data (oggetto di dati contestuali).

          Se la funzione di callback restituisce false, verrà impedito l'invio dell'hit finale da parte dell'SDK.

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

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

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

    • Di seguito è riportata la sintassi per questo metodo:

      trackingTimedActionExistsJs(name)
      
      • Restituisce: Bool
      • Parametro: name
        • Tipo: String
        • Nome dell’azione temporizzata per la quale è necessario verificare l’esistenza.
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Restituisce l'identificatore visitatore generato automaticamente.

    Si tratta di un ID visitatore univoco specifico per l’app, generato dai server Adobe. Se non è possibile raggiungere i server Adobe al momento della generazione, l’ID viene generato utilizzando CFUUID di Apple. Il valore viene generato al primo avvio e memorizzato e utilizzato da tale momento in poi. Questo ID viene mantenuto nei successivi aggiornamenti dell’app, viene salvato e ripristinato durante il processo standard di backup dell’applicazione e viene 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. 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 è nil e viene utilizzato l'identificatore di tracciamento. Per ulteriori informazioni, consulta la riga userIdentifier di seguito.

    • Di seguito è riportata la sintassi per questo metodo:

      trackingIdentifier()
      
      • Restituisce: String
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var trackingId = ADBMobile.trackingIdentifier();
      
  • trackingSendQueuedHits

    Forza l'invio da parte della libreria di tutti gli hit nella coda, indipendentemente dal numero di hit attualmente presenti nella coda.

    • Di seguito è riportata la sintassi per questo metodo:

      trackingSendQueuedHits()
      
      • Restituisce: N/D
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADBMobile.trackingSendQueuedHits();
      
  • trackingClearQueue

    Elimina tutti gli hit dalla coda offline.

    • Di seguito è riportata la sintassi per questo metodo:

      trackingClearQueue()
      
      • Restituisce: N/D
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADBMobile.trackingClearQueue();
      
  • trackingGetQueueSize

    Recupera il numero di hit attualmente presenti nella coda offline.

    • Di seguito è riportata la sintassi per questo metodo:

      trackingGetQueueSize()
      
      • Restituisce: numero
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var queueSize = ADBMobile.trackingGetQueueSize();
      

Metodi di Audience Manager

  • audienceVisitorProfile

    Restituisce il profilo del visitatore ottenuto più di recente.

    Restituisce null se non è stato ancora inviato alcun segnale. Il profilo del visitatore viene salvato in NSUserDefaults in modo da essere facilmente accessibile per diversi avvii dell'applicazione.

    • Di seguito è riportata la sintassi per questo metodo:

      audienceVisitorProfile()
      
      • Restituisce: oggetto
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var profile = ADBMobile.audienceVisitorProfile();
      
  • audienceDpid

    Restituisce il DPID corrente.

    • Di seguito è riportata la sintassi per questo metodo:

      audienceDpid()
      
      • Restituisce: String
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var dpid = ADBMobile.audienceDpid();
      
  • audienceDpuuid

    Restituisce il DPUUID corrente.

    • Di seguito è riportata la sintassi per questo metodo:

      audienceDpuuid()
      
      • Restituisce: String
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var dpuuid = ADBMobile.audienceDpuuid();
      
  • audienceSetDpidDpuuid

    Imposta il dpid e il dpuuid e, se sono impostati, saranno inviati con ciascun segnale.

    • Di seguito è riportata la sintassi per questo metodo:

      audienceSetDpidDpuuid(dpid, dpuuid)
      
      • Restituisce: N/D
      • Parametro: dpid
        • Tipo: String
        • ID del provider di dati Audience Manager.
      • Parametro: dpuuid
        • Tipo: String
        • Identificatore per la combinazione utente-provider dati.
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Invia a Audience Manager un segnale con caratteristiche e riceve i segmenti corrispondenti restituiti in una funzione di callback.

    • Di seguito è riportata la sintassi per questo metodo:

      audienceSignalWithDataJsCallback(traits [, callback])
      
      • Parametro: traits
        • Tipo: oggetto
        • Dizionario delle caratteristiche per questo utente.
      • Parametro: callback
        • Tipo: function(profile)
        • Il profilo restituito da Audience Manager nel parametro per la funzione di callback.
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Ripristina l'identificatore UUID di Audience Manager e svuota il profilo visitatore corrente.

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

      audienceReset()
      
      • Restituisce: N/D
      • Parametro: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      ADBMobile.audienceReset();
      

Metodi del servizio ID

  • visitorMarketingCloudID

    Recupera l'Experience Cloud ID dal servizio ID.

    • Di seguito è riportata la sintassi per questo metodo:

      visitorMarketingCloudID()
      
      • Restituisce: String
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var mcid = ADBMobile.visitorMarketingCloudID();
      
  • visitorSyncIdentifiers

    Oltre a Experience Cloud ID, puoi impostare ID cliente aggiuntivi da associare a ogni visitatore. L’API visitatore accetta più ID cliente per lo stesso visitatore, con un identificatore del tipo di cliente per separare l’ambito dei diversi ID cliente. Questo metodo corrisponde a setCustomerIDs nella libreria JavaScript.

    • Di seguito è riportata la sintassi per questo metodo:

      visitorSyncIdentifiers(identifiers)
      
      • Restituisce: N/D

      • Parametro: identifiers

        • Tipo: Object
        • Identificatori da sincronizzare con il servizio ID per l'utente corrente.
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Sincronizza gli identificatori forniti con il servizio ID.

    • Di seguito è riportata la sintassi per questo metodo:

      visitorSyncIdentifiersAuthenticationState(identifiers, authState)
      
      • Restituisce: N/D
      • Parametri: identifiers
        • Tipo: Object
        • Identificatori da sincronizzare con il servizio ID per l'utente corrente.
      • Parametro: authState
        • Tipo: ADBMobileVisitorAuthenticationState
        • Lo stato di autenticazione dell’utente e i valori possibili includono:
          • ADBMobileVisitorAuthenticationStateUnknown
          • ADBMobileVisitorAuthenticationStateAuthenticated
          • ADBMobileVisitorAuthenticationStateLoggedOut
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Sincronizza con il servizio ID il tipo e il valore dell'identificatore fornito.

    • Di seguito è riportata la sintassi per questo metodo:

      visitorSyncIdentifierWithTypeIdentifierAuthenticationState(idType, identifier, authState)
      
      • Restituisce: N/D
      • Parametro: idType
        • Tipo: String
        • Tipo dell'identificatore da sincronizzare.
      • Parametro: identifier
        • Tipo: String
        • Valore dell'identificatore da sincronizzare.
      • Parametro: authState
        • Tipo: ADBMobileVisitorAuthenticationState
          Stato di autenticazione dell’utente. Possibili valori:
          • ADBMobileVisitorAuthenticationStateUnknown
          • ADBMobileVisitorAuthenticationStateAuthenticated
          • ADBMobileVisitorAuthenticationStateLoggedOut
    • Di seguito è riportato un esempio di codice per questo metodo:

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

    Recupera un array di oggetti ADBVisitorID di sola lettura. Il codice seguente è un esempio di oggetto VisitorID:

    {
        idType: "abc",
        authenticationState: 1, 
        identifier: "123"
    }
    
    • Di seguito è riportata la sintassi per questo metodo:

      visitorGetIDsJs()
      
      • Restituisce: Array [Object]

      • Parametri: nessuno

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

      var myVisitorIds = ADBMobile.visitorGetIDsJs();
      

Metodi di Target

  • targetThirdPartyID

    Restituisce l'ID di terze parti.

    • Di seguito è riportata la sintassi per questo metodo:

      targetThirdPartyID()
      
      • Restituisce: String
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var thirdPartyID = ADBMobile.targetThirdPartyID();
      
  • targetSetThirdPartyID

    Imposta l'ID di terze parti.

    • Di seguito è riportata la sintassi per questo metodo:

      targetSetThirdPartyID(thirdPartyID)
      
      • Restituisce: N/D
      • Parametri: thirdPartyID
        • Tipo: String
        • ID di terze parti da usare per le richieste di Target.
    • Di seguito è riportato un esempio di codice per questo metodo:

    ADBMobile.targetSetThirdPartyID(‘thirdPartyID’);
    
  • targetPcID

    Restituisce il PcID.

    • Di seguito è riportata la sintassi per questo metodo:

      targetPcID()
      
      • Restituisce: String
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var pcID = ADBMobile.targetPcID();
      
  • targetSessionID

    Restituisce l'ID della sessione.

    • Di seguito è riportata la sintassi per questo metodo:

      targetSessionID()
      
      • Restituisce: String
      • Parametri: nessuno
    • Di seguito è riportato un esempio di codice per questo metodo:

      var sessionID = ADBMobile.targetSessionID();
      

In questa pagina