Especificações do servidor para destinos criados com o Destination SDK

Última atualização em 2023-10-31
  • Tópicos
  • Destinations
    Exibir mais informações sobre este tópico
  • Criado para:
  • Admin
    User

As especificações do servidor de destino definem o tipo de plataforma de destino que receberá os dados do Adobe Experience Platform e os parâmetros de comunicação entre a Platform e o seu destino. Por exemplo:

  • A transmissão a especificação do servidor de destino define o ponto de acesso do servidor HTTP que receberá as mensagens HTTP da Platform. Para saber como as chamadas HTTP para o endpoint são formatadas, leia o especificações de modelos página.
  • Um Amazon S3 a especificação do servidor de destino define o S3 nome e caminho do bucket em que o Platform exportará os arquivos.
  • Um SFTP a especificação do servidor de destino define o nome do host, o diretório raiz, a porta de comunicação e o tipo de criptografia do servidor SFTP no qual o Platform exportará os arquivos.

Para entender onde esse componente se encaixa em uma integração criada com o Destination SDK, consulte o diagrama no opções de configuração ou consulte as seguintes páginas de visão geral da configuração de destino:

Você pode configurar as especificações do servidor de destino por meio da /authoring/destination-servers terminal. Consulte as seguintes páginas de referência de API para obter exemplos detalhados de chamadas de API, onde é possível configurar os componentes mostrados nesta página.

Esta página mostra todos os tipos de servidor de destino suportados pelo Destination SDK, com todos os seus parâmetros de configuração. Ao criar seu destino, substitua os valores de parâmetro pelos seus próprios.

IMPORTANTE

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.

Tipos de integração compatíveis

Consulte a tabela abaixo para obter detalhes sobre quais tipos de integrações suportam a funcionalidade descrita nesta página.

Tipo de integração Suporte à funcionalidade
Integrações em tempo real (streaming) Sim
Integrações baseadas em arquivo (lote) Sim

Quando criando ou atualizando um servidor de destino, use uma das configurações de tipo de servidor descritas nesta página. Dependendo dos seus requisitos de integração, substitua os valores de parâmetro de amostra desses exemplos pelos seus próprios.

Campos codificados permanentemente em comparação a campos de modelo

Ao criar um servidor de destino por meio do Destination SDK, você pode definir valores de parâmetros de configuração codificando-os na configuração ou usando campos com modelo. Campos modelados permitem que você leia os valores fornecidos pelo usuário na interface do usuário da Platform.

Os parâmetros do servidor de destino têm dois campos configuráveis. Essas opções determinam se você está usando valores codificados ou com modelos.

Parâmetro Tipo Descrição
templatingStrategy String Obrigatório. Define se há um valor embutido em código fornecido por meio do value ou um valor configurável pelo usuário na interface. Valores compatíveis:
  • NONE: use esse valor quando estiver codificando o valor do parâmetro por meio da variável value (consulte a próxima linha). Exemplo:"value": "my-storage-bucket".
  • PEBBLE_V1: use esse valor quando quiser que os usuários forneçam um valor de parâmetro na interface do. Exemplo: "value": "{{customerData.bucket}}".
value String Obrigatório. Define o valor do parâmetro. Tipos de valores suportados:
  • Valor codificado permanentemente: use um valor embutido em código (como "value": "my-storage-bucket") quando não for necessário que os usuários insiram um valor de parâmetro na interface do usuário. Ao codificar um valor fixo, templatingStrategy deve ser sempre definido como NONE.
  • Valor modelado: use um valor de modelo (como "value": "{{customerData.bucket}}") quando quiser que os usuários forneçam um valor de parâmetro na interface do. Ao usar valores de modelos, templatingStrategy deve ser sempre definido como PEBBLE_V1.

Quando usar campos embutidos em código ou com modelos

Os campos embutidos em código e com modelo têm seus próprios usos no Destination SDK, dependendo do tipo de integração que está sendo criada.

Conectar ao destino sem entrada do usuário

Quando os usuários conectar ao seu destino na interface da Platform, talvez você queira lidar com o processo de conexão de destino sem sua entrada.

Para fazer isso, você pode codificar os parâmetros de conexão da plataforma de destino na especificação do servidor. Quando você usa valores de parâmetro embutidos em código na configuração do servidor de destino, a conexão entre o Adobe Experience Platform e a plataforma de destino é manipulada sem nenhuma entrada do usuário.

No exemplo abaixo, um parceiro cria um servidor de destino da Data Landing Zone com o path.value campo sendo codificado.

{
   "name":"Data Landing Zone destination server",
   "destinationServerType":"FILE_BASED_DLZ",
   "fileBasedDlzDestination":{
      "path":{
         "templatingStrategy":"NONE",
         "value":"Your/hardcoded/path/here"
      },
      "useCase": "Your use case"
   }
}

Como resultado, quando os usuários passam pelo tutorial de conexão de destino, eles não verão um etapa de autenticação. Em vez disso, a autenticação é realizada pela Platform, conforme mostrado na imagem abaixo.

Imagem da interface mostrando a tela de autenticação entre a Platform e um destino DLZ.

Conectar ao destino com entrada do usuário

Quando a conexão entre a Platform e seu destino deve ser estabelecida seguindo uma entrada de usuário específica na interface do usuário da Platform, como selecionar um endpoint da API ou fornecer um valor de campo, você pode usar campos modelos na especificação do servidor para ler a entrada do usuário e se conectar à plataforma de destino.

No exemplo abaixo, um parceiro cria uma tempo real (transmissão) integração e o url.value o campo usa o parâmetro de modelo {{customerData.region}} para personalizar parte do endpoint da API com base na entrada do usuário.

{
   "name":"Templatized API endpoint example",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"https://api.yourcompany.com/data/{{customerData.region}}/items"
      }
   }
}

Para conceder aos usuários a opção de selecionar um valor na interface do usuário da Platform, a variável region também deve ser definido na variável configuração de destino como um campo de dados do cliente, conforme mostrado abaixo:

"customerDataFields":[
   {
      "name":"region",
      "title":"Region",
      "description":"Select an option",
      "type":"string",
      "isRequired":true,
      "readOnly":false,
      "enum":[
         "US",
         "EU"
      ]
   }

Como resultado, quando os usuários passam pelo tutorial de conexão de destino, eles devem selecionar uma região antes de se conectarem à plataforma de destino. Quando se conectam ao destino, o campo de modelo {{customerData.region}} é substituído pelo valor que o usuário selecionou na interface, como mostrado na imagem abaixo.

Imagem da interface do usuário mostrando a tela de conexão de destino com um seletor de região.

Servidor de destino (transmissão) em tempo real

Esse tipo de servidor de destino permite exportar dados do Adobe Experience Platform para o seu destino por meio de solicitações HTTP. A configuração do servidor contém informações sobre o servidor que recebe as mensagens (o servidor do seu lado).

Esse processo fornece dados do usuário como uma série de mensagens HTTP para a plataforma de destino. Os parâmetros abaixo formam o modelo de especificações do servidor HTTP.

A amostra abaixo mostra um exemplo de uma configuração de servidor de destino para um destino em tempo real (transmissão).

{
   "name":"Your destination server name",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{YOUR_API_ENDPOINT}"
      }
   }
}
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 isso como URL_BASED para destinos de transmissão.
templatingStrategy String Obrigatório.
  • Uso PEBBLE_V1 se estiver usando um campo de modelo em vez de um valor embutido em código na variável value campo. Use essa opção se você tiver um terminal como: https://api.moviestar.com/data/{{customerData.region}}/items, em que os usuários devem selecionar a região do endpoint na interface do usuário da Platform.
  • Uso NONE se nenhuma transformação templatizada for necessária no lado do Adobe, por exemplo, se você tiver um ponto de extremidade como: https://api.moviestar.com/data/items
value String Obrigatório. Preencha o endereço do endpoint da API ao qual o Experience Platform deve se conectar.

Amazon S3 servidor de destino

Esse servidor de destino permite exportar arquivos contendo dados do Adobe Experience Platform para o armazenamento do Amazon S3.

A amostra abaixo mostra um exemplo de uma configuração de servidor de destino para um destino 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}}"
      }
   }
}
Parâmetro Tipo Descrição
name String O nome do servidor de destino.
destinationServerType String Defina esse valor de acordo com sua plataforma de destino. Para exportar arquivos para um Amazon S3 bucket, defina como FILE_BASED_S3.
fileBasedS3Destination.bucket.templatingStrategy String Obrigatório. Defina esse valor de acordo com o tipo de valor usado no bucket.value campo.
  • Se quiser que os usuários insiram seu próprio nome de bucket na interface do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o value para ler um valor do campo campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um nome de bucket embutido em código para a sua integração, como "bucket.value":"MyBucket", em seguida, defina esse valor como NONE.
fileBasedS3Destination.bucket.value String O nome do Amazon S3 bucket a ser usado por esse destino. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como "value":"MyBucket".
fileBasedS3Destination.path.templatingStrategy String Obrigatório. Defina esse valor de acordo com o tipo de valor usado no path.value campo.
  • Se você quiser que seus usuários insiram seu próprio caminho na interface do usuário do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o path.value para ler um valor do campo campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um caminho embutido em código para sua integração, como "bucket.value":"/path/to/MyBucket", em seguida, defina esse valor como NONE.
fileBasedS3Destination.path.value String O caminho para o Amazon S3 bucket a ser usado por esse destino. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como "value":"/path/to/MyBucket".

SFTP servidor de destino

Esse servidor de destino permite exportar arquivos contendo dados do Adobe Experience Platform para o seu SFTP servidor de armazenamento.

O exemplo abaixo mostra um exemplo de configuração de servidor de destino para um destino 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"
   }
}
Parâmetro Tipo Descrição
name String O nome do servidor de destino.
destinationServerType String Defina esse valor de acordo com sua plataforma de destino. Para exportar arquivos para um SFTP destino, defina como FILE_BASED_SFTP.
fileBasedSFTPDestination.rootDirectory.templatingStrategy String Obrigatório. Defina esse valor de acordo com o tipo de valor usado no rootDirectory.value campo.
  • Se você quiser que seus usuários insiram seu próprio caminho de diretório raiz na interface do usuário do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o rootDirectory.value para ler um valor fornecido pelo usuário no campo campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um caminho de diretório raiz embutido em código para a integração, como "rootDirectory.value":"Storage/MyDirectory", em seguida, defina esse valor como NONE.
fileBasedSFTPDestination.rootDirectory.value String O caminho para o diretório que hospedará os arquivos exportados. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como "value":"Storage/MyDirectory"
fileBasedSFTPDestination.hostName.templatingStrategy String Obrigatório. Defina esse valor de acordo com o tipo de valor usado no hostName.value campo.
  • Se você quiser que seus usuários insiram seu próprio nome de host na interface do usuário do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o hostName.value para ler um valor fornecido pelo usuário no campo campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se você estiver usando um nome de host codificado para sua integração, como "hostName.value":"my.hostname.com", em seguida, defina esse valor como NONE.
fileBasedSFTPDestination.hostName.value String O nome do host do servidor SFTP. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como "hostName.value":"my.hostname.com".
port Número inteiro A porta do servidor de arquivos SFTP.
encryptionMode String Indica se deve ser usada criptografia de arquivo. Valores compatíveis:
  • PGP
  • None

Azure Data Lake Storage (ADLS) servidor de destino

Esse servidor de destino permite exportar arquivos contendo dados do Adobe Experience Platform para o seu Azure Data Lake Storage conta.

O exemplo abaixo mostra um exemplo de uma configuração de servidor de destino para um Azure Data Lake Storage destino.

{
   "name":"ADLS destination server",
   "destinationServerType":"FILE_BASED_ADLS_GEN2",
   "fileBasedAdlsGen2Destination":{
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      }
   }
}
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. Defina esse valor de acordo com o tipo de valor usado no path.value campo.
  • Se quiser que os usuários insiram seus ADLS caminho da pasta na interface do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o path.value para ler um valor do campo campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um caminho embutido em código para sua integração, como "abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/", em seguida, defina esse valor como NONE.
fileBasedAdlsGen2Destination.path.value String O caminho para o seu ADLS pasta de armazenamento. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/.

Azure Blob Storage servidor de destino

Esse servidor de destino permite exportar arquivos contendo dados do Adobe Experience Platform para o seu Azure Blob Storage recipiente.

O exemplo abaixo mostra um exemplo de uma configuração de servidor de destino para um Azure Blob Storage destino.

{
   "name":"Blob destination server",
   "destinationServerType":"FILE_BASED_AZURE_BLOB",
   "fileBasedAzureBlobDestination":{
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      },
      "container":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.container}}"
      }
   }
}
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. Defina esse valor de acordo com o tipo de valor usado no path.value campo.
  • Se quiser que os usuários insiram os próprios Azure Blob URI da conta de armazenamento na interface do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o path.value campo para ler o valor do campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um caminho embutido em código para sua integração, como "path.value": "https://myaccount.blob.core.windows.net/", em seguida, defina esse valor como NONE.
fileBasedAzureBlobDestination.path.value String O caminho para o seu Azure Blob armazenamento. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como https://myaccount.blob.core.windows.net/.
fileBasedAzureBlobDestination.container.templatingStrategy String Obrigatório. Defina esse valor de acordo com o tipo de valor usado no container.value campo.
  • Se quiser que os usuários insiram os próprios Azure Blob nome do container na interface do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o container.value campo para ler o valor do campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um nome de contêiner embutido em código para a integração, como "path.value: myContainer", em seguida, defina esse valor como NONE.
fileBasedAzureBlobDestination.container.value String O nome do contêiner do Armazenamento Azure Blob a ser usado para esse destino. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como myContainer.

Data Landing Zone (DLZ) servidor de destino

Esse servidor de destino permite exportar arquivos contendo dados da Platform para um Data Landing Zone armazenamento.

O exemplo abaixo mostra um exemplo de uma configuração de servidor de destino para um Data Landing Zone (DLZ) destino.

{
   "name":"Data Landing Zone destination server",
   "destinationServerType":"FILE_BASED_DLZ",
   "fileBasedDlzDestination":{
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      },
      "useCase": "Your use case"
   }
}
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. Defina esse valor de acordo com o tipo de valor usado no path.value campo.
  • Se quiser que os usuários insiram os próprios Data Landing Zone na interface do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o path.value para ler um valor do campo campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um caminho embutido em código para sua integração, como "path.value": "https://myaccount.blob.core.windows.net/", em seguida, defina esse valor como NONE.
fileBasedDlzDestination.path.value String O caminho para a pasta de destino que hospedará os arquivos exportados.

Google Cloud Storage servidor de destino

Esse servidor de destino permite exportar arquivos que contêm dados da Platform para o Google Cloud Storage conta.

O exemplo abaixo mostra um exemplo de uma configuração de servidor de destino para um Google Cloud Storage destino.

{
   "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}}"
      }
   }
}
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. Defina esse valor de acordo com o tipo de valor usado no bucket.value campo.
  • Se quiser que os usuários insiram os próprios Google Cloud Storage nome do bucket na interface do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o bucket.value para ler um valor do campo campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um nome de bucket embutido em código para a sua integração, como "bucket.value": "my-bucket", em seguida, defina esse valor como NONE.
fileBasedGoogleCloudStorageDestination.bucket.value String O nome do Google Cloud Storage bucket a ser usado por esse destino. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como "value": "my-bucket".
fileBasedGoogleCloudStorageDestination.path.templatingStrategy String Obrigatório. Defina esse valor de acordo com o tipo de valor usado no path.value campo.
  • Se quiser que os usuários insiram os próprios Google Cloud Storage caminho do bucket na interface do Experience Platform, defina esse valor como PEBBLE_V1. Nesse caso, você deve modelar o path.value para ler um valor do campo campos de dados do cliente preenchido pelo usuário. Esse caso de uso é mostrado no exemplo acima.
  • Se estiver usando um caminho embutido em código para sua integração, como "path.value": "/path/to/my-bucket", em seguida, defina esse valor como NONE.
fileBasedGoogleCloudStorageDestination.path.value String O caminho para o Google Cloud Storage pasta a ser usada por este destino. Pode ser um campo de modelo que lerá o valor da variável campos de dados do cliente preenchido pelo usuário (como mostrado no exemplo acima) ou um valor embutido em código, como "value": "/path/to/my-bucket".

Próximas etapas

Depois de ler este artigo, você terá que entender melhor o que é uma especificação de servidor de destino e como configurá-la.

Para saber mais sobre os outros componentes do servidor de destino, consulte os seguintes artigos:

Nesta página