Creare una configurazione di destinazione
Questa pagina esemplifica la richiesta API e il payload che è possibile utilizzare per creare la propria configurazione di destinazione, utilizzando l'endpoint API /authoring/destinations
.
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, consulta la guida introduttiva per informazioni importanti che devi 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
È possibile creare una nuova configurazione di destinazione effettuando una richiesta POST all'endpoint /authoring/destinations
.
platform.adobe.io/data/core/activation/authoring/destinations
Formato API
POST /authoring/destinations
La richiesta seguente crea una nuova configurazione di destinazione Amazon S3, configurata dai parametri forniti nel payload. Il payload seguente include tutti i parametri per le destinazioni basate su file accettate dall'endpoint /authoring/destinations
.
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 Experience Platform per la tua scheda di destinazione. Puntare a non più di 4-5 frasi. {width="100" modal="regular"} |
status |
Stringa | Indica lo stato del ciclo di vita della scheda di destinazione. I valori accettati sono TEST , PUBLISHED e DELETED . Utilizza TEST quando configuri per la prima volta la destinazione. |
customerAuthenticationConfigurations.authType |
Stringa | Indica la configurazione utilizzata per autenticare i clienti Experienci Platform nel server di destinazione. Per informazioni dettagliate sui tipi di autenticazione supportati, vedere configurazione dell'autenticazione del cliente. |
customerDataFields.name |
Stringa | Immetti un nome per il campo personalizzato che stai presentando. Per informazioni dettagliate su queste impostazioni, vedere Campi dati cliente. {width="100" modal="regular"} |
customerDataFields.type |
Stringa | Indica il tipo di campo personalizzato che si sta introducendo. I valori accettati sono string , object , integer .Per informazioni dettagliate su queste impostazioni, vedere Campi dati cliente. |
customerDataFields.title |
Stringa | Indica il nome del campo, così come viene visualizzato dai clienti nell’interfaccia utente di Experience Platform. Per informazioni dettagliate su queste impostazioni, vedere Campi dati cliente. |
customerDataFields.description |
Stringa | Fornisci una descrizione per il campo personalizzato. Per informazioni dettagliate su queste impostazioni, vedere Campi dati cliente. |
customerDataFields.isRequired |
Booleano | Indica se questo campo è obbligatorio nel flusso di lavoro di configurazione della destinazione. Per informazioni dettagliate su queste impostazioni, vedere Campi dati cliente. |
customerDataFields.enum |
Stringa | Esegue il rendering del campo personalizzato come menu a discesa ed elenca le opzioni disponibili per l'utente. Per informazioni dettagliate su queste impostazioni, vedere Campi dati cliente. |
customerDataFields.default |
Stringa | Definisce il valore predefinito da un elenco enum . |
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.Per informazioni dettagliate su queste impostazioni, vedere Campi dati cliente. |
uiAttributes.documentationLink |
Stringa | Fa riferimento alla pagina della documentazione nel Catalogo destinazioni per la tua destinazione. Utilizza https://www.adobe.com/go/destinations-YOURDESTINATION-en , dove YOURDESTINATION è il nome della tua destinazione. Per una destinazione denominata Moviestar, si utilizza https://www.adobe.com/go/destinations-moviestar-en . Tieni presente che questo collegamento funziona solo dopo che Adobe ha impostato la destinazione live e che la documentazione è stata pubblicata.Per informazioni dettagliate su queste impostazioni, vedere Attributi dell'interfaccia utente. {width="100" modal="regular"} |
uiAttributes.category |
Stringa | Fa riferimento alla categoria assegnata alla destinazione in Adobe Experience Platform. Per ulteriori informazioni, leggere Categorie di destinazione. Utilizzare uno dei valori seguenti: 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 .Per informazioni dettagliate su queste impostazioni, vedere Attributi dell'interfaccia utente. |
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. Impostato su Streaming per le integrazioni basate su API, oppure su 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 si sta configurando. |
identityNamespaces.externalId.transformation |
Stringa | Non visualizzato nella configurazione di esempio. Utilizzato, ad esempio, quando il cliente Platform 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 quali spazi dei nomi di identità standard (ad esempio, IDFA) i clienti possono mappare all'identità che stai configurando. Quando si utilizza acceptedGlobalNamespaces , è possibile utilizzare "requiredTransformation":"sha256(lower($))" per inserire indirizzi e-mail o numeri di telefono in minuscolo e con hash. |
destinationDelivery.authenticationRule |
Stringa |
Indica come Platform clienti si connettono alla destinazione. I valori accettati sono
|
destinationDelivery.destinationServerId |
Stringa | instanceId del modello del 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 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 |
Stringa | instanceId del modello di metadati del pubblico utilizzato per questa destinazione. |
schemaConfig.profileFields |
Array | Quando si aggiunge profileFields predefinito 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 | Utilizza true se gli utenti devono essere in grado di mappare gli attributi del profilo da Experience 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 | Utilizza 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. Consulta 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, sai come creare una nuova configurazione di destinazione tramite l'endpoint API Destination SDK /authoring/destinations
.
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: