Métodos do plug-in PhoneGap

Os métodos do plug-in PhoneGap no Android podem ser usados para desempenhar uma variedade de tarefas.

Nos arquivos html em que deseja usar o rastreamento, adicione o código a seguir na guia <head>:

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

Métodos de configuração

getPrivacyStatus

Retorna o status de privacidade do usuário atual.

Estes são os status disponíveis:
- ADB.optedIn: Essas ocorrências são enviadas imediatamente.
- ADB.optedOut: Essas ocorrências são descartadas.
- ADB.optUnknown: Se o conjunto de relatórios estiver habilitado para mostrar o carimbo de data e hora, as ocorrências serão salvas até o status de privacidade ser alterado para aceitar (as ocorrências são enviadas) ou rejeitar (as ocorrências são descartadas). Se o conjunto de relatórios não tiver carimbo de hora e data, as ocorrências são descartadas até o status de privacidade ser alterado para opt in.
  
  O valor padrão está definido no arquivo ADBMobileConfig.json.
- Esta é a amostra de código para este método:
```
getPrivacyStatus(function (value) { myTempVal = value; }, function () {myTempVal = null;}); 
```
setPrivacyStatus

Define o de privacidade do usuário atual como status status.

Você pode definir um dos seguintes estados:
- ADB.optedIn: Essas ocorrências são enviadas imediatamente.
- ADB.optedOut: Essas ocorrências são descartadas.
- ADB.optUnknown: Se o conjunto de relatórios estiver habilitado para mostrar o carimbo de data e hora, as ocorrências serão salvas até o status de privacidade ser alterado para aceitar (as ocorrências são enviadas) ou rejeitar (as ocorrências são descartadas). Se o conjunto de relatórios não tiver carimbo de hora e data, as ocorrências são descartadas até o status de privacidade ser alterado para opt in.
- Esta é a amostra de código para este método:
```
ADB.setPrivacyStatus('ADB.optedIn');
```
getLifetimeValue

Retorna o valor do tempo de vida do usuário atual. O valor padrão é 0.
- Esta é a amostra de código para este método:
```
ADB.getLifetimeValue(function (value) { myTempVal = value }, function () { myTempVal = null; }); 
```
setDebugLogging

Ativa (true) ou desativa (false) na exibição de informações de depuração. Por padrão, essa variável é false.
- Esta é a amostra de código para este método:
```
ADB.setDebugLogging(true);
```

getVersion

Obtém a versão da biblioteca.

Esta é a amostra de código para este método:

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

trackingIdentifier

Retorna o identificador de visitante gerado automaticamente.

Esta é uma ID de visitante exclusiva e específica do aplicativo gerada quando ele é iniciado pela primeira vez e é armazenada e usada a partir desse ponto. Essa ID é preservada entre as atualizações do aplicativo e é removida quando o aplicativo é desinstalado.

DICA

Se o aplicativo for atualizado do Experience Cloud 3.x para o 4.x SDK, a ID de visitante anterior (personalizada ou gerada automaticamente) será recuperada e armazenada como o identificador de usuário personalizado. Para obter mais informações, consulte getUserIdentifier abaixo. Esta ID preserva os dados de visitante entre atualizações do SDK.

Para novas instalações no SDK 4.x, o identificador do usuário é null e o identificador de rastreamento é usado.
- Esta é a amostra de código para este método:
```
ADB.trackingIdentifier(function (value) { myTempVal = value; }, function () { myTempVal = null; }); 
```
getUserIdentifier

Se um identificador de usuário do cliente foi definido, retorna esse identificador. Caso contrário, retorna null. O valor padrão é null.
- Esta é a amostra de código para este método:
```
getUserIdentifier(function(value) { myTempVal = value; }, function () { myTempVal = null; });
```
setUserIdentifier

Define o identificador do usuário para identifier.
- Esta é a amostra de código para este método:
```
ADB.setUserIdentifier('testUser');
```

setPushIdentifier

Define o token do dispositivo para notificações por push.

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

Esta é a sintaxe para este método:

ADB.setPushIdentifier(pushIdentifier, success, fail);

Esta é a amostra de código para este método:

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

keepLifecycleSessionAlive

Define a preferência manter vivo da sessão de ciclo de vida.

IMPORTANTE

Chamar keepLifecycleSessionAlive impede que seu aplicativo inicie uma nova sessão na próxima vez que for retomado a partir do segundo plano. Você só deve usar esse método se o seu aplicativo se registrar para notificações em segundo plano.
- Esta é a amostra de código para este método:
```
ADB.keepLifecycleSessionAlive(); 
```
trackingSendQueuedHits

Força a biblioteca a enviar todas as ocorrências na fila, independentemente das opções de agrupamento atuais.
- Esta é a amostra de código para este método:
```
ADB.trackingSendQueuedHits();
```
trackingGetQueueSize

Obtém ou define o número de chamadas de rastreamento armazenadas na fila offline.
- Esta é a amostra de código para este método:
```
ADB.trackingGetQueueSize(function (value) { myTempVal = value;}, function () { myTempVal = null;}); 
```
trackingClearQueue

Remove todo o número de chamadas de rastreamento armazenadas da fila offline.

AVISO

Tenha cuidado ao limpar a fila manualmente, pois o resultado não pode ser revertido.
- Esta é a amostra de código para este método:
```
ADB.trackingClearQueue(function (value) { myTempVal = value; }, function () { myTempVal = null; }); 
```

Métodos PII

collectPII

Envia uma solicitação de coleta de PII.

Esta é a sintaxe para este método:

ADB.collectPII(piiData,success, fail);

Esta é a amostra 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 rastreamento

trackAdobeDeepLink

Rastreia os cliques em deep links da Adobe.

DICA

Se a chamada de Ciclo de vida for um evento de inicialização, os dados do Adobe Link serão anexados, caso contrário, uma chamada extra será enviada.
- Esta é a sintaxe para este método:
```
ADB.trackAdobeDeepLink(deeplinkURL, success, fail); 
```
- Esta é a amostra de código para este método:
```
ADB.trackAdobeDeepLink('xyz-deeplink-url',function (value) { alert('success'); },function (value) { alert('fail') }); 
```
trackState

Rastreia um estado de aplicativo com dados de contexto opcionais. Os estados são as exibições disponíveis no aplicativo, como home dashboard, app settings, cart, e assim por diante. Esses estados são semelhantes às páginas em um site, e as chamadas de trackState aumentam as visualizações de página.

cData: objeto JSON com pares de valor chave para enviar em dados de contexto.
- Esta é a sintaxe para este método:
```
ADB.trackState(string stateName[,JSON cData]);
```
- Estas são amostras de código para este método:
```
  ADB.trackState("login&amp;nbsp;page"); 
```
```
  ADB.trackState("login page", {"user":"john","remember":"true"});
```
trackAction

Rastreia uma ação no seu aplicativo. As ações incluem logins, banner taps, feed subscriptions e outras métricas que ocorrem no aplicativo e que você deseja medir.
- Esta é a sintaxe para este método:
```
ADB.trackAction(string action[,JSON cData]); 
```
- Estas são as amostras de código para este método:
```
  ADB.trackAction("login");
```
```
  ADB.trackAction("login", {"user":"john","remember":"true"}); 
```
trackLocation

Envia as coordenadas x e y atuais. Também usa pontos de interesse definidos no arquivo ADBMobileConfig.json a fim de determinar se o local fornecido como parâmetro está dentro do POI. Se as coordenadas atuais estão dentro de um POI definido, uma variável de dados de contexto é preenchida e enviada com a chamada trackLocation.
- Esta é a sintaxe para este método:
```
ADB.trackLocation(x, y[,JSON cData]); 
```
- Esta é a amostra de código para este método:
```
ADB.trackLocation('40.431596', '-111.893713'); 
```
trackLifetimeValueIncrease

Adiciona uma amount ao valor do ciclo de vida do usuário.
- Esta é a sintaxe para este método:
```
ADB.trackLifetimeValueIncrease(amount[,JSON cData]); 
```
- Esta é a amostra de código para este método:
```
ADB.trackLifetimeValueIncrease('10.01'); 
```
trackTimedActionStart

Inicia uma ação programada com o nome action.

Se você chamar este método para uma ação já iniciada, a ação programada anterior será substituída.

DICA

Essa chamada não envia uma ocorrência.
- Esta é a sintaxe para este método:
```
ADB.trackTimedActionStart(action[,JSON cData]);
```
- Esta é a amostra de código para este método:
```
ADB.trackTimedActionStart("cartToCheckout"); 
```
trackTimedActionUpdate

Passa em cData para atualizar os dados de contexto associados a action.

Os cData passados estão anexados aos dados existentes da ação e, se a mesma chave já estiver definida como action, eles substituirão os dados.
- Esta é a sintaxe para este método:
```
ADB.trackTimedActionUpdate(String action[,JSON cData]);
```
- Esta é a amostra de código para este método:
```
ADB.trackTimedActionUpdate("cartToCheckout",{'SampleContextDataKey3':'SampleContextDataVal3','SampleContextDataKey4':'SampleContextDataVal4'});
```
trackTimedActionEnd

Encerra uma ação programada.
- Esta é a amostra de código para este método:
```
ADB.trackTimedActionEnd("cartToCheckout"); 
```
trackingTimedActionExists

Retorna se uma ação cronometrada estiver em andamento.
- Esta é a sintaxe para este método:
```
ADB.trackingTimedActionExists(function (value) { myTempVal = value }, function () { myTempVal = null; }); 
```

Métodos de sinal

trackBeacon

Rastreia quando um usuário está perto de um sinal.

Esta é a sintaxe para este método:

ADB.trackBeacon(uuid, major, minor, proximity, cData)

Esta é a amostra de código para este método:

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

clearCurrentBeacon

Apaga os dados de sinal depois que o usuário se distancia de um sinal.
- Esta é a sintaxe para este método:
```
ADB.clearCurrentBeacon(success, fail)
```
- Esta é a amostra de código para este método:
```
ADB.clearCurrentBeacon(); 
```

Métodos do Target

targetLoadRequest

Envia uma solicitação ao servidor do Target configurado e retorna o valor da cadeia de caracteres da oferta.

Esta é a sintaxe para este método:

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

Esta é a amostra de código para este método:

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

targetLoadOrderConfirmRequest

Envia uma solicitação para o servidor Target configurado.

Esta é a sintaxe para este método:

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

Esta é a sintaxe 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

Limpa os cookies do Target do armazenamento compartilhado de cookies.
- Esta é a amostra de código para este método:
```
ADB.targetClearCookies(); 
```

targetLoadRequestWithNameWithLocationParameters

Processa uma solicitação de serviço do Target.

Esta é a sintaxe para este método:

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

Esta é a amostra 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

Processa uma solicitação de serviço do Target.

Esta é a sintaxe para este método:

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

Esta é a amostra 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

Obtém o valor do cookie SessionID retornado para este visitante pelo servidor Target.
- Esta é a sintaxe para este método:
```
ADB.targetSessionID (success, fail); 
```
- Esta é a amostra de código para este método:
```
ADB.targetSessionID(function (value) { alert(value) },function (value){ alert('fail'); });  
```
targetPcID

Obtém o valor do cookie PcID retornado para este visitante pelo servidor do Target.
- Esta é a sintaxe para este método:
```
ADB.targetPcID (success, fail); 
```
- Esta é a amostra de código para este método:
```
ADB.targetPcID(function  (value) { alert(value) },function (value) { alert('fail'); });
```

targetSetThirdPartyID

Define a ID de visitante personalizada para o Target.

Esta é a sintaxe para este método:

ADB.targetSetThirdPartyID(thirdPartyID, success, fail);

Esta é a amostra de código para este método:

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

targetThirdPartyID

Obtém a ID de visitante personalizada para o Target.
- Esta é a sintaxe para este método:
```
ADB.targetThirdPartyID(success, fail);
```
- Esta é uma amostra de código para este método:
```
 ADB.targetThirdPartyID(function (value) { alert(value); },function (value) { alert('fail')__;});
```

Métodos de aquisição

acquisitionCampaignStartForApp

Envia uma solicitação ao servidor do Target configurado e retorna o valor da cadeia de caracteres da oferta.

Esta é a sintaxe para este método:

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

Estas são as amostras de código para este método:

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

ADB.acquisitionCampaignStartForApp(“appId”, {‘key’:‘value’});

Identificador de publicidade

Na atividade principal gerada pelo Cordova, faça uma chamada Config.submitAdvertisingIdentifierTask() no método onResume(). Para obter mais informações, consulte Métodos de configuração.

Métodos do Audience Manager

audienceGetVisitorProfile

Obtém o perfil do visitante.

Esta é a sintaxe para este método:
```
ADB.audienceGetVisitorProfile(); 
```

Esta é a amostra de código para este método:

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

audienceGetDpuuid

Retorna DPUUID.

Esta é a sintaxe para este método:
```
ADB.audienceGetDpuuid(success fail);
```

Esta é a amostra de código para este método:

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

audienceGetDpid

Retorna DPID.

Esta é a sintaxe para este método:
```
ADB.audienceGetDpid(success, fail);
```

Esta é a amostra de código para este método:

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

audienceSetDpidAndDpuuid

Define a DPID e a DPUUID.

Esta é a sintaxe para este método:

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

Estas são as amostras de código para este método:

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

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

audienceSignalWithData

Processa uma solicitação de serviço do Audience Manager.

Esta é a sintaxe para este método:

ADB.audienceSignalWithData(success, fail, data);

Estas são as amostras de código para este método:

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

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

audienceReset

Redefine o UUID do Audience Manager e limpa o perfil de visitante atual.
- Esta é a amostra de código para este método:
```
ADB.audienceReset();
```

Métodos do serviço de ID

visitorGetMarketingCloudId

Retorna a Experience Cloud ID do Serviço de ID.
- Esta é a sintaxe para este método:
```
ADB.visitorGetMarketingCloudId(success, fail); 
```
- Esta é a amostra de código para este método:
```
ADB.visitorGetMarketingCloudId(function (value) { mcid = value;},function (){ mcid = null;});
```

visitorSyncIdentifiers

Sincroniza os identificadores fornecidos com o serviço de ID.

Esta é a sintaxe para este método:

ADB.visitorSyncIdentifiers(identifiers, success, fail);

Estas são as amostras 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 os identificadores fornecidos ao serviço de ID.

Esta é a sintaxe para este método:

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

Esta é a amostra 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 o identificador fornecido ao serviço de ID.

Esta é a sintaxe para este método:

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

Esta é a amostra 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

Adiciona identificadores de visitantes ao URL fornecido.
- Esta é a sintaxe para este método:
```
 ADB.visitorAppendToURL(urlToAppend, success, fail); 
```
- Esta é a amostra de código para este método:
```
ADB.visitorAppendToURL('test_visitor_url', function (value) alert(value);},'');
```
visitorGetIDs

Retorna todas as visitorID que foram sincronizadas.
- Esta é a sintaxe para este método:
```
ADB.visitorGetIDs (success, fail);
```
- Esta é a amostra de código para este método:
```
ADB.visitorGetIDs(function (value) { alert(value); },function (value) { alert('fail') ;}); 
```

Recursos no adobe.com

Behavioral Targeting Multivariate Testing Automated Onboarding Content Intelligence Responsive Forms Second Party Data

Nesta página

Visualização seguinte:

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now

Métodos do plug-in PhoneGap

Métodos de configuração

Métodos PII

Métodos de rastreamento

Métodos de sinal

Métodos do Target

Métodos de aquisição

Identificador de publicidade

Métodos do Audience Manager

Métodos do serviço de ID

Recursos no adobe.com

Nesta página

Visualização seguinte:

Time to shine!

Time to shine!

Aprender

Documentação

Community

Suporte

Resources

Adobe Account

Adobe