DocumentaçãoExperience PlatformDados de modelo em esquemas

Dados de modelo em esquemas

Last update: Thu Oct 03 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Iniciante
  • Intermediário
  • Desenvolvedor

Nesta lição, você modelará os dados do Luma em esquemas. Esta é uma das lições mais longas do tutorial, então pegue um copo de água e aperte a fivela!

A padronização e a interoperabilidade são os principais conceitos por trás da Adobe Experience Platform. O Experience Data Model (XDM) é um esforço para padronizar os dados de experiência do cliente e definir esquemas para o gerenciamento da experiência do cliente.

O XDM é uma especificação documentada publicamente projetada para melhorar o potencial das experiências digitais. Ela fornece estruturas e definições comuns para qualquer aplicativo usar na comunicação com os serviços da plataforma. Seguindo os padrões XDM, todos os dados de experiência do cliente podem ser incorporados a uma representação comum que pode fornecer insights de maneira mais rápida e integrada. Você pode obter insights valiosos das ações do cliente, definir públicos-alvo do cliente por meio de segmentos e expressar atributos do cliente para fins de personalização.

O XDM é a estrutura fundamental que permite ao Adobe Experience Cloud, acionado pelo Experience Platform, enviar a mensagem certa à pessoa certa, no canal direito, no momento exato. A metodologia na qual o Experience Platform é criado, Sistema XDM, operacionaliza esquemas do Experience Data Model para uso pelos serviços da plataforma.

Os Arquitetos de dados precisarão criar esquemas fora deste tutorial, mas os Engenheiros de dados trabalharão em conjunto com os esquemas criados pelo Arquiteto de dados.

Antes de começar os exercícios, assista a este vídeo curto para saber mais sobre esquemas e o Experience Data Model (XDM):

https://video.tv.adobe.com/v/38512?learn=on&captions=por_br

TIP
Para aprofundar a modelagem de dados no Experience Platform, recomendamos assistir à lista de reprodução Modelar os dados da experiência do cliente com XDM, disponível gratuitamente no Experience League!

Permissões necessárias

Na lição Configurar Permissões, você configura todos os controles de acesso necessários para concluir esta lição.

Criar esquema de fidelidade por meio da interface

Neste exercício, criaremos um esquema para os dados de fidelidade do Luma.

  1. Vá para a interface do usuário da Platform e verifique se sua sandbox está selecionada.

  2. Vá para Esquemas na navegação à esquerda.

  3. Selecione o botão Criar esquema na parte superior direita.
    Esquema com grupo de campos OOTB

  4. No fluxo de trabalho Criar esquema, selecione Perfil Individual como a classe base do esquema, já que modelaremos os atributos de um cliente individual (pontos, status, etc.).

  5. Selecione Próximo.
    Selecionar classe base

  6. Digite Luma Loyalty Schema no campo de texto Nome para exibição do esquema. Na tela abaixo, você também pode revisar e verificar a estrutura do esquema base fornecida pela classe escolhida.

  7. Selecione Concluir para criar seu esquema.
    Concluir a criação do esquema de fidelidade

Adicionar grupos de campos padrão

Depois que o esquema for criado, você será redirecionado para o Editor de esquema, onde poderá adicionar campos ao esquema. Você pode adicionar campos individuais diretamente ao esquema ou usar grupos de campos. É importante observar que todos os campos individuais ainda estão associados a uma classe ou grupo de campos. Você pode escolher entre um grande conjunto de grupos de campo padrão do setor fornecidos pelo Adobe ou criar os seus próprios. À medida que você começa a modelar seus próprios dados no Experience Platform, é bom se familiarizar com os grupos de campo padrão do setor fornecidos pelo Adobe. Sempre que possível, é uma prática recomendada usá-los, pois eles às vezes alimentam serviços downstream, como IA do cliente, Attribution AI e Adobe Analytics.

Ao trabalhar com seus próprios dados, uma etapa significativa será determinar quais dos seus próprios dados devem ser capturados na Platform e como eles devem ser modelados. Este grande tópico é discutido com mais detalhes na lista de reprodução Modelar os dados da experiência do cliente com o XDM. Neste tutorial, eu vou guiá-lo pela implementação de alguns esquemas predeterminados.

Para adicionar grupos de campos:

  1. Selecione Adicionar sob o cabeçalho Grupos de campos.
    Adicionar um novo grupo de campos

  2. No modal Adicionar grupos de campos, selecione os seguintes grupos de campos:

    1. Detalhes demográficos para dados básicos do cliente, como nome e data de nascimento
    2. Detalhes de Contato Pessoal para obter detalhes de contato básicos, como endereço de email e número de telefone

  3. Você pode visualizar os campos de contribuição no grupo de campos selecionando o ícone no lado direito da linha.
    Selecionar grupos de campos padrão

  4. Marque a caixa Setor > Varejo para expor grupos de campos específicos do setor.

  5. Selecione Detalhes de fidelidade para adicionar os campos do programa de fidelidade.

  6. Selecione Adicionar grupos de campos para adicionar todos os três grupos de campos ao esquema.
    Adicionar grupos de campos padrão ao esquema de fidelidade

Agora dedique algum tempo para explorar o estado atual do schema. Os grupos de campos adicionaram campos padrão relacionados a uma pessoa, seus detalhes de contato e status do programa de fidelidade. Esses dois grupos de campos podem ser úteis ao criar esquemas para os dados da sua própria empresa. Selecione uma linha de grupo de campos específica ou marque a caixa ao lado do nome do grupo de campos para ver como a visualização é alterada.

Para salvar o esquema, selecione Salvar.
Salvar o esquema

NOTE
Não há problema se um grupo de campos adicionar um campo para um ponto de dados que você não coleta. Por exemplo, "faxPhone" pode ser um campo para o qual a Luma não coleta dados. Tudo bem. O fato de um campo estar definido no esquema não significa que os dados para ele devem ser assimilados posteriormente. Também é possível remover o campo do esquema.

Adicionar um grupo de campos personalizado

Agora, vamos criar um grupo de campos personalizado.

Embora o grupo de campos de fidelidade contivesse um campo loyaltyID, a Luma gostaria de gerenciar todos os identificadores de sistema em um único grupo para ajudar a garantir a consistência em seus esquemas.

Os grupos de campos devem ser criados no fluxo de trabalho de esquema. É possível:

  • Primeiro adicione um novo campo personalizado ao esquema e depois crie um grupo de campos personalizado, ou
  • Primeiro crie um grupo de campos personalizado e depois adicione os campos a ele.

Neste tutorial, começamos com a criação de um grupo de campos personalizado.

Para criar o grupo de campos:

  1. Selecione Adicionar sob o cabeçalho Grupos de Campos de Esquema
    Adicionar um novo grupo de campos
  2. Selecionar Criar novo grupo de campos
  3. Usar Luma Identity profile field group como Nome de exibição
  4. Usar system identifiers for XDM Individual Profile class como Descrição
  5. Selecionar Adicionar grupos de campos
    Adicionar um novo grupo de campos

O novo grupo de campos vazio é adicionado ao esquema. Os botões + podem ser usados para adicionar novos campos a qualquer local na hierarquia. Em nosso caso, queremos adicionar campos no nível raiz:

  1. Selecione + ao lado do nome do esquema. Isso adiciona um novo campo no namespace de id do locatário para gerenciar conflitos entre os campos personalizados e quaisquer campos padrão.

  2. Na barra lateral Propriedades do campo, adicione os detalhes do novo campo:

    1. Nome do campo: systemIdentifier

    2. Nome de exibição: System Identifier

    3. Tipo: Objeto

    4. Na lista suspensa Grupo de Campos, selecione o grupo de campos do perfil de identidade Luma que criamos.

      Adicionar um novo grupo de campos

    5. Selecione Aplicar

      Aplicar novas propriedades de campo

Agora adicione dois campos sob o objeto systemIdentifier:

  1. Primeiro campo

    1. Nome do campo: loyaltyId
    2. Nome de exibição: Loyalty Id
    3. Tipo: Cadeia

  2. Segundo campo

    1. Nome do Campo: crmId
    2. Nome para Exibição: CRM Id
    3. Tipo: Cadeia

Seu novo grupo de campos deve ter esta aparência. Selecione o botão Salvar para salvar seu esquema, mas deixe o esquema aberto para o próximo exercício.
Grupo de campos de fidelidade concluído

Criar um tipo de dados

Os grupos de campos, como o novo Luma Identity profile field group, podem ser reutilizados em outros esquemas, permitindo que você aplique definições de dados padrão em vários sistemas. Mas eles só podem ser reutilizados em esquemas que compartilham uma classe, neste caso a classe Perfil Individual XDM.

O tipo de dados é outra construção de vários campos que pode ser reutilizada em esquemas em várias classes. Vamos converter nosso novo objeto systemIdentifier em um tipo de dados:

Com o Luma Loyalty Schema ainda aberto, selecione o objeto systemIdentifier e selecione Converter em novo tipo de dados

Grupo de campos de fidelidade Concluído

Se você Cancelar do esquema e navegar até a guia Tipos de dados, verá seu tipo de dados recém-criado. Usaremos esse tipo de dados posteriormente na lição.

Grupo de campos de fidelidade Concluído

Criar esquema do CRM por meio da API

Agora criaremos um esquema usando a API.

TIP
Se preferir ignorar o exercício de API, você poderá criar o seguinte schema usando o método de interface do usuário:
  1. Usar a classe Perfil Individual
  2. Nomeie como Luma CRM Schema
  3. Use os seguintes grupos de campos: Detalhes demográficos, Detalhes de contato pessoal e grupo de campos de perfil de identidade da Luma

Primeiro, criamos o schema vazio:

  1. Abrir Postman

  2. Se você não tiver um token de acesso, abra a solicitação OAuth: Request Access Token e selecione Enviar para solicitar um novo token de acesso.

  3. Abra as variáveis de ambiente e altere o valor de CONTAINER_ID de global para tenant. Lembre-se, você deve usar tenant sempre que quiser interagir com seus próprios elementos personalizados na Platform, como criar um esquema.

  4. Selecione Salvar
    Alterar CONTAINER_ID para locatário

  5. Abrir a solicitação Schema Registry API > Schemas > Create a new custom schema.

  6. Abra a guia Corpo, cole o seguinte código e selecione Enviar para fazer a chamada de API. Esta chamada cria um novo esquema usando a mesma classe base XDM Individual Profile:

    code language-json 
    {
  "type": "object",
  "title": "Luma CRM Schema",
  "description": "Schema for CRM data of Luma Retail ",
  "allOf": [{
    "$ref": "https://ns.adobe.com/xdm/context/profile"
  }]
}
    note note
    NOTE
    As referências de namespace nesta e em amostras de código subsequentes (por exemplo, https://ns.adobe.com/xdm/context/profile) podem ser obtidas usando-se chamadas de API de lista com o CONTAINER_ID e o cabeçalho de aceitação definido com os valores corretos. Alguns também são facilmente acessíveis na interface do usuário.

  7. Você deve receber uma resposta de 201 Created

  8. Copiar meta:altId do corpo da Resposta. Usaremos depois em outro exercício.
    Criar o esquema do CRM

  9. O novo schema deve estar visível na interface do usuário, mas sem grupos de campos
    Criar o esquema do CRM

NOTE
A meta:altId ou a ID do esquema também pode ser obtida fazendo a solicitação de API Schema Registry API > Schemas > Retrieve a list of schemas within the specified container. com o CONTAINER_ID definido como tenant e um cabeçalho de aceitação application/vnd.adobe.xdm+json.
TIP
Problemas comuns com esta chamada e prováveis correções:
  • Nenhum token de autenticação: execute a solicitação OAuth: Request Access Token para gerar um novo token
  • 401: Not Authorized to PUT/POST/PATCH/DELETE for this path : /global/schemas/: Atualizar a variável de ambiente CONTAINER_ID de global para tenant
  • 403: PALM Access Denied. POST access is denied for this resource from access control: Verifique suas permissões de usuário no Admin Console

Adicionar grupos de campos padrão

Agora é hora de adicionar os grupos de campos ao esquema:

  1. Em Postman, Abrir a solicitação Schema Registry API > Schemas > Update one or more attributes of a custom schema specified by ID.

  2. Na guia Params, cole o valor meta:altId da resposta anterior como SCHEMA_ID

  3. Abra a guia Corpo e cole o seguinte código e selecione Enviar para fazer a chamada de API. Esta chamada adiciona os grupos de campos padrão ao seu Luma CRM Schema:

    code language-json 
    [{
    "op": "add",
    "path": "/allOf/-",
    "value": {
      "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details"
    }
  },
  {
    "op": "add",
    "path": "/allOf/-",
    "value": {
      "$ref": "https://ns.adobe.com/xdm/context/profile-person-details"
    }
  }
]

  4. Você deve obter um status 200 OK para a resposta e os grupos de campos devem estar visíveis como parte do esquema na interface

    Grupos de campos padrão adicionados

Adicionar grupo de campos personalizado

Agora vamos adicionar nosso Luma Identity profile field group ao esquema. Primeiro, precisamos encontrar a ID do novo grupo de campos, usando uma API de lista:

  1. Abrir a solicitação Schema Registry API > Field groups > Retrieve a list of field groups within the specified container.

  2. Selecione o botão Enviar para recuperar uma lista de todos os grupos de campos personalizados da sua conta

  3. Pegue o valor $id de Luma Identity profile field group (o seu será diferente do valor nesta captura de tela)
    Recuperar a lista de grupos de campos

  4. Abra a solicitação Schema Registry API > Schemas > Update one or more attributes of a custom schema specified by ID. novamente

  5. A guia Params ainda deve ter o $id do esquema

  6. Abra a guia Corpo e cole o seguinte código, substituindo o valor $ref pelo $id de seu próprio Luma Identity profile field group:

    code language-json 
    [{
  "op": "add",
  "path": "/allOf/-",
  "value": {
    "$ref": "REPLACE_WITH_YOUR_OWN_FIELD_GROUP_ID"
  }
}]

  7. Selecionar Enviar
    Adicionando o grupo Campo de Identidade

Verifique se o grupo de campos foi adicionado ao esquema verificando a resposta da API e na interface.

Criar esquema de eventos de compra offline

Agora vamos criar um esquema com base na classe Evento de experiência para os dados de compra offline da Luma. Como você agora está se familiarizando com a interface do usuário do editor de esquemas, reduzirei o número de capturas de tela nas instruções:

  1. Crie um esquema com a classe Evento de experiência.
  2. Nomeie seu esquema Luma Offline Purchase Events Schema.
  3. Adicione o grupo de campos padrão Detalhes do Commerce para capturar detalhes de pedidos comuns. Passe alguns minutos explorando os objetos internos.
  4. Pesquisar por Luma Identity profile field group. Não está disponível! Lembre-se de que os grupos de campos estão vinculados a uma classe e, como estamos usando uma classe diferente para este esquema, não podemos usá-lo. Precisamos adicionar um novo grupo de campos para a classe XDM ExperienceEvent que contém os campos de identidade. Nosso tipo de dados tornará isso realmente fácil!
  5. Selecione o botão de opção Criar novo grupo de campos
  6. Insira o Nome de exibição como Luma Identity ExperienceEvent field group e selecione o botão Adicionar grupos de campos
  7. Selecione + ao lado do nome do esquema.
  8. Como o Nome do Campo, digite systemIdentifier.
  9. Como o Nome para Exibição, digite System Identifier.
  10. Como o Tipo, selecione Identificador de Sistema, que é o tipo de dados personalizado que você criou anteriormente.
  11. Como o Grupo de Campos, selecione o grupo de campos Identity ExperienceEvent da Luma.
  12. Selecione o botão Aplicar.
  13. Selecione o botão Salvar.

Observe como o tipo de dados adicionou todos os campos.

Adicionar o tipo de dados ao grupo de campos

Além disso, selecione XDM ExperienceEvent sob o cabeçalho Class e inspecione alguns dos campos contribuídos por essa classe. Observe que os campos _id e carimbo de data e hora são necessários ao usar a classe XDM ExperienceEvent — esses campos devem ser preenchidos para cada registro assimilado ao usar esse esquema:

Estrutura base do evento de experiência

Criar esquema de eventos da Web

Agora vamos criar mais um schema para os dados do site do Luma. Até agora, você deve ser um especialista na criação de esquemas! Crie o seguinte esquema com essas propriedades

Propriedade
Valor
Classe
Evento de experiência
Nome do esquema
Esquema de eventos da Web da Luma
Grupo de campos
ExperienceEvent do SDK da Web da AEP
Grupo de campos
Evento de experiência do consumidor

Selecione o grupo de campos Evento de experiência do consumidor. Este grupo de campos contém os objetos de comércio e productListItems que também estavam nos Detalhes do Commerce. Na verdade, o Evento de Experiência do Consumidor é uma combinação de vários outros grupos de campos padrão que também estão disponíveis separadamente. O grupo de campos ExperienceEvent do SDK da Web da AEP também contém outros grupos de campos, incluindo alguns dos mesmos no Evento de Experiência do Consumidor. Felizmente, eles se misturam perfeitamente.

Observe que não adicionamos Luma Identity ExperienceEvent field group a este esquema. Isso ocorre porque o SDK da Web tem uma maneira diferente de coletar identidades. Se você selecionar a classe XDM ExperienceEvent na seção Composition do editor de esquema, você observará que um dos campos adicionados por padrão é chamado IdentityMap. IdentityMap é usado por vários aplicativos Adobe para vincular à Platform. Você verá como as identidades são enviadas para a Platform via identityMap na lição de assimilação de streaming.

Criar esquema do catálogo de produtos

Usando os Detalhes do Commerce e os Eventos de Experiência do Consumidor grupos de campos, a Luma relata alguns detalhes de eventos relacionados ao produto por meio do tipo de dados padrão productListItems. Mas eles também têm campos adicionais de detalhes do produto que gostariam de enviar para a Platform. Em vez de capturar todos esses campos em seus sistemas de ponto de venda e comércio eletrônico, a Luma preferiria assimilar esses campos diretamente do sistema de catálogo de produtos. Uma "relação de esquema" permite definir uma relação entre dois esquemas para fins de classificação ou pesquisas. A Luma usará um relacionamento para classificar os detalhes do produto. Começaremos o processo agora e o concluiremos no final da próxima lição.

NOTE
Se você for um cliente existente do Analytics ou do Target, classificar entidades com relacionamentos de esquema é análogo às classificações de SAINT ou fazer upload do catálogo de produtos para o Recommendations

Primeiro, devemos criar um esquema para o catálogo de produtos da Luma usando uma classe personalizada:

  1. Selecione o botão Criar esquema.

  2. No fluxo de trabalho Criar esquema, selecione a opção Outros.
    Criar novo Esquema

  3. Selecione o botão Criar classe

  4. Nomeie como Luma Product Catalog Class

  5. Deixe o Comportamento como Registro

  6. Selecione o botão Criar.
    Criar nova classe

  7. A Classe de Catálogo de Produtos Luma criada aparece na tabela Classes abaixo. Verifique se a classe está selecionada e selecione Próximo.
    Nova classe adicionada

  8. Nomeie o esquema Luma Product Catalog Schema.

  9. Crie um novo grupo de campos chamado Luma Product Catalog field group com os seguintes campos:

    1. productName: Nome do produto: String
    2. productCategory: Categoria do produto: String
    3. productColor: Cor do produto: String
    4. productSku: SKU do produto: Cadeia de caracteres | Obrigatório
    5. productSize: Product Size: String
    6. productPrice: Preço do produto: Duplo

  10. Salvar o esquema

O novo esquema deve ter esta aparência. Observe como o campo productSku é listado na seção Campos obrigatórios:
Esquema do produto

A próxima etapa é definir a relação entre os dois esquemas ExperienceEvent e o Luma Product Catalog Schema. No entanto, há algumas etapas adicionais que devemos seguir na próxima lição antes que possamos fazer isso.

Recursos adicionais

Agora que você tem seus esquemas, você pode mapear identidades!

recommendation-more-help
513160b6-bf42-4c58-abdd-4f817b1cccad