Introdução para desenvolvedores get-started-developers

Como Desenvolvedor, você é responsável pela implementação e integração do Adobe Journey Optimizer em seus aplicativos e sistemas. Você pode começar a trabalhar com Adobe Journey Optimizer assim que o Administrador do Sistema e o Engenheiro de Dados concederem acesso e prepararem seu ambiente.

Sua função no ecossistema do Journey Optimizer

Enquanto outros membros da equipe configuram o Journey Optimizer por meio da interface do usuário, você se concentrará em:

  • Implementando SDKs em aplicativos para dispositivos móveis e Web
  • Enviando eventos de seus aplicativos para acionar jornadas
  • Criando pontos de extremidade de API que o Journey Optimizer pode chamar por meio de ações personalizadas
  • Integrando o Journey Optimizer aos seus sistemas e infraestrutura existentes
  • Testando e depurando suas implementações

O Engenheiro de Dados manipulará esquemas de dados, configurações de eventos e fontes de dados. O Administrador definirá as permissões e as configurações de canal. Os profissionais de marketing criarão as jornadas e o conteúdo que usam suas implementações.

Este guia aborda as etapas essenciais de implementação técnica para ajudar você a começar a usar o Journey Optimizer. Se você estiver criando aplicativos para dispositivos móveis, experiências da Web ou integrações de API, siga as seções abaixo para configurar sua implementação.

Pré-requisitos prerequisites

Antes de iniciar a implementação, verifique se você tem:

Categoria
Exigências
Competências técnicas
* Experiência com JavaScript (para Web SDK) ou Swift/Kotlin (para SDK móvel)
* Noções básicas sobre APIs RESTful e JSON
* Familiaridade com programação assíncrona e arquiteturas orientadas por eventos
* Conhecimento da arquitetura de aplicativos de sua organização
Acesso e ferramentas
* Acesso ao Adobe Developer Console para credenciais de API
* Ambiente de desenvolvimento com acesso à base de código do seu aplicativo
* Ferramentas de teste como o Postman para teste de API
* Ferramentas de desenvolvedor do navegador ou ferramentas de depuração móvel
De outros membros da equipe
* Acesso ao ambiente concedido pelos esquemas XDM do Administrador
* e definições de evento dos requisitos do Engenheiro de dados
* e casos de uso dos Profissionais de marketing

Entender a base técnica technical-foundation

Antes de mergulhar na implementação, familiarize-se com os conceitos técnicos principais:

  1. Integração do Adobe Experience Platform: o Journey Optimizer foi criado nativamente no Adobe Experience Platform. Compreender a arquitetura subjacente ajudará você a criar implementações mais eficazes. Saiba mais sobre como o Journey Optimizer funciona.

  2. Modelos de dados XDM: o Journey Optimizer usa o Experience Data Model (XDM) para estruturar dados de evento e perfil. Como desenvolvedor, você precisará entender como enviar dados que estejam em conformidade com os esquemas configurados pelo seu Engenheiro de dados. Saiba mais sobre esquemas XDM.

  3. Autenticação e segurança: todas as implementações exigem autenticação adequada. Entenda como configurar a autenticação para SDKs e APIs. Saiba mais sobre Autenticação de API.

Configurar integrações do aplicativo móvel mobile-integration

Configurar o Adobe Experience Platform Mobile SDK

Para ativar notificações por push, mensagens no aplicativo e outros recursos móveis, integre o Adobe Experience Platform Mobile SDK em seus aplicativos móveis.

  1. Instalar e configurar o Mobile SDK: siga a documentação do Adobe Experience Platform Mobile SDK para começar a integração com o SDK.

  2. Criar uma propriedade móvel: configure uma propriedade móvel em Adobe Experience Platform Data Collection. Saiba como criar e configurar uma propriedade móvel.

  3. Configurar notificações por push:

    • Para aplicativos iOS: registre seu aplicativo com APNs (serviço de notificação por push da Apple). Saiba mais na documentação da Apple.
    • Para aplicativos Android: configure o Firebase Cloud Messaging para seu aplicativo Android. Saiba mais na documentação da Google.
  4. Testar a integração móvel: use o fluxo de trabalho de início rápido da integração móvel para configurar e testar rapidamente a configuração móvel.

As etapas detalhadas para configurar notificações por push estão disponíveis em esta página.

Implementar experiências baseadas em código (Mobile SDK)

Para personalização nativa de aplicativos móveis usando experiências baseadas em código:

Implementar experiências da Web web-implementation

Configurar o Adobe Experience Platform Web SDK

Para implementações baseadas na Web, o Web SDK é o seu principal ponto de integração:

  1. Instalar o Web SDK: siga o guia de implementação do Web SDK para configurar o SDK no seu site.

  2. Configurar sequências de dados: crie e configure uma sequência de dados em Adobe Experience Platform Data Collection com o Journey Optimizer habilitado. Saiba mais na documentação de sequências de dados.

  3. Habilitar notificações por push da Web (opcional): configure a propriedade pushNotifications na configuração do Web SDK e use o comando sendPushSubscription para registrar assinaturas por push.

Implementar experiências baseadas em código (Web SDK)

Experiências baseadas em código permitem personalizar qualquer ponto de contato digital:

  1. Escolha seu método de implementação: cliente, servidor ou híbrido. Revise amostras de implementação para cada abordagem.

  2. Definir superfícies: identifique os locais em seu aplicativo onde você deseja fornecer conteúdo personalizado. Saiba mais sobre a configuração da superfície.

  3. Implementar renderização de conteúdo: use o Web SDK para buscar e aplicar conteúdo de personalização. Consulte tutoriais de implementação baseados em código.

  4. Enviar eventos de exibição e interação: controle quando o conteúdo é exibido e quando os usuários interagem com ele para fins de análise e otimização.

Explore implementações de amostra no GitHub para ver as experiências de código em ação.

Saiba mais sobre a introdução a experiências baseadas em código.

Implementar a transmissão de eventos event-streaming

Enviar eventos para acionar jornadas

Como desenvolvedor, você implementará o código para enviar eventos que acionam jornadas. O Engenheiro de dados configurará os esquemas e as definições de eventos no Journey Optimizer.

  1. Entender a carga do evento: trabalhe com seu Engenheiro de Dados para obter o esquema do evento e a estrutura de carga necessária. A carga deve estar em conformidade com o esquema XDM configurado. Saiba mais sobre requisitos de esquema de evento.

  2. Implementar a transmissão de eventos: envie eventos para a Adobe Experience Platform usando as APIs de assimilação de transmissão. Saiba mais sobre as etapas para enviar eventos.

  3. Manipular tipos de evento:

    • Eventos unitários: implementam o envio de eventos para ações específicas de pessoas (por exemplo, clique de botão, conclusão de compra)
    • Eventos comerciais: enviar eventos comerciais (por exemplo, atualizações de estoque, alterações de preço)
  4. Entrega de evento de teste: verifique se os eventos foram recebidos corretamente e acione jornadas conforme esperado. Saiba mais sobre a solução de problemas do evento.

Exemplo de implementação para enviar um evento via API:

POST https://{DATACOLLECTION_ENDPOINT}/collection/{DATASTREAM_ID}
Content-Type: application/json

{
  "header": {
    "datasetId": "{DATASET_ID}",
    "imsOrgId": "{ORG_ID}",
    "source": {
      "name": "Web SDK"
    }
  },
  "body": {
    "xdmMeta": {
      "schemaRef": {
        "id": "{SCHEMA_ID}"
      }
    },
    "xdmEntity": {
      "_id": "unique-event-id",
      "eventType": "purchase",
      "timestamp": "2024-01-01T12:00:00Z",
      // ... your event data
    }
  }
}

Saiba mais sobre como trabalhar com eventos do jornada.

Desenvolver endpoints de ação personalizados custom-actions

As ações personalizadas permitem que o jornada chame suas APIs. Como desenvolvedor, você criará os endpoints de API invocados pelas ações personalizadas:

  1. Criar seu ponto de extremidade de API: crie pontos de extremidade de API RESTful que o Journey Optimizer chamará durante a execução da jornada. Seu terminal deve:

    • Aceitar cargas JSON
    • Autenticar solicitações (OAuth, chave de API ou JWT)
    • Processar solicitações dentro de limites de tempo apropriados
    • Retornar respostas no formato esperado
  2. Entenda os recursos de ação personalizados: as ações personalizadas podem se conectar a sistemas de terceiros, como Epsilon, Slack, Firebase ou seus próprios serviços. Saiba mais sobre Ações personalizadas.

  3. Trabalhar com configurações de ação: o Administrador ou o Engenheiro de Dados configurará a ação personalizada no Journey Optimizer, definindo a URL do ponto de extremidade de API, o método de autenticação e os parâmetros. Você fornecerá a eles a especificação da API. Saiba mais sobre a configuração de ação personalizada.

  4. Retornar dados acionáveis: crie sua API para retornar dados que possam ser usados nas etapas de jornada subsequentes. Saiba mais sobre respostas de ação.

  5. Implemente a limitação de taxa: certifique-se de que seus pontos de extremidade possam manipular o volume esperado. O Journey Optimizer aplica um limite de 5000 chamadas/segundo, mas o sistema deve ser resiliente. Saiba mais sobre limitação e limitação.

Exemplo de caso de uso: Gravando eventos de jornada no Experience Platform usando ações personalizadas.

Trabalhar com APIs do Journey Optimizer apis

O Journey Optimizer fornece APIs REST abrangentes para acesso programático:

  1. Entender os recursos da API: as APIs do Journey Optimizer permitem criar, ler, atualizar e excluir vários recursos de forma programática. Saiba mais sobre APIs do Journey Optimizer.

  2. Autenticação: siga este tutorial para configurar a autenticação de API usando o Adobe Developer Console.

  3. Explorar referências de API: procure a documentação completa da API e tente APIs diretamente na Referência da API do Adobe Journey Optimizer.

  4. Campanhas acionadas por API: crie mensagens transacionais com campanhas acionadas por API. Para cenários de alto volume (até 5000 TPS), explore o modo Alta Taxa de Transferência (requer licença complementar).

  5. APIs de Gerenciamento de Decisão: use APIs especializadas para gerenciamento de ofertas e decisões. Saiba mais no Guia da API de Gestão de Decisões.

Teste e depuração testing

  1. Depurar implementação do SDK: use o Adobe Experience Platform Assurance para inspecionar eventos do SDK, validar a coleta de dados e solucionar problemas de integração em tempo real. Saiba mais sobre o Assurance.

  2. Entrega de evento de teste: verifique se os eventos do seu aplicativo são recebidos corretamente pela Adobe Experience Platform e acione jornadas conforme esperado. Monitore a assimilação de eventos e valide a estrutura de carga.

  3. Validar integrações de API: teste seus pontos de extremidade de ação personalizados para garantir que eles lidem corretamente com as solicitações do Journey Optimizer, respondam dentro dos limites de tempo e retornem os formatos de dados esperados.

  4. Usar o modo de teste com perfis de teste: trabalhe com seu Engenheiro de dados para obter acesso aos perfis de teste e, em seguida, validar sua implementação usando o modo de teste de jornada. Saiba como testar jornadas.

  5. Monitorar logs do SDK: habilite o log de depuração na implementação do SDK para solucionar problemas durante o desenvolvimento:

    • SDK Móvel: habilitar o log para ver eventos SDK e chamadas de API
    • Web SDK: use o console do navegador para monitorar a atividade do SDK
  6. Verificar configuração da sequência de dados: verifique se a sequência de dados está configurada corretamente para enviar dados à Journey Optimizer. Verifique se os eventos fluem pelo fluxo de dados para os destinos corretos.

  7. Consultar dados de jornada para análise: use consultas SQL no Data Lake para analisar eventos de etapa de jornada, depurar problemas e monitorar o desempenho da ação personalizada. Explore exemplos de consulta para análise de jornada incluindo:

    • Motivos de rastreamento de entrada/saída de perfil e descarte
    • Métricas de desempenho de ação personalizada (latência, taxa de transferência, erros)
    • Entrega de eventos e padrões de erro
    • Jornada estados de instância

Tópicos avançados do desenvolvedor advanced-topics

Trabalho com dados contextuais e enriquecimento

  • Iterar em matrizes: use a sintaxe Handlebars para exibir listas dinâmicas de eventos, respostas de ação personalizadas e pesquisas de conjuntos de dados em mensagens. Saiba mais sobre iteração de dados contextuais.
  • Pesquisa de conjunto de dados: implemente pesquisas de conjunto de dados para enriquecer dados de jornada de conjuntos de dados do Adobe Experience Platform. Trabalhe com seu engenheiro de dados na configuração do. Saiba mais sobre pesquisa de conjunto de dados.

Trabalhar com consentimento e governança

Implemente políticas de consentimento e governança de dados em suas integrações:

  • Governança de dados: aplique políticas de uso de dados a ações personalizadas. Saiba mais sobre governança de dados.
  • Gerenciamento de consentimento: lida com as preferências de consentimento do cliente em suas implementações. Saiba mais sobre consentimento.

Otimização e práticas recomendadas

Recursos adicionais additional-resources

Colaborar entre funções next-steps

Seu trabalho de implementação cruza com outros membros da equipe:

Trabalhar com engenheiros de dados

Colabore com engenheiros de dados em configurações de dados e eventos:

  • Obter os esquemas XDM e as estruturas de evento necessárias para implementar

  • Entenda quais eventos você precisa enviar e o formato de carga necessário

  • Alinhe os requisitos de coleta de dados e os padrões de qualidade dos dados

  • Teste a entrega de eventos e a assimilação de dados juntas

Trabalhar com Administradores

Colabore com Administradores sobre acesso e configurações:

  • Fornecer especificações de API para ações personalizadas que serão configuradas

  • Solicite as permissões necessárias e as credenciais da API

  • Coordenar os requisitos de configuração de canal (por exemplo, certificados de push)

  • Alinhar ambientes de teste e estratégia de sandbox

Trabalhar com profissionais de marketing

Colabore com Profissionais de marketing sobre requisitos e testes de jornada:

  • Entender quais interações de usuário devem acionar eventos

  • Implementar o rastreamento para desempenho do conteúdo e envolvimento do usuário

  • Suporte a testes de jornadas com os recursos implementados

  • Solucionar problemas com entrega de mensagens ou personalização

Começar a implementar o

Pronto para começar a criar? Escolha sua primeira área de implementação nas seções acima:

  1. Aplicativo móvel? Iniciar com Integração com o Mobile SDK
  2. Site? Iniciar com configuração do Web SDK
  3. Integração de API? Ir para Trabalho com APIs
  4. Sistema personalizado? Confira Ações personalizadas

Cada seção inclui links para documentação técnica detalhada, amostras de código e tutoriais para orientar sua implementação do.

recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76