Esta página exemplifica a solicitação de API e a carga que você pode usar para atualizar uma configuração existente do servidor de destino usando o /authoring/destination-servers
Endpoint da API.
Qualquer operação de atualização em destinos de produção/públicos estará visível somente após o uso do API de publicação e envie a atualização para revisão do Adobe.
Para obter uma descrição detalhada dos recursos que você pode configurar por meio desse endpoint, leia os seguintes artigos:
Todos os nomes e valores de parâmetros compatíveis com o Destination SDK são diferencia maiúsculas de minúsculas. Para evitar erros de diferenciação entre maiúsculas e minúsculas, use os nomes e valores dos parâmetros exatamente como mostrado na documentação.
Antes de continuar, reveja o guia de introdução para obter informações importantes que você precisa saber para fazer chamadas com êxito para a API, incluindo como obter a permissão de criação de destino e os cabeçalhos necessários.
Você pode atualizar um existente configuração do servidor de destino fazendo uma PUT
solicitação à /authoring/destination-servers
terminal com a carga atualizada.
Ponto de acesso da API: platform.adobe.io/data/core/activation/authoring/destination-servers
Para obter uma configuração existente do servidor de destino e suas {INSTANCE_ID}
, consulte o artigo sobre recuperando uma configuração do servidor de destino.
Formato da API
PUT /authoring/destination-servers/{INSTANCE_ID}
Parâmetro | Descrição |
---|---|
{INSTANCE_ID} |
A ID da configuração do servidor de destino que você deseja atualizar. Para obter uma configuração existente do servidor de destino e suas {INSTANCE_ID} , consulte Recuperar uma configuração do servidor de destino. |
As solicitações a seguir atualizam uma configuração existente do servidor de destino, configurada pelos parâmetros fornecidos na carga.
Selecione cada guia abaixo para visualizar o conteúdo correspondente.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers\{INSTANCE_ID} \
-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":"PUT",
"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"
}
}
Parâmetro | Tipo | Descrição |
---|---|---|
name |
String | Obrigatório. Representa um nome amigável do servidor, visível somente para o Adobe. Este nome não está visível para parceiros ou clientes. Exemplo Moviestar destination server . |
destinationServerType |
String | Obrigatório. Defina como URL_BASED para destinos em tempo real (transmissão). |
urlBasedDestination.url.templatingStrategy |
String | Obrigatório.
|
urlBasedDestination.url.value |
String | Obrigatório. Preencha o endereço do endpoint da API ao qual o Experience Platform deve se conectar. |
httpTemplate.httpMethod |
String | Obrigatório. O método que o Adobe usará nas chamadas para o servidor. As opções são GET , PUT , PUT , DELETE , PATCH . |
httpTemplate.requestBody.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
httpTemplate.requestBody.value |
String | Obrigatório. Essa string é a versão com escape de caracteres que transforma os dados de clientes da Platform no formato esperado pelo seu serviço.
|
httpTemplate.contentType |
String | Obrigatório. O tipo de conteúdo que seu servidor aceita. Este valor é mais provável application/json . |
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração atualizada do servidor de destino.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers\{INSTANCE_ID} \
-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": ""
}
}
}
}
Parâmetro | Tipo | Descrição |
---|---|---|
name |
String | O nome da conexão de destino. |
destinationServerType |
String | Defina esse valor de acordo com sua plataforma de destino. Para Amazon S3, defina como FILE_BASED_S3 . |
fileBasedS3Destination.bucket.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedS3Destination.bucket.value |
String | O nome do Amazon S3 bucket a ser usado por esse destino. |
fileBasedS3Destination.path.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedS3Destination.path.value |
String | O caminho para a pasta de destino que hospedará os arquivos exportados. |
fileConfigurations |
N/D | Consulte configuração da formatação de arquivo para obter informações detalhadas sobre como definir essas configurações. |
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração atualizada do servidor de destino.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{INSTANCE_ID} \
-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": ""
}
}
}
}
Parâmetro | Tipo | Descrição |
---|---|---|
name |
String | O nome da conexão de destino. |
destinationServerType |
String | Defina esse valor de acordo com sua plataforma de destino. Para SFTP destinos, defina como FILE_BASED_SFTP . |
fileBasedSFTPDestination.rootDirectory.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedSFTPDestination.rootDirectory.value |
String | O diretório raiz do armazenamento de destino. |
fileBasedSFTPDestination.hostName.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedSFTPDestination.hostName.value |
String | O nome do host do armazenamento de destino. |
port |
Número inteiro | A porta do servidor de arquivos SFTP. |
encryptionMode |
String | Indica se deve ser usada criptografia de arquivo. Valores compatíveis:
|
fileConfigurations |
N/D | Consulte configuração da formatação de arquivo para obter informações detalhadas sobre como definir essas configurações. |
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração atualizada do servidor de destino.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{INSTANCE_ID} \
-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": ""
}
}
}
}
Parâmetro | Tipo | Descrição |
---|---|---|
name |
String | O nome da conexão de destino. |
destinationServerType |
String | Defina esse valor de acordo com sua plataforma de destino. Para Azure Data Lake Storage destinos, defina como FILE_BASED_ADLS_GEN2 . |
fileBasedAdlsGen2Destination.path.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedAdlsGen2Destination.path.value |
String | O caminho para a pasta de destino que hospedará os arquivos exportados. |
fileConfigurations |
N/D | Consulte configuração da formatação de arquivo para obter informações detalhadas sobre como definir essas configurações. |
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração atualizada do servidor de destino.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{INSTANCE_D} \
-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": ""
}
}
}
}
Parâmetro | Tipo | Descrição |
---|---|---|
name |
String | O nome da conexão de destino. |
destinationServerType |
String | Defina esse valor de acordo com sua plataforma de destino. Para Azure Blob Storage destinos, defina como FILE_BASED_AZURE_BLOB . |
fileBasedAzureBlobDestination.path.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedAzureBlobDestination.path.value |
String | O caminho para a pasta de destino que hospedará os arquivos exportados. |
fileBasedAzureBlobDestination.container.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedAzureBlobDestination.container.value |
String | O nome do Azure Blob Storage contêiner a ser usado por este destino. |
fileConfigurations |
N/D | Consulte configuração da formatação de arquivo para obter informações detalhadas sobre como definir essas configurações. |
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração atualizada do servidor de destino.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{INSTANCE_ID} \
-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": ""
}
}
}
}
Parâmetro | Tipo | Descrição |
---|---|---|
name |
String | O nome da conexão de destino. |
destinationServerType |
String | Defina esse valor de acordo com sua plataforma de destino. Para Data Landing Zone destinos, defina como FILE_BASED_DLZ . |
fileBasedDlzDestination.path.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedDlzDestination.path.value |
String | O caminho para a pasta de destino que hospedará os arquivos exportados. |
fileConfigurations |
N/D | Consulte configuração da formatação de arquivo para obter informações detalhadas sobre como definir essas configurações. |
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração atualizada do servidor de destino.
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{INSTANCE_ID} \
-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": ""
}
}
}
}
Parâmetro | Tipo | Descrição |
---|---|---|
name |
String | O nome da conexão de destino. |
destinationServerType |
String | Defina esse valor de acordo com sua plataforma de destino. Para Google Cloud Storage destinos, defina como FILE_BASED_GOOGLE_CLOUD . |
fileBasedGoogleCloudStorageDestination.bucket.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedGoogleCloudStorageDestination.bucket.value |
String | O nome do Google Cloud Storage bucket a ser usado por esse destino. |
fileBasedGoogleCloudStorageDestination.path.templatingStrategy |
String | Obrigatório. Use PEBBLE_V1 . |
fileBasedGoogleCloudStorageDestination.path.value |
String | O caminho para a pasta de destino que hospedará os arquivos exportados. |
fileConfigurations |
N/D | Consulte configuração da formatação de arquivo para obter informações detalhadas sobre como definir essas configurações. |
Uma resposta bem-sucedida retorna o status HTTP 200 com os detalhes da configuração atualizada do servidor de destino.
Os endpoints da API Destination SDK seguem os princípios gerais de mensagem de erro da API Experience Platform. Consulte Códigos de status da API e erros no cabeçalho da solicitação no guia de solução de problemas da Platform.
Depois de ler este documento, você sabe como atualizar uma configuração do servidor de destino por meio do Destination SDK /authoring/destination-servers
Endpoint da API.
Para saber mais sobre o que você pode fazer com esse endpoint, consulte os seguintes artigos: