Serverspecifikationer för mål som skapats med Destination SDK
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:
- En målserverspecifikation för direktuppspelning definierar HTTP-serverslutpunkten som tar emot HTTP-meddelanden från plattformen. Om du vill lära dig att konfigurera hur HTTP-anrop till slutpunkten formateras läser du sidan Mallating specs .
- En Amazon S3-målserverspecifikation definierar S3-bucket-namnet och sökvägen dit Platform ska exportera filerna.
- En SFTP-målserverspecifikation definierar värdnamnet, rotkatalogen, kommunikationsporten och krypteringstypen för SFTP-servern där plattformen ska exportera filerna.
Om du vill veta var den här komponenten passar in i en integrering som skapats med Destination SDK kan du läsa diagrammet i dokumentationen för konfigurationsalternativ eller följande sidor med en översikt över målkonfigurationen:
Du kan konfigurera målserverspecifikationerna via slutpunkten /authoring/destination-servers. 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.
Integrationstyper som stöds supported-integration-types
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.
När du skapar eller uppdaterar en målserver ska du använda 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.
Hårdkodade jämfört med mallsidesfält templatized-fields
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.
templatingStrategyKrävs. Definierar om det finns ett hårdkodat värde som tillhandahålls via fältet value eller ett användarkonfigurerbart värde i användargränssnittet. Värden som stöds:
NONE: Använd det här värdet när du hårdkodar parametervärdet via parameternvalue(se nästa rad). Exempel:"value": "my-storage-bucket".PEBBLE_V1: Använd det här värdet när du vill att användarna ska ange ett parametervärde i användargränssnittet. Exempel:"value": "{{customerData.bucket}}".
valueKrävs. Definierar parametervärdet. Värdetyper som stöds:
- Hårdkodat värde: Använd ett hårdkodat värde (till exempel
"value": "my-storage-bucket") om du inte behöver att användarna anger ett parametervärde i gränssnittet. När du hårdkodar ett värde skatemplatingStrategyalltid anges tillNONE. - Mallat värde: Använd ett mallbaserat värde (till exempel
"value": "{{customerData.bucket}}") när du vill att användarna ska ange ett parametervärde i användargränssnittet. När du använder mallsidiga värden skatemplatingStrategyalltid anges tillPEBBLE_V1.
När hårdkodade jämfört med mallsidesfält ska användas
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.
Ansluter till målet utan användarindata
När användare ansluter till ditt mål i plattformsgränssnittet kanske du vill hantera målanslutningsprocessen utan deras 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 fältet path.value 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"
}
}
Det innebär att användare som går igenom självstudiekursen för målanslutning inte kommer att se något autentiseringssteg. Autentiseringen hanteras i stället av Platform, vilket visas i bilden nedan.
Ansluter 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 realtidsintegrering (direktuppspelning) och fältet url.value använder den mallatiserade 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 från plattformsgränssnittet måste parametern region också definieras i målkonfigurationen 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 innebär att användare som går igenom självstudiekursen för målanslutning måste välja en region innan de kan ansluta till målplattformen. När de ansluter till målet ersätts det mallbaserade fältet {{customerData.region}} med det värde som användaren har valt i användargränssnittet, vilket visas i bilden nedan.
Målserver för realtid (direktuppspelning) streaming-example
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}"
}
}
}
nameMoviestar destination server.destinationServerTypeURL_BASED för direktuppspelningsmål.templatingStrategyKrävs.
- Använd
PEBBLE_V1om du använder ett mallbaserat fält i stället för ett hårdkodat värde i fältetvalue. Använd det här alternativet om du har en slutpunkt somhttps://api.moviestar.com/data/{{customerData.region}}/items, där användarna måste välja slutpunktsområdet i plattformsgränssnittet. - Använd
NONEom ingen mallad omvandling behövs på Adobe, till exempel om du har en slutpunkt som:https://api.moviestar.com/data/items
valueAmazon S3 målserver s3-example
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}}"
}
}
}
namedestinationServerTypeFILE_BASED_S3.fileBasedS3Destination.bucket.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet bucket.value.
- Om du vill att dina användare ska ange sina egna bucket-namn i användargränssnittet för Experience Platform, anger du det här värdet som
PEBBLE_V1. I det här fallet måste du mallatisera fältetvalueför att läsa ett värde från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder ett hårdkodat pytsnamn för integreringen, till exempel
"bucket.value":"MyBucket", ska du ange det här värdet somNONE.
fileBasedS3Destination.bucket.value"value":"MyBucket".fileBasedS3Destination.path.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet path.value.
- Om du vill att dina användare ska ange sin egen sökväg i användargränssnittet för Experience Platform anger du värdet
PEBBLE_V1. I det här fallet måste du mallatisera fältetpath.valueför att läsa ett värde från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder en hårdkodad sökväg för din integrering, till exempel
"bucket.value":"/path/to/MyBucket", anger du det här värdet tillNONE.
fileBasedS3Destination.path.value"value":"/path/to/MyBucket".SFTP målserver sftp-example
Med den här målservern kan du exportera filer som innehåller Adobe Experience Platform-data till lagringsservern SFTP.
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"
}
}
namedestinationServerTypeFILE_BASED_SFTP.fileBasedSFTPDestination.rootDirectory.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet rootDirectory.value.
- Om du vill att dina användare ska ange sin egen rotkatalogsökväg i användargränssnittet för Experience Platform anger du det här värdet till
PEBBLE_V1. I det här fallet måste du mallatisera fältetrootDirectory.valueför att läsa ett användartillhandahållet värde från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder en hårdkodad rotkatalogsökväg för din integrering, till exempel
"rootDirectory.value":"Storage/MyDirectory", anger du det här värdet tillNONE.
fileBasedSFTPDestination.rootDirectory.value"value":"Storage/MyDirectory"fileBasedSFTPDestination.hostName.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet hostName.value.
- Om du vill att dina användare ska ange sitt eget värdnamn i användargränssnittet för Experience Platform anger du det här värdet till
PEBBLE_V1. I det här fallet måste du mallatisera fältethostName.valueför att läsa ett användartillhandahållet värde från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder ett hårdkodat värdnamn för din integrering, till exempel
"hostName.value":"my.hostname.com", anger du det här värdet tillNONE.
fileBasedSFTPDestination.hostName.value"hostName.value":"my.hostname.com".portencryptionModeAnger om filkryptering ska användas. Värden som stöds:
- PGP
- Ingen
Azure Data Lake Storage (ADLS) målserver adls-example
Med den här målservern kan du exportera filer som innehåller Adobe Experience Platform-data till ditt Azure Data Lake Storage-konto.
Exemplet nedan visar ett exempel på en målserverkonfiguration för ett Azure Data Lake Storage-mål.
{
"name":"ADLS destination server",
"destinationServerType":"FILE_BASED_ADLS_GEN2",
"fileBasedAdlsGen2Destination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
namedestinationServerTypeFILE_BASED_ADLS_GEN2 för Azure Data Lake Storage mål.fileBasedAdlsGen2Destination.path.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet path.value.
- Om du vill att dina användare ska ange sin ADLS-mappsökväg i användargränssnittet för Experience Platform anger du det här värdet till
PEBBLE_V1. I det här fallet måste du mallatisera fältetpath.valueför att läsa ett värde från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder en hårdkodad sökväg för din integrering, till exempel
"abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/", anger du det här värdet tillNONE.
fileBasedAdlsGen2Destination.path.valueabfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/.Azure Blob Storage målserver blob-example
Med den här målservern kan du exportera filer som innehåller Adobe Experience Platform-data till Azure Blob Storage-behållaren.
Exemplet nedan visar ett exempel på en målserverkonfiguration för ett 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}}"
}
}
}
namedestinationServerTypeFILE_BASED_AZURE_BLOB för Azure Blob Storage mål.fileBasedAzureBlobDestination.path.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet path.value.
- Om du vill att dina användare ska ange sina egna Azure Blob lagringskontos-URI i användargränssnittet för Experience Platform anger du det här värdet till
PEBBLE_V1. I det här fallet måste du mallatisera fältetpath.valueför att kunna läsa värdet från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder en hårdkodad sökväg för din integrering, till exempel
"path.value": "https://myaccount.blob.core.windows.net/", anger du det här värdet tillNONE.
fileBasedAzureBlobDestination.path.valuehttps://myaccount.blob.core.windows.net/.fileBasedAzureBlobDestination.container.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet container.value.
- Om du vill att dina användare ska ange sitt eget Azure Blob behållarnamn i användargränssnittet för Experience Platform anger du det här värdet till
PEBBLE_V1. I det här fallet måste du mallatisera fältetcontainer.valueför att kunna läsa värdet från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder ett hårdkodat behållarnamn för integreringen, till exempel
"path.value: myContainer", anger du det här värdet tillNONE.
fileBasedAzureBlobDestination.container.valuemyContainer.Data Landing Zone (DLZ) målserver dlz-example
Med den här målservern kan du exportera filer som innehåller plattformsdata till ett Data Landing Zone-lagringsutrymme.
Exemplet nedan visar ett exempel på en målserverkonfiguration för ett Data Landing Zone (DLZ)-mål.
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"useCase": "Your use case"
}
}
namedestinationServerTypeFILE_BASED_DLZ för Data Landing Zone mål.fileBasedDlzDestination.path.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet path.value.
- Om du vill att dina användare ska ange sitt eget Data Landing Zone-konto i användargränssnittet för Experience Platform anger du det här värdet till
PEBBLE_V1. I det här fallet måste du mallatisera fältetpath.valueför att läsa ett värde från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder en hårdkodad sökväg för din integrering, till exempel
"path.value": "https://myaccount.blob.core.windows.net/", anger du det här värdet tillNONE.
fileBasedDlzDestination.path.valueGoogle Cloud Storage målserver gcs-example
Med den här målservern kan du exportera filer som innehåller plattformsdata till ditt Google Cloud Storage-konto.
Exemplet nedan visar ett exempel på en målserverkonfiguration för ett 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}}"
}
}
}
namedestinationServerTypeFILE_BASED_GOOGLE_CLOUD för Google Cloud Storage mål.fileBasedGoogleCloudStorageDestination.bucket.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet bucket.value.
- Om du vill att dina användare ska ange sina egna Google Cloud Storage-bucket-namn i användargränssnittet för Experience Platform anger du det här värdet till
PEBBLE_V1. I det här fallet måste du mallatisera fältetbucket.valueför att läsa ett värde från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder ett hårdkodat pytsnamn för integreringen, till exempel
"bucket.value": "my-bucket", ska du ange det här värdet somNONE.
fileBasedGoogleCloudStorageDestination.bucket.value"value": "my-bucket".fileBasedGoogleCloudStorageDestination.path.templatingStrategyKrävs. Ange det här värdet enligt den typ av värde som används i fältet path.value.
- Om du vill att dina användare ska ange sin egen Google Cloud Storage-bucket-sökväg i användargränssnittet för Experience Platform anger du det här värdet till
PEBBLE_V1. I det här fallet måste du mallatisera fältetpath.valueför att läsa ett värde från kunddatafälten som fyllts i av användaren. Det här användningsexemplet visas i exemplet ovan. - Om du använder en hårdkodad sökväg för din integrering, till exempel
"path.value": "/path/to/my-bucket", anger du det här värdet tillNONE.
fileBasedGoogleCloudStorageDestination.path.value"value": "/path/to/my-bucket".Nästa steg next-steps
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: