Show Menu
TEMAS×

Métodos de TVJS

Esta es una lista de métodos de TVJS que proporciona la biblioteca tvOS.

Métodos de configuración

  • version
    Devuelve la versión actual de la biblioteca de Adobe Mobile.
    • Esta es la sintaxis para este método:
      version()
      
      
    • Este es un ejemplo de código para este método:
      var sdkVersion = ADBMobile.version();
      
      
    • Devuelve: String
  • privacyStatus
    Devuelve la representación NSUInteger de enumeración del estado de privacidad para el usuario actual.
    Las opciones son las siguientes:
    • ADBMobilePrivacyStatusOptIn : Las visitas se envían inmediatamente.
    • ADBMobilePrivacyStatusOptOut : Se descartan las visitas.
    • ADBMobilePrivacyStatusUnknown : si el seguimiento en línea está activado, las visitas se guardan hasta que el estado de privacidad cambie a Opt-in (entonces se envían las visitas) u Opt-out (entonces se descartan las visitas).
      Si el seguimiento en línea no está activado, las visitas se descartan hasta que el estado de privacidad cambie a Opt-in. El valor predeterminado se establece en el archivo ADBMobileConfig.json .
    • Esta es la sintaxis para este método:
      privacyStatus()
      
      
    • Este es un ejemplo de código para este método:
      var privacyStatus = ADBMobile.privacyStatus();
      
      
    • Devuelve: Number
  • Método setPrivacyStatus
    Establece el estado de privacidad del usuario actual en uno de los siguientes valores:
    • ADBMobilePrivacyStatusOptIn : Las visitas se envían inmediatamente.
    • ADBMobilePrivacyStatusOptOut : Se descartan las visitas.
    • ADBMobilePrivacyStatusUnknown : Si el seguimiento en línea está activado, las visitas se guardan hasta que el estado de privacidad cambie a Opt-in (entonces se envían las visitas) u Opt-out (entonces se descartan las visitas). Si el seguimiento en línea no está activado, las visitas se descartan hasta que el estado de privacidad cambie a Opt-in.
    • Esta es la sintaxis para este método:
      setPrivacyStatus(privacyStatus)
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.setPrivacyStatus(ADBMobilePrivacyStatusOptIn);
      
      
  • lifetimeValue
    Devuelve el valor de duración del usuario actual. El valor predeterminado es 0 .
    • Esta es la sintaxis para este método:
      lifetimeValue()
      
      
    • Este es un ejemplo de código para este método:
      var ltv = ADBMobile.lifetimeValue();
      
      
    • Devuelve: Number
  • userIdentifier
    Devuelve el identificador del usuario si se ha establecido uno personalizado. Devuelve “nil” si no se ha establecido un identificador personalizado. El valor predeterminado es nil .
    Si la aplicación se actualiza del SDK 3.x al 4.x de Experience Cloud, el ID de visitante previo (personalizado o generado automáticamente) se recupera y se almacena como identificador de usuario personalizado. Esto preserva los datos de visitante al actualizar el SDK. Para nuevas instalaciones sobre el SDK 4.x, el identificador de usuario es nil hasta que se establece.
    • Esta es la sintaxis para este método:
      userIdentifier()
      
      
    • Este es un ejemplo de código para este método:
      var uid = ADBMobile.userIdentifier();
      
      
    • Devuelve: String
  • setUserIdentifier
    Establece el identificador de usuario.
    • Esta es la sintaxis para este método:
      setUserIdentifier(userId)
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.setUserIdentifier(‘myUserId’);
      
      
    • Devuelve: N/A
    • Parámetro: userID
      • Tipo: String
      • Nuevo identificador para el usuario actual.
  • setAdvertisingIdentifier
    Establece el IDFA en el SDK y, si se ha establecido en el SDK, el IDFA se envía durante el ciclo vital. También se puede acceder al IDFA en Señales (Postbacks).
    Recupere el IDFA desde las API de Apple solo si está utilizando un servicio publicitario. Si recupera el IDFA y no lo utiliza de forma apropiada, podría rechazarse la aplicación.
    • Esta es la sintaxis para este método:
      setAdvertisingIdentifier(idfa)
      
      
    • Este es un ejemplo de código para este método:
      ADBMobile.setAdvertisingIdentifier(‘myIdfa’);
      
      
    • Devuelve: N/A
    • Parámetro: idfa
      • Tipo: String
      • IDFA obtenido de la API de Apple.
  • setDebugLogging
    Establece la preferencia de registro de depuración.
    • Esta es la sintaxis para este método:
      setDebugLogging(logging)
      
      
    • Este es un ejemplo de código para este método:
      `ADBMobile.setDebugLogging(true);
      
      
    • Devuelve: N/A
    • Parámetros: logging
      • Tipo: Bool
      • Valor que indica si el SDK de Adobe debe registrarse en la consola de depuración.

Métodos de Analytics

  • trackStateData
    Realiza el seguimiento del estado de una aplicación con datos de contexto opcionales. Los estados son las visualizaciones disponibles en su aplicación, como el tablero de inicio, la configuración de la aplicación, el carrito, etcétera. Estos estados son similares a las páginas de un sitio web y las llamadas trackState incrementan las visualizaciones de página.
    Si el estado está vacío, en los informes se muestra app name app version (build). Si observa este valor en los informes, asegúrese de que establece el estado en cada llamada a trackState.
    Esta es la única llamada de seguimiento que incrementa las visualizaciones de página.
    • Esta es la sintaxis para este método:
      trackStateData(stateName [, contextData])
      
      
      • Devuelve: N/A
      • Parámetro: stateName
        • Tipo: String
        • Nombre del estado de la página
      • Parámetro: contextData
        • Tipo: Object
        • Datos de contexto adicionales para esta visita.
    • Este es un ejemplo de código para este método:
      ADBMobile.trackStateData(‘homepage’, {‘userid’:12345});
      
      
  • trackActionData
    Realiza el seguimiento de una acción en la aplicación. Las acciones son cosas que suceden en la aplicación y que es interesante medir, por ejemplo, inicios de sesión, toques en banners, suscripciones a fuentes y otras métricas.
    • Esta es la sintaxis para este método:
      trackActionData(actionName [, contextData])
      
      
      • Devuelve: N/A
      • Parámetros: actionName
        • Tipo: String
        • Nombre de la acción a la que hacer seguimiento.
      • Parámetro: contextData
        • Tipo: Object
        • Datos de contexto adicionales para esta visita.
    • Este es un ejemplo de código para este método:
      ADBMobile.trackActionData(‘likeClicked’, {‘imageName’:’funnyKitty’});
      
      
  • trackLocationWithLatLonData
    Envía las coordenadas de latitud y longitud actuales.
    También utiliza puntos de interés (POI) definidos en el archivo ADBMobileConfig.json para determinar si la ubicación proporcionada como parámetro se encuentra en alguno de sus puntos de interés. Si las coordinadas actuales se encuentran en un punto de interés definido, se rellena una variable de datos de contexto y se envía junto con la llamada a trackLocation .
    • Esta es la sintaxis para este método:
      trackLocationWithLatLonData(lat, lon [, contextData]);
      
      
      • Devuelve: N/A
      • Parámetro: lat
        • Tipo: número
        • Latitud de la ubicación.
      • Parámetro: lon
        • Tipo: número
        • Longitud de la ubicación.
      • Parámetro: contextData
        • Tipo: Object
        • Datos de contexto adicionales para esta visita.
    • Este es un ejemplo de código para este método:
      ADBMobile.trackLocationWithLatLonData(43.36, -116.12, null);
      
      
  • trackLifetimeValueIncreaseJsData
    Agrega una cantidad al valor de duración del usuario.
    • Esta es la sintaxis para este método:
      trackLifetimeValueIncreaseJsData(increaseAmount)
      
      
      • Devuelve: N/A
      • Parámetro: increaseAmount
        • Tipo: número
        • Cantidad que se debe sumar al valor de duración del usuario.
    • Este es un ejemplo de código para este método:
      ADBMobile.trackLifetimeValueIncreaseJsData(5);
      
      
  • trackTimedActionStartData
    Inicia una acción temporizada con acción de nombre. Si invoca este método para una acción que ya se ha iniciado, se sobrescribe la acción temporizada anterior.
    Esta llamada no envía una visita.
    • Esta es la sintaxis para este método:
      trackTimedActionStartData(name [, contextData])
      
      
      • Devuelve: N/A
      • Parámetro: name
        • Tipo: String
        • Nombre de la acción temporizada que se inicia.
      • Parámetro: contextData
        • Tipo: Object
        • Datos de contexto adicionales para esta visita.
    • Este es un ejemplo de código para este método:
      ADBMobile.trackTimedActionStartData(‘level1’, {‘userId’:42423});
      
      
  • trackTimedActionUpdateData
    Pasa datos para actualizar los datos de contexto asociados a la acción determinada.
    Los datos que se pasan se anexan a los ya existentes para la acción dada. Si la misma clave ya está definida para action, los datos se sobrescriben.
    Esta llamada no envía una visita.
    • Esta es la sintaxis para este método:
      trackTimedActionUpdateData(name [, contextData])
      
      
      • Devuelve: N/A
      • Parámetro: name
        • Tipo: String
        • Nombre de la acción temporizada que se actualiza.
      • Parámetro: contextData
        • Tipo: Object
        • Datos de contexto adicionales para esta visita.
    • Este es un ejemplo de código para este método:
      ADBMobile.trackTimedActionUpdateData(‘level1’);
      
      
  • trackTimedActionEndJsLogic
    Finaliza una acción temporizada.
    Si proporciona una función de llamada de retorno, puede acceder a los valores de tiempo finales. Si no se proporciona ninguna llamada de retorno, o si la llamada de retorno devuelve el valor true, el SDK de Adobe envía una visita automáticamente. Cuando la llamada de retorno devuelve un valor false, la visita de la acción temporizada se suprime.
    • Esta es la sintaxis para este método:
      trackTimedActionEndJsLogic(name [, callback])
      
      
      • Devuelve: N/A
      • Parámetros: name
        • Tipo: String
        • Nombre de la acción temporizada que finaliza.
      • Parámetro: callback
        • Tipo: function(inAppDuration, totalDuration, data)
        • Método de llamada de retorno que tiene como parámetros inAppDuration (número), totalDuration (número), y data (objeto de datos de contexto).
          Puede suprimir el envío al SDK de la última visita devolviendo un valor false en su función de llamada de retorno.
      • Este es un ejemplo de código para este método:
        ADBMobile.trackTimedActionEndJsLogic(‘level1’, 
        function(inAppDuration, totalDuration, data) {
            // do something with final values
            return true;
            });
        
        
  • trackingTimedActionExistsJs
    Devuelve si la acción temporizada está en progreso o no.
    • Esta es la sintaxis para este método:
      trackingTimedActionExistsJs(name)
      
      
      • Devuelve: Bool
      • Parámetro: name
        • Tipo: String
        • Nombre de la acción temporizada para la que debe comprobar la existencia.
    • Este es un ejemplo de código para este método:
      var actionExists = ADBMobile.trackTimedActionExistsJs(‘level1’);
      
      
  • trackingIdentifier
    Devuelve el identificador de visitante generado automáticamente.
    Se trata de un identificador de visitante exclusivo y específico para la aplicación que generan los servidores de Adobe. Si los servidores de Adobe no están disponibles en el momento de la generación, el ID se genera empleando el CFUUID de Apple. El valor se genera durante el primer inicio, que después se almacena y utiliza a partir de ese momento. Este ID se preserva al actualizar la aplicación, se guarda y se restaura durante el proceso estándar de copia de seguridad de la aplicación, y se elimina al desinstalarla.
    Si la aplicación se actualiza del SDK 3.x al 4.x de Experience Cloud, el ID de visitante previo (personalizado o generado automáticamente) se recupera y se almacena como identificador de usuario personalizado. Esto preserva los datos de visitante al actualizar el SDK. Para nuevas instalaciones sobre el SDK 4.x, el identificador de usuario tiene el valor nil y se utiliza el identificador de seguimiento. Para obtener más información, consulte abajo la fila userIdentifier.
    • Esta es la sintaxis para este método:
      trackingIdentifier()
      
      
      • Devuelve: String
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var trackingId = ADBMobile.trackingIdentifier();
      
      
  • trackingSendQueuedHits
    Fuerza la biblioteca a enviar todas las visitas en la cola sin conexión, sin importar cuántas haya en la cola.
    • Esta es la sintaxis para este método:
      trackingSendQueuedHits()
      
      
      • Devuelve: N/A
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      ADBMobile.trackingSendQueuedHits();
      
      
  • trackingClearQueue
    Borra todas las visitas de la cola sin conexión.
    • Esta es la sintaxis para este método:
      trackingClearQueue()
      
      
      • Devuelve: N/A
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      ADBMobile.trackingClearQueue();
      
      
  • trackingGetQueueSize
    Recupera el número de visitas que hay actualmente en la cola sin conexión.
    • Esta es la sintaxis para este método:
      trackingGetQueueSize()
      
      
      • Devuelve: número
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var queueSize = ADBMobile.trackingGetQueueSize();
      
      

Métodos de Audience Manager

  • audienceVisitorProfile
    Devuelve el perfil del visitante que se haya obtenido más recientemente.
    Devuelve null si todavía no se ha enviado ninguna señal. El perfil del visitante está guardado en NSUserDefaults para acceder fácilmente entre los distintos lanzamientos de la aplicación.
    • Esta es la sintaxis para este método:
      audienceVisitorProfile()
      
      
      • Devuelve: objeto
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var profile = ADBMobile.audienceVisitorProfile();
      
      
  • audienceDpid
    Devuelve el DPID actual.
    • Esta es la sintaxis para este método:
      audienceDpid()
      
      
      • Devuelve: String
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var dpid = ADBMobile.audienceDpid();
      
      
  • audienceDpuuid
    Devuelve el DPUUID actual.
    • Esta es la sintaxis para este método:
      audienceDpuuid()
      
      
      • Devuelve: String
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var dpuuid = ADBMobile.audienceDpuuid();
      
      
  • audienceSetDpidDpuuid
    Establece dpid y dpuuid. Si están establecidos, se envían con cada señal.
    • Esta es la sintaxis para este método:
      audienceSetDpidDpuuid(dpid, dpuuid)
      
      
      • Devuelve: N/A
      • Parámetro: dpid
        • Tipo: String
        • ID de proveedor de datos de Audience Manager.
      • Parámetro: dpuuid
        • Tipo: String
        • Identificador para la combinación de usuario y proveedor de datos.
    • Este es un ejemplo de código para este método:
      ADBMobile.audienceSetDpidDpuuid(‘myDpid’, ‘userDpuuid’);
      
      
  • audienceSignalWithDataJsCallback
    Envía a Audience Manager una señal con características y obtiene una devolución de los segmentos coincidentes en una función de llamada de retorno.
    • Esta es la sintaxis para este método:
      audienceSignalWithDataJsCallback(traits [, callback])
      
      
      • Parámetro: traits
        • Tipo: Object
        • Diccionario de características para el usuario actual.
      • Parámetro: callback
        • Tipo: function(profile)
        • El perfil devuelto desde Audience Manager en el parámetro de la función de llamada de retorno.
    • Este es un ejemplo de código para este método:
      ADBMobile.audienceSignalWithDataJsCallback({‘trait’:’something’}, 
      function(profile) {
          //do something with the user’s segments found in profile
           });
      
      
  • audienceReset
    Restaura el UUID de Audience Manager y purga el perfil del visitante actual.
    • Este es un ejemplo de código para este método:
      audienceReset()
      
      
      • Devuelve: N/A
      • Parámetro: Ninguno
    • Este es un ejemplo de código para este método:
      ADBMobile.audienceReset();
      
      

Métodos del servicio de ID

  • visitorMarketingCloudID
    Recupera el Experience Cloud ID desde el servicio de ID.
    • Esta es la sintaxis para este método:
      visitorMarketingCloudID()
      
      
      • Devuelve: String
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var mcid = ADBMobile.visitorMarketingCloudID();
      
      
  • visitorSyncIdentifiers
    Además del Experience Cloud ID, puede configurar ID de cliente adicionales para asociarlos a cada visitante. La API de visitante acepta varios ID de cliente para el mismo visitante, con un identificador de tipo de cliente para separar el ámbito de los distintos ID de cliente. Este método corresponde a setCustomerIDs en la biblioteca JavaScript.
    • Esta es la sintaxis para este método:
      visitorSyncIdentifiers(identifiers)
      
      
      • Devuelve: N/A
      • Parámetro: identifiers
        • Tipo: Object
        • Identificadores para sincronizar con el servicio de ID del usuario actual.
    • Este es un ejemplo de código para este método:
      ADBMobile.visitorSyncIdentifiers({‘idType’:’idValue’});
      
      
  • visitorSyncIdentifiersAuthenticationState
    Sincroniza los identificadores proporcionados con el servicio de ID.
    • Esta es la sintaxis para este método:
      visitorSyncIdentifiersAuthenticationState(identifiers, authState)
      
      
      • Devuelve: N/A
      • Parámetros: identifiers
        • Tipo: Object
        • Identificadores para sincronizar con el servicio de ID del usuario actual.
      • Parámetro: authState
        • Tipo: ADBMobileVisitorAuthenticationState
        • El estado de autenticación del usuario y los valores posibles incluyen:
          • ADBMobileVisitorAuthenticationStateUnknown
          • ADBMobileVisitorAuthenticationStateAuthenticated
          • ADBMobileVisitorAuthenticationStateLoggedOut
    • Este es un ejemplo de código para este método:
      ADBMobile.visitorSyncIdentifiersAuthenticationState({'myIdType':'valueForUser'}, ADBMobileVisitorAuthenticationStateLoggedOut)
      
      
  • visitorSyncIdentifierWithTypeIdentifierAuthenticationState
    Sincroniza el tipo de identificador y el valor proporcionados con el servicio de ID.
    • Esta es la sintaxis para este método:
      visitorSyncIdentifierWithTypeIdentifierAuthenticationState(idType, identifier, authState)
      
      
      • Devuelve: N/A
      • Parámetro: idType
        • Tipo: String
        • Tipo de identificador que está sincronizando.
      • Parámetro: identifier
        • Tipo: String
        • Valor del identificador que está sincronizando.
      • Parámetro: authState
        • Tipo: Estado de autenticación del usuario ADBMobileVisitorAuthenticationStateAuthentication. Entre los posibles valores están:
          • ADBMobileVisitorAuthenticationStateUnknown
          • ADBMobileVisitorAuthenticationStateAuthenticated
          • ADBMobileVisitorAuthenticationStateLoggedOut
    • Este es un ejemplo de código para este método:
      ADBMobile.visitorSyncIdentifierWithTypeIdentifierAuthenticationState('myIdType', 'valueForUser', 
      ADBMobileVisitorAuthenticationStateAuthenticated);
      
      
  • visitorGetIDsJs
    Recupera una matriz de objetos ADBVisitorID de solo lectura. La siguiente muestra de código es un ejemplo de objeto VisitorID:
    {
        idType: "abc",
        authenticationState: 1, 
        identifier: "123"
    }
    
    
    • Esta es la sintaxis para este método:
      visitorGetIDsJs()
      
      
      • Devuelve: Array [Object]
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var myVisitorIds = ADBMobile.visitorGetIDsJs();
      
      

Métodos de Target

  • targetThirdPartyID
    Devuelve el ID de terceros.
    • Esta es la sintaxis para este método:
      targetThirdPartyID()
      
      
      • Devuelve: String
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var thirdPartyID = ADBMobile.targetThirdPartyID();
      
      
  • targetSetThirdPartyID
    Establece el ID de terceros.
    • Esta es la sintaxis para este método:
      targetSetThirdPartyID(thirdPartyID)
      
      
      • Devuelve: N/A
      • Parámetros: thirdPartyID
        • Tipo: String
        • ID de tercero para usar en solicitudes de destino.
    • Este es un ejemplo de código para este método:
    ADBMobile.targetSetThirdPartyID(‘thirdPartyID’);
    
    
  • targetPcID
    Devuelve el valor de PcID.
    • Esta es la sintaxis para este método:
      targetPcID()
      
      
      • Devuelve: String
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var pcID = ADBMobile.targetPcID();
      
      
  • targetSessionID
    Devuelve el ID de sesión.
    • Esta es la sintaxis para este método:
      targetSessionID()
      
      
      • Devuelve: String
      • Parámetros: ninguno
    • Este es un ejemplo de código para este método:
      var sessionID = ADBMobile.targetSessionID();