Migração para a biblioteca 4.x do iOS

Estas informações ajudam a migrar da versão 3.x ou 2.x da biblioteca do iOS para a versão 4.x.

IMPORTANTE

O SDK usa o NSUserDefaults para armazenar dados necessários para calcular usuários únicos, métricas de ciclo de vida e outros dados relacionados à funcionalidade principal do SDK. Se modificar ou remover os valores no NSUserDefaults esperados pelo SDK, pode resultar um comportamento inesperado na forma de inconsistência de dados.

Na versão 4.x da biblioteca do SDK do iOS, os métodos públicos são consolidados em um único cabeçalho. Além disso, a funcionalidade agora pode ser acessada por meio de métodos de nível de classe; portanto, não é necessário acompanhar cursores, instâncias ou singletons.

Eventos, propriedades e eVars

Na versão 4, não é mais possível atribuir variáveis como eventos, eVars, props, herdeiros e listas diretamente no aplicativo. Em vez disso, o SDK usa dados de contexto e regras de processamento para mapear os dados do aplicativo para as variáveis do Analytics para os relatórios.

As regras de processamento oferecem as seguintes vantagens:

  • Você pode alterar o mapeamento de dados sem enviar uma atualização para a loja de aplicativos.

  • Você pode usar nomes significativos para dados em vez de definir variáveis específicas para um conjunto de relatórios.

  • Há pouco impacto no envio de dados extras.

    Esses valores não aparecerão nos relatórios até que sejam mapeados usando as regras de processamento.

DICA

Os valores antes atribuídos diretamente às variáveis agora devem ser adicionados ao NSDictionary de data.

Remover propriedades não usadas

O novo arquivo ADBMobileConfig.json contém configurações globais específicas do aplicativo e substitui a maioria das variáveis de configuração usadas em versões anteriores. Este é um exemplo de um arquivo ADBMobileConfig.json:

{ 
    "version" : "1.0", 
    "analytics" : { 
        "rsids" : "coolApp", 
        "server" : "my.CoolApp.com", 
        "charset" : "UTF-8", 
        "ssl" : true, 
        "offlineEnabled" : true, 
        "lifecycleTimeout" : 5, 
        "privacyDefault" : "optedin", 
        "poi" : [ 
                    ["san francisco",37.757144,-122.44812,7000], 
                    ["santa cruz",36.972935,-122.01725,600] 
                ] 
    }, 
 "target" : { 
  "clientCode" : "myTargetClientCode", 
  "timeout" : 5 
 }, 
 "audienceManager" : { 
  "server" : "myServer.demdex.com" 
 } 
}

Mover o arquivo de configuração

Para mover o arquivo de configuração:

  1. Mova o valor definido para a variável na primeira coluna para a variável na segunda coluna.
  2. Remova a variável de configuração antiga do seu código.

Informações sobre migração

As tabelas a seguir listam as variáveis de configuração que você precisa mover para o arquivo de configuração.

Migrar da versão 3.x

Mova o valor da primeira coluna para a variável na segunda coluna.

Variável de configuração Variável no arquivo ADBMobileConfig.json
offlineTrackingEnabled "offlineEnabled"
offlineHitLimit “batchLimit”
reportSuiteIDs "rsids"
trackingServer "server"
charSet "charset"
currencyCode "currency"
ssl "ssl"
linkTrackVars Remover, não é mais usado.
linkTrackEvents Remover, não é mais usado.

Migrar da versão 2.x

Mova o valor da primeira coluna para a variável na segunda coluna.

Variável de configuração Variável no arquivo ADBMobileConfig.json
trackOffline "offlineEnabled"
offlineLimit “batchLimit”
account "rsids"
trackingServer “server”, remover o prefixo "https://". O prefixo do protocolo é adicionado automaticamente com base na configuração “ssl”.
trackingServerSecure Remover. Para conexões seguras, defina "server" e ative "ssl".
charSet "charset"
currencyCode "currency"
ssl "ssl"
linkTrackVars Remover, não é mais usado.
linkTrackEvents Remover, não é mais usado.
carimbo de data e hora Remover, não é mais configurável.
dc Remover, não é mais usado.
userAgent Remover, não é mais configurável.
dynamicVariablePrefix Remover, não é mais usado.
visitorNamespace Remover, não é mais usado.
usePlugins Remover, não é mais usado.
useBestPractices todas as chamadas para medição de churn (getChurnInstance) Remover, substituído pelas métricas de ciclo de vida. Para obter mais informações, consulte Medições de ciclo de vida.

Atualizar chamadas e variáveis de rastreamento

Em vez de usar as chamadas focadas na Web track e trackLink, o SDK versão 4 usa os seguintes métodos:

  • Os estados trackState:data: 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.

  • As ações trackAction:data:, como logons, banner taps, feed subscriptions e outras métricas que ocorrem no aplicativo e que você deseja medir.

O parâmetro data para ambos os métodos é um NSDictionary que contém os pares de nomes/valores enviados como dados de contexto.

Eventos, propriedades, eVars

Na versão 4, não é mais possível atribuir variáveis como eventos, eVars, props, herdeiros e listas diretamente no aplicativo. O SDK agora usa dados de contexto e regras de processamento para mapear os dados do aplicativo para as variáveis do Analytics para os relatórios.

As regras de processamento oferecem as seguintes vantagens:

  • Você pode alterar o mapeamento de dados sem enviar uma atualização para a loja de aplicativos.

  • Você pode usar nomes significativos para dados em vez de definir variáveis específicas para um conjunto de relatórios.

  • Há pouco impacto no envio de dados extras.

    Esses valores não aparecerão nos relatórios até que sejam mapeados usando as regras de processamento. Para obter mais informações, consulte Regras de processamento e Dados de contexto.

Os valores atribuídos diretamente às variáveis devem ser adicionados ao data NSDictionary. Isso significa que as chamadas para setProp, setEvar e atribuições para dados de contexto persistentes devem ser removidas e os valores devem ser adicionados ao parâmetro data.

AppSection/servidor, GeoZip, ID da transação, campanha e outras variáveis padrão

Os dados que você estava configurando no objeto de medição, incluindo as variáveis listadas acima, agora devem ser adicionados ao data NSDictionary. Os únicos dados enviados com uma chamada trackState ou trackAction são a carga no parâmetro data.

Substituir chamadas de rastreamento

No seu código, substitua os seguintes métodos com uma chamada para trackState ou trackAction:

Migrar da versão 3.x

  • trackAppState (trackState)
  • trackEvents (trackAction)
  • track (trackAction)
  • trackWithContextData (trackAction)
  • trackLinkURL (trackAction)

Migrar da versão 2.x

  • track (trackState)
  • trackLink (trackAction)

ID de visitante personalizada

Substitua a variável visitorID por uma chamada de setUserIdentifier:.

Rastreamento offline

O rastreamento offline está habilitado no arquivo ADBMobileConfig.json e todas as outras configurações offline são feitas automaticamente.

No seu código, remova chamadas para os seguintes métodos:

Versão 3.x

  • setOnline
  • setOffline

Versão 2.x

  • forceOffline
  • forceOnline

Variável products

Como a variável não está disponível nas regras de processamento, você pode usar a seguinte sintaxe para definir productsprodutos:

//create a processing rule to set the corresponding product event. 
// for example, set prodView event when context data a.action = "product view" 
[ADBMobile trackAction:@"LikeButtonClicked"  
                  data:@{@"&&products" : @";Cool Shoe"}];

Nesta página