Esta é uma lista de métodos TVJS fornecidos pela biblioteca tvOS.
versão
Retorna a versão atual da biblioteca do Adobe Mobile.
Esta é a sintaxe para este método:
version()
Esta é a amostra de código para este método:
var sdkVersion = ADBMobile.version();
Devoluções: String
privacyStatus
Retorna a representação NSUInteger do enum de status de privacidade para o usuário atual.
Estas são as opções:
ADBMobilePrivacyStatusOptIn
: as ocorrências são enviadas imediatamente.
ADBMobilePrivacyStatusOptOut
: as ocorrências são descartadas.
ADBMobilePrivacyStatusUnknown
: se o rastreamento offline estiver ativado, as ocorrências são salvas até o status de privacidade ser alterado para “aceitar” (as ocorrências são enviadas) ou “recusar” (as ocorrências são descartadas).
Se o rastreamento offline não estiver ativado, as ocorrências são descartadas até o status de privacidade ser alterado para aceitar. O valor por padrão está definido no arquivo ADBMobileConfig.json
.
Esta é a sintaxe para este método:
privacyStatus()
Esta é a amostra de código para este método:
var privacyStatus = ADBMobile.privacyStatus();
Devoluções: Number
setPrivacyStatus
Define o status de privacidade do usuário atual para um dos seguintes valores:
ADBMobilePrivacyStatusOptIn
: as ocorrências são enviadas imediatamente.ADBMobilePrivacyStatusOptOut
: as ocorrências são descartadas.ADBMobilePrivacyStatusUnknown
: se o rastreamento offline estiver ativado, as ocorrências são salvas até o status de privacidade ser alterado para “aceitar” (as ocorrências são enviadas) ou “recusar” (as ocorrências são descartadas).Se o rastreamento offline não estiver ativado, as ocorrências são descartadas até o status de privacidade ser alterado para aceitar.
Esta é a sintaxe para este método:
setPrivacyStatus(privacyStatus)
Esta é a amostra de código para este método:
ADBMobile.setPrivacyStatus(ADBMobilePrivacyStatusOptIn);
lifetimeValue
Retorna o valor do tempo de vida do usuário atual. O valor padrão é 0
.
Esta é a sintaxe para este método:
lifetimeValue()
Esta é a amostra de código para este método:
var ltv = ADBMobile.lifetimeValue();
Devoluções: Number
userIdentifier
Retorna o identificador do usuário se algum identificador personalizado estiver configurado. Retorna nil se um identificador personalizado não estiver configurado. O padrão é nil
.
Se seu aplicativo for atualizado do SDK 3.x da Experience Cloud para o 4.x, a ID anterior de visitante, personalizada ou gerada automaticamente, será recuperada e armazenada como o identificador personalizado do usuário. Isso preserva os dados dos visitantes entre as atualizações de SDK. Para novas instalações no SDK 4.x, o identificador do usuário é nil até sua definição.
Esta é a sintaxe para este método:
userIdentifier()
Esta é a amostra de código para este método:
var uid = ADBMobile.userIdentifier();
Devoluções: String
setUserIdentifier
Define o identificador do usuário.
Esta é a sintaxe para este método:
setUserIdentifier(userId)
Esta é a amostra de código para este método:
ADBMobile.setUserIdentifier(‘myUserId’);
Retorna: N/A
Parâmetro: userID
setAdvertisingIdentifier
Define o IDFA no SDK e, se tiver sido definido no SDK, o IDFA será enviado no ciclo de vida. O IDFA também pode ser acessado em Sinais (Postbacks).
Recupere o IDFA das APIs da Apple somente se estiver usando um serviço de anúncios. Se você recuperar o IDFA e não o utilizar corretamente, seu aplicativo poderá ser rejeitado.
Esta é a sintaxe para este método:
setAdvertisingIdentifier(idfa)
Esta é a amostra de código para este método:
ADBMobile.setAdvertisingIdentifier(‘myIdfa’);
Retorna: N/A
Parâmetro: idfa
String
setDebugLogging
Define a preferência de registro de depuração.
Esta é a sintaxe para este método:
setDebugLogging(logging)
Esta é a amostra de código para este método:
`ADBMobile.setDebugLogging(true);
Retorna: N/A
Parâmetros: logging
Bool
trackStateData
Rastreia um estado de aplicativo com dados de contexto opcionais. Os estados são as visualizações que estão disponíveis no seu aplicativo, como o painel de entrada, as configurações do aplicativo, o carrinho e assim por diante. Esses estados são semelhantes às páginas em um site, e as chamadas de trackState aumentam as exibições de página.
Se o estado estiver vazio, será exibido como app name app version (build) nos relatórios. Caso veja esse valor em relatórios, certifique-se de configurar o estado em cada chamada de trackState.
Esta é a única chamada de rastreamento que aumenta as exibições de página.
Esta é a sintaxe para este método:
trackStateData(stateName [, contextData])
stateName
String
contextData
Esta é a amostra de código para este método:
ADBMobile.trackStateData(‘homepage’, {‘userid’:12345});
trackActionData
Rastreia uma ação no seu aplicativo. As ações são coisas que ocorrem no seu aplicativo e que deseja avaliar, como logons, toques em banners, assinaturas de feed e outras métricas.
Esta é a sintaxe para este método:
trackActionData(actionName [, contextData])
actionName
contextData
Esta é a amostra de código para este método:
ADBMobile.trackActionData(‘likeClicked’, {‘imageName’:’funnyKitty’});
trackLocationWithLatLonData
Envia as coordenadas atuais de latitude e longitude.
Também usa pontos de interesse (POIs) definidos no arquivo ADBMobileConfig.json
a fim de determinar se o local fornecido como parâmetro está dentro dos POIs. 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:
trackLocationWithLatLonData(lat, lon [, contextData]);
lat
lon
contextData
Esta é a amostra de código para este método:
ADBMobile.trackLocationWithLatLonData(43.36, -116.12, null);
trackLifetimeValueIncreaseJsData
Adiciona uma quantia ao valor do ciclo de vida do usuário.
Esta é a sintaxe para este método:
trackLifetimeValueIncreaseJsData(increaseAmount)
increaseAmount
Esta é a amostra de código para este método:
ADBMobile.trackLifetimeValueIncreaseJsData(5);
trackTimedActionStartData
Inicia uma ação programada com a ação de nome. Se você chamar este método para uma ação já iniciada, a ação programada anterior será substituída.
Essa chamada não envia uma ocorrência.
Esta é a sintaxe para este método:
trackTimedActionStartData(name [, contextData])
name
contextData
Esta é a amostra de código para este método:
ADBMobile.trackTimedActionStartData(‘level1’, {‘userId’:42423});
trackTimedActionUpdateData
Transmita dados para atualizar os dados de contexto associados a determinada ação.
Os dados transmitidos são anexados aos dados existentes para determinada ação e, se a mesma chave já estiver definida para a ação, os dados são sobrescritos.
Essa chamada não envia uma ocorrência.
Esta é a sintaxe para este método:
trackTimedActionUpdateData(name [, contextData])
name
contextData
Esta é a amostra de código para este método:
ADBMobile.trackTimedActionUpdateData(‘level1’);
trackTimedActionEndJsLogic
Encerra uma ação programada.
Se você fornecer uma função de retorno de chamada, poderá acessar os valores de tempo finais. Se nenhum retorno de chamada for fornecido, ou se o retorno de chamada retornar true, o SDK da Adobe enviará automaticamente uma ocorrência. Quando volta um “false” da chamada de retorno, a ocorrência de ação cronometrada é eliminada.
Esta é a sintaxe para este método:
trackTimedActionEndJsLogic(name [, callback])
Retorna: N/A
Parâmetros: name
Parâmetro: callback
Tipo: function(inAppDuration, totalDuration, data)
Método de chamada de retorno que terá inAppDuration
(número), totalDuration
(número) e data
(objeto de dados de contexto) em seus parâmetros.
É possível eliminar o envio da ocorrência final pelo SDK, retornando false
em sua função de chamada de retorno.
Esta é a amostra de código para este método:
ADBMobile.trackTimedActionEndJsLogic(‘level1’,
function(inAppDuration, totalDuration, data) {
// do something with final values
return true;
});
trackingTimedActionExistsJs
Retorna se uma ação cronometrada estiver em andamento.
Esta é a sintaxe para este método:
trackingTimedActionExistsJs(name)
name
String
Esta é a amostra de código para este método:
var actionExists = ADBMobile.trackTimedActionExistsJs(‘level1’);
trackingIdentifier
Retorna o identificador de visitante gerado automaticamente.
Esta é uma ID de visitante exclusiva específica do aplicativo gerada pelos servidores da Adobe. Se não for possível atingir a geração de servidores no momento, a ID será gerada usando a CFUUID da Apple. O valor é gerado na primeira inicialização e é armazenado e usado a partir desse ponto. Essa ID é preservada entre as atualizações do aplicativo, é salva e restaurada durante o processo padrão de backup do aplicativo e é removida quando o aplicativo é desinstalado.
Se seu aplicativo for atualizado do SDK 3.x da Experience Cloud para o 4.x, a ID anterior de visitante, personalizada ou gerada automaticamente, será recuperada e armazenada como o identificador personalizado do usuário. Isso preserva os dados dos visitantes entre as atualizações de SDK. Para novas instalações no SDK 4.x, o identificador do usuário é nil
e o identificador de rastreamento é usado. Para obter mais informações, consulte a linha userIdentifier abaixo.
Esta é a sintaxe para este método:
trackingIdentifier()
String
Esta é a amostra de código para este método:
var trackingId = ADBMobile.trackingIdentifier();
trackingSendQueuedHits
Força a biblioteca a enviar todas as ocorrências na fila offline, independentemente de quantas estão na fila no momento.
Esta é a sintaxe para este método:
trackingSendQueuedHits()
Esta é a amostra de código para este método:
ADBMobile.trackingSendQueuedHits();
trackingClearQueue
Apaga todas as ocorrências da fila offline.
Esta é a sintaxe para este método:
trackingClearQueue()
Esta é a amostra de código para este método:
ADBMobile.trackingClearQueue();
trackingGetQueueSize
Recupera o número de ocorrências na fila offline.
Esta é a sintaxe para este método:
trackingGetQueueSize()
Esta é a amostra de código para este método:
var queueSize = ADBMobile.trackingGetQueueSize();
audienceVisitorProfile
Retorna o perfil do visitante obtido recentemente.
Retorna null se nenhum sinal tiver sido enviado. O perfil do visitante é salvo em NSUserDefaults
para facilitar o acesso nas várias inicializações do aplicativo.
Esta é a sintaxe para este método:
audienceVisitorProfile()
Esta é a amostra de código para este método:
var profile = ADBMobile.audienceVisitorProfile();
audienceDpid
Retorna a DPID atual.
Esta é a sintaxe para este método:
audienceDpid()
Esta é a amostra de código para este método:
var dpid = ADBMobile.audienceDpid();
audienceDpuuid
Retorna a DPUUID atual.
Esta é a sintaxe para este método:
audienceDpuuid()
String
Esta é a amostra de código para este método:
var dpuuid = ADBMobile.audienceDpuuid();
audienceSetDpidDpuuid
Define a dpid e a dpuuid e, se estiverem configuradas, serão enviadas com cada sinal.
Esta é a sintaxe para este método:
audienceSetDpidDpuuid(dpid, dpuuid)
dpid
String
dpuuid
String
Esta é a amostra de código para este método:
ADBMobile.audienceSetDpidDpuuid(‘myDpid’, ‘userDpuuid’);
audienceSignalWithDataJsCallback
Envia ao Audience Manager um sinal com características e obtém os segmentos correspondentes que são retornados em uma função de retorno de chamada.
Esta é a sintaxe para este método:
audienceSignalWithDataJsCallback(traits [, callback])
traits
callback
Esta é a amostra 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 o UUID do Audience Manager e elimina o perfil do visitante atual.
Esta é a amostra de código para este método:
audienceReset()
Esta é a amostra de código para este método:
ADBMobile.audienceReset();
visitorMarketingCloudID
Recupera a Experience Cloud ID a partir do serviço de ID.
Esta é a sintaxe para este método:
visitorMarketingCloudID()
Esta é a amostra de código para este método:
var mcid = ADBMobile.visitorMarketingCloudID();
visitorSyncIdentifiers
Além da Experience Cloud ID, você pode definir IDs de cliente adicionais para serem associados a cada visitante. A API de visitante aceita várias IDs do cliente para o mesmo visitante, juntamente com um identificador de tipo de cliente para separar o escopo de diferentes IDs do cliente. Este método corresponde a setCustomerIDs na biblioteca do JavaScript.
Esta é a sintaxe para este método:
visitorSyncIdentifiers(identifiers)
Retorna: N/A
Parâmetro: identifiers
Object
Esta é a amostra de código para este método:
ADBMobile.visitorSyncIdentifiers({‘idType’:’idValue’});
visitorSyncIdentifiersAuthenticationState
Sincroniza os identificadores fornecidos ao serviço de ID.
Esta é a sintaxe para este método:
visitorSyncIdentifiersAuthenticationState(identifiers, authState)
identifiers
Object
authState
ADBMobileVisitorAuthenticationStateUnknown
ADBMobileVisitorAuthenticationStateAuthenticated
ADBMobileVisitorAuthenticationStateLoggedOut
Esta é a amostra de código para este método:
ADBMobile.visitorSyncIdentifiersAuthenticationState({'myIdType':'valueForUser'}, ADBMobileVisitorAuthenticationStateLoggedOut)
visitorSyncIdentifierWithTypeIdentifierAuthenticationState
Sincroniza o tipo de identificador e o valor fornecidos ao serviço de ID.
Esta é a sintaxe para este método:
visitorSyncIdentifierWithTypeIdentifierAuthenticationState(idType, identifier, authState)
idType
String
identifier
String
authState
ADBMobileVisitorAuthenticationStateUnknown
ADBMobileVisitorAuthenticationStateAuthenticated
ADBMobileVisitorAuthenticationStateLoggedOut
Esta é a amostra de código para este método:
ADBMobile.visitorSyncIdentifierWithTypeIdentifierAuthenticationState('myIdType', 'valueForUser',
ADBMobileVisitorAuthenticationStateAuthenticated);
visitorGetIDsJs
Obtém uma matriz de objetos ADBVisitorID somente leitura. O código a seguir é um exemplo de um objeto VisitorID:
{
idType: "abc",
authenticationState: 1,
identifier: "123"
}
Esta é a sintaxe para este método:
visitorGetIDsJs()
Devoluções: Array [Object]
Parâmetros: nenhum
Esta é a amostra de código para este método:
var myVisitorIds = ADBMobile.visitorGetIDsJs();
targetThirdPartyID
Retorna a ID de terceiros.
Esta é a sintaxe para este método:
targetThirdPartyID()
String
Esta é a amostra de código para este método:
var thirdPartyID = ADBMobile.targetThirdPartyID();
targetSetThirdPartyID
Define a ID de terceiros.
Esta é a sintaxe para este método:
targetSetThirdPartyID(thirdPartyID)
thirdPartyID
String
Esta é a amostra de código para este método:
ADBMobile.targetSetThirdPartyID(‘thirdPartyID’);
targetPcID
Retorna a PcID.
Esta é a sintaxe para este método:
targetPcID()
String
Esta é a amostra de código para este método:
var pcID = ADBMobile.targetPcID();
targetSessionID
Retorna a ID da sessão.
Esta é a sintaxe para este método:
targetSessionID()
String
Esta é a amostra de código para este método:
var sessionID = ADBMobile.targetSessionID();