Configuração de esquema de parceiro

O Experience Platform usa esquemas para descrever a estrutura dos dados de forma consistente e reutilizável. Quando os dados são assimilados na Platform, eles são estruturados de acordo com um esquema XDM. Para obter mais informações sobre o modelo de composição de esquema, incluindo princípios de design e práticas recomendadas, consulte as noções básicas da composição de esquema.

Ao criar um destino com o Destination SDK, você pode definir seu próprio esquema de parceiro a ser usado pela plataforma de destino. Isso oferece aos usuários a capacidade de mapear atributos de perfil da Platform para campos específicos reconhecidos pela plataforma de destino, tudo na interface do usuário da Platform.

Ao configurar o esquema de parceiro para o seu destino, você pode ajustar o mapeamento de campos compatível com sua plataforma de destino, como:

Para entender onde esse componente se encaixa em uma integração criada com o Destination SDK, consulte o diagrama na documentação de opções de configuração ou consulte o guia sobre como usar o Destination SDK para configurar um destino baseado em arquivo.

Você pode definir suas configurações de esquema por meio do ponto de extremidade /authoring/destinations. Consulte as seguintes páginas de referência de API para obter exemplos detalhados de chamadas de API, onde é possível configurar os componentes mostrados nesta página.

Este artigo descreve todas as opções de configuração de esquema compatíveis que você pode usar para o seu destino e mostra o que os clientes verão na interface do usuário da Platform.

Tipos de integração compatíveis supported-integration-types

Consulte a tabela abaixo para obter detalhes sobre quais tipos de integrações suportam a funcionalidade descrita nesta página.

Configuração de esquema compatível supported-schema-types

O Destination SDK suporta várias configurações de esquema:

A seção schemaConfig usa vários parâmetros de configuração, dependendo do tipo de esquema necessário, conforme mostrado nas seções abaixo.

Criar um esquema estático attributes-schema

Para criar um esquema estático com atributos de perfil, defina os atributos de destino na matriz profileFields conforme mostrado abaixo.

"schemaConfig":{
      "profileFields":[
           {
              "name":"phoneNo",
              "title":"phoneNo",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the mobilePhone.number value in Experience Platform could be phoneNo on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           },
                      {
              "name":"firstName",
              "title":"firstName",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the person.name.firstName value in Experience Platform could be firstName on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           },
                      {
              "name":"lastName",
              "title":"lastName",
              "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the person.name.lastName value in Experience Platform could be phoneNo on your side.",
              "type":"string",
              "isRequired":false,
              "readOnly":false,
              "hidden":false
           }
        ],
      "useCustomerSchemaForAttributeMapping":false,
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true,
      "segmentNamespaceAllowList": ["someNamespace"],
      "segmentNamespaceDenyList": ["someOtherNamespace"]

}

A experiência de interface do usuário resultante é mostrada nas imagens abaixo.

Ao selecionar o target mapping, os usuários podem ver os campos definidos na matriz profileFields.

Após selecionar os atributos, eles podem vê-los na coluna do campo de destino.

Criar um esquema dinâmico dynamic-schema-configuration

O Destination SDK oferece suporte à criação de esquemas de parceiros dinâmicos. Ao contrário de um esquema estático, um esquema dinâmico não usa uma matriz profileFields. Em vez disso, os esquemas dinâmicos usam um servidor de esquema dinâmico que se conecta à sua própria API de onde recupera a configuração do esquema.

Em uma configuração de esquema dinâmico, a matriz profileFields é substituída pela seção dynamicSchemaConfig, conforme mostrado abaixo.

"schemaConfig":{
   "dynamicSchemaConfig":{
      "dynamicEnum": {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"DYNAMIC_SCHEMA_SERVER_ID",
         "value": "Schema Name",
         "responseFormat": "SCHEMA"
      }
   },
   "profileRequired":true,
   "segmentRequired":true,
   "identityRequired":true
}

Mapeamentos necessários required-mappings

Na configuração do esquema, além do esquema estático ou dinâmico, você tem a opção de adicionar mapeamentos necessários (ou predefinidos). Esses são mapeamentos que os usuários podem visualizar na interface do usuário da Platform, mas não podem modificá-los ao configurar uma conexão com o seu destino.

Por exemplo, é possível impor que o campo de endereço de email sempre seja enviado ao destino.

Veja abaixo dois exemplos de uma configuração de esquema com os mapeamentos necessários e como eles se parecem na etapa de mapeamento do fluxo de trabalho ativar dados para destinos em lote.

"schemaConfig": {
    "requiredMappingsOnly": true,
    "requiredMappings": [
      {
        "sourceType": "text/x.schema-path",
        "source": "personalEmail.address",
        "destination": "personalEmail.address"
      }
    ]
}

"schemaConfig": {
    "requiredMappingsOnly": true,
    "requiredMappings": [
      {
        "destination": "identityMap.ExamplePartner_ID",
        "mandatoryRequired": true,
        "primaryKeyRequired": true
      }
    ]
}

Configuração do suporte para públicos externos external-audiences

Para configurar o destino para oferecer suporte à ativação de públicos gerados externamente, inclua o trecho abaixo na seção schemaConfig.

"schemaConfig": {
  "segmentNamespaceDenyList": [],
  ...
}

Consulte as descrições de propriedade na tabela mais acima nesta página para saber mais sobre a funcionalidade segmentNamespaceDenyList.

Próximas etapas next-steps

Depois de ler este artigo, você deve entender melhor quais tipos de esquema são compatíveis com o Destination SDK e como você pode configurar seu esquema.

Para saber mais sobre os outros componentes de destino, consulte os seguintes artigos: