På den här sidan beskrivs alla serverkonfigurationsalternativ för de filbaserade målservrarna och hur du ställer in olika filkonfigurationsalternativ för användare som exporterar filer från Experience Platform till målet.
Server- och filkonfigurationsspecifikationerna för filbaserade mål kan konfigureras i Adobe Experience Platform Destination SDK via /destination-servers
slutpunkt. Läs API-slutpunktsåtgärder för målserver för en fullständig lista över åtgärder som du kan utföra på slutpunkten.
Avsnitten nedan innehåller specifikationer för målservern som är specifika för varje batchmåltyp som stöds i Destinationen SDK.
I exemplet nedan visas en korrekt målserverkonfiguration för ett Amazon S3-mål.
{
"name": "S3 destination",
"destinationServerType": "FILE_BASED_S3",
"fileBasedS3Destination": {
"bucket": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.bucket}}"
},
"path": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.path}}"
}
},
"fileConfigurations": {
// See the file formatting configuration section further below on this page
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Namnet på målanslutningen. |
destinationServerType |
Sträng | Ange det här värdet enligt målplattformen. För Amazon S3, ange detta till FILE_BASED_S3 . |
fileBasedS3Destination.bucket.templatingStrategy |
Sträng | Obligatoriskt. Använd PEBBLE_V1 . |
fileBasedS3Destination.bucket.value |
Sträng | Namnet på Amazon S3 bucket som ska användas för detta mål. |
fileBasedS3Destination.path.templatingStrategy |
Sträng | Obligatoriskt. Använd PEBBLE_V1 . |
fileBasedS3Destination.path.value |
Sträng | Sökvägen till målmappen som ska vara värd för de exporterade filerna. |
fileConfigurations |
Objekt | Se filformatskonfiguration om du vill ha detaljerade förklaringar om det här avsnittet. |
I exemplet nedan visas en korrekt 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"
},
"fileConfigurations": {
// See the file formatting configuration section further below on this page
}
}
Parameter | Typ | Beskrivning |
---|---|---|
name |
Sträng | Namnet på målanslutningen. |
destinationServerType |
Sträng | Ange det här värdet enligt målplattformen. För SFTP mål, ange detta till FILE_BASED_SFTP . |
fileBasedSftpDestination.rootDirectory.templatingStrategy |
Sträng | Obligatoriskt. Använd PEBBLE_V1 . |
fileBasedSftpDestination.rootDirectory.value |
Sträng | Mållagringens rotkatalog. |
fileBasedSftpDestination.hostName.templatingStrategy |
Sträng | Obligatoriskt. Använd PEBBLE_V1 . |
fileBasedSftpDestination.hostName.value |
Sträng | Mållagringens värdnamn. |
port |
Heltal | SFTP-filserverporten. |
encryptionMode |
Sträng | Anger om filkryptering ska användas. Värden som stöds:
|
fileConfigurations |
Objekt | Se filformatskonfiguration om du vill ha detaljerade förklaringar om det här avsnittet. |
Exemplet nedan visar en korrekt 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}}"
}
},
"fileConfigurations": {
// See the file formatting configuration section further below on this page
}
}
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. Använd PEBBLE_V1 . |
fileBasedAdlsGen2Destination.path.value |
Sträng | Sökvägen till målmappen som ska vara värd för de exporterade filerna. |
fileConfigurations |
Objekt | Se filformatskonfiguration om du vill ha detaljerade förklaringar om det här avsnittet. |
Exemplet nedan visar en korrekt 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}}"
}
},
"fileConfigurations": {
// See the file formatting configuration section further below on this page
}
}
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. Använd PEBBLE_V1 . |
fileBasedAzureBlobDestination.path.value |
Sträng | Sökvägen till målmappen som ska vara värd för de exporterade filerna. |
fileBasedAzureBlobDestination.container.templatingStrategy |
Sträng | Obligatoriskt. Använd PEBBLE_V1 . |
fileBasedAzureBlobDestination.container.value |
Sträng | Namnet på Azure Blob Storage behållare som ska användas av det här målet. |
fileConfigurations |
Objekt | Se filformatskonfiguration om du vill ha detaljerade förklaringar om det här avsnittet. |
Exemplet nedan visar en korrekt målserverkonfiguration för en Data Landing Zone (DLZ).
{
"name":"DLZ destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"useCase": "Your use case"
},
"fileConfigurations": {
// See the file formatting configuration section further below on this page
}
}
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. Använd PEBBLE_V1 . |
fileBasedDlzDestination.path.value |
Sträng | Sökvägen till målmappen som ska vara värd för de exporterade filerna. |
fileConfigurations |
Objekt | Se filformatskonfiguration om du vill ha detaljerade förklaringar om det här avsnittet. |
Exemplet nedan visar en korrekt 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}}"
}
},
"fileConfigurations":{
// See the file formatting configuration section further below on this page
}
}
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. Använd PEBBLE_V1 . |
fileBasedGoogleCloudStorageDestination.bucket.value |
Sträng | Namnet på Google Cloud Storage bucket som ska användas för detta mål. |
fileBasedGoogleCloudStorageDestination.path.templatingStrategy |
Sträng | Obligatoriskt. Använd PEBBLE_V1 . |
fileBasedGoogleCloudStorageDestination.path.value |
Sträng | Sökvägen till målmappen som ska vara värd för de exporterade filerna. |
fileConfigurations |
Objekt | Se filformatskonfiguration om du vill ha detaljerade förklaringar om det här avsnittet. |
I det här avsnittet beskrivs filformateringsinställningarna för den exporterade CSV
filer. Du kan ändra flera egenskaper för de exporterade filerna så att de matchar kraven i filmottagningssystemet på din sida för att optimera läsningen och tolkningen av de filer som tas emot från Experience Platform.
CSV-alternativ stöds bara när CSV-filer exporteras. The fileConfigurations
-avsnittet är inte obligatoriskt när du konfigurerar en ny målserver. Om du inte skickar några värden i API-anropet för CSV-alternativen är standardvärdena från referenstabell längre ned kommer att användas.
templatingStrategy
ange till NONE
I konfigurationsexemplet nedan är alla CSV-alternativ fasta. Exportinställningarna som definieras i var och en av csvOptions
parametrar är slutgiltiga och användarna kan inte ändra dem.
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
},
"maxFileRowCount":5000000
}
templatingStrategy
ange till PEBBLE_V1
I konfigurationsexemplet nedan är inget av CSV-alternativen fast. The value
i var och en av csvOptions
parametrarna har konfigurerats i ett motsvarande kunddatafält via /destinations
slutpunkt (till exempel customerData.quote
för quote
filformateringsalternativ) och användare kan använda användargränssnittet i Experience Platform för att välja mellan de olika alternativ som du konfigurerar i motsvarande kunddatafält.
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'compression' and customerData.compression is not empty %}{{customerData.compression}}{% else %}NONE{% endif %}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"sep": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'delimiter' %}{{customerData.csvOptions.delimiter}}{% else %},{% endif %}"
},
"quote": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'quote' %}{{customerData.csvOptions.quote}}{% else %}\"{% endif %}"
},
"escape": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'escape' %}{{customerData.csvOptions.escape}}{% else %}\\{% endif %}"
},
"nullValue": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'nullValue' %}{{customerData.csvOptions.nullValue}}{% else %}null{% endif %}"
},
"emptyValue": {
"templatingStrategy": "PEBBLE_V1",
"value": "{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'emptyValue' %}{{customerData.csvOptions.emptyValue}}{% else %}{% endif %}"
}
}
}
CSV-filformateringsalternativen som beskrivs nedan beskrivs även i Apache Spark-guide för CSV-filer. Beskrivningarna nedan är hämtade från Apache Spark-guiden.
Nedan visas en fullständig referens över alla tillgängliga filformateringsalternativ i Destination SDK, tillsammans med utdataexempel för varje alternativ.
Fält | Obligatoriskt/valfritt | Beskrivning | Standardvärde | Exempel på utdata 1 | Exempel på utdata 2 |
---|---|---|---|---|---|
templatingStrategy |
Obligatoriskt | För varje filformateringsalternativ som du konfigurerar måste du lägga till parametern templatingStrategy , som kan ha två värden:
|
– | – | – |
compression.value |
Valfritt | Komprimeringskodek som ska användas när data sparas i en fil. Värden som stöds: none , bzip2 , gzip , lz4 och snappy . |
none |
– | – |
fileType.value |
Valfritt | Anger utdatafilens format. Värden som stöds: csv , parquet och json . |
csv |
– | – |
csvOptions.quote.value |
Valfritt | Endast för"fileType.value": "csv" . Anger ett enskilt tecken som används för att undvika citattecken där avgränsaren kan vara en del av värdet. |
null |
– | – |
csvOptions.quoteAll.value |
Valfritt | Endast för"fileType.value": "csv" . Anger om alla värden alltid ska omslutas av citattecken. Som standard är det bara escape-värden som innehåller ett citattecken. |
false |
quoteAll :false --> male,John,"TestLastName" |
quoteAll :true -->"male","John","TestLastName" |
csvOptions.delimiter.value |
Valfritt | Endast för"fileType.value": "csv" . Anger en avgränsare för varje fält och värde. Avgränsaren kan vara ett eller flera tecken. |
, |
delimiter :, —> comma-separated values" |
delimiter :\t —> tab-separated values |
csvOptions.escape.value |
Valfritt | Endast för"fileType.value": "csv" . Anger ett enskilt tecken som används för att undvika citattecken i ett redan citattecken. |
\ |
"escape" :"\\" —> male,John,"Test,\"LastName5" |
"escape" :"'" —> male,John,"Test,'''"LastName5" |
csvOptions.escapeQuotes.value |
Valfritt | Endast för"fileType.value": "csv" . Anger om värden som innehåller citattecken alltid ska omslutas av citattecken. Standard är att undvika alla värden som innehåller ett citattecken. |
true |
– | – |
csvOptions.header.value |
Valfritt | Endast för"fileType.value": "csv" . Anger om kolumnnamnen ska skrivas som den första raden i den exporterade filen. |
true |
– | – |
csvOptions.ignoreLeadingWhiteSpace.value |
Valfritt | Endast för"fileType.value": "csv" . Anger om inledande blanksteg ska trimmas från värden. |
true |
ignoreLeadingWhiteSpace :true —> "male","John","TestLastName" |
ignoreLeadingWhiteSpace :false –> " male","John","TestLastName" |
csvOptions.ignoreTrailingWhiteSpace.value |
Valfritt | Endast för"fileType.value": "csv" . Anger om efterföljande blanksteg ska trimmas från värden. |
true |
ignoreTrailingWhiteSpace :true —> "male","John","TestLastName" |
ignoreTrailingWhiteSpace :false —> "male ","John","TestLastName" |
csvOptions.nullValue.value |
Valfritt | Endast för"fileType.value": "csv" . Anger strängbeteckningen för ett null-värde. |
"" |
nullvalue :"" —> male,"",TestLastName |
nullvalue :"NULL" —> male,NULL,TestLastName |
csvOptions.dateFormat.value |
Valfritt | Endast för"fileType.value": "csv" . Anger datumformatet. |
yyyy-MM-dd |
dateFormat :yyyy-MM-dd —> male,TestLastName,John,2022-02-24 |
dateFormat :MM/dd/yyyy —> male,TestLastName,John,02/24/2022 |
csvOptions.timestampFormat.value |
Valfritt | Endast för"fileType.value": "csv" . Anger strängen som anger ett tidsstämpelformat. |
yyyy-MM-dd'T'HH:mm:ss[.SSS][XXX] |
– | – |
csvOptions.charToEscapeQuoteEscaping.value |
Valfritt | Endast för"fileType.value": "csv" . Ställer in ett enda tecken som används för att kringgå citattecknet. |
\ när escape- och citattecknen är olika. \0 när escape- och citattecknet är detsamma. |
– | – |
csvOptions.emptyValue.value |
Valfritt | Endast för"fileType.value": "csv" . Anger strängbeteckningen för ett tomt värde. |
"" |
"emptyValue":"" --> male,"",John |
"emptyValue":"empty" —> male,empty,John |