Utilizzare Destination SDK per configurare una destinazione di streaming
Panoramica overview
In questa pagina viene descritto come utilizzare le informazioni in Opzioni di configurazione in Destinazioni SDK e in altre funzionalità di Destination SDK e documenti di riferimento API per configurare una destinazione di streaming. I passaggi sono disposti in ordine sequenziale di seguito.
Prerequisiti prerequisites
Prima di passare ai passaggi illustrati di seguito, leggere la pagina Guida introduttiva di Destination SDK per informazioni su come ottenere le credenziali di autenticazione di Adobe I/O necessarie e altri prerequisiti per l'utilizzo delle API di Destination SDK. Ciò presuppone che tu abbia completato i prerequisiti di partnership e autorizzazione e che sia pronto per iniziare a sviluppare la tua destinazione.
Passaggi per utilizzare le opzioni di configurazione in Destination SDK per impostare la destinazione steps
Passaggio 1: creare una configurazione di server e modelli create-server-template-configuration
Iniziare creando una configurazione del server e del modello utilizzando l'endpoint /destinations-server.
Di seguito è riportato un esempio di configurazione. Si noti che il modello di trasformazione dei messaggi nel parametro requestBody.value è indicato nel passaggio 3, Crea modello di trasformazione.
POST platform.adobe.io/data/core/activation/authoring/destination-servers
{
"name":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"httpMethod":"POST",
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"insert after you create a template in step 3"
},
"contentType":"application/json"
}
}
Passaggio 2: creare la configurazione di destinazione create-destination-configuration
Di seguito è riportata una configurazione di esempio per un modello di destinazione, creato utilizzando l'endpoint API /destinations. Per ulteriori informazioni, vedere creare una configurazione di destinazione.
Per connettere il server e la configurazione del modello nel passaggio 1 a questa configurazione di destinazione, aggiungere qui l'ID istanza del server e della configurazione del modello come destinationServerId.
identityNamespaces, come illustrato di seguito. Se non è configurata alcuna identità di destinazione, gli utenti non potranno procedere oltre il passaggio di mappatura del flusso di lavoro di attivazione.POST platform.adobe.io/data/core/activation/authoring/destinations
{
"name":"Moviestar",
"description":"Moviestar is a fictional destination, used for this example.",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
],
"customerDataFields":[
{
"name":"endpointsInstance",
"type":"string",
"title":"Select Endpoint",
"description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
"isRequired":true,
"enum":[
"US",
"EU",
"APAC",
"NZ"
]
},
{
"name":"customerID",
"type":"string",
"title":"Moviestar Customer ID",
"description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
"isRequired":true,
"pattern":""
}
],
"uiAttributes":{
"documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
"category":"mobile",
"connectionType":"Server-to-server",
"frequency":"Streaming"
},
"identityNamespaces":{
"external_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
},
"another_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
}
},
"segmentMappingConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false
},
"audienceMetadataConfig":{
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"aggregation":{
"aggregationType":"CONFIGURABLE_AGGREGATION",
"configurableAggregation":{
"aggregationPolicyId":null,
"aggregationKey":{
"includeSegmentId":true,
"includeSegmentStatus":true,
"includeIdentity":true,
"oneIdentityPerGroup":true,
"groups":null
},
"splitUserById":true,
"maxBatchAgeInSecs":2400,
"maxNumEventsInBatch":5000
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
]
}
Passaggio 3: creare un modello di trasformazione dei messaggi. Utilizza il linguaggio dei modelli per specificare il formato di output del messaggio create-transformation-template
In base ai payload supportati dalla destinazione, è necessario creare un modello che trasformi il formato dei dati esportati dal formato Adobe XDM in un formato supportato dalla destinazione. Vedi gli esempi di modelli nella sezione Utilizzo di un linguaggio per modelli per le trasformazioni di identità, attributi e appartenenza a un pubblico e utilizzo dello strumento per la creazione di modelli fornito da Adobe.
Dopo aver creato un modello di trasformazione dei messaggi che funziona per te, aggiungilo al server e alla configurazione del modello creati nel passaggio 1.
{
"name":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{\n \"users\": [\n {% for profile in input.profiles %}\n {{profile|raw}}{% if not loop.last %},{% endif %}\n {% endfor %}\n ]\n}"
},
"contentType":"application/json"
}
}
Passaggio 4: creare la configurazione dei metadati del pubblico create-audience-metadata-configuration
Per alcune destinazioni, Destination SDK richiede di configurare una configurazione di metadati di pubblico per creare, aggiornare o eliminare in modo programmatico i tipi di pubblico nella destinazione. Consulta Gestione dei metadati del pubblico per informazioni su quando devi configurare questa configurazione e su come farlo.
Se utilizzi una configurazione di metadati di pubblico, devi collegarla alla configurazione di destinazione creata nel passaggio 2. Aggiungi l'ID istanza della configurazione dei metadati del pubblico alla configurazione di destinazione come audienceTemplateId.
{
"name":"Moviestar",
"description":"Moviestar is a fictional destination, used for this example.",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
],
"customerDataFields":[
{
"name":"endpointsInstance",
"type":"string",
"title":"Select Endpoint",
"description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
"isRequired":true,
"enum":[
"US",
"EU",
"APAC",
"NZ"
]
},
{
"name":"customerID",
"type":"string",
"title":"Moviestar Customer ID",
"description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
"isRequired":true,
"pattern":""
}
],
"uiAttributes":{
"documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
"category":"mobile",
"connectionType":"Server-to-server",
"frequency":"Streaming"
},
"identityNamespaces":{
"external_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
},
"another_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
}
},
"segmentMappingConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false
},
"audienceMetadataConfig":{
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"aggregation":{
"aggregationType":"CONFIGURABLE_AGGREGATION",
"configurableAggregation":{
"aggregationPolicyId":null,
"aggregationKey":{
"includeSegmentId":true,
"includeSegmentStatus":true,
"includeIdentity":true,
"oneIdentityPerGroup":true,
"groups":null
},
"splitUserById":true,
"maxBatchAgeInSecs":2400,
"maxNumEventsInBatch":5000
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
]
}
Passaggio 5: configurare l’autenticazione set-up-authentication
A seconda che si specifichi "authenticationRule": "CUSTOMER_AUTHENTICATION" o "authenticationRule": "PLATFORM_AUTHENTICATION" nella configurazione di destinazione precedente, è possibile impostare l'autenticazione per la destinazione utilizzando l'endpoint /destination o /credentials.
CUSTOMER_AUTHENTICATION è la più comune delle due regole di autenticazione ed è quella da utilizzare se si richiede agli utenti di fornire una forma di autenticazione alla destinazione prima di poter impostare una connessione ed esportare dati.Se hai selezionato "authenticationRule": "CUSTOMER_AUTHENTICATION" nella configurazione di destinazione e la tua destinazione supporta il metodo di autenticazione OAuth 2, leggi Autenticazione OAuth 2.
Se hai selezionato "authenticationRule": "PLATFORM_AUTHENTICATION", devi creare una configurazione credenziali.
Passaggio 6: verifica della destinazione test-destination
Dopo aver configurato la destinazione utilizzando gli endpoint di configurazione nei passaggi precedenti, puoi utilizzare lo strumento di test della destinazione per testare l'integrazione tra Adobe Experience Platform e la destinazione.
Come parte del processo di test della destinazione, devi utilizzare l’interfaccia utente di Experience Platform per creare i segmenti che attiverai nella destinazione. Fai riferimento alle due risorse seguenti per istruzioni su come creare tipi di pubblico in Experience Platform:
Passaggio 7: pubblicare la destinazione publish-destination
Dopo aver configurato e testato la destinazione, utilizza l'API di pubblicazione della destinazione per inviare la configurazione ad Adobe per la revisione.
Passaggio 8: documentare la destinazione document-destination
Se sei un fornitore di software indipendente (ISV) o un integratore di sistemi (SI) che crea una integrazione prodotta, utilizza il processo di documentazione self-service per creare una pagina di documentazione del prodotto per la tua destinazione nel catalogo delle destinazioni di Experience Platform.
Passaggio 9: invia la destinazione per la revisione di Adobe submit-for-review
Infine, prima che la destinazione possa essere pubblicata nel catalogo Experience Platform e visibile a tutti i clienti Experience Platform, devi inviarla ufficialmente per la revisione da parte di Adobe. Trova informazioni complete su come inviare per la revisione una destinazione prodotta creata in Destination SDK.