Creare una configurazione di destinazione
Questa pagina esemplifica la richiesta API e il payload che puoi utilizzare per creare la tua configurazione di destinazione, utilizzando /authoring/destinations
Endpoint API
Per una descrizione dettagliata delle funzionalità che puoi configurare tramite questo endpoint, leggi i seguenti articoli:
- Configurazione autenticazione cliente
- Autorizzazione OAuth2
- Campi dati cliente
- Attributi dell’interfaccia utente
- Configurazione dello schema
- Configurazione dello spazio dei nomi dell’identità
- Consegna della destinazione
- Configurazione dei metadati del pubblico
- Configurazione dei metadati del pubblico
- Criterio di aggregazione
- Configurazione batch
- Qualifiche del profilo storico
Guida introduttiva alle operazioni API di configurazione di destinazione get-started
Prima di continuare, controlla guida introduttiva per informazioni importanti che è necessario conoscere per effettuare correttamente chiamate all’API, tra cui come ottenere l’autorizzazione di authoring della destinazione richiesta e le intestazioni richieste.
Creare una configurazione di destinazione create
Per creare una nuova configurazione di destinazione, devi effettuare una richiesta POST al /authoring/destinations
endpoint.
platform.adobe.io/data/core/activation/authoring/destinations
Formato API
POST /authoring/destinations
La richiesta seguente crea un nuovo Amazon S3 configurazione di destinazione, configurata dai parametri forniti nel payload. Il payload seguente include tutti i parametri per le destinazioni basate su file accettate dal /authoring/destinations
endpoint.
Tieni presente che non è necessario aggiungere tutti i parametri alla chiamata API e che il payload è personalizzabile in base ai requisiti API.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 19-row-3 20-row-3 21-row-3 22-row-3 23-row-3 24-row-3 25-row-3 26-row-3 27-row-3 28-row-3 29-row-3 30-row-3 31-row-3 layout-auto | ||||
---|---|---|---|---|
Parametro | Tipo | Descrizione | ||
name |
Stringa | Indica il titolo della destinazione nel catalogo di Experienci Platform. | ||
description |
Stringa |
Fornisci una descrizione che Adobe utilizzerà nel catalogo delle destinazioni Experienci Platform per la tua scheda di destinazione. Puntare a non più di 4-5 frasi.+-------------------------------------------------------------------------------------------------------+ | img-md |
|
||
status |
Stringa | Indica lo stato del ciclo di vita della scheda di destinazione. I valori accettati sono TEST , PUBLISHED , e DELETED . Utilizzare TEST la prima volta che configuri la destinazione. |
||
customerAuthenticationConfigurations.authType |
Stringa | Indica la configurazione utilizzata per autenticare i clienti Experienci Platform nel server di destinazione. Consulta configurazione autenticazione cliente per informazioni dettagliate sui tipi di autenticazione supportati. | ||
customerDataFields.name |
Stringa |
Immetti un nome per il campo personalizzato che stai presentando.
|
||
customerDataFields.type |
Stringa | Indica il tipo di campo personalizzato che si sta introducendo. I valori accettati sono string , object , integer .Consulta Campi dati cliente per informazioni dettagliate su queste impostazioni. |
||
customerDataFields.title |
Stringa | Indica il nome del campo, così come viene visualizzato dai clienti nell’interfaccia utente di Experienci Platform. Consulta Campi dati cliente per informazioni dettagliate su queste impostazioni. |
||
customerDataFields.description |
Stringa | Fornisci una descrizione per il campo personalizzato. Consulta Campi dati cliente per informazioni dettagliate su queste impostazioni. | ||
customerDataFields.isRequired |
Booleano | Indica se questo campo è obbligatorio nel flusso di lavoro di configurazione della destinazione. Consulta Campi dati cliente per informazioni dettagliate su queste impostazioni. |
||
customerDataFields.enum |
Stringa | Esegue il rendering del campo personalizzato come menu a discesa ed elenca le opzioni disponibili per l'utente. Consulta Campi dati cliente per informazioni dettagliate su queste impostazioni. |
||
customerDataFields.default |
Stringa | Definisce il valore predefinito da un enum elenco. |
||
customerDataFields.pattern |
Stringa | Se necessario, applica un pattern per il campo personalizzato. Utilizza espressioni regolari per applicare un pattern. Ad esempio, se gli ID cliente non includono numeri o trattini bassi, immetti ^[A-Za-z]+$ in questo campo.Consulta Campi dati cliente per informazioni dettagliate su queste impostazioni. |
||
uiAttributes.documentationLink |
Stringa |
Fa riferimento alla pagina della documentazione in Catalogo delle destinazioni per la tua destinazione. Utilizzare
|
||
uiAttributes.category |
Stringa | Fa riferimento alla categoria assegnata alla destinazione in Adobe Experience Platform. Per ulteriori informazioni, consulta Categorie di destinazione. Utilizza uno dei seguenti valori: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments .Consulta Attributi dell’interfaccia utente per informazioni dettagliate su queste impostazioni. |
||
uiAttributes.connectionType |
Stringa |
Il tipo di connessione, a seconda della destinazione. Valori supportati:
|
||
uiAttributes.frequency |
Stringa | Si riferisce al tipo di esportazione dei dati supportato dalla destinazione. Imposta su Streaming per integrazioni basate su API, oppure Batch quando si esportano file nelle destinazioni. |
||
identityNamespaces.externalId.acceptsAttributes |
Booleano | Indica se i clienti possono mappare gli attributi di profilo standard all’identità che stai configurando. | ||
identityNamespaces.externalId.acceptsCustomNamespaces |
Booleano | Indica se i clienti possono mappare le identità appartenenti a spazi dei nomi personalizzati all’identità che stai configurando. | ||
identityNamespaces.externalId.transformation |
Stringa | Non visualizzato nella configurazione di esempio. Utilizzato, ad esempio, quando Platform il cliente ha come attributo indirizzi e-mail semplici e la tua piattaforma accetta solo e-mail con hash. Qui puoi fornire la trasformazione da applicare (ad esempio, trasformare l’e-mail in minuscolo, quindi in hash). | ||
identityNamespaces.externalId.acceptedGlobalNamespaces |
- | Indica quale spazi dei nomi di identità standard (ad esempio, IDFA) i clienti possono effettuare il mapping all’identità che stai configurando. Quando si utilizza acceptedGlobalNamespaces , è possibile utilizzare "requiredTransformation":"sha256(lower($))" agli indirizzi e-mail o ai numeri di telefono in minuscolo e con hash. |
||
destinationDelivery.authenticationRule |
Stringa |
Indica come Platform i clienti si connettono alla tua destinazione. I valori accettati sono
|
||
destinationDelivery.destinationServerId |
Stringa | Il instanceId del modello server di destinazione utilizzato per questa destinazione. |
||
backfillHistoricalProfileData |
Booleano | Controlla se i dati storici del profilo vengono esportati quando i tipi di pubblico vengono attivati nella destinazione. Imposta sempre questo su true . |
||
segmentMappingConfig.mapUserInput |
Booleano | Controlla se l’ID di mappatura del pubblico nel flusso di lavoro di attivazione della destinazione viene immesso dall’utente. | ||
segmentMappingConfig.mapExperiencePlatformSegmentId |
Booleano | Controlla se l’ID di mappatura del pubblico nel flusso di lavoro di attivazione della destinazione è l’ID del pubblico Experience Platform. | ||
segmentMappingConfig.mapExperiencePlatformSegmentName |
Booleano | Controlla se l’ID di mappatura del pubblico nel flusso di lavoro di attivazione della destinazione è il nome Experience Platform del pubblico. | ||
segmentMappingConfig.audienceTemplateId |
Booleano | Il instanceId del modello metadati pubblico utilizzato per questa destinazione. |
||
schemaConfig.profileFields |
Array | Quando si aggiungono impostazioni predefinite profileFields come mostrato nella configurazione precedente, gli utenti avranno la possibilità di mappare gli attributi di Experience Platform agli attributi predefiniti sul lato della destinazione. |
||
schemaConfig.profileRequired |
Booleano | Utilizzare true gli utenti devono essere in grado di mappare gli attributi del profilo da Experienci Platform ad attributi personalizzati sul lato della destinazione, come mostrato nella configurazione di esempio precedente. |
||
schemaConfig.segmentRequired |
Booleano | Usa sempre segmentRequired:true . |
||
schemaConfig.identityRequired |
Booleano | Utilizzare true se gli utenti devono essere in grado di mappare gli spazi dei nomi delle identità dall’Experience Platform allo schema desiderato. |
Gestione degli errori API
Gli endpoint API di Destination SDK seguono i principi generali dei messaggi di errore API di Experience Platform. Fai riferimento a Codici di stato API e errori di intestazione della richiesta nella guida alla risoluzione dei problemi di Platform.
Passaggi successivi
Dopo aver letto questo documento, ora sai come creare una nuova configurazione di destinazione tramite la Destination SDK /authoring/destinations
Endpoint API
Per ulteriori informazioni su cosa è possibile fare con questo endpoint, consulta i seguenti articoli:
Per capire dove questo endpoint si inserisce nel processo di authoring della destinazione, vedi i seguenti articoli: