Métodos del complemento PhoneGap

Puede utilizar métodos del complemento PhoneGap de iOS para completar diversas tareas.

Cuando quiera utilizar el seguimiento en archivos html, agregue lo siguiente a la etiqueta <head>:

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

Métodos de configuración

  • getPrivacyStatus

    Devuelve el estado de privacidad del usuario actual. Estos son los estados disponibles:

    • ADB.optedIn, donde las visitas se envían inmediatamente.

    • ADB.optedOut, donde las visitas se descartan.

    • ADB.optUnknownSi el grupo de informes tiene habilitada la marca de fecha y hora, las visitas se guardan hasta que el estado de privacidad cambie a incluido (las visitas se envían) o excluido (las visitas se descartan). Si el grupo de informes no tiene habilitada la marca de fecha y hora, las visitas se descartan hasta que el estado de privacidad cambie a Opt-in.
      El valor predeterminado se establece en el archivo ADBMobileConfig.json.

      • Este es un ejemplo de código para este método:

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

  • setPrivacyStatus

    Establece el estado de privacidad del usuario actual como status. Puede establecer uno de los siguientes estados:

    • ADB.optedIn, donde las visitas se envían inmediatamente.

    • ADB.optedOut, donde las visitas se descartan.

    • ADB.optUnknown: Si el grupo de informes tiene habilitada la marca de fecha y hora, las visitas se guardan hasta que el estado de privacidad cambie a incluido (las visitas se envían) o excluido (las visitas se descartan).

      Si el grupo de informes no tiene habilitada la marca de fecha y hora, las visitas se descartan hasta que el estado de privacidad cambie a Opt-in.

    • Este es un ejemplo de código para este método:

        ADB.setPrivacyStatus('ADB.optedIn');

  • getLifetimeValue

    Devuelve el valor de duración del usuario actual. El valor predeterminado es 0.

    • Este es un ejemplo de código para este método:

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

  • setDebugLogging

    Habilita (true) o deshabilita (false) la visualización de información de depuración. De forma predeterminada, el valor de esta variable es false.

    • Este es un ejemplo de código para este método:

      ADB.setDebugLogging(true);

  • getVersion

    Obtiene la versión de la biblioteca.

    • Este es un ejemplo de código para este método:

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

  • trackingIdentifier

    Devuelve el identificador de visitante generado automáticamente. Se trata de un ID único de visitante y específico para la aplicación que se genera al iniciar la aplicación por primera vez y que se almacena y utiliza a partir de ese momento. Este ID se preserva al actualizar la aplicación y se elimina al desinstalarla.

    SUGERENCIA

    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 (consulte getUserIdentifier). De este modo, se preservan los datos de visitante tras actualizar el SDK. Para nuevas instalaciones sobre el SDK 4.x, el identificador de usuario tiene el valor null y se utiliza el identificador de seguimiento.

    • Este es un ejemplo de código para este método:

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

  • getUserIdentifier

    Devuelve el identificador de usuario personalizado si se ha establecido uno, o null si no se ha establecido. El valor predeterminado es null.

    • Este es un ejemplo de código para este método:

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

  • setUserIdentifier

    Establece el identificador de usuario como identifier.

    • Este es un ejemplo de código para este método:

      ADB.setUserIdentifier('testUser');

  • setPushIdentifier

    Establece el token del dispositivo para notificaciones push.

    • Esta es la sintaxis para este método:

      ADB.setPushIdentifier(pushIdentifier,success,fail);

    • Este es un ejemplo de código para este método:

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

  • keepLifecycleSessionAlive

    Establece la preferencia de mantenimiento de sesión del ciclo vital.

    IMPORTANTE

    Llamar a keepLifecycleSessionAlive impide que la aplicación inicie una nueva sesión la próxima vez que se reanude desde el segundo plano. Solo debe utilizar este método si la aplicación recibe notificaciones en segundo plano.

    • Este es un ejemplo de código para este método:

      ADB.keepLifecycleSessionAlive();

  • trackingSendQueuedHits

    Fuerza a la biblioteca a enviar todas las visitas en cola, sean cuales sean las opciones de agrupamiento actuales.

    • Este es un ejemplo de código para este método:

      ADB.trackingSendQueuedHits();

  • trackingGetQueueSize

    Obtiene o establece el número de llamadas de seguimiento almacenadas en la cola sin conexión.

    • Este es un ejemplo de código para este método:

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

  • trackingClearQueue

    Elimina todas las llamadas de seguimiento almacenadas de la cola sin conexión.

    PRECAUCIÓN

    Tenga cuidado al borrar la cola manualmente ya que la eliminación no puede revertirse.

    • Este es un ejemplo de código para este método:

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

  • keepLifecycleSessionAlive

    Indica al SDK que la siguiente reanudación desde segundo plano no debe iniciar una nueva sesión, independientemente del valor del tiempo de espera de sesión del ciclo vital en el archivo de configuración.

    IMPORTANTE

    Importante: El propósito de este método es que se utilice en aplicaciones que realizan un registro de notificaciones mientras se encuentran en segundo plano, y solo debería invocarse desde el código que se está ejecutando cuando la aplicación esté en segundo plano.

    • Este es un ejemplo de código para este método:

      ADB.keepLifecycleSessionAlive();

  • collectLifecycleData

    Indica al SDK que los datos del ciclo vital deben ser recopilados para su uso en todas las soluciones en el SDK. Para obtener más información, consulte Métricas del ciclo vital.

    • Este es un ejemplo de código para este método:

      ADB.collectLifecycleData();

Métodos de PII

  • collectPII

    Envía una solicitud de recopilación de PII.

    • Esta es la sintaxis para este método:

      ADB.collectPII(piiData,success,fail);

    • Este es un ejemplo de código para este método:

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

Métodos de seguimiento

  • trackAdobeDeepLink

    Realiza un seguimiento de los clics en vínculos profundos de Adobe.

    SUGERENCIA

    Si la llamada al ciclo vital es un evento de inicio, los datos de vínculo de Adobe se adjuntan. En caso contrario, se envía una llamada adicional.

    • Esta es la sintaxis para este método:

      ADB.trackAdobeDeepLink(deeplinkURL,success,fail);

    • Este es un ejemplo de código para este método:

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

  • trackPushMessageClickthrough

    Realiza un seguimiento de los clics en un mensaje push.

    • Esta es la sintaxis para este método:

      ADB.trackPushMessageClickthrough(userInfo,success,fail);

    • Este es un ejemplo de código para este método:

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

  • trackLocalNotificationClickThrough

    Realiza un seguimiento de los clics en un mensaje de notificación local.

    • Esta es la sintaxis para este método:

      ADB.trackLocalNotificationClickThrough(userInfo,success,fail);

    • Este es un ejemplo de código para este método:

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

  • trackState

    Realiza el seguimiento del estado de una aplicación con datos de contexto opcionales. Los estados son las vistas que están disponibles en la aplicación, como home dashboard, app settings o cart, entre otros. Estos estados son similares a las páginas de un sitio web y las llamadas trackState incrementan las visualizaciones de página. cData: Objeto JSON con pares de clave-valor para enviar en los datos de contexto.

    • Esta es la sintaxis para este método:

      ADB.trackState(stringstateName[,JSONcData]);

    • Estos son ejemplos de código para este método:

      ADB.trackState("loginpage");

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

  • trackAction

    Realiza el seguimiento de una acción en la aplicación. Las acciones son eventos que suceden en la aplicación y que se pueden medir, por ejemplo, logins, banner taps, feed subscriptions y otras métricas.

    • Esta es la sintaxis para este método:

      ADB.trackAction(stringaction[,JSONcData]);

    • Estos son ejemplos de código para este método:

      ADB.trackAction("login");

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

  • trackActionFromBackground

    Rastrea una acción que se produjo en el fondo. Esto evita que los eventos del ciclo vital se activen en determinados escenarios.

    • Esta es la sintaxis para este método:

      ADB.trackActionFromBackground(stringaction[,JSONcData]);

    • Estos son ejemplos de código para este método:

      ADB.trackActionFromBackground("login");

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

  • trackLocation

    Envía las coordenadas x e y actuales. También utiliza puntos de interés 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:

       ADB.trackLocation(x,y[,JSONcData]);

    • Este es un ejemplo de código para este método:

      ADB.trackLocation('40.431596','-111.893713');

  • trackLifetime​ValueIncrease

    Agrega una amount al valor de duración del usuario.

    • Esta es la sintaxis para este método:

      ADB.trackLifetimeValueIncrease(amount[,JSONcData]);

    • Este es un ejemplo de código para este método:

      ADB.trackLifetimeValueIncrease('10.01');

  • trackTimed​ActionStart

    Inicia una acción temporizada llamada action. Si invoca este método para una acción que ya se ha iniciado, se sobrescribe la acción temporizada anterior.

    SUGERENCIA

    Esta llamada no envía una visita.

    • Esta es la sintaxis para este método:

      ADB.trackTimedActionStart(action[,JSONcData]);

    • Este es un ejemplo de código para este método:

      ADB.trackTimedActionStart("cartToCheckout");

  • trackTimed​ActionUpdate

    Pasa cData para actualizar los datos de contexto asociados a action en cuestión. Los cData que se pasan se agregan a los datos existentes de esa acción y los sobrescriben si ya se ha definido la misma clave para action.

    SUGERENCIA

    Esta llamada no envía una visita.

    • Esta es la sintaxis para este método:

      ADB.trackTimedActionUpdate(Stringaction[,JSONcData]);

    • Este es un ejemplo de código para este método:

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

  • trackTimed​ActionEnd

    Finaliza una acción temporizada.

    • Este es un ejemplo de código para este método:

      ADB.trackTimedActionEnd("cartToCheckout");

  • trackingTimedActionExists

    Devuelve si la acción temporizada está en progreso o no.

    • Esta es la sintaxis para este método:

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

Métodos de Target

  • targetLoadRequest

    Envía una solicitud al servidor de Target configurado y devuelve el valor de cadena de la oferta.

    • Esta es la sintaxis para este método:

      ADB.targetLoadRequest(success,fail,name,defaultContent,parameters);

    • Este es un ejemplo de código para este método:

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

  • targetLoadOrderConfirmRequest

    Envía una solicitud al servidor de Target configurado.

    • Esta es la sintaxis para este método:

      ADB.targetLoadOrderConfirmRequest(success,fail,name,orderId,orderTotal,productPurchaseId,parameters);

    • Este es un ejemplo de código para este método:

      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

    Borra las cookies de Target del almacenamiento de cookies compartido.

    • Este es un ejemplo de código para este método:

      ADB.targetClearCookies();

  • targetLoadRequestWithNameWithLocationParameters

    Procesa una solicitud de servicio de Target.

    • Esta es la sintaxis para este método:

      ADB.targetLoadRequestWithNameWithLocationParameters(success,fail,name,defaultContent,profileParameters,orderParameters,mboxParameters,requestLocationParameters
);

    • Este es un ejemplo de código para este método:

      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

    Procesa una solicitud de servicio de Target.

    • Esta es la sintaxis para este método:

      ADB.targetLoadRequestWithRequestName(success, fail, name, defaultContent, profileParameters, orderParameters, mboxParameters);

    • Este es un ejemplo de código para este método:

      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

    Obtiene el valor de la cookie SessionID que el servidor de Target devuelve para este visitante.

    • Esta es la sintaxis para este método:

      ADB.targetSessionID(success,fail);

    • Este es un ejemplo de código para este método:

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

  • targetPcID

    Obtiene el valor de la cookie PcID que el servidor de Target devuelve para este visitante.

    • Esta es la sintaxis para este método:

      ADB.targetPcID(success,fail);

    • Este es un ejemplo de código para este método:

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

  • targetSetThirdPartyID

    Establece el ID de visitante personalizado para Target.

    • Esta es la sintaxis para este método:

      ADB.targetSetThirdPartyID(thirdPartyID,success,fail);

    • Este es un ejemplo de código para este grupo:

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

  • targetThirdPartyID

    Obtiene el ID de visitante personalizado para Target.

    • Esta es la sintaxis para este método:

      ADB.targetThirdPartyID(success,fail);

    • Este es un ejemplo de código para este método:

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

Métodos de adquisición

  • acquisitionCampaignStartForApp

    Permite a los desarrolladores iniciar una campaña de adquisición de aplicación como si el usuario hubiera hecho clic en un vínculo. Esto resulta útil para crear vínculos de adquisición manuales y controlar personalmente el redireccionamiento al App Store (por ejemplo, mediante SKStoreView).

    • Esta es la sintaxis para este método:

      ADB.acquisitionCampaignStartForApp(appId,data,success,fail);

    • Este es un ejemplo de código para este método:

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

Identificador de publicidad

En el AppDelegate que genera Cordova, realice una llamada a [ADBMobile setAdvertisingIdentifier:] en el método delegado application:didFinishLaunchingWithOptions:. Para obtener más información, consulte Métodos de configuración.

Métodos de Audience Manager

  • audienceGetVisitorProfile

    Obtiene el perfil del visitante.

    • Esta es la sintaxis para este método:

      ADB.audienceGetVisitorProfile();

    • Este es un ejemplo de código para este método:

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

  • audienceGetDpuuid

    Devuelve el DPUUID.

    • Esta es la sintaxis para este método:

      ADB.audienceGetDpuuid(success,fail);

    • Este es un ejemplo de código para este método:

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

  • audienceGetDpid

    Devuelve el DPID.

    • Esta es la sintaxis para este método:

       ADB.audienceGetDpid(success,fail);

    • Este es un ejemplo de código para este método:

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

  • audienceSetDpidAndDpuuid

    Establece el DPID y el DPUUID.

    • Esta es la sintaxis para este método:

      ADB.audienceSetDpidAndDpuuid(dpid,dpuuid,success,fail);

    • Estos son ejemplos de código para este método:

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

      ADB.audienceSetDpidAndDpuuid(‘dpid’,‘dpuuid’);

  • audienceSignalWithData

    Procesa una solicitud de servicio de Audience Manager.

    • Esta es la sintaxis para este método:

      ADB.audienceSignalWithData(success,fail,data);

    • Estos son ejemplos de código para este método:

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

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

  • audienceReset

    Restaura el UUID de Audience Manager y elimina el perfil del visitante actual.

    • Este es un ejemplo de código para este método:

      ADB.audienceReset();

Métodos del servicio de ID

  • visitorGetMarketingCloudId

    Devuelve el Experience Cloud ID desde el servicio de ID.

    • Esta es la sintaxis para este método:

      ADB.visitorGetMarketingCloudId(success,fail);

    • Este es un ejemplo de código para este método:

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

  • visitorSyncIdentifiers

    Sincroniza los identificadores proporcionados con el servicio de ID.

    • Esta es la sintaxis para este método:

      ADB.visitorSyncIdentifiers(identifiers,success,fail);

    • Estos son ejemplos de código para este método:

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

      ADB.visitorSyncIdentifiers({‘key_id_1’:‘value_id_1’});

  • visitorSyncIdentifiersWithAuthenticationState

    Sincroniza los identificadores proporcionados con el servicio de ID de visitante.

    • Esta es la sintaxis para este método:

      ADB.visitorSyncIdentifiersWithAuthenticationState(identifiers,authenticationState,success,fail);

    • Este es un ejemplo de código para este método:

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

  • visitorSyncIdentifierWithType

    Sincroniza el identificador proporcionado con el servicio de ID de visitante.

    • Esta es la sintaxis para este método:

      ADB.visitorSyncIdentifierWithType(identifierType,identifier,authenticationState,success,fail);

    • Este es un ejemplo de código para este método:

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

  • visitorAppendToURL

    Adjunta los identificadores de visitante a la URL dada.

    • Esta es la sintaxis para este método:

      ADB.visitorAppendToURL(urlToAppend,success,fail);

    • Este es un ejemplo de código para este método:

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

  • visitorGetIDs

    Devuelve todos los visitorIDs que sincronizados.

    • Esta es la sintaxis para este método:

      ADB.visitorGetIDs(success,fail)

    • Este es un ejemplo de código para este método:

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

En esta página