Skapa en målserverkonfiguration
Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
Att skapa en målserver är det första steget när du ska skapa ett eget mål med Destination SDK. Målservern innehåller konfigurationsalternativ för server och mallsätta specifikationer, meddelandeformatoch filformatering alternativ (för filbaserade mål).
Den här sidan innehåller exempel på API-begäran och nyttolast som du kan använda för att skapa en egen målserver med hjälp av /authoring/destination-servers
API-slutpunkt.
En detaljerad beskrivning av de funktioner som du kan konfigurera via den här slutpunkten finns i följande artiklar:
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.
Komma igång med API-åtgärder för målserver get-started
Innan du fortsätter bör du granska komma igång-guide för viktig information som du behöver känna till för att kunna anropa API:t, inklusive hur du får nödvändig behörighet för målredigering och obligatoriska huvuden.
Skapa en målserverkonfiguration create
Du kan skapa en ny målserverkonfiguration genom att skapa en POST
begäran till /authoring/destination-servers
slutpunkt.
API-slutpunkt: platform.adobe.io/data/core/activation/authoring/destination-servers
API-format
POST /authoring/destination-servers
Beroende på vilken måltyp du skapar måste du konfigurera en något annorlunda typ av målserver.
Skapa statiska målservrar för schema static-destination-servers
Se exempel på målservrar för destinationer som använder i flikarna nedan statiska scheman.
Exempelnyttolasterna nedan innehåller alla parametrar som stöds av varje målservertyp. Du behöver inte inkludera alla parametrar i din begäran. Nyttolasten kan anpassas efter dina behov.
Välj varje flik nedan för att visa motsvarande API-begäranden.
Realtid (direktuppspelning)
Skapa en målserver för realtid (direktuppspelning)
Du måste skapa en målserver för realtid (direktuppspelning) som liknar den som visas nedan när du konfigurerar en API-baserad integrering för realtid (direktuppspelning).
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"httpMethod":"POST",
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{ \"attributes\": [ {% for ns in [\"external_id\", \"yourdestination_id\"] %} {% if input.profile.identityMap[ns] is not empty and first_namespace_encountered %} , {% endif %} {% set first_namespace_encountered = true %} {% for identity in input.profile.identityMap[ns]%} { \"{{ ns }}\": \"{{ identity.id }}\" {% if input.profile.segmentMembership.ups is not empty %} , \"AEPSegments\": { \"add\": [ {% for segment in input.profile.segmentMembership.ups %} {% if segment.value.status == \"realized\" or segment.value.status == \"existing\" %} {% if added_segment_found %} , {% endif %} {% set added_segment_found = true %} \"{{ destination.segmentAliases[segment.key] }}\" {% endif %} {% endfor %} ], \"remove\": [ {% for segment in input.profile.segmentMembership.ups %} {% if segment.value.status == \"exited\" %} {% if removed_segment_found %} , {% endif %} {% set removed_segment_found = true %} \"{{ destination.segmentAliases[segment.key] }}\" {% endif %} {% endfor %} ] } {% set removed_segment_found = false %} {% set added_segment_found = false %} {% endif %} {% if input.profile.attributes is not empty %} , {% endif %} {% for attribute in input.profile.attributes %} \"{{ attribute.key }}\": {% if attribute.value is empty %} null {% else %} \"{{ attribute.value.value }}\" {% endif %} {% if not loop.last%} , {% endif %} {% endfor %} } {% if not loop.last %} , {% endif %} {% endfor %} {% endfor %} ] }"
},
"contentType":"application/json"
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 layout-auto |
|
|
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 till URL_BASED för mål för realtidsströmning. |
urlBasedDestination.url.templatingStrategy |
Sträng |
Obligatoriskt.
- Använd
PEBBLE_V1 om Adobe behöver omvandla URL:en i value fält nedan. Använd det här alternativet om du har en slutpunkt som https://api.moviestar.com/data/{{customerData.region}}/items , där region kan skilja sig mellan kunderna. I det här fallet måste du även konfigurera region som kunddatafält i [destinationskonfiguration] (…/destination-configuration/create-destination-configuration.md.
- Använd
NONE om ingen omformning behövs på Adobe-sidan, till exempel om du har en slutpunkt som: https://api.moviestar.com/data/items .
|
urlBasedDestination.url.value |
Sträng |
Obligatoriskt. Fyll i adressen till API-slutpunkten som Experience Platform ska ansluta till. |
httpTemplate.httpMethod |
Sträng |
Obligatoriskt. Den metod som Adobe ska använda i anrop till servern. Alternativen är GET , PUT , POST , DELETE , PATCH . |
httpTemplate.requestBody.templatingStrategy |
Sträng |
Obligatoriskt. Använd PEBBLE_V1 . |
httpTemplate.requestBody.value |
Sträng |
Obligatoriskt. Den här strängen är den teckenescape-konverterade version som transformerar data för plattformskunder till det format som tjänsten förväntar sig.
|
httpTemplate.contentType |
Sträng |
Obligatoriskt. Den innehållstyp som servern accepterar. Detta värde är mest sannolikt application/json . |
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
Amazon S3
Skapa en Amazon S3-målserver
Du måste skapa en Amazon S3 målserver som liknar den som visas nedan när du konfigurerar en filbaserad Amazon S3 mål.
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name": "S3 destination",
"destinationServerType": "FILE_BASED_S3",
"fileBasedS3Destination": {
"bucket": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.bucket}}"
},
"path": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.path}}"
}
},
"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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 layout-auto |
|
|
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, ställ in det här på 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 |
Ej tillämpligt |
Se filformatskonfiguration för detaljerad information om hur du konfigurerar de här inställningarna. |
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
SFTP
Skapa en SFTP målserver
Du måste skapa en SFTP målserver som liknar den som visas nedan när du konfigurerar en filbaserad SFTP mål.
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name":"File-based SFTP destination server",
"destinationServerType":"FILE_BASED_SFTP",
"fileBasedSFTPDestination":{
"rootDirectory":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.rootDirectory}}"
},
"port": 22,
"encryptionMode" : "PGP"
},
"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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 layout-auto |
|
|
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 |
Ej tillämpligt |
Se filformatskonfiguration för detaljerad information om hur du konfigurerar de här inställningarna. |
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
Azure Data Lake-lagring
Skapa en Azure Data Lake Storage målserver
Du måste skapa en Azure Data Lake Storage målserver som liknar den som visas nedan när du konfigurerar en filbaserad Azure Data Lake Storage mål.
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name":"ADLS destination server",
"destinationServerType":"FILE_BASED_ADLS_GEN2",
"fileBasedAdlsGen2Destination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
},
"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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 layout-auto |
|
|
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 |
Ej tillämpligt |
Se filformatskonfiguration för detaljerad information om hur du konfigurerar de här inställningarna. |
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
Azure Blob Storage
Skapa en Azure Blob Storage målserver
Du måste skapa en Azure Blob Storage målserver som liknar den som visas nedan när du konfigurerar en filbaserad Azure Blob Storage mål.
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"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": {
"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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 layout-auto |
|
|
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 |
Ej tillämpligt |
Se filformatskonfiguration för detaljerad information om hur du konfigurerar de här inställningarna. |
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
DLZ (Data Landing Zone)
Skapa en Data Landing Zone (DLZ) målserver
Du måste skapa en Data Landing Zone (DLZ) målserver som liknar den som visas nedan när du konfigurerar en filbaserad Data Landing Zone (DLZ) mål.
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name":"DLZ destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"useCase": "Your use case"
},
"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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 layout-auto |
|
|
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 |
Ej tillämpligt |
Se filformatskonfiguration för detaljerad information om hur du konfigurerar de här inställningarna. |
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
Google Cloud-lagring
Skapa en Google Cloud Storage målserver
Du måste skapa en Google Cloud Storage målserver som liknar den som visas nedan när du konfigurerar en filbaserad Google Cloud Storage mål.
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"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": {
"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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 layout-auto |
|
|
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 |
Ej tillämpligt |
Se filformatskonfiguration för detaljerad information om hur du konfigurerar de här inställningarna. |
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
Skapa dynamiska målservrar för schema dynamic-schema-servers
Med dynamiska scheman kan du dynamiskt hämta de målattribut som stöds och generera scheman baserat på ditt eget API. Du måste konfigurera en målserver för dynamiska scheman innan du kan konfigurera schemat.
Se ett exempel på en målserver på fliken nedan för mål som använder dynamiska scheman.
Nedan finns exempelnyttolasten med alla parametrar som krävs för en dynamisk schemaserver.
Dynamisk schemaserver
Skapa en dynamisk schemaserver
Du måste skapa en dynamisk schemaserver som liknar den som visas nedan när du konfigurerar ett mål som hämtar sitt profilschema från din egen API-slutpunkt. I motsats till ett statiskt schema använder ett dynamiskt schema inte ett profileFields
array. I stället använder dynamiska scheman en dynamisk schemaserver som ansluter till din egen API från den plats där schemakonfigurationen hämtas.
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name":"Dynamic Schema Server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://YOUR_API_ENDPOINT/"
}
},
"httpTemplate":{
"httpMethod":"GET"
},
"responseFields":[
{
"templatingStrategy":"PEBBLE_V1",
"value":"{\n \"type\":\"object\",\n \"title\": \"Contact Schema\",\n \"properties\": {\n {% for setDefinition in response.body.items %}\n \"{{setDefinition.key}}\": {\n \"title\" : \"{{setDefinition.name.value}}\",\n \"type\" : \"object\",\n \"properties\": {\n {% for attribute in setDefinition.attributes %}\n \"{{attribute.key}}\": {\n \"title\" : \"{{attribute.name.value}}\",\n \"type\" : \"string\"\n }\n {% if not loop.last %},{%endif%}\n {% endfor %}\n }\n }\n {% if not loop.last %},{%endif%}\n {% endfor %}\n }\n}",
"name":"schema"
}
]
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 layout-auto |
|
|
Parameter |
Typ |
Beskrivning |
name |
Sträng |
Obligatoriskt. Representerar ett eget namn på den dynamiska schemaservern som bara visas för Adobe. |
destinationServerType |
Sträng |
Obligatoriskt. Ange till URL_BASED för dynamiska schemaservrar. |
urlBasedDestination.url.templatingStrategy |
Sträng |
Obligatoriskt.
- Använd
PEBBLE_V1 om Adobe behöver omvandla URL:en i value fält nedan. Använd det här alternativet om du har en slutpunkt som: https://api.moviestar.com/data/{{customerData.region}}/items .
- Använd
NONE om ingen omformning behövs på Adobe-sidan, till exempel om du har en slutpunkt som: https://api.moviestar.com/data/items .
|
urlBasedDestination.url.value |
Sträng |
Obligatoriskt. Fyll i adressen till API-slutpunkten som Experience Platform ska ansluta till och hämta schemafälten för att fylla i som målfält i mappningssteget i aktiveringsarbetsflödet. |
httpTemplate.httpMethod |
Sträng |
Obligatoriskt. Den metod som Adobe ska använda i anrop till servern. För dynamiska schemaservrar använder du GET . |
responseFields.templatingStrategy |
Sträng |
Obligatoriskt. Använd PEBBLE_V1 . |
responseFields.value |
Sträng |
Obligatoriskt. Den här strängen är den omformningsmall för tecken som escape-konverterar svar från partner-API:t till det partnerschema som visas i plattformens användargränssnitt.
|
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
Skapa dynamiska målservrar för listrutor dynamic-dropdown-servers
Använd dynamiska listrutor för att dynamiskt hämta och fylla i listrutor med kunddatafält, baserat på ditt eget API. Du kan till exempel hämta en lista över befintliga användarkonton som du vill använda för en målanslutning.
Du måste konfigurera en målserver för dynamiska listrutor innan du kan konfigurera det dynamiska listrutan för kunddatafältet.
På fliken nedan finns ett exempel på en målserver som används för att dynamiskt hämta de värden som ska visas i en listruteväljare från ett API.
Nedan finns exempelnyttolasten med alla parametrar som krävs för en dynamisk schemaserver.
Dynamisk nedrullningsbar server
Skapa en dynamisk nedrullningsbar server
Du måste skapa en dynamisk nedrullningsbar server som liknar den som visas nedan när du konfigurerar ett mål som hämtar värdena för ett nedrullningsbart kunddatafält från din egen API-slutpunkt.
accordion |
Begäran |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name":"Server for dynamic dropdown",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.users}}/items"
}
},
"httpTemplate":{
"httpMethod":"GET",
"headers":[
{
"header":"Authorization",
"value":{
"templatingStrategy":"PEBBLE_V1",
"value":"My Bearer Token"
}
},
{
"header":"x-integration",
"value":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.integrationId}}"
}
},
{
"header":"Accept",
"value":{
"templatingStrategy":"NONE",
"value":"application/json"
}
}
]
},
"responseFields":[
{
"templatingStrategy":"PEBBLE_V1",
"value":"{% set list = [] %} {% for record in response.body %} {% set list = list|merge([{'name' : record.name, 'value' : record.id }]) %} {% endfor %}{{ {'list': list} | toJson | raw }}",
"name":"list"
}
]
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 layout-auto |
|
|
Parameter |
Typ |
Beskrivning |
name |
Sträng |
Obligatoriskt. Representerar ett eget namn på den dynamiska listruteservern som bara visas för Adobe. |
destinationServerType |
Sträng |
Obligatoriskt. Ange till URL_BASED för dynamiska nedrullningsbara servrar. |
urlBasedDestination.url.templatingStrategy |
Sträng |
Obligatoriskt.
- Använd
PEBBLE_V1 om Adobe behöver omvandla URL:en i value fält nedan. Använd det här alternativet om du har en slutpunkt som: https://api.moviestar.com/data/{{customerData.region}}/items .
- Använd
NONE om ingen omformning behövs på Adobe-sidan, till exempel om du har en slutpunkt som: https://api.moviestar.com/data/items .
|
urlBasedDestination.url.value |
Sträng |
Obligatoriskt. Fyll i adressen till API-slutpunkten som Experience Platform ska ansluta till och hämta listrutans värden. |
httpTemplate.httpMethod |
Sträng |
Obligatoriskt. Den metod som Adobe ska använda i anrop till servern. För dynamiska listruteservrar använder du GET . |
httpTemplate.headers |
Objekt |
Optiona.l Inkludera eventuella rubriker som krävs för att ansluta till den dynamiska listruteservern. |
responseFields.templatingStrategy |
Sträng |
Obligatoriskt. Använd PEBBLE_V1 . |
responseFields.value |
Sträng |
Obligatoriskt. Strängen är den omformningsmall som används för att omvandla det svar som tas emot från ditt API till värden som visas i plattformens användargränssnitt.
|
|
accordion |
svar |
Ett lyckat svar returnerar HTTP-status 200 med information om den nya målserverkonfigurationen. |
API-felhantering error-handling
Destination SDK-API-slutpunkter följer de allmänna felmeddelandeprinciperna för Experience Platform API. Se API-statuskoder och fel i begäranhuvudet i felsökningsguiden för plattformen.
Nästa steg next-steps
När du har läst det här dokumentet kan du nu skapa en ny målserver via Destinationen SDK /authoring/destination-servers
API-slutpunkt.
Mer information om vad du kan göra med den här slutpunkten finns i följande artiklar:
Mer information om var den här slutpunkten passar in i målredigeringsprocessen finns i följande artiklar: