Show Menu
TÓPICOS×

Arquivo de configuração JSON do ADBMobile

Essas informações ajudam você a entender as variáveis no arquivo de configuração ADBMobile.json.

ADBMobileConfig.json referência do arquivo de configuração

O mesmo arquivo de configuração pode ser usado para seu aplicativo em várias plataformas:
No Android , o arquivo ADBMobileConfig.json deve ser colocado na pasta assets .
Veja a seguir uma lista das variáveis no arquivo JSON e a versão mínima do SDK necessária para cada variável:
  • aquisição
    • Versão mínima do SDK: 4.1
    • Ativa a aquisição de aplicativos móveis.
      • o server , que é o servidor da aquisição verificado na primeira inicialização de um referencial de aquisição.
      • o appid , a ID gerada que identifica exclusivamente este aplicativo no servidor de aquisição. Se esta seção estiver faltando, habilite a aquisição do aplicativo móvel e baixe o arquivo de configuração do SDK novamente. Para obter mais informações, consulte referrerTimeout nesta lista de variáveis.
  • analyticsForwardingEnabled
    • A versão mínima do SDK é 4.8.0.
    • O valor padrão é false .
      As propriedades no objeto audienceManager . Se o Audience Manager estiver configurado, e o analyticsForwardingEnabled estiver definido como true , todo o tráfego do Analytics também é enviado para o Audience Manager.
  • backdateSessionInfo
    • Versão mínima do SDK: 4.6.
    • Ativa/desativa a capacidade do Adobe SDK de colocar data retroativa em ocorrências de informações de sessão.
      Ocorrências de informações de sessão, no momento, consistem-se em falhas e duração de sessões e podem ser habilitadas ou desabilitadas.
      Habilitar ou desabilitar ocorrências
      • Se você definir o valor como false , as ocorrências são desabilitadas . O SDK retorna ao comportamento pré-4.1 de agrupar as informações de sessão referentes à sessão anterior com a primeira ocorrência da sessão subsequente. O Adobe SDK também anexa as informações da sessão ao ciclo de vida atual, o que impede a criação de uma visita inflada. Como visitas infladas não são mais criadas, ocorre uma queda imediata em contagens de visitas.
      • Se você não fornecer um valor, o valor padrão é true e as ocorrências são habilitadas . Quando as ocorrências são ativadas, o Adobe SDK define a ocorrência de informações de sessão para 1 segundo depois da ocorrência final na sessão anterior. Isso significa que os dados de falhas e da sessão estarão relacionados à data exata em que ocorreram. Como efeito secundário, o SDK pode criar uma visita para a ocorrência retroativa. Uma ocorrência recebe data retroativa em cada nova inicialização do aplicativo.
        As informações de ocorrência de sessão retroativa são enviadas em uma chamada de servidor da sessão de informações e podem ser aplicadas chamadas de servidor adicionais.
  • batchLimit
    • Versão mínima do SDK: 4.1
    • Limite de números de ocorrências que serão enviadas em chamadas consecutivas.
      Por exemplo, se o batchLimit for definido como 10, cada ocorrência antes da 10ª será armazenada na fila. Quando a 10ª ocorrência entrar, todas as 10 ocorrências serão enviadas na ordem.
      Lembre-se das seguintes informações:
      • O valor padrão é 0 , o que significa que o agrupamento não está ativado.
      • Exige offlineEnabled = true .
  • charset
    • Versão mínima do SDK: 4.0
    • Define o conjunto de caracteres que está sendo usado nos dados enviados para o Analytics.
      O charset é usado para converter dados recebidos em UTF-8 para fins de armazenamento e relatórios.
  • clientCode
    • Versão mínima do SDK: 4.0
    • O código de cliente atribuído.
      Esta variável é exigida pelo Target.
  • coopUnsafe
    • Versão mínima do SDK: 4.16.1
    • A propriedade booleana do objeto marketingCloud que, quando definido como true , causa a remoção do dispositivo do Device Co-op da Experience Cloud.
    • O valor padrão é false .
    • Essa configuração é usada somente para clientes provisionados do Device Co-op. Para membros do Device Co-op que requerem que esse valor seja definido como true , é necessário trabalhar com a equipe do Co-op para solicitar um sinalizador de lista de bloqueios em sua conta do Device Co-op. Não há um caminho de autoatendimento para habilitar esses sinalizadores.
    Lembre-se das seguintes informações:
    • Quando coopUnsafe estiver definido como true , coop_unsafe=1 sempre será anexado a ocorrências do Audience Manager e da ID do visitante.
    • Se você habilitar o encaminhamento pelo lado do servidor do Analytics para o Audience Manager, você também verá coop_unsafe=1 em ocorrências do Analytics.
  • environmentId
    • Versão mínima do SDK: 4.14
    • A ID do ambiente que você deseja utilizar.
      Você pode especificar uma ID válida ( environmentId=8 ), e se environmentId não for incluída, o ambiente padrão Produção é usado.
  • lifecycleTimeout
    • Versão mínima do SDK: 4.0
    • O valor padrão é 300 segundos.
      Especifica o período de tempo, em segundos, que deve decorrer entre o momento em que o aplicativo é iniciado e antes de a inicialização ser considerada uma nova sessão. Esse tempo de espera também se aplica quando seu aplicativo é enviado para segundo plano e reativado.
      O tempo que seu aplicativo gasta em segundo plano não está incluído na duração da sessão.
  • messages
    • Versão mínima do SDK: 4.2
    • Gerada automaticamente pelo Adobe Mobile Services, define as configurações das mensagens no aplicativo. Para obter mais informações, consulte a seção Descrição de mensagens abaixo:
  • offlineEnabled
    • Versão mínima do SDK: 4.0
    • Quando ativado, as ocorrências são enfileiradas enquanto o dispositivo está offline e enviadas posteriormente quando o dispositivo estiver online.
      Seu conjunto de relatórios deve ter o carimbo de data e hora habilitado para usar o rastreamento offline.
      O valor padrão é false .
      Se o carimbo de data e hora estiver ativado no conjunto de relatórios, sua propriedade de configuração offlineEnabled deve ser verdadeira. Caso o conjunto de relatórios não tenha um carimbo de data e hora, sua propriedade de configuração offlineEnabled deve ser false.
      Se isso não for configurado corretamente, os dados serão perdidos. Caso não tenha certeza se um conjunto de relatórios tem um carimbo de data e hora, entre em contato com o Atendimento ao cliente ou baixe o arquivo de configuração do Adobe Mobile Services.
      Caso esteja relatando dados AppMeasurement para um conjunto de relatórios que também coleta dados JavaScript, pode ser necessário configurar um conjunto de relatórios separado para dados móveis, a fim de evitar a perda de dados, ou incluir um carimbo de data e hora personalizado nas ocorrências de JavaScript que usam a variável s.timestamp .
  • org
    • Versão mínima do SDK: 4.3
    • Especifica a ID de organização da Experience Cloud para o serviço de ID.
  • poi
    • Versão mínima do SDK: 4.0
    • Cada vetor de pontos de interesse (POI) contém o nome do POI, a latitude, a longitude e o raio em metros para a área do ponto.
      O nome do POI pode ser qualquer cadeia de caracteres. Quando uma chamada trackLocation é enviada, 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 .
      "poi": [
                 ["san francisco",37.757144,-122.44812,7000]
                 ["santa cruz",36.972935,-122.01725,600]
             ]
      
      
      A partir da versão 4.2, os POIs são definidos na interface do Adobe Mobile e sincronizados dinamicamente no arquivo de configuração do aplicativo. Esta sincronização exige a configuração analytics.poi :
      “analytics.poi“: `https://assets.adobedtm.com/`
      …/yourfile.json”`,
      
      
      Se esta configuração não estiver definida, o arquivo ADBMobile.json deve ser atualizado para incluir esta linha. Para baixar um arquivo de configuração atualizado, consulte Antes de começar .
  • postback
    • Versão mínima do SDK: 4.6
    • Aqui está a definição do modelo de mensagem "callback":
      "payload":{
        "templateurl":"", //required will be token-expanded prior to being sent
        "templatebody":"", //optional - if this length > 0 POST will be used as transport method. This is a base64 encoded blob, which will be decoded and token-expanded prior to being sent.
        "contenttype": "", // optional - if this is length > 0 and POST type is selected this will be set as the Content-Type header.  if this is not supplied for a POST request, the default will be "application/x-www-form-urlencoded"
        "timeout": 0 // optional - number of seconds to wait before timing out.  Default is 2.}
      
      
      O objeto payload no código é uma amostra de carga para uma definição de mensagem que consta no arquivo ADBMobileConfig.json . Para obter mais informações, consulte Postbacks .
  • privacyDefault
    • Versão mínima do SDK: 4.0
    • O valor padrão é optedin .
      • Para optedin , as ocorrências são enviadas imediatamente.
      • Para optedout , as ocorrências são descartadas.
      • Para 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 optedin . Esta ação apenas define o valor inicial. Se este valor estiver definido ou alterado no código, o novo valor é usado até que seja alterado novamente, ou quando o aplicativo é desinstalado e instalado novamente.
  • referrerTimeout
    • Versão mínima do SDK: 4.1
    • Número de segundos que o SDK aguarda para dados de referência de aquisição na primeira inicialização antes do tempo limite. Se você estiver usando a aquisição, recomendamos um tempo limite de 5 segundos.
      Esta variável é exigida pela Aquisição. Se a variável estiver definida para 0 ou não estiver incluída, o SDK não aguardará os dados de aquisição e as métricas de aquisição não serão rastreadas.
  • remotes
    • Versão mínima do SDK: 4.2
    • Configurado automaticamente e define os terminais hospedados pela Adobe para arquivos de configuração dinâmicos.
      O último tempo de atualização de cada arquivo de configuração é verificado em relação à versão atual em cada inicialização e as atualizações são baixadas e salvas.
      • analytics.poi é o terminal para a configuração de POI hospedada.
      • messages é o terminal para a configuração da mensagem hospedada no aplicativo.
  • rsids
    • Versão mínima do SDK: 4.0
    • Um ou mais conjuntos de relatórios para receber dados do Analytics. Diversas IDs de conjunto de relatórios devem ser separadas por vírgulas, sem espaçamento entre as mesmas.
        "rsids" "rsid"
      
      
        "rsids" "rsid1,rsid2"
      
      
      Esta variável é exigida pelo Analytics.
  • server
    • Versão mínima do SDK: 4.0
    • O servidor Analytics ou Gerenciamento de público-alvo, com base no nó principal. Essa variável deve ser preenchida com o domínio do servidor, sem um prefixo de protocolo https:// ou https:// . Este prefixo é manipulado automaticamente pela biblioteca com base na variável ssl . Se ssl for true , é realizada uma conexão segura com o servidor. Se ssl for false , é realizada uma conexão insegura com o servidor.
  • ssl
    • Versão mínima do SDK: 4.0
    • O valor padrão é false .
      Ativa ( true ) ou desativa ( false ) a capacidade de enviar dados de medição por SSL (HTTPS).
      A definição para o modelo de mensagem "callback" é mostrada abaixo:
      "payload": {
          "templateurl":"",//required-will be token-expanded prior to being sent 
          "templatebody": "", //optional - if this length >  0 POST will be used& as transport method. This is a base64 encoded blob, which will be  decoded and token-expanded prior to being sent.
          "contenttype": "" // optional - if this is length > 0 POST type is selected this will be set as the Content-Type header. if this is not supplied for a POST request, the default will be "application/x-www-form-urlencoded"
          "timeout": 0 // optional - number of seconds to wait before timing& out. Default is 2.}
      
      
  • timeout
    • Versão mínima do SDK: 4.0
    • Determina quanto tempo o Target aguarda uma resposta.

Exemplo de arquivo ADBMobileConfig.json

A seguir, há um exemplo de arquivo ADBMobileConfig.json :
 { 
    "version": "2014-08-05T19:18:28.169Z", 
    "marketingCloud" : { 
        "org": "016D5C175213CCA80A490D05@AdobeOrg", 
        "coopUnsafe": false 
    }, 
    "target": { 
        "clientCode": "", 
        "timeout": 5, 
        "environmentId": 8 
    }, 
    "audienceManager": { 
        "server": "", 
        "analyticsForwardingEnabled": false 
    }, 
    "acquisition": { 
        "server": "c00.adobe.com", 
        "appid": "10a77a60192fbb628376e1b1daeeb65debf934e2c807e067ceb2963a41b165ee" 
    }, 
    "analytics": { 
        "rsids": "coolApp", 
        "server": "my.CoolApp.com", 
        "ssl": true, 
        "offlineEnabled": true, 
        "charset": "UTF-8", 
        "lifecycleTimeout": 300, 
        "privacyDefault": "optedin", 
        "batchLimit": 0, 
        "referrerTimeout": 5, 
        "poi": [ 
            ["san francisco",37.757144,-122.44812,7000],  
            ["santa cruz",36.972935,-122.01725,600] 
        ] 
    }, 
    "messages": [ 
        { 
            "messageId": "cb426565-a563-497a-a889-9dbeb451f8ae", 
            "template": "fullscreen", 
            "payload": { 
                 "html": "<!DOCTYPE html><html><head><meta charset=\"utf-8\" /><title></title><style></style></head><body><iframe src=\"https://www.adobe.com/\" frameborder=\"0\"></iframe></body></html>" 
            }, 
            "showOffline": false, 
            "showRule": "always", 
            "endDate": 2524730400, 
            "startDate": 0, 
            "audiences": [], 
            "triggers": [ 
                { 
                    "key": "pev2", 
                    "matches": "eq", 
                    "values": [ 
                        "AMACTION:custom" 
                    ] 
                } 
            ] 
        } 
    ], 
    "remotes": { 
        "analytics.poi": "https://assets.adobedtm.com/staging/42a6fc9b77cd9f29082cf19b787bae75b7d1f9ca/scripts/satellite-53e0faadc2f9ed92bc00003b.json", 
        "messages": "https://assets.adobedtm.com/staging/42a6fc9b77cd9f29082cf19b787bae75b7d1f9ca/scripts/satellite-53e0f9e2c2f9ed92bc000032.json" 
    } 
}

Descrição das mensagens

O nó de mensagens é gerado automaticamente pelo Adobe Mobile Services e, normalmente, a alteração não precisa ser manual. A descrição a seguir é fornecida para fins de solução de problemas:
  • "messageId"
  • ID gerada, obrigatória
  • "template"
    • "alert", "fullscreen" ou "local"
    • obrigatório
  • "showOffline"
    • true ou false
    • o padrão é false
  • "showRule"
    • "always", "once", ou "untilClick"
    • obrigatório
  • "endDate"
    • número de segundos desde 1º de janeiro de 1970
    • o padrão é 2524730400
  • "startDate"
    • número de segundos desde 1º de janeiro de 1970
    • o padrão é 0
  • "payload"
    • "html"
      • apenas o modelo de tela cheia, obrigatório
      • html definindo a mensagem
    • "image"
      • somente tela cheia, opcional
      • url para a imagem a ser usada para uma imagem em tela cheia
    • "altImage"
      • somente tela cheia, opcional
      • nome da imagem empacotada a usar se o url especificado em
        • image
        • está inatingível
    • "title"
      • tela cheia e alerta, obrigatório
      • texto de título para uma tela cheia ou mensagem de alerta
    • "content"
      • alerta e notificação local, obrigatório
      • sub-texto para uma mensagem de alerta ou texto de notificação para uma mensagem de notificação local
    • "confirm"
      • alerta, opcional
      • texto usado no botão confirmar
    • "cancel"
      • alerta, obrigatório
      • texto usado no botão cancelar
    • "url"
      • alerta, opcional
      • ação do URL a carregar se o botão de confirmação for clicado
    • "wait"
      • notificação local, obrigatória
      • quantidade de tempo para aguardar (em segundos) para publicar a notificação local depois de combinar os critérios
  • "audiences"
    • matriz de objetos que define como a mensagem deve ser mostrada
    • "key"
      • nome da variável a procurar na ocorrência, obrigatório
  • "matches"
    • tipo de correspondência usado ao fazer a comparação
    • eq = igual
    • ne = não é igual
    • co = contém
    • nc = não contém
    • sw = inicia com
    • ew = termina com
    • ex = existe
    • nx = não existe
    • It = menor que
    • le = menor que ou igual
    • gt = maior que
    • ge = maior que ou igual
  • "values"
    • uma matriz de valores usados para corresponder com o valor da variável nomeada em
      • key
      • com o tipo de correspondência em
      • matches
  • "triggers"
    • o mesmo que o público-alvo, mas esta é a ação em vez do público-alvo
    • "key"
    • "matches"
    • "values"