Especificaciones del servidor para destinos creados con Destination SDK

Las especificaciones del servidor de destino definen el tipo de plataforma de destino que recibirá los datos de Adobe Experience Platform y los parámetros de comunicación entre Platform y el destino. Por ejemplo:

  • A transmisión La especificación del servidor de destino define el extremo del servidor HTTP que recibirá los mensajes HTTP de Platform. Para aprender a configurar el formato de las llamadas HTTP al extremo, lea la especificaciones de creación de plantillas página.
  • Un Amazon S3 la especificación del servidor de destino define el S3 nombre del contenedor y ruta donde Platform exportará los archivos.
  • Un SFTP Las especificaciones del servidor de destino definen el nombre de host, el directorio raíz, el puerto de comunicación y el tipo de cifrado del servidor SFTP, donde Platform exportará los archivos.

Para saber dónde encaja este componente en una integración creada con Destination SDK, consulte el diagrama en la opciones de configuración o consulte las siguientes páginas de información general sobre la configuración de destino:

Puede configurar las especificaciones del servidor de destino mediante el /authoring/destination-servers punto final. Consulte las siguientes páginas de referencia de la API para ver ejemplos detallados de llamadas de la API donde puede configurar los componentes que se muestran en esta página.

Esta página muestra todos los tipos de servidores de destino admitidos por Destination SDK, con todos sus parámetros de configuración. Al crear el destino, reemplace los valores de parámetro por los suyos propios.

IMPORTANTE

Todos los nombres y valores de parámetro admitidos por el Destination SDK son distingue mayúsculas de minúsculas. Para evitar errores de distinción entre mayúsculas y minúsculas, utilice los nombres y valores de los parámetros exactamente como se muestra en la documentación.

Tipos de integración admitidos

Consulte la tabla siguiente para obtener detalles sobre qué tipos de integraciones admiten la funcionalidad descrita en esta página.

Tipo de integración Admite funcionalidad
Integraciones en tiempo real (streaming) Sí
Integraciones basadas en archivos (por lotes) Sí

Cuándo creación o actualización Como servidor de destino, utilice una de las configuraciones de tipo de servidor descritas en esta página. Según los requisitos de integración, asegúrese de reemplazar los valores de parámetro de muestra de estos ejemplos por los suyos propios.

Campos no codificados frente a campos con plantillas

Al crear un servidor de destino a través de Destination SDK, puede definir los valores de los parámetros de configuración mediante su codificación en la configuración o utilizando campos con plantilla. Los campos con plantilla le permiten leer valores proporcionados por el usuario desde la interfaz de usuario de Platform.

Los parámetros del servidor de destino tienen dos campos configurables. Estas opciones dictan si está utilizando valores codificados o con plantillas.

Parámetro Tipo Descripción
templatingStrategy Cadena Requerido. Define si hay un valor codificado proporcionado mediante la variable value o un valor que pueda configurar el usuario en la interfaz de usuario. Valores compatibles:
  • NONE: utilice este valor cuando esté codificando el valor del parámetro mediante el value (consulte la fila siguiente). Ejemplo:"value": "my-storage-bucket".
  • PEBBLE_V1: utilice este valor cuando desee que los usuarios proporcionen un valor de parámetro en la interfaz de usuario. Ejemplo: "value": "{{customerData.bucket}}".
value Cadena Requerido. Define el valor del parámetro. Tipos de valores admitidos:
  • Valor codificado: utilice un valor codificado (como "value": "my-storage-bucket") cuando no necesite que los usuarios introduzcan un valor de parámetro en la interfaz de usuario. Al codificar un valor, templatingStrategy siempre debe configurarse como NONE.
  • Valor con plantilla: utilice un valor con plantilla (como "value": "{{customerData.bucket}}") cuando desee que los usuarios proporcionen un valor de parámetro en la interfaz de usuario. Cuando se utilizan valores con plantilla, templatingStrategy siempre debe configurarse como PEBBLE_V1.

Cuándo utilizar campos con código o con plantilla

Los campos con plantilla y los campos codificados tienen sus propios usos en Destination SDK, según el tipo de integración que cree.

Conectarse al destino sin la entrada del usuario

Cuando los usuarios conectar con el destino En la interfaz de usuario de Platform, es posible que desee controlar el proceso de conexión de destino sin su entrada.

Para ello, puede codificar de forma rígida los parámetros de conexión de la plataforma de destino en la especificación del servidor. Cuando se utilizan valores de parámetros codificados de forma rígida en la configuración del servidor de destino, la conexión entre Adobe Experience Platform y la plataforma de destino se gestiona sin que el usuario tenga que realizar ninguna entrada.

En el ejemplo siguiente, un socio crea un servidor de destino de zona de aterrizaje de datos con path.value campo 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, cuando los usuarios pasan por el tutorial de conexión de destino, no verán un paso de autenticación. En su lugar, Platform gestiona la autenticación, como se muestra en la siguiente imagen.

Imagen de la interfaz de usuario que muestra la pantalla de autenticación entre Platform y un destino DLZ.

Conexión al destino con la entrada del usuario

Cuando se debe establecer la conexión entre Platform y el destino después de una entrada específica del usuario en la interfaz de usuario de Platform, como seleccionar un punto final de API o proporcionar un valor de campo, puede utilizar campos con plantilla en la especificación del servidor para leer la entrada del usuario y conectarse a la plataforma de destino.

En el ejemplo siguiente, un socio crea un tiempo real (streaming) integración y el url.value Este campo utiliza el parámetro con plantilla {{customerData.region}} para personalizar parte del extremo de la API en función de los datos introducidos por el usuario.

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

Para dar a los usuarios la opción de seleccionar un valor de la IU de Platform, la variable region El parámetro también debe definirse en la variable configuración de destino como campo de datos de cliente, como se muestra a continuación:

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

Como resultado, cuando los usuarios pasan por el tutorial de conexión de destino, deben seleccionar una región antes de poder conectarse a la plataforma de destino. Cuando se conectan al destino, el campo con plantilla {{customerData.region}} se reemplaza por el valor que el usuario ha seleccionado en la interfaz de usuario, como se muestra en la siguiente imagen.

Imagen de la interfaz de usuario que muestra la pantalla de conexión de destino con un selector de región.

Servidor de destino en tiempo real (streaming)

Este tipo de servidor de destino le permite exportar datos de Adobe Experience Platform a su destino a través de solicitudes HTTP. La configuración del servidor contiene información sobre el servidor que recibe los mensajes (el servidor de su lado).

Este proceso envía datos de usuario como una serie de mensajes HTTP a la plataforma de destino. Los parámetros siguientes forman la plantilla de especificaciones del servidor HTTP.

El siguiente ejemplo muestra un ejemplo de configuración de servidor de destino para un destino de tiempo real (flujo continuo).

{
   "name":"Your destination server name",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{YOUR_API_ENDPOINT}"
      }
   }
}
Parámetro Tipo Descripción
name Cadena Requerido. Representa un nombre descriptivo del servidor, visible solo para el Adobe. Este nombre no es visible para socios o clientes. Ejemplo: Moviestar destination server.
destinationServerType Cadena Requerido. Configure esto como URL_BASED para destinos de streaming.
templatingStrategy Cadena Requerido.
  • Uso PEBBLE_V1 si utiliza un campo con plantilla en lugar de un valor codificado en la variable value field. Utilice esta opción si tiene un punto final como: https://api.moviestar.com/data/{{customerData.region}}/items, donde los usuarios deben seleccionar la región de extremo de la interfaz de usuario de Platform.
  • Uso NONE si no se necesita ninguna transformación con plantilla en el lado del Adobe, por ejemplo, si tiene un punto final como: https://api.moviestar.com/data/items
value Cadena Requerido. Rellene la dirección del extremo de API al que el Experience Platform debe conectarse.

Amazon S3 servidor de destino

Este servidor de destino le permite exportar archivos que contienen datos de Adobe Experience Platform a su almacenamiento de Amazon S3.

El siguiente ejemplo muestra un ejemplo de configuración de servidor de destino para un destino de 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 Descripción
name Cadena Nombre del servidor de destino.
destinationServerType Cadena Establezca este valor según la plataforma de destino. Para exportar archivos a un Amazon S3 cubo, establezca esto en FILE_BASED_S3.
fileBasedS3Destination.bucket.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable bucket.value field.
  • Si desea que los usuarios introduzcan su propio nombre de contenedor en la interfaz de usuario de Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable value para leer un valor del campo campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza un nombre de contenedor predefinido para su integración, como "bucket.value":"MyBucket", luego establezca este valor en NONE.
fileBasedS3Destination.bucket.value Cadena El nombre del Amazon S3 contenedor que utilizará este destino. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como "value":"MyBucket".
fileBasedS3Destination.path.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable path.value field.
  • Si desea que los usuarios introduzcan su propia ruta en la interfaz de usuario de Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable path.value para leer un valor del campo campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza una ruta codificada de forma rígida para la integración, como "bucket.value":"/path/to/MyBucket", luego establezca este valor en NONE.
fileBasedS3Destination.path.value Cadena La ruta al Amazon S3 contenedor que utilizará este destino. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como "value":"/path/to/MyBucket".

SFTP servidor de destino

Este servidor de destino le permite exportar archivos que contengan datos de Adobe Experience Platform a su SFTP servidor de almacenamiento.

El siguiente ejemplo muestra un ejemplo de configuración de servidor de destino para un 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 Descripción
name Cadena Nombre del servidor de destino.
destinationServerType Cadena Establezca este valor según la plataforma de destino. Para exportar archivos a un SFTP destino, establecer esto como FILE_BASED_SFTP.
fileBasedSFTPDestination.rootDirectory.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable rootDirectory.value field.
  • Si desea que los usuarios introduzcan su propia ruta de directorio raíz en la interfaz de usuario de Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable rootDirectory.value para leer un valor proporcionado por el usuario desde el campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza una ruta de directorio raíz codificada de forma rígida para la integración, como "rootDirectory.value":"Storage/MyDirectory", luego establezca este valor en NONE.
fileBasedSFTPDestination.rootDirectory.value Cadena Ruta al directorio que alojará los archivos exportados. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como "value":"Storage/MyDirectory"
fileBasedSFTPDestination.hostName.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable hostName.value field.
  • Si desea que los usuarios introduzcan su propio nombre de host en la interfaz de usuario de Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable hostName.value para leer un valor proporcionado por el usuario desde el campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza un nombre de host codificado para la integración, como "hostName.value":"my.hostname.com", luego establezca este valor en NONE.
fileBasedSFTPDestination.hostName.value Cadena El nombre de host del servidor SFTP. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como "hostName.value":"my.hostname.com".
port Número entero El puerto del servidor de archivos SFTP.
encryptionMode Cadena Indica si se debe utilizar el cifrado de archivos. Valores compatibles:
  • PGP
  • Ninguna

Azure Data Lake Storage (ADLS) servidor de destino

Este servidor de destino le permite exportar archivos que contengan datos de Adobe Experience Platform a su Azure Data Lake Storage cuenta.

El siguiente ejemplo muestra un ejemplo de configuración de servidor de destino para un 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 Descripción
name Cadena Nombre de la conexión de destino.
destinationServerType Cadena Establezca este valor según la plataforma de destino. Para Azure Data Lake Storage destinos, establezca esto en FILE_BASED_ADLS_GEN2.
fileBasedAdlsGen2Destination.path.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable path.value field.
  • Si desea que los usuarios introduzcan su ADLS ruta de la carpeta en la interfaz de usuario del Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable path.value para leer un valor del campo campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza una ruta codificada de forma rígida para la integración, como "abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/", luego establezca este valor en NONE.
fileBasedAdlsGen2Destination.path.value Cadena La ruta a su ADLS carpeta de almacenamiento. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/.

Azure Blob Storage servidor de destino

Este servidor de destino le permite exportar archivos que contengan datos de Adobe Experience Platform a su Azure Blob Storage contenedor.

El siguiente ejemplo muestra un ejemplo de configuración de servidor de destino para un 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 Descripción
name Cadena Nombre de la conexión de destino.
destinationServerType Cadena Establezca este valor según la plataforma de destino. Para Azure Blob Storage destinos, establezca esto en FILE_BASED_AZURE_BLOB.
fileBasedAzureBlobDestination.path.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable path.value field.
  • Si desea que los usuarios introduzcan los suyos propios Azure Blob URI de cuenta de almacenamiento en la interfaz de usuario del Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable path.value para leer el valor del campo campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza una ruta codificada de forma rígida para la integración, como "path.value": "https://myaccount.blob.core.windows.net/", luego establezca este valor en NONE.
fileBasedAzureBlobDestination.path.value Cadena La ruta a su Azure Blob almacenamiento. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como https://myaccount.blob.core.windows.net/.
fileBasedAzureBlobDestination.container.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable container.value field.
  • Si desea que los usuarios introduzcan los suyos propios Azure Blob nombre de contenedor en la interfaz de usuario del Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable container.value para leer el valor del campo campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza un nombre de contenedor incrustado en el código para la integración, como "path.value: myContainer", luego establezca este valor en NONE.
fileBasedAzureBlobDestination.container.value Cadena Nombre del contenedor de almacenamiento del blob de Azure que se utilizará para este destino. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como myContainer.

Data Landing Zone (DLZ) servidor de destino

Este servidor de destino le permite exportar archivos que contienen datos de Platform a un Data Landing Zone almacenamiento.

El siguiente ejemplo muestra un ejemplo de configuración de servidor de destino para una 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 Descripción
name Cadena Nombre de la conexión de destino.
destinationServerType Cadena Establezca este valor según la plataforma de destino. Para Data Landing Zone destinos, establezca esto en FILE_BASED_DLZ.
fileBasedDlzDestination.path.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable path.value field.
  • Si desea que los usuarios introduzcan los suyos propios Data Landing Zone en la interfaz de usuario de Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable path.value para leer un valor del campo campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza una ruta codificada de forma rígida para la integración, como "path.value": "https://myaccount.blob.core.windows.net/", luego establezca este valor en NONE.
fileBasedDlzDestination.path.value Cadena Ruta a la carpeta de destino que alojará los archivos exportados.

Google Cloud Storage servidor de destino

Este servidor de destino le permite exportar archivos que contengan datos de Platform a su Google Cloud Storage cuenta.

El siguiente ejemplo muestra un ejemplo de configuración de servidor de destino para una 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 Descripción
name Cadena Nombre de la conexión de destino.
destinationServerType Cadena Establezca este valor según la plataforma de destino. Para Google Cloud Storage destinos, establezca esto en FILE_BASED_GOOGLE_CLOUD.
fileBasedGoogleCloudStorageDestination.bucket.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable bucket.value field.
  • Si desea que los usuarios introduzcan los suyos propios Google Cloud Storage nombre del contenedor en la IU de Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable bucket.value para leer un valor del campo campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza un nombre de contenedor predefinido para su integración, como "bucket.value": "my-bucket", luego establezca este valor en NONE.
fileBasedGoogleCloudStorageDestination.bucket.value Cadena El nombre del Google Cloud Storage contenedor que utilizará este destino. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como "value": "my-bucket".
fileBasedGoogleCloudStorageDestination.path.templatingStrategy Cadena Requerido. Establezca este valor según el tipo de valor utilizado en la variable path.value field.
  • Si desea que los usuarios introduzcan los suyos propios Google Cloud Storage ruta del contenedor en la interfaz de usuario de Experience Platform, establezca este valor en PEBBLE_V1. En este caso, debe crear una plantilla de la variable path.value para leer un valor del campo campos de datos del cliente rellenado por el usuario. Este caso de uso se muestra en el ejemplo anterior.
  • Si utiliza una ruta codificada de forma rígida para la integración, como "path.value": "/path/to/my-bucket", luego establezca este valor en NONE.
fileBasedGoogleCloudStorageDestination.path.value Cadena La ruta al Google Cloud Storage carpeta que utilizará este destino. Puede ser un campo con plantilla que lea el valor del campos de datos del cliente rellenado por el usuario (como se muestra en el ejemplo anterior) o un valor codificado, como "value": "/path/to/my-bucket".

Pasos siguientes

Después de leer este artículo, debería comprender mejor qué es una especificación de servidor de destino y cómo puede configurarla.

Para obtener más información acerca de los demás componentes del servidor de destino, consulte los siguientes artículos:

En esta página