Specifiche del server per le destinazioni create con Destination SDK
Le specifiche del server di destinazione definiscono il tipo di piattaforma di destinazione che riceverà i dati da Adobe Experience Platform e i parametri di comunicazione tra Platform e la destinazione. Ad esempio:
- Una specifica del server di destinazione streaming definisce l'endpoint del server HTTP che riceverà i messaggi HTTP da Platform. Per informazioni su come configurare la formattazione delle chiamate HTTP all'endpoint, leggere la pagina delle specifiche dei modelli.
- Una specifica del server di destinazione Amazon S3 definisce il nome e il percorso del bucket S3 in cui Platform esporterà i file.
- Una specifica del server di destinazione SFTP definisce il nome host, la directory radice, la porta di comunicazione e il tipo di crittografia del server SFTP in cui Platform esporterà i file.
Per capire dove questo componente si inserisce in un'integrazione creata con Destination SDK, consulta il diagramma nella documentazione delle opzioni di configurazione oppure vedi le seguenti pagine di panoramica sulla configurazione di destinazione:
È possibile configurare le specifiche del server di destinazione tramite l'endpoint /authoring/destination-servers
. Consulta le seguenti pagine di riferimento API per esempi dettagliati di chiamate API, in cui puoi configurare i componenti mostrati in questa pagina.
Questa pagina mostra tutti i tipi di server di destinazione supportati da Destination SDK, con tutti i relativi parametri di configurazione. Quando crei la destinazione, sostituisci i valori dei parametri con i tuoi.
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.
Quando crea o aggiorna un server di destinazione, utilizza una delle configurazioni del tipo di server descritte in questa pagina. A seconda dei requisiti di integrazione, assicurati di sostituire i valori dei parametri di esempio di questi esempi con i tuoi.
Campi hardcoded e template templatized-fields
Durante la creazione di un server di destinazione tramite Destination SDK, è possibile definire i valori dei parametri di configurazione codificandoli nella configurazione o utilizzando campi modello. I campi con modello consentono di leggere i valori forniti dall’utente dall’interfaccia utente di Platform.
I parametri del server di destinazione hanno due campi configurabili. Queste opzioni determinano se si utilizzano valori hardcoded o template.
templatingStrategy
Obbligatorio. Definisce se è presente un valore hardcoded fornito tramite il campo value
o un valore configurabile dall'utente nell'interfaccia utente. Valori supportati:
NONE
: utilizzare questo valore quando si codifica il valore del parametro tramite il parametrovalue
(vedere la riga successiva). Esempio:"value": "my-storage-bucket"
.PEBBLE_V1
: utilizzare questo valore quando si desidera che gli utenti forniscano un valore di parametro nell'interfaccia utente. Esempio:"value": "{{customerData.bucket}}"
.
value
Richiesto. Definisce il valore del parametro. Tipi di valore supportati:
- Valore hardcoded: utilizza un valore hard coded (ad esempio
"value": "my-storage-bucket"
) quando non è necessario che gli utenti immettano un valore di parametro nell'interfaccia utente. Quando si codifica un valore a livello di codice,templatingStrategy
deve essere sempre impostato suNONE
. - Valore con modello: utilizzare un valore con modello (ad esempio
"value": "{{customerData.bucket}}"
) quando si desidera che gli utenti forniscano un valore di parametro nell'interfaccia utente. Quando si utilizzano valori con modelli,templatingStrategy
deve essere sempre impostato suPEBBLE_V1
.
Quando utilizzare campi hardcoded e campi con modelli
Sia i campi hardcoded che i campi template hanno un proprio uso nella Destination SDK, a seconda del tipo di integrazione che si sta creando.
Connessione alla destinazione senza l'input dell'utente
Quando gli utenti si connettono alla destinazione nell'interfaccia utente di Platform, è possibile gestire il processo di connessione di destinazione senza l'input degli utenti.
A questo scopo, puoi codificare i parametri di connessione della piattaforma di destinazione nelle specifiche del server. Quando si utilizzano valori di parametri hardcoded nella configurazione del server di destinazione, la connessione tra Adobe Experience Platform e la piattaforma di destinazione viene gestita senza alcun input da parte dell’utente.
Nell'esempio seguente, un partner crea un server di destinazione Data Landing Zone con il campo path.value
codificato.
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"NONE",
"value":"Your/hardcoded/path/here"
},
"useCase": "Your use case"
}
}
Di conseguenza, quando gli utenti seguono l'esercitazione sulla connessione di destinazione, non visualizzeranno un passaggio di autenticazione. L’autenticazione viene invece gestita da Platform, come illustrato nell’immagine seguente.
Connessione alla destinazione con l'input dell'utente
Quando la connessione tra Platform e la destinazione deve essere stabilita in base a un input specifico dell’utente nell’interfaccia utente di Platform, ad esempio la selezione di un endpoint API o la fornitura di un valore di campo, puoi utilizzare i campi modello nelle specifiche del server per leggere l’input dell’utente e connettersi alla piattaforma di destinazione.
Nell'esempio seguente, un partner crea un'integrazione in tempo reale (streaming) e il campo url.value
utilizza il parametro {{customerData.region}}
modello per personalizzare parte dell'endpoint API in base all'input dell'utente.
{
"name":"Templatized API endpoint example",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.yourcompany.com/data/{{customerData.region}}/items"
}
}
}
Per consentire agli utenti di selezionare un valore dall'interfaccia utente di Platform, il parametro region
deve essere definito anche nella configurazione di destinazione come campo dati cliente, come illustrato di seguito:
"customerDataFields":[
{
"name":"region",
"title":"Region",
"description":"Select an option",
"type":"string",
"isRequired":true,
"readOnly":false,
"enum":[
"US",
"EU"
]
}
Di conseguenza, quando gli utenti seguono l'esercitazione sulla connessione di destinazione, devono selezionare un'area geografica prima di connettersi alla piattaforma di destinazione. Quando si connettono alla destinazione, il campo con modello {{customerData.region}}
viene sostituito con il valore selezionato dall'utente nell'interfaccia utente, come illustrato nell'immagine seguente.
Server di destinazione in tempo reale (streaming) streaming-example
Questo tipo di server di destinazione ti consente di esportare dati da Adobe Experience Platform alla destinazione tramite richieste HTTP. La configurazione del server contiene informazioni sul server che riceve i messaggi (il server sul lato dell’utente).
Questo processo distribuisce i dati utente come una serie di messaggi HTTP alla piattaforma di destinazione. I parametri seguenti costituiscono il modello delle specifiche del server HTTP.
L’esempio seguente mostra un esempio di configurazione del server di destinazione per una destinazione in tempo reale (streaming).
{
"name":"Your destination server name",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"{YOUR_API_ENDPOINT}"
}
}
}
name
Moviestar destination server
.destinationServerType
URL_BASED
per le destinazioni di streaming.templatingStrategy
Obbligatorio.
- Usa
PEBBLE_V1
se nel campovalue
utilizzi un campo con modello invece di un valore hardcoded. Utilizzare questa opzione se si dispone di un endpoint comehttps://api.moviestar.com/data/{{customerData.region}}/items
, in cui gli utenti devono selezionare l'area dell'endpoint dall'interfaccia utente di Platform. - Utilizzare
NONE
se non è necessaria alcuna trasformazione modellata sul lato Adobe, ad esempio se si dispone di un endpoint come:https://api.moviestar.com/data/items
value
Server di destinazione Amazon S3 s3-example
Questo server di destinazione ti consente di esportare i file contenenti dati di Adobe Experience Platform nell’archiviazione Amazon S3.
L’esempio seguente mostra un esempio di configurazione del server di destinazione per una destinazione Amazon S3.
{
"name":"Amazon S3 destination",
"destinationServerType":"FILE_BASED_S3",
"fileBasedS3Destination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
name
destinationServerType
FILE_BASED_S3
.fileBasedS3Destination.bucket.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo bucket.value
.
- Se desideri che gli utenti inseriscano il proprio nome di bucket nell'interfaccia utente Experience Platform, imposta questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campovalue
per leggere un valore dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione utilizzi un nome di bucket hardcoded, ad esempio
"bucket.value":"MyBucket"
, imposta questo valore suNONE
.
fileBasedS3Destination.bucket.value
"value":"MyBucket"
.fileBasedS3Destination.path.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo path.value
.
- Se desideri che gli utenti inseriscano il proprio percorso nell'interfaccia utente di Experience Platform, imposta questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campopath.value
per leggere un valore dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione si utilizza un percorso hardcoded, ad esempio
"bucket.value":"/path/to/MyBucket"
, impostare questo valore suNONE
.
fileBasedS3Destination.path.value
"value":"/path/to/MyBucket"
.Server di destinazione SFTP sftp-example
Questo server di destinazione consente di esportare file contenenti dati Adobe Experience Platform nel server di archiviazione SFTP.
L’esempio seguente mostra un esempio di configurazione del server di destinazione per una destinazione SFTP.
{
"name":"File-based SFTP destination server",
"destinationServerType":"FILE_BASED_SFTP",
"fileBasedSFTPDestination":{
"rootDirectory":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.rootDirectory}}"
},
"hostName":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.hostName}}"
},
"port":22,
"encryptionMode":"PGP"
}
}
name
destinationServerType
FILE_BASED_SFTP
.fileBasedSFTPDestination.rootDirectory.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo rootDirectory.value
.
- Se si desidera che gli utenti inseriscano il proprio percorso di directory principale nell'interfaccia utente di Experience Platform, impostare questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il camporootDirectory.value
per leggere un valore fornito dall'utente dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione si utilizza un percorso di directory principale hardcoded, ad esempio
"rootDirectory.value":"Storage/MyDirectory"
, impostare questo valore suNONE
.
fileBasedSFTPDestination.rootDirectory.value
"value":"Storage/MyDirectory"
fileBasedSFTPDestination.hostName.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo hostName.value
.
- Se desideri che gli utenti inseriscano il proprio nome host nell'interfaccia utente Experience Platform, imposta questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campohostName.value
per leggere un valore fornito dall'utente dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione si utilizza un nome host hardcoded, ad esempio
"hostName.value":"my.hostname.com"
, impostare questo valore suNONE
.
fileBasedSFTPDestination.hostName.value
"hostName.value":"my.hostname.com"
.port
encryptionMode
Indica se utilizzare la crittografia file. Valori supportati:
- PGP
- Nessuna
Server di destinazione Azure Data Lake Storage (ADLS) adls-example
Questo server di destinazione ti consente di esportare i file contenenti dati di Adobe Experience Platform nel tuo account Azure Data Lake Storage.
Nell'esempio seguente viene illustrato un esempio di configurazione del server di destinazione per una destinazione Azure Data Lake Storage.
{
"name":"ADLS destination server",
"destinationServerType":"FILE_BASED_ADLS_GEN2",
"fileBasedAdlsGen2Destination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
name
destinationServerType
FILE_BASED_ADLS_GEN2
.fileBasedAdlsGen2Destination.path.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo path.value
.
- Se desideri che gli utenti inseriscano il percorso della cartella ADLS nell'interfaccia utente di Experience Platform, imposta questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campopath.value
per leggere un valore dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione si utilizza un percorso hardcoded, ad esempio
"abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/"
, impostare questo valore suNONE
.
fileBasedAdlsGen2Destination.path.value
abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/
.Server di destinazione Azure Blob Storage blob-example
Questo server di destinazione consente di esportare i file contenenti dati di Adobe Experience Platform nel contenitore Azure Blob Storage.
Nell'esempio seguente viene illustrato un esempio di configurazione del server di destinazione per una destinazione Azure Blob Storage.
{
"name":"Blob destination server",
"destinationServerType":"FILE_BASED_AZURE_BLOB",
"fileBasedAzureBlobDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"container":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.container}}"
}
}
}
name
destinationServerType
FILE_BASED_AZURE_BLOB
.fileBasedAzureBlobDestination.path.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo path.value
.
- Se si desidera che gli utenti immettano il proprio Azure Blob URI dell'account di archiviazione nell'interfaccia utente di Experience Platform, impostare questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campopath.value
per leggere il valore dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione si utilizza un percorso hardcoded, ad esempio
"path.value": "https://myaccount.blob.core.windows.net/"
, impostare questo valore suNONE
.
fileBasedAzureBlobDestination.path.value
https://myaccount.blob.core.windows.net/
.fileBasedAzureBlobDestination.container.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo container.value
.
- Se desideri che gli utenti inseriscano il proprio Azure Blob nome contenitore nell'interfaccia utente di Experience Platform, imposta questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campocontainer.value
per leggere il valore dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione si utilizza un nome di contenitore hardcoded, ad esempio
"path.value: myContainer"
, impostare questo valore suNONE
.
fileBasedAzureBlobDestination.container.value
myContainer
.Server di destinazione Data Landing Zone (DLZ) dlz-example
Questo server di destinazione consente di esportare i file contenenti i dati di Platform in un archivio Data Landing Zone.
Nell'esempio seguente viene illustrato un esempio di configurazione del server di destinazione per una destinazione Data Landing Zone (DLZ).
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"useCase": "Your use case"
}
}
name
destinationServerType
FILE_BASED_DLZ
.fileBasedDlzDestination.path.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo path.value
.
- Se desideri che gli utenti inseriscano il proprio account Data Landing Zone nell'interfaccia utente di Experience Platform, imposta questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campopath.value
per leggere un valore dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione si utilizza un percorso hardcoded, ad esempio
"path.value": "https://myaccount.blob.core.windows.net/"
, impostare questo valore suNONE
.
fileBasedDlzDestination.path.value
Server di destinazione Google Cloud Storage gcs-example
Questo server di destinazione ti consente di esportare i file contenenti i dati di Platform nel tuo account Google Cloud Storage.
Nell'esempio seguente viene illustrato un esempio di configurazione del server di destinazione per una destinazione Google Cloud Storage.
{
"name":"Google Cloud Storage Server",
"destinationServerType":"FILE_BASED_GOOGLE_CLOUD",
"fileBasedGoogleCloudStorageDestination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
name
destinationServerType
FILE_BASED_GOOGLE_CLOUD
.fileBasedGoogleCloudStorageDestination.bucket.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo bucket.value
.
- Se desideri che gli utenti inseriscano il proprio nome di bucket Google Cloud Storage nell'interfaccia utente di Experience Platform, imposta questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campobucket.value
per leggere un valore dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione utilizzi un nome di bucket hardcoded, ad esempio
"bucket.value": "my-bucket"
, imposta questo valore suNONE
.
fileBasedGoogleCloudStorageDestination.bucket.value
"value": "my-bucket"
.fileBasedGoogleCloudStorageDestination.path.templatingStrategy
Richiesto. Impostare questo valore in base al tipo di valore utilizzato nel campo path.value
.
- Se desideri che gli utenti inseriscano il proprio percorso del bucket Google Cloud Storage nell'interfaccia utente di Experience Platform, imposta questo valore su
PEBBLE_V1
. In questo caso, è necessario formattare il campopath.value
per leggere un valore dai campi dati cliente compilati dall'utente. Questo caso d’uso è illustrato nell’esempio precedente. - Se per l'integrazione si utilizza un percorso hardcoded, ad esempio
"path.value": "/path/to/my-bucket"
, impostare questo valore suNONE
.
fileBasedGoogleCloudStorageDestination.path.value
"value": "/path/to/my-bucket"
.Passaggi successivi next-steps
Dopo aver letto questo articolo, è necessario comprendere meglio cosa è una specifica del server di destinazione e come configurarla.
Per ulteriori informazioni sugli altri componenti del server di destinazione, consulta i seguenti articoli: