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 het stromenspecificatie 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 wordt geformatteerd, lees de het templating specspagina.
- Een Amazon S3specificatie van de bestemmingsserver bepaalt de S3 emmernaam en weg waar het Platform de dossiers zal uitvoeren.
- Een SFTPspecificatie van de bestemmingsserver bepaalt de gastheernaam, wortelfolder, communicatie haven, en encryptietype van de server SFTP waar het 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 de documentatie van configuratieoptiesof zie de volgende pagina's van het overzicht van bestemmingsconfiguratie:
U kunt de specificaties van de bestemmingsserver via het /authoring/destination-servers
eindpunt vormen. 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 creërendof het bijwerkeneen bestemmingsserver, gebruik één 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.
templatingStrategy
Vereist. Bepaalt of er een hard-gecodeerde waarde via het value
gebied, of een user-configurable waarde in UI wordt verstrekt. Ondersteunde waarden:
NONE
: gebruik deze waarde wanneer u de parameterwaarde via de parametervalue
hard codeert (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}}"
.
value
Vereiste. Definieert de parameterwaarde. Ondersteunde waardetypen
- hard-gecodeerde waarde: Gebruik een hard-gecodeerde waarde (zoals
"value": "my-storage-bucket"
) wanneer u geen gebruikers nodig hebt om een parameterwaarde in UI in te gaan. Wanneer een waarde hard wordt gecodeerd, moettemplatingStrategy
altijd worden ingesteld opNONE
. - Getemplates waarde: Gebruik een getemplatificeerde waarde (zoals
"value": "{{customerData.bucket}}"
) wanneer u uw gebruikers een parameterwaarde in UI wilt verstrekken. Wanneer u getemplatificeerde waarden gebruikt, moettemplatingStrategy
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.
het Verbinden met uw bestemming zonder gebruikersinput
Wanneer de gebruikers met uw bestemmingin Platform UI verbinden, 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 onderstaande voorbeeld maakt een partner een doelserver voor de landingszone van gegevens en het veld path.value
wordt gecodeerd.
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"NONE",
"value":"Your/hardcoded/path/here"
},
"useCase": "Your use case"
}
}
Dientengevolge, wanneer de gebruikers door het leerprogramma van de bestemmingsverbindinggaan, zullen zij geen authentificatiestapzien. In plaats daarvan, wordt de authentificatie behandeld door Platform, zoals aangetoond in het hieronder beeld.
Verbindend met uw bestemming met gebruikersinput
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 voorbeeld hieronder, leidt een partner tot a real time (het stromen)integratie en het url.value
gebied gebruikt de 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"
}
}
}
Om gebruikers de optie te geven om een waarde van het Platform UI te selecteren, moet de region
parameter ook in de bestemmingsconfiguratieals gebied van klantengegevens worden bepaald, zoals hieronder getoond:
"customerDataFields":[
{
"name":"region",
"title":"Region",
"description":"Select an option",
"type":"string",
"isRequired":true,
"readOnly":false,
"enum":[
"US",
"EU"
]
}
Dientengevolge, wanneer de gebruikers door het leerprogramma van de bestemmingsverbindinggaan, moeten zij een gebied selecteren alvorens zij met het bestemmingsplatform kunnen verbinden. Wanneer de gebruiker verbinding maakt met het doel, wordt het sjabloonveld {{customerData.region}}
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}"
}
}
}
name
Moviestar destination server
.destinationServerType
URL_BASED
voor streamingdoelen.templatingStrategy
Vereist.
- Gebruik
PEBBLE_V1
als u in het veldvalue
een getemplativeerd veld gebruikt in plaats van een hard gecodeerde waarde. Gebruik deze optie als u een eindpunt zoals:https://api.moviestar.com/data/{{customerData.region}}/items
hebt, waar de gebruikers het eindpuntgebied van Platform UI moeten selecteren. - Gebruik
NONE
als 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
value
Amazon 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}}"
}
}
}
name
destinationServerType
FILE_BASED_S3
.fileBasedS3Destination.bucket.templatingStrategy
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld bucket.value
wordt gebruikt.
- Stel deze waarde in op
PEBBLE_V1
als u wilt dat uw gebruikers hun eigen emmernaam invoeren in de interface van het Experience Platform. In dit geval, moet u hetvalue
gebied templatiseren om een waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden gevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerde emmernaam voor uw integratie, zoals
"bucket.value":"MyBucket"
gebruikt, dan plaats deze waarde aanNONE
.
fileBasedS3Destination.bucket.value
"value":"MyBucket"
.fileBasedS3Destination.path.templatingStrategy
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld path.value
wordt gebruikt.
- Als u wilt dat uw gebruikers hun eigen pad invoeren in de gebruikersinterface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1
. In dit geval, moet u hetpath.value
gebied templatiseren om een waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden gevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een pad met harde codes gebruikt voor uw integratie, zoals
"bucket.value":"/path/to/MyBucket"
, 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"
}
}
name
destinationServerType
FILE_BASED_SFTP
.fileBasedSFTPDestination.rootDirectory.templatingStrategy
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld rootDirectory.value
wordt gebruikt.
- Als u wilt dat uw gebruikers hun eigen pad naar de hoofdmap invoeren in de gebruikersinterface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1
. In dit geval, moet u hetrootDirectory.value
gebied templatiseren om een user-provided waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden ingevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een pad naar de hoofdmap met harde codes gebruikt voor uw integratie, zoals
"rootDirectory.value":"Storage/MyDirectory"
, stelt u deze waarde in opNONE
.
fileBasedSFTPDestination.rootDirectory.value
"value":"Storage/MyDirectory"
fileBasedSFTPDestination.hostName.templatingStrategy
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld hostName.value
wordt gebruikt.
- Als u wilt dat uw gebruikers hun eigen hostnaam invoeren in de gebruikersinterface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1
. In dit geval, moet u hethostName.value
gebied templatiseren om een user-provided waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden ingevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerde gastheernaam voor uw integratie, zoals
"hostName.value":"my.hostname.com"
gebruikt, dan plaats deze waarde aanNONE
.
fileBasedSFTPDestination.hostName.value
"hostName.value":"my.hostname.com"
.port
encryptionMode
Geeft 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.
In het onderstaande voorbeeld ziet u een voorbeeld van een doelserverconfiguratie voor een Azure Data Lake Storage -doel.
{
"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
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld path.value
wordt gebruikt.
- Stel deze waarde in op
PEBBLE_V1
als u wilt dat uw gebruikers het pad naar de ADLS -map invoeren in de gebruikersinterface van het Experience Platform. In dit geval, moet u hetpath.value
gebied templatiseren om een waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden gevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een pad met harde codes gebruikt voor uw integratie, zoals
"abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/"
, stelt u deze waarde in opNONE
.
fileBasedAdlsGen2Destination.path.value
abfs://<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.
In het onderstaande voorbeeld ziet u een voorbeeld van een doelserverconfiguratie voor een Azure Blob Storage -doel.
{
"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
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld path.value
wordt gebruikt.
- Als u uw gebruikers hun eigen Azure Blob opslagrekening URIin het Experience Platform UI wilt invoeren, plaats deze waarde aan
PEBBLE_V1
. In dit geval, moet u hetpath.value
gebied templatiseren om de waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden gevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een pad met harde codes gebruikt voor uw integratie, zoals
"path.value": "https://myaccount.blob.core.windows.net/"
, stelt u deze waarde in opNONE
.
fileBasedAzureBlobDestination.path.value
https://myaccount.blob.core.windows.net/
.fileBasedAzureBlobDestination.container.templatingStrategy
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld container.value
wordt gebruikt.
- Als u uw gebruikers hun eigen Azure Blob containernaamin het Experience Platform UI wilt invoeren, plaats deze waarde aan
PEBBLE_V1
. In dit geval, moet u hetcontainer.value
gebied templatiseren om de waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden gevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerde containernaam voor uw integratie gebruikt, zoals
"path.value: myContainer"
, dan plaats deze waarde aanNONE
.
fileBasedAzureBlobDestination.container.value
myContainer
.Data Landing Zone (DLZ) doelserver dlz-example
Met deze doelserver kunt u bestanden met platformgegevens exporteren naar een Data Landing Zone -opslag.
Het voorbeeld hieronder toont een voorbeeld van een configuratie van de bestemmingsserver 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"
}
}
name
destinationServerType
FILE_BASED_DLZ
.fileBasedDlzDestination.path.templatingStrategy
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld path.value
wordt gebruikt.
- Als u wilt dat uw gebruikers hun eigen Data Landing Zone -account invoeren in de gebruikersinterface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1
. In dit geval, moet u hetpath.value
gebied templatiseren om een waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden gevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een pad met harde codes gebruikt voor uw integratie, zoals
"path.value": "https://myaccount.blob.core.windows.net/"
, stelt u deze waarde in opNONE
.
fileBasedDlzDestination.path.value
Google 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 doelserverconfiguratie voor een Google Cloud Storage -doel.
{
"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
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld bucket.value
wordt gebruikt.
- Stel deze waarde in op
PEBBLE_V1
als u wilt dat uw gebruikers hun eigen Google Cloud Storage emmernaam invoeren in de interface van het Experience Platform. In dit geval, moet u hetbucket.value
gebied templatiseren om een waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden gevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een hard-gecodeerde emmernaam voor uw integratie, zoals
"bucket.value": "my-bucket"
gebruikt, dan plaats deze waarde aanNONE
.
fileBasedGoogleCloudStorageDestination.bucket.value
"value": "my-bucket"
.fileBasedGoogleCloudStorageDestination.path.templatingStrategy
Vereiste. Stel deze waarde in op basis van het type waarde dat in het veld path.value
wordt gebruikt.
- Als u wilt dat uw gebruikers hun eigen Google Cloud Storage emmerpad invoeren in de gebruikersinterface van het Experience Platform, stelt u deze waarde in op
PEBBLE_V1
. In dit geval, moet u hetpath.value
gebied templatiseren om een waarde van de gebieden van klantengegevenste lezen die door de gebruiker worden gevuld. Dit gebruiksgeval wordt in het bovenstaande voorbeeld getoond. - Als u een pad met harde codes gebruikt voor uw integratie, zoals
"path.value": "/path/to/my-bucket"
, 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: