Målserverns specifikationer definierar vilken typ av målplattform som ska ta emot data från Adobe Experience Platform och kommunikationsparametrarna mellan plattformen och destinationen. Till exempel:
Mer information om var den här komponenten passar in i en integrering som skapas med Destination SDK finns i diagrammet i konfigurationsalternativ eller se följande sidor med översikt över målkonfigurationen:
Du kan konfigurera målserverns specifikationer via /authoring/destination-servers
slutpunkt. På följande API-referenssidor finns detaljerade API-anropsexempel där du kan konfigurera komponenterna som visas på den här sidan.
På den här sidan visas alla målservertyper som stöds av Destinationen SDK, med alla deras konfigurationsparametrar. Ersätt parametervärdena med dina egna när du skapar målet.
Alla parameternamn och värden som stöds av Destinationen SDK är skiftlägeskänslig. Undvik skiftlägeskänslighetsfel genom att använda parameternamn och värden exakt som de visas i dokumentationen.
Se tabellen nedan för mer ingående information om vilka typer av integreringar som stöder de funktioner som beskrivs på den här sidan.
Integrationstyp | Funktioner |
---|---|
Integrering i realtid (direktuppspelning) | Ja |
Filbaserade (batch) integreringar | Ja |
När skapa eller uppdatera en målserver använder du någon av de servertypskonfigurationer som beskrivs på den här sidan. Beroende på dina integrationskrav ska du se till att ersätta exempelparametervärdena från de här exemplen med dina egna.
När du skapar en målserver via Destination SDK kan du definiera parametervärden för konfiguration antingen genom att hårdkoda dem i konfigurationen eller genom att använda mallfält. I mallbaserade fält kan du läsa användardefinierade värden från plattformens användargränssnitt.
Målserverparametrar har två konfigurerbara fält. Dessa alternativ avgör om du använder hårdkodade eller mallsidiga värden.
Parameter | Typ | Beskrivning |
---|---|---|
templatingStrategy |
Sträng | Obligatoriskt. Definierar om det finns ett hårdkodat värde via value eller ett användarkonfigurerbart värde i användargränssnittet. Värden som stöds:
|
value |
Sträng | Obligatoriskt. Definierar parametervärdet. Värdetyper som stöds:
|
Både hårdkodade och mallbaserade fält har sina egna användningsområden i Destinationen SDK, beroende på vilken typ av integrering du skapar.
Ansluta till målet utan användarindata
När användare ansluta till ditt mål i plattformsgränssnittet kanske du vill hantera målanslutningsprocessen utan indata.
Det gör du genom att hårdkoda anslutningsparametrarna för målplattformen i serverspecifikationen. När du använder hårdkodade parametervärden i målserverkonfigurationen hanteras anslutningen mellan Adobe Experience Platform och målplattformen utan indata från användaren.
I exemplet nedan skapar en partner en Data Landing Zone-målserver med path.value
fält som hårdkodas.
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"NONE",
"value":"Your/hardcoded/path/here"
},
"useCase": "Your use case"
}
}
Detta resulterar i att när användare går igenom självstudiekurs om målanslutning, kommer de inte att se autentiseringssteg. Autentiseringen hanteras i stället av Platform, vilket visas i bilden nedan.
Ansluta till målet med användarindata
När anslutningen mellan plattformen och målet ska upprättas efter en viss användarinmatning i plattformsgränssnittet, till exempel val av en API-slutpunkt eller tillhandahållande av ett fältvärde, kan du använda mallfält i serverspecifikationen för att läsa användarinmatningen och ansluta till målplattformen.
I exemplet nedan skapar en partner en realtid (direktuppspelning) integrering och url.value
fältet använder den mallsidiga parametern {{customerData.region}}
för att anpassa en del av API-slutpunkten baserat på användarindata.
{
"name":"Templatized API endpoint example",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.yourcompany.com/data/{{customerData.region}}/items"
}
}
}
Om du vill att användarna ska kunna välja ett värde i användargränssnittet för plattformen väljer du region
-parametern måste också definieras i målkonfiguration som ett kunddatafält, vilket visas nedan:
"customerDataFields":[
{
"name":"region",
"title":"Region",
"description":"Select an option",
"type":"string",
"isRequired":true,
"readOnly":false,
"enum":[
"US",
"EU"
]
}
Detta resulterar i att när användare går igenom självstudiekurs om målanslutningmåste de välja en region innan de kan ansluta till målplattformen. När de ansluter till målet, det mallsidiga fältet {{customerData.region}}
ersätts med det värde som användaren har valt i användargränssnittet, vilket visas i bilden nedan.
Med den här målservertypen kan du exportera data från Adobe Experience Platform till målet via HTTP-begäranden. Serverkonfigurationen innehåller information om servern som tar emot meddelandena (servern på din sida).
Den här processen levererar användardata som en serie HTTP-meddelanden till målplattformen. Parametrarna nedan utgör mallen för specifikationer för HTTP-servern.
I exemplet nedan visas ett exempel på en målserverkonfiguration för ett mål för realtidsströmning.
{
"name":"Your destination server name",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"{YOUR_API_ENDPOINT}"
}
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Obligatoriskt. Representerar ett eget namn på servern som bara visas för Adobe. Detta namn är inte synligt för partners eller kunder. Exempel: Moviestar destination server . |
destinationServerType |
Sträng | Obligatoriskt. Ange detta till URL_BASED för direktuppspelningsmål. |
templatingStrategy |
Sträng | Obligatoriskt.
|
value |
Sträng | Obligatoriskt. Fyll i adressen till API-slutpunkten som Experience Platform ska ansluta till. |
Med den här målservern kan du exportera filer som innehåller Adobe Experience Platform-data till din Amazon S3-lagring.
Exemplet nedan visar ett exempel på en målserverkonfiguration för ett Amazon S3-mål.
{
"name":"Amazon S3 destination",
"destinationServerType":"FILE_BASED_S3",
"fileBasedS3Destination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Namnet på målservern. |
destinationServerType |
Sträng | Ange det här värdet enligt målplattformen. Exportera filer till en Amazon S3 bucket, ställ in det här på FILE_BASED_S3 . |
fileBasedS3Destination.bucket.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i bucket.value fält.
|
fileBasedS3Destination.bucket.value |
Sträng | Namnet på Amazon S3 bucket som ska användas för detta mål. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som "value":"MyBucket" . |
fileBasedS3Destination.path.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i path.value fält.
|
fileBasedS3Destination.path.value |
Sträng | Sökvägen till Amazon S3 bucket som ska användas för detta mål. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som "value":"/path/to/MyBucket" . |
Med den här målservern kan du exportera filer som innehåller Adobe Experience Platform-data till SFTP lagringsserver.
Exemplet nedan visar ett exempel på en målserverkonfiguration för ett SFTP-mål.
{
"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"
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Namnet på målservern. |
destinationServerType |
Sträng | Ange det här värdet enligt målplattformen. Exportera filer till en SFTP mål, ange detta till FILE_BASED_SFTP . |
fileBasedSFTPDestination.rootDirectory.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i rootDirectory.value fält.
|
fileBasedSFTPDestination.rootDirectory.value |
Sträng | Sökvägen till den katalog som ska vara värd för de exporterade filerna. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som "value":"Storage/MyDirectory" |
fileBasedSFTPDestination.hostName.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i hostName.value fält.
|
fileBasedSFTPDestination.hostName.value |
Sträng | Värdnamnet för SFTP-servern. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som "hostName.value":"my.hostname.com" . |
port |
Heltal | SFTP-filserverporten. |
encryptionMode |
Sträng | Anger om filkryptering ska användas. Värden som stöds:
|
Med den här målservern kan du exportera filer som innehåller Adobe Experience Platform-data till Azure Data Lake Storage konto.
Exemplet nedan visar ett exempel på en målserverkonfiguration för en Azure Data Lake Storage mål.
{
"name":"ADLS destination server",
"destinationServerType":"FILE_BASED_ADLS_GEN2",
"fileBasedAdlsGen2Destination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Namnet på målanslutningen. |
destinationServerType |
Sträng | Ange det här värdet enligt målplattformen. För Azure Data Lake Storage mål, ange detta till FILE_BASED_ADLS_GEN2 . |
fileBasedAdlsGen2Destination.path.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i path.value fält.
|
fileBasedAdlsGen2Destination.path.value |
Sträng | Vägen till ADLS lagringsmapp. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/ . |
Med den här målservern kan du exportera filer som innehåller Adobe Experience Platform-data till Azure Blob Storage behållare.
Exemplet nedan visar ett exempel på en målserverkonfiguration för en Azure Blob Storage mål.
{
"name":"Blob destination server",
"destinationServerType":"FILE_BASED_AZURE_BLOB",
"fileBasedAzureBlobDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"container":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.container}}"
}
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Namnet på målanslutningen. |
destinationServerType |
Sträng | Ange det här värdet enligt målplattformen. För Azure Blob Storage mål, ange detta till FILE_BASED_AZURE_BLOB . |
fileBasedAzureBlobDestination.path.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i path.value fält.
|
fileBasedAzureBlobDestination.path.value |
Sträng | Vägen till Azure Blob lagring. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som https://myaccount.blob.core.windows.net/ . |
fileBasedAzureBlobDestination.container.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i container.value fält.
|
fileBasedAzureBlobDestination.container.value |
Sträng | Namnet på Azure Blob Storage-behållaren som ska användas för det här målet. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som myContainer . |
Med den här målservern kan du exportera filer som innehåller plattformsdata till en Data Landing Zone lagring.
Exemplet nedan visar ett exempel på en målserverkonfiguration för en 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"
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Namnet på målanslutningen. |
destinationServerType |
Sträng | Ange det här värdet enligt målplattformen. För Data Landing Zone mål, ange detta till FILE_BASED_DLZ . |
fileBasedDlzDestination.path.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i path.value fält.
|
fileBasedDlzDestination.path.value |
Sträng | Sökvägen till målmappen som ska vara värd för de exporterade filerna. |
Med den här målservern kan du exportera filer som innehåller plattformsdata till Google Cloud Storage konto.
Exemplet nedan visar ett exempel på en målserverkonfiguration för en Google Cloud Storage mål.
{
"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}}"
}
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Namnet på målanslutningen. |
destinationServerType |
Sträng | Ange det här värdet enligt målplattformen. För Google Cloud Storage mål, ange detta till FILE_BASED_GOOGLE_CLOUD . |
fileBasedGoogleCloudStorageDestination.bucket.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i bucket.value fält.
|
fileBasedGoogleCloudStorageDestination.bucket.value |
Sträng | Namnet på Google Cloud Storage bucket som ska användas för detta mål. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som "value": "my-bucket" . |
fileBasedGoogleCloudStorageDestination.path.templatingStrategy |
Sträng | Obligatoriskt. Ange det här värdet enligt den typ av värde som används i path.value fält.
|
fileBasedGoogleCloudStorageDestination.path.value |
Sträng | Sökvägen till Google Cloud Storage mapp som ska användas av det här målet. Detta kan antingen vara ett mallbaserat fält som läser värdet från kunddatafält ifylld av användaren (som i exemplet ovan) eller ett hårdkodat värde, som "value": "/path/to/my-bucket" . |
När du har läst den här artikeln bör du få en bättre förståelse för vad en målserverspecifikation är och hur du kan konfigurera den.
Mer information om andra målserverkomponenter finns i följande artiklar: