Server specs voor bestemmingen die met Destination SDK worden gecreeerd
De serverspecificaties van de bestemming bepalen het type van bestemmingsplatform dat de gegevens van Adobe Experience Platform, en de communicatie parameters tussen Platform en uw bestemming zal ontvangen. Bijvoorbeeld:
- A streaming De specificatie van de bestemmingsserver bepaalt het de servereindpunt van HTTP dat de berichten van HTTP van Platform zal ontvangen. Leren om te vormen hoe de vraag van HTTP aan het eindpunt geformatteerd is, lees sjabloonspecificaties pagina.
- An Amazon S3 de specificatie van de doelserver bepaalt S3 De naam van de emmer en weg waar Platform de dossiers zal uitvoeren.
- An SFTP De specificaties van de bestemmingsserver bepalen de gastheernaam, de wortelfolder, de communicatie haven, en het encryptietype van de server SFTP waar Platform de dossiers zal uitvoeren.
Om te begrijpen waar deze component in een integratie past die met Destination SDK wordt gecreeerd, zie het diagram in configuratieopties documentatie of zie de volgende pagina's van het overzicht van bestemmingsconfiguratie:
U kunt de specificaties van de doelserver configureren via de /authoring/destination-servers eindpunt. Zie de volgende API verwijzingspagina's voor gedetailleerde API vraagvoorbeelden waar u de componenten kunt vormen die in deze pagina worden getoond.
Deze pagina toont alle types van bestemmingsserver die door Destination SDK, met al hun configuratieparameters worden gesteund. Vervang bij het maken van uw bestemming de parameterwaarden door uw eigen waarden.
Ondersteunde integratietypen supported-integration-types
Raadpleeg de onderstaande tabel voor meer informatie over de integratietypen die de op deze pagina beschreven functionaliteit ondersteunen.
Wanneer maken of bijwerken Als doelserver, gebruikt u een van de configuraties van het servertype die in deze pagina worden beschreven. Afhankelijk van uw integratievereisten, zorg ervoor om de waarden van de steekproefparameter van deze voorbeelden met uw te vervangen.
Velden met harde code en sjablonen templatized-fields
Wanneer het creëren van een bestemmingsserver door Destination SDK, kunt u configuratieparameterwaarden of door hard-coderen hen in de configuratie, of door templatized gebieden te gebruiken bepalen. Met sjabloonvelden kunt u door de gebruiker opgegeven waarden lezen vanuit de gebruikersinterface van het platform.
Doelserverparameters hebben twee configureerbare velden. Deze opties bepalen of u hard-gecodeerde of templatized waarden gebruikt.
templatingStrategyVereist. Hiermee wordt bepaald of er een waarde met harde code wordt opgegeven via het dialoogvenster value of een door de gebruiker instelbare waarde in de gebruikersinterface. Ondersteunde waarden:
NONE: Gebruik deze waarde wanneer u de parameterwaarde via devalueparameter (zie de volgende rij). Voorbeeld:"value": "my-storage-bucket".PEBBLE_V1: Gebruik deze waarde als u wilt dat de gebruikers een parameterwaarde opgeven in de gebruikersinterface. Voorbeeld:"value": "{{customerData.bucket}}".
valueVereist. Definieert de parameterwaarde. Ondersteunde waardetypen
- Waarde met harde code: Gebruik een hard-gecodeerde waarde (zoals
"value": "my-storage-bucket") wanneer u niet wilt dat gebruikers een parameterwaarde in de gebruikersinterface invoeren. Bij hard coderen van een waardetemplatingStrategymoet altijd worden ingesteld opNONE. - Sjabloonwaarde: Gebruik een getemplatificeerde waarde (zoals
"value": "{{customerData.bucket}}") als u wilt dat de gebruikers een parameterwaarde opgeven in de gebruikersinterface. Bij gebruik van getemplatificeerde waardentemplatingStrategymoet altijd worden ingesteld opPEBBLE_V1.
Wanneer moet u hard-gecodeerde en getemplatificeerde velden gebruiken?
Zowel hard-gecodeerde als templatized gebieden hebben hun eigen gebruik in Destination SDK, afhankelijk van welk type van integratie u creeert.
Verbinding maken met uw bestemming zonder gebruikersinvoer
Wanneer gebruikers verbinden met uw bestemming in Platform UI, zou u het proces van de bestemmingsverbinding zonder hun input kunnen willen behandelen.
Hiervoor kunt u de verbindingsparameters van het doelplatform hard coderen in de serverspecificatie. Wanneer u hard-gecodeerde parameterwaarden in uw configuratie van de bestemmingsserver gebruikt, wordt de verbinding tussen Adobe Experience Platform en uw bestemmingsplatform behandeld zonder enige input van de gebruiker.
In het voorbeeld hieronder, leidt een partner tot een Gegevens Landing Zone bestemmingsserver met path.value veld dat hardcoded is.
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"NONE",
"value":"Your/hardcoded/path/here"
},
"useCase": "Your use case"
}
}
Dit betekent dat wanneer gebruikers de zelfstudie over doelverbinding, zullen zij geen verificatiestap. In plaats daarvan, wordt de authentificatie behandeld door Platform, zoals aangetoond in het hieronder beeld.
Verbinding maken met uw bestemming met gebruikersinvoer
Wanneer de verbinding tussen Platform en uw bestemming na een specifieke gebruikersinput in het Platform UI zou moeten worden gevestigd, zoals het selecteren van een API eindpunt of het verstrekken van een gebiedswaarde, kunt u getemplatificeerde gebieden in de serverspecificatie gebruiken om de gebruikersinput te lezen en met uw bestemmingsplatform te verbinden.
In het onderstaande voorbeeld maakt een partner een real-time (streaming) integratie en de url.value veld gebruikt getemplatificeerde parameter {{customerData.region}} om een deel van het API eindpunt te personaliseren dat op gebruikersinput wordt gebaseerd.
{
"name":"Templatized API endpoint example",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.yourcompany.com/data/{{customerData.region}}/items"
}
}
}
Als u gebruikers de mogelijkheid wilt geven een waarde te selecteren in de interface van het platform, kunt u de region moet ook in de doelconfiguratie als gegevensveld voor klanten, zoals hieronder wordt getoond:
"customerDataFields":[
{
"name":"region",
"title":"Region",
"description":"Select an option",
"type":"string",
"isRequired":true,
"readOnly":false,
"enum":[
"US",
"EU"
]
}
Dit betekent dat wanneer gebruikers de zelfstudie over doelverbinding, moeten ze een gebied selecteren voordat ze verbinding kunnen maken met het doelplatform. Wanneer ze verbinding maken met het doel, wordt het sjabloonveld {{customerData.region}} wordt vervangen door de waarde die de gebruiker in de gebruikersinterface heeft geselecteerd, zoals wordt weergegeven in de onderstaande afbeelding.
Doelserver in realtime (streaming) streaming-example
Met dit type doelserver kunt u gegevens vanuit Adobe Experience Platform naar uw bestemming exporteren via HTTP-aanvragen. De serverconfiguratie bevat informatie over de server die de berichten ontvangt (de server aan uw kant).
Dit proces levert gebruikersgegevens als reeks berichten van HTTP aan uw bestemmingsplatform. De onderstaande parameters vormen de HTTP-serverspectsjabloon.
Het voorbeeld hieronder toont een voorbeeld van een configuratie van de bestemmingsserver voor een (het stromen) bestemming in real time.
{
"name":"Your destination server name",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"{YOUR_API_ENDPOINT}"
}
}
}
nameMoviestar destination server.destinationServerTypeURL_BASED voor streamingdoelen.templatingStrategyVereist.
- Gebruiken
PEBBLE_V1als u een sjabloonveld gebruikt in plaats van een hard gecodeerde waarde in het dialoogvenstervalueveld. Gebruik deze optie als u een eindpunt als:https://api.moviestar.com/data/{{customerData.region}}/items, waar de gebruikers het eindpuntgebied van het Platform UI moeten selecteren. - Gebruiken
NONEals er aan de zijde van de Adobe geen getemplatificeerde transformatie nodig is, bijvoorbeeld als u een eindpunt hebt, zoals:https://api.moviestar.com/data/items
valueAmazon S3 doelserver s3-example
Met deze doelserver kunt u bestanden met Adobe Experience Platform-gegevens exporteren naar uw Amazon S3-opslagruimte.
Het voorbeeld hieronder toont een voorbeeld van een configuratie van de bestemmingsserver voor een bestemming van 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}}"
}
}
}
namedestinationServerTypeFILE_BASED_S3.fileBasedS3Destination.bucket.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster bucket.value veld.
- Als u wilt dat uw gebruikers hun eigen emmernaam invoeren in de gebruikersinterface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtvalueeen waarde uit het veld klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerde emmernaam voor uw integratie gebruikt, zoals
"bucket.value":"MyBucket"Vervolgens stelt u deze waarde in opNONE.
fileBasedS3Destination.bucket.value"value":"MyBucket".fileBasedS3Destination.path.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster path.value veld.
- Als u wilt dat uw gebruikers hun eigen pad invoeren in de interface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtpath.valueeen waarde uit het veld klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerd weg voor uw integratie gebruikt, zoals
"bucket.value":"/path/to/MyBucket"Vervolgens stelt u deze waarde in opNONE.
fileBasedS3Destination.path.value"value":"/path/to/MyBucket".SFTP doelserver sftp-example
Met deze doelserver kunt u bestanden met Adobe Experience Platform-gegevens exporteren naar uw SFTP opslagserver.
Het voorbeeld hieronder toont een voorbeeld van een configuratie van de bestemmingsserver voor een bestemming 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"
}
}
namedestinationServerTypeFILE_BASED_SFTP.fileBasedSFTPDestination.rootDirectory.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster rootDirectory.value veld.
- Als u wilt dat uw gebruikers hun eigen hoofdmappad invoeren in de gebruikersinterface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtrootDirectory.valueveld voor het lezen van een door de gebruiker opgegeven waarde uit de klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerd weg van de wortelfolder voor uw integratie gebruikt, zoals
"rootDirectory.value":"Storage/MyDirectory"Vervolgens stelt u deze waarde in opNONE.
fileBasedSFTPDestination.rootDirectory.value"value":"Storage/MyDirectory"fileBasedSFTPDestination.hostName.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster hostName.value veld.
- Als u wilt dat uw gebruikers hun eigen hostnaam invoeren in de interface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachthostName.valueveld voor het lezen van een door de gebruiker opgegeven waarde uit de klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerde gastheernaam voor uw integratie gebruikt, zoals
"hostName.value":"my.hostname.com"Vervolgens stelt u deze waarde in opNONE.
fileBasedSFTPDestination.hostName.value"hostName.value":"my.hostname.com".portencryptionModeGeeft aan of bestandsversleuteling moet worden gebruikt. Ondersteunde waarden:
- PGP
- Geen
Azure Data Lake Storage (ADLS) doelserver adls-example
Met deze doelserver kunt u bestanden met Adobe Experience Platform-gegevens exporteren naar uw Azure Data Lake Storage account.
Het voorbeeld hieronder toont een voorbeeld van een configuratie van de bestemmingsserver voor een Azure Data Lake Storage bestemming.
{
"name":"ADLS destination server",
"destinationServerType":"FILE_BASED_ADLS_GEN2",
"fileBasedAdlsGen2Destination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
namedestinationServerTypeFILE_BASED_ADLS_GEN2.fileBasedAdlsGen2Destination.path.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster path.value veld.
- Als u wilt dat de gebruikers hun ADLS mappad in de gebruikersinterface van het Experience Platform, stel deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtpath.valueeen waarde uit het veld klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerd weg voor uw integratie gebruikt, zoals
"abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/"Vervolgens stelt u deze waarde in opNONE.
fileBasedAdlsGen2Destination.path.valueabfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/.Azure Blob Storage doelserver blob-example
Met deze doelserver kunt u bestanden met Adobe Experience Platform-gegevens exporteren naar uw Azure Blob Storage container.
Het voorbeeld hieronder toont een voorbeeld van een configuratie van de bestemmingsserver voor een Azure Blob Storage bestemming.
{
"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.fileBasedAzureBlobDestination.path.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster path.value veld.
- Als u wilt dat uw gebruikers hun eigen gegevens invoeren Azure Blob URI opslagaccount in de interface van het Experience Platform stelt u deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtpath.valuete lezen uit het veld klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerd weg voor uw integratie gebruikt, zoals
"path.value": "https://myaccount.blob.core.windows.net/"Vervolgens stelt u deze waarde in opNONE.
fileBasedAzureBlobDestination.path.valuehttps://myaccount.blob.core.windows.net/.fileBasedAzureBlobDestination.container.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster container.value veld.
- Als u wilt dat uw gebruikers hun eigen gegevens invoeren Azure Blob containernaam in de interface van het Experience Platform stelt u deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtcontainer.valuete lezen uit het veld klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerde containernaam voor uw integratie gebruikt, zoals
"path.value: myContainer"Vervolgens stelt u deze waarde in opNONE.
fileBasedAzureBlobDestination.container.valuemyContainer.Data Landing Zone (DLZ) doelserver dlz-example
Met deze doelserver kunt u bestanden met platformgegevens exporteren naar een Data Landing Zone opslag.
In het onderstaande voorbeeld ziet u een voorbeeld van een configuratie van een doelserver voor een Data Landing Zone (DLZ) bestemming.
{
"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.fileBasedDlzDestination.path.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster path.value veld.
- Als u wilt dat uw gebruikers hun eigen gegevens invoeren Data Landing Zone -account in de gebruikersinterface van het Experience Platform. Stel deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtpath.valueeen waarde uit het veld klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerd weg voor uw integratie gebruikt, zoals
"path.value": "https://myaccount.blob.core.windows.net/"Vervolgens stelt u deze waarde in opNONE.
fileBasedDlzDestination.path.valueGoogle Cloud Storage doelserver gcs-example
Met deze doelserver kunt u bestanden met platformgegevens exporteren naar uw Google Cloud Storage account.
In het onderstaande voorbeeld ziet u een voorbeeld van een configuratie van een doelserver voor een Google Cloud Storage bestemming.
{
"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.fileBasedGoogleCloudStorageDestination.bucket.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster bucket.value veld.
- Als u wilt dat uw gebruikers hun eigen gegevens invoeren Google Cloud Storage bucketnaam in de gebruikersinterface van het Experience Platform, stel deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtbucket.valueeen waarde uit het veld klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerde emmernaam voor uw integratie gebruikt, zoals
"bucket.value": "my-bucket"Vervolgens stelt u deze waarde in opNONE.
fileBasedGoogleCloudStorageDestination.bucket.value"value": "my-bucket".fileBasedGoogleCloudStorageDestination.path.templatingStrategyVereist. Stel deze waarde in op basis van het type waarde dat wordt gebruikt in het dialoogvenster path.value veld.
- Als u wilt dat uw gebruikers hun eigen gegevens invoeren Google Cloud Storage emmerpad in de interface van het Experience Platform, stel deze waarde in op
PEBBLE_V1. In dit geval moet u de opdrachtpath.valueeen waarde uit het veld klantgegevensvelden ingevuld door de gebruiker. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerd weg voor uw integratie gebruikt, zoals
"path.value": "/path/to/my-bucket"Vervolgens stelt u deze waarde in opNONE.
fileBasedGoogleCloudStorageDestination.path.value"value": "/path/to/my-bucket".Volgende stappen next-steps
Na het lezen van dit artikel, zou u een beter inzicht in moeten hebben wat een specificatie van de bestemmingsserver is, en hoe u het kunt vormen.
Raadpleeg de volgende artikelen voor meer informatie over de andere componenten van de doelserver: