Configurazione schema partner

Experience Platform utilizza gli schemi per descrivere la struttura dei dati in modo coerente e riutilizzabile. Quando si acquisiscono dati in Experience Platform, questi sono strutturati in base a uno schema XDM. Per ulteriori informazioni sul modello di composizione dello schema, inclusi i principi di progettazione e le best practice, vedere le nozioni di base sulla composizione dello schema.

Quando si crea una destinazione con Destination SDK, è possibile definire uno schema partner personalizzato da utilizzare per la piattaforma di destinazione. Utilizza lo schema partner per mappare gli attributi del profilo da Experience Platform a campi specifici riconosciuti dalla piattaforma di destinazione, il tutto nell’interfaccia utente di Experience Platform.

Durante la configurazione dello schema partner per la destinazione, puoi ottimizzare la mappatura dei campi supportata dalla piattaforma di destinazione, ad esempio:

Per capire dove questo componente si inserisce in un’integrazione creata con Destination SDK, vedere il diagramma nella documentazione delle opzioni di configurazione o la guida su come utilizzare Destination SDK per configurare una destinazione basata su file.

È possibile configurare le impostazioni dello schema tramite l’endpoint /authoring/destinations. Consulta le seguenti pagine di riferimento API per esempi dettagliati di chiamate API, in cui puoi configurare i componenti mostrati in questa pagina.

Questo articolo descrive tutte le opzioni di configurazione dello schema supportate che è possibile utilizzare per la destinazione e mostra ciò che viene visualizzato nell’interfaccia utente di Experience Platform.

Tipi di integrazione supportati supported-integration-types

Consulta la tabella seguente per informazioni dettagliate sui tipi di integrazioni che supportano le funzionalità descritte in questa pagina.

Configurazione dello schema supportata supported-schema-types

Destination SDK supporta più configurazioni di schema:

La sezione schemaConfig utilizza più parametri di configurazione, a seconda del tipo di schema necessario, come illustrato nelle sezioni seguenti.

Creare uno schema statico attributes-schema

Per creare uno schema statico con attributi di profilo, definire gli attributi di destinazione nell’array profileFields come illustrato di seguito.

"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"]

}

L’esperienza dell’interfaccia utente risultante viene mostrata nelle immagini seguenti.

Quando si seleziona la mappatura di destinazione, è possibile visualizzare i campi definiti nell’array profileFields.

Dopo aver selezionato gli attributi, puoi visualizzarli nella colonna del campo di destinazione.

Creare uno schema dinamico dynamic-schema-configuration

Destination SDK supporta la creazione di schemi partner dinamici. A differenza di uno schema statico, uno schema dinamico non utilizza un array profileFields. Gli schemi dinamici utilizzano invece un server di schema dinamico che si connette alla tua API da dove recupera la configurazione dello schema.

In una configurazione di schema dinamico, l’array profileFields è sostituito dalla sezione dynamicSchemaConfig, come illustrato di seguito.

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

Mappature richieste required-mappings

All’interno della configurazione dello schema, oltre allo schema statico o dinamico, puoi aggiungere mappature richieste (o predefinite). Si tratta di mappature che è possibile visualizzare nell’interfaccia utente di Experience Platform, ma che non è possibile modificare quando si imposta una connessione alla destinazione.

Ad esempio, puoi applicare che il campo dell’indirizzo e-mail venga sempre inviato alla destinazione.

Di seguito sono riportati due esempi di configurazione dello schema con mappature richieste e del loro aspetto nel passaggio di mappatura del flusso di lavoro attiva dati su destinazioni batch.

"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
      }
    ]
}

Configurare il supporto per il pubblico esterno external-audiences

Per configurare la destinazione in modo da supportare l’attivazione di tipi di pubblico generati esternamente, includere lo snippet di codice riportato di seguito nella sezione schemaConfig.

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

Per ulteriori informazioni sulla funzionalità segmentNamespaceDenyList, consulta le descrizioni delle proprietà nella tabella più avanti in questa pagina.

Passaggi successivi next-steps

Ora puoi comprendere i tipi di schema statici e dinamici supportati da Destination SDK, come aggiungere le mappature richieste e come configurare la destinazione per supportare tipi di pubblico esterni.

Per ulteriori informazioni sugli altri componenti di destinazione, consulta i seguenti articoli: