Server-Spezifikationen für Ziele, die mit Destination SDK erstellt wurden
Ziel-Server-Spezifikationen definieren den Typ der Zielplattform, die die Daten von Adobe Experience Platform erhält, sowie die Kommunikationsparameter zwischen Platform und Ihrem Ziel. Beispiel:
- Eine Streaming-Ziel-Server-Spezifikation definiert den HTTP-Server-Endpunkt, der die HTTP-Nachrichten von Platform erhält. Informationen zum Konfigurieren der Formatierung der HTTP-Aufrufe an den Endpunkt finden Sie auf der Seite Spezifikationen für Vorlagentypen.
- Eine Amazon S3-Ziel-Server-Spezifikation definiert den S3-Behälternamen und -Pfad, in den Platform die Dateien exportiert.
- Eine SFTP-Ziel-Server-Spezifikation definiert den Host-Namen, das Stammverzeichnis, den Kommunikations-Port und den Verschlüsselungstyp des SFTP-Servers, auf den Platform die Dateien exportiert.
Informationen dazu, wo diese Komponente in eine mit Destination SDK erstellte Integration passt, finden Sie im Diagramm in der Dokumentation zu Konfigurationsoptionen oder auf den folgenden Übersichtsseiten zur Zielkonfiguration:
Sie können die Ziel-Server-Spezifikationen über den Endpunkt /authoring/destination-servers
konfigurieren. Detaillierte Beispiele für API-Aufrufe, in denen Sie die auf dieser Seite angezeigten Komponenten konfigurieren können, finden Sie auf den folgenden API-Referenzseiten.
Auf dieser Seite werden alle von Destination SDK unterstützten Ziel-Server-Typen mit allen Konfigurationsparametern angezeigt. Ersetzen Sie beim Erstellen Ihres Ziels die Parameterwerte durch Ihre eigenen.
Unterstützte Integrationstypen supported-integration-types
Die nachstehende Tabelle beschreibt ausführlich, welche Integrationstypen die auf dieser Seite beschriebenen Funktionen unterstützen.
Wenn Sie einen Ziel-Server erstellen oder aktualisieren, verwenden Sie eine der auf dieser Seite beschriebenen Konfigurationen des Server-Typs. Stellen Sie je nach Integrationsanforderungen sicher, dass Sie die Beispielparameterwerte aus diesen Beispielen durch Ihre eigenen ersetzen.
Hartcodierte bzw. vorlagenbasierte Felder templatized-fields
Bei der Erstellung eines Ziel-Servers durch Destination SDK können Sie die Parameterwerte für die Konfiguration entweder durch eine Hartcodierung in die Konfiguration oder durch Verwendung von Vorlagenfeldern definieren. Mit vorlagenbasierten Feldern können Sie von Benutzenden bereitgestellte Werte aus der Platform-Benutzeroberfläche lesen.
Die Ziel-Server-Parameter haben zwei konfigurierbare Felder. Diese Optionen bestimmen, ob Sie hartcodierte oder vorlagenbasierte Werte verwenden.
templatingStrategy
Erforderlich. Definiert, ob ein hartcodierter Wert vorhanden ist, der über das Feld value
bereitgestellt wird, oder ein von Benutzenden konfigurierbarer Wert in der Benutzeroberfläche. Unterstützte Werte:
NONE
: Verwenden Sie diesen Wert, wenn Sie den Parameterwert über den Parametervalue
hartcodieren (siehe nächste Zeile). Beispiel:"value": "my-storage-bucket"
.PEBBLE_V1
: Verwenden Sie diesen Wert, wenn Ihre Benutzerinnen und Benutzer in der Benutzeroberfläche einen Parameterwert angeben sollen. Beispiel:"value": "{{customerData.bucket}}"
.
value
Erforderlich. Definiert den Parameterwert. Unterstützte Werttypen:
- Hartcodierter Wert: Verwenden Sie einen hartcodierten Wert (z. B.
"value": "my-storage-bucket"
), wenn Benutzerinnen und Benutzer keinen Parameterwert in der Benutzeroberfläche eingeben müssen. Beim Hartcodieren eines Werts solltetemplatingStrategy
immer aufNONE
festgelegt werden. - Vorlagenwert: Verwenden Sie einen Vorlagenwert (z. B.
"value": "{{customerData.bucket}}"
), wenn Ihre Benutzerinnen und Benutzer einen Parameterwert in der Benutzeroberfläche angeben sollen. Bei Verwendung von Vorlagenwerten solltetemplatingStrategy
immer aufPEBBLE_V1
festgelegt werden.
Wann hartcodierte bzw. vorlagenbasierte Felder verwendet werden sollten
Sowohl hartcodierte als auch vorlagenbasierte Felder haben ihre eigene Verwendung in Destination SDK, je nachdem, welche Art von Integration Sie erstellen.
Herstellen einer Verbindung zu Ihrem Ziel ohne Benutzereingabe
Wenn Benutzerinnen und Benutzer in der Platform-Benutzeroberfläche eine Verbindung zu Ihrem Ziel herstellen, möchten Sie vielleicht den Verbindungsprozess zum Ziel ohne Benutzereingabe abwickeln.
Dazu können Sie die Verbindungsparameter der Zielplattform in der Server-Spezifikation hartcodieren. Wenn Sie in Ihrer Ziel-Server-Konfiguration hartcodierte Parameterwerte verwenden, wird die Verbindung zwischen Adobe Experience Platform und Ihrer Zielplattform ohne Benutzereingabe veranlasst.
Im folgenden Beispiel erstellt ein Partner einen Data Landing Zone(DLZ)-Ziel-Server, wobei das Feld path.value
hartcodiert ist…
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"NONE",
"value":"Your/hardcoded/path/here"
},
"useCase": "Your use case"
}
}
Wenn Benutzerinnen und Benutzer das Tutorial zur Zielverbindung durchlaufen, sehen sie also keinen Authentifizierungsschritt. Stattdessen wird die Authentifizierung von Platform durchgeführt, wie in der Abbildung unten dargestellt.
Herstellen einer Verbindung zu Ihrem Ziel mit Benutzereingabe
Wenn die Verbindung zwischen Platform und Ihrem Ziel anhand einer bestimmten Benutzereingabe in der Platform-Benutzeroberfläche hergestellt werden soll, z. B. durch Auswahl eines API-Endpunkts oder Angabe eines Feldwerts, können Sie in der Server-Spezifikation vorlagenbasierte Felder verwenden, um die Benutzereingabe zu lesen und eine Verbindung mit Ihrer Zielplattform herzustellen.
Im folgenden Beispiel erstellt ein Partner eine Echtzeit (Streaming)-Integration, und das Feld url.value
verwendet den Vorlagenparameter {{customerData.region}}
, um einen Teil des API-Endpunkts basierend auf der Benutzereingabe zu personalisieren.
{
"name":"Templatized API endpoint example",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.yourcompany.com/data/{{customerData.region}}/items"
}
}
}
Damit Benutzerinnen und Benutzer einen Wert in der Platform-Benutzeroberfläche auswählen können, muss der Parameter region
auch in der Zielkonfiguration als Kundendatenfeld definiert werden, wie unten dargestellt:
"customerDataFields":[
{
"name":"region",
"title":"Region",
"description":"Select an option",
"type":"string",
"isRequired":true,
"readOnly":false,
"enum":[
"US",
"EU"
]
}
Wenn Benutzerinnen und Benutzer das Tutorial zur Zielverbindung durchlaufen, müssen sie dann erst eine Region auswählen, bevor sie eine Verbindung zur Zielplattform herstellen können. Wenn sie eine Verbindung zum Ziel herstellen, wird das Vorlagenfeld {{customerData.region}}
durch den Wert ersetzt, den sie in der Benutzeroberfläche ausgewählt haben, wie in der Abbildung unten dargestellt.
Echtzeit-Ziel-Server (Streaming) streaming-example
Mit diesem Ziel-Server-Typ können Sie Daten von Adobe Experience Platform über HTTP-Anfragen an Ihr Ziel exportieren. Die Server-Konfiguration enthält Informationen zum Server, der die Nachrichten erhält (der Server auf Ihrer Seite).
Dieser Prozess stellt Benutzerdaten als eine Reihe von HTTP-Nachrichten an Ihre Zielplattform bereit. Die folgenden Parameter bilden die Vorlage für HTTP-Server-Spezifikationen.
Das folgende Beispiel zeigt ein Beispiel einer Ziel-Server-Konfiguration für ein Echtzeit-Ziel (Streaming).
{
"name":"Your destination server name",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"{YOUR_API_ENDPOINT}"
}
}
}
name
Moviestar destination server
.destinationServerType
URL_BASED
fest.templatingStrategy
Erforderlich.
- Verwenden Sie
PEBBLE_V1
, wenn Sie im Feldvalue
einen hartcodierten Wert verwenden und nicht ein Vorlagenfeld. Verwenden Sie diese Option, wenn Sie einen Endpunkt wiehttps://api.moviestar.com/data/{{customerData.region}}/items
haben, wo die Benutzerinnen und Benutzer die Region des Endpunkts in der Platform-Benutzeroberfläche auswählen müssen. - Verwenden Sie
NONE
, wenn auf Seiten von Adobe keine vorlagenbasierte Transformation erforderlich ist, z. B. wenn Sie einen Endpunkt wiehttps://api.moviestar.com/data/items
haben.
value
Amazon S3-Ziel-Server s3-example
Mit diesem Ziel-Server können Sie Dateien, die Adobe Experience Platform-Daten enthalten, in Ihren Amazon S3-Speicher exportieren.
Das folgende Beispiel zeigt ein Beispiel einer Ziel-Server-Konfiguration für ein Amazon S3-Ziel.
{
"name":"Amazon S3 destination",
"destinationServerType":"FILE_BASED_S3",
"fileBasedS3Destination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
name
destinationServerType
FILE_BASED_S3
.fileBasedS3Destination.bucket.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld bucket.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren eigenen Behälternamen in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das Feldvalue
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten Behälternamen für Ihre Integration verwenden, z. B.
"bucket.value":"MyBucket"
, setzen Sie diesen Wert aufNONE
.
fileBasedS3Destination.bucket.value
"value":"MyBucket"
.fileBasedS3Destination.path.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld path.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren eigenen Pfad in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das Feldpath.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten für Ihre Integration verwenden, z. B.
"bucket.value":"/path/to/MyBucket"
, setzen Sie diesen Wert aufNONE
.
fileBasedS3Destination.path.value
"value":"/path/to/MyBucket"
.SFTP-Ziel-Server sftp-example
Mit diesem Ziel-Server können Sie Dateien mit Adobe Experience Platform-Daten in Ihren SFTP Speicher-Server exportieren.
Das folgende Beispiel zeigt ein Beispiel einer Ziel-Server-Konfiguration für ein SFTP-Ziel.
{
"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"
}
}
name
destinationServerType
FILE_BASED_SFTP
.fileBasedSFTPDestination.rootDirectory.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld rootDirectory.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren eigenen Stammordnerpfad in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das FeldrootDirectory.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten Stammordnerpfad für Ihre Integration verwenden, z. B.
"rootDirectory.value":"Storage/MyDirectory"
, setzen Sie diesen Wert aufNONE
.
fileBasedSFTPDestination.rootDirectory.value
"value":"Storage/MyDirectory"
.fileBasedSFTPDestination.hostName.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld hostName.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren eigenen Host-Namen in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das FeldhostName.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten Host-Namen für Ihre Integration verwenden, z. B.
"hostName.value":"my.hostname.com"
, setzen Sie diesen Wert aufNONE
.
fileBasedSFTPDestination.hostName.value
"hostName.value":"my.hostname.com"
.port
encryptionMode
Gibt an, ob eine Dateiverschlüsselung verwendet werden soll. Unterstützte Werte:
- PGP
- Keine
Azure Data Lake Storage (ADLS) -Ziel-Server adls-example
Mit diesem Ziel-Server können Sie Dateien mit Adobe Experience Platform-Daten in Ihr Azure Data Lake Storage-Konto exportieren.
Das folgende Beispiel zeigt ein Beispiel einer Ziel-Server-Konfiguration für ein Azure Data Lake Storage-Ziel.
{
"name":"ADLS destination server",
"destinationServerType":"FILE_BASED_ADLS_GEN2",
"fileBasedAdlsGen2Destination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
}
}
name
destinationServerType
FILE_BASED_ADLS_GEN2
.fileBasedAdlsGen2Destination.path.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld path.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren ADLS-Ordnerpfad in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das Feldpath.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten für Ihre Integration verwenden, z. B.
"abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/"
, setzen Sie diesen Wert aufNONE
.
fileBasedAdlsGen2Destination.path.value
abfs://<file_system>@<account_name>.dfs.core.windows.net/<path>/
.Azure Blob Storage-Ziel-Server blob-example
Mit diesem Ziel-Server können Sie Dateien mit Adobe Experience Platform-Daten in Ihren Azure Blob Storage-Container exportieren.
Das folgende Beispiel zeigt ein Beispiel einer Ziel-Server-Konfiguration für ein Azure Blob Storage-Ziel.
{
"name":"Blob destination server",
"destinationServerType":"FILE_BASED_AZURE_BLOB",
"fileBasedAzureBlobDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"container":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.container}}"
}
}
}
name
destinationServerType
FILE_BASED_AZURE_BLOB
.fileBasedAzureBlobDestination.path.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld path.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren eigenen Azure Blob Speicherkonto-URI in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das Feldpath.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten für Ihre Integration verwenden, z. B.
"path.value": "https://myaccount.blob.core.windows.net/"
, setzen Sie diesen Wert aufNONE
.
fileBasedAzureBlobDestination.path.value
https://myaccount.blob.core.windows.net/
.fileBasedAzureBlobDestination.container.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld container.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren eigenen Azure Blob-Container-Namen in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das Feldcontainer.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten Container-Namen für Ihre Integration verwenden, z. B.
"path.value: myContainer"
, setzen Sie diesen Wert aufNONE
.
fileBasedAzureBlobDestination.container.value
myContainer
.Data Landing Zone (DLZ) -Ziel-Server dlz-example
Mit diesem Ziel-Server können Sie Dateien mit Platform-Daten in einen Data Landing Zone-Speicher exportieren.
Das folgende Beispiel zeigt ein Beispiel einer Ziel-Server-Konfiguration für ein Data Landing Zone-Ziel (DLZ).
{
"name":"Data Landing Zone destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"useCase": "Your use case"
}
}
name
destinationServerType
FILE_BASED_DLZ
.fileBasedDlzDestination.path.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld path.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihr eigenes Data Landing Zone -Konto in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das Feldpath.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten für Ihre Integration verwenden, z. B.
"path.value": "https://myaccount.blob.core.windows.net/"
, setzen Sie diesen Wert aufNONE
.
fileBasedDlzDestination.path.value
Google Cloud Storage-Ziel-Server gcs-example
Mit diesem Ziel-Server können Sie Dateien mit Platform-Daten in Ihr Google Cloud Storage -Konto exportieren.
Das folgende Beispiel zeigt ein Beispiel einer Ziel-Server-Konfiguration für ein Google Cloud Storage-Ziel.
{
"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}}"
}
}
}
name
destinationServerType
FILE_BASED_GOOGLE_CLOUD
.fileBasedGoogleCloudStorageDestination.bucket.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld bucket.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren eigenen Google Cloud Storage-Behälternamen in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das Feldbucket.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten Behälternamen für Ihre Integration verwenden, z. B.
"bucket.value": "my-bucket"
, setzen Sie diesen Wert aufNONE
.
fileBasedGoogleCloudStorageDestination.bucket.value
"value": "my-bucket"
.fileBasedGoogleCloudStorageDestination.path.templatingStrategy
Erforderlich. Legen Sie diesen Wert entsprechend dem Typ des im Feld path.value
verwendeten Wertes fest.
- Wenn Sie möchten, dass Ihre Benutzerinnen und Benutzer ihren eigenen Google Cloud Storage-Behälterpfad in der Experience Platform-Benutzeroberfläche eingeben, setzen Sie diesen Wert auf
PEBBLE_V1
. In diesem Fall müssen Sie das Feldpath.value
mit einer Vorlage versehen, um einen Wert aus den Kundendatenfeldern, die von den Benutzenden ausgefüllt werden, zu lesen. Dieser Anwendungsfall wird im obigen Beispiel gezeigt. - Wenn Sie einen hartcodierten für Ihre Integration verwenden, z. B.
"path.value": "/path/to/my-bucket"
, setzen Sie diesen Wert aufNONE
.
fileBasedGoogleCloudStorageDestination.path.value
"value": "/path/to/my-bucket"
.Nächste Schritte next-steps
Nach dem Lesen dieses Artikels sollten Sie besser verstehen, was eine Spezifikation für den Ziel-Server ist und wie Sie diese konfigurieren können.
Weitere Informationen zu den anderen Ziel-Server-Komponenten finden Sie in den folgenden Artikeln: