Verwenden des Destination SDK zum Konfigurieren eines Streaming-Ziels
Übersicht overview
Auf dieser Seite wird die Verwendung der Informationen unter Konfigurationsoptionen im Destinations SDK sowie anderen Destination SDK-Funktionen und API-Referenzdokumenten zum Konfigurieren eines Streaming-Ziels beschrieben. Die Schritte sind im Folgenden in der vorgegebenen Reihenfolge aufgeführt.
Voraussetzungen prerequisites
Bevor Sie mit den unten dargestellten Schritten fortfahren, lesen Sie die Seite Erste Schritte der Destination SDK , um Informationen zum Abrufen der erforderlichen Adobe I/O-Authentifizierungsberechtigungen und anderen Voraussetzungen für die Verwendung mit Destination SDK-APIs zu erhalten. Dies setzt voraus, dass Sie die Voraussetzungen für Partnerschaft und Berechtigung erfüllt haben und bereit sind, mit der Entwicklung Ihres Ziels zu beginnen.
Schritte zum Verwenden der Konfigurationsoptionen im Destination SDK zum Einrichten Ihres Ziels steps
Schritt 1: Erstellen einer Server- und Vorlagenkonfiguration create-server-template-configuration
Erstellen Sie zunächst einen Server und eine Vorlagenkonfiguration mithilfe des /destinations-server -Endpunkts.
Unten ist eine Beispielkonfiguration dargestellt. Beachten Sie, dass die Nachrichtenumwandlungsvorlage im requestBody.value-Parameter in Schritt 3, Erstellen einer Umwandlungsvorlage, behandelt wird.
POST platform.adobe.io/data/core/activation/authoring/destination-servers
{
"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":"insert after you create a template in step 3"
},
"contentType":"application/json"
}
}
Schritt 2: Erstellen einer Zielkonfiguration create-destination-configuration
Im Folgenden finden Sie eine Beispielkonfiguration für eine Zielvorlage, die mithilfe dem /destinations-API-Endpunkt erstellt wurde. Weitere Informationen finden Sie unter Erstellen einer Zielkonfiguration .
Um die Server- und Vorlagenkonfiguration in Schritt 1 mit dieser Zielkonfiguration zu verbinden, fügen Sie die Instanz-ID der Server- und Vorlagenkonfiguration hier als destinationServerId hinzu.
identityNamespaces mindestens eine Zielidentität hinzufügen, wie unten dargestellt. Wenn keine Zielidentität konfiguriert ist, können Benutzer nicht über den Zuordnungsschritt des Aktivierungs-Workflows hinausgehen.POST platform.adobe.io/data/core/activation/authoring/destinations
{
"name":"Moviestar",
"description":"Moviestar is a fictional destination, used for this example.",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
],
"customerDataFields":[
{
"name":"endpointsInstance",
"type":"string",
"title":"Select Endpoint",
"description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
"isRequired":true,
"enum":[
"US",
"EU",
"APAC",
"NZ"
]
},
{
"name":"customerID",
"type":"string",
"title":"Moviestar Customer ID",
"description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
"isRequired":true,
"pattern":""
}
],
"uiAttributes":{
"documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
"category":"mobile",
"connectionType":"Server-to-server",
"frequency":"Streaming"
},
"identityNamespaces":{
"external_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
},
"another_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
}
},
"audienceMetadataConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"aggregation":{
"aggregationType":"CONFIGURABLE_AGGREGATION",
"configurableAggregation":{
"aggregationPolicyId":null,
"aggregationKey":{
"includeSegmentId":true,
"includeSegmentStatus":true,
"includeIdentity":true,
"oneIdentityPerGroup":true,
"groups":null
},
"splitUserById":true,
"maxBatchAgeInSecs":2400,
"maxNumEventsInBatch":5000
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
]
}
Schritt 3: Erstellen einer Nachrichtenumwandlungsvorlage – Verwenden Sie die Vorlagensprache, um das Ausgabeformat der Nachricht anzugeben create-transformation-template
Basierend auf den Payloads, die das Ziel unterstützt, müssen Sie eine Vorlage erstellen, die das Format der exportierten Daten aus dem Adobe-XDM-Format in ein vom Ziel unterstütztes Format umwandelt. Siehe Vorlagenbeispiele im Abschnitt Verwenden einer Vorlagensprache für die Transformationen von Identität, Attributen und Zielgruppenzugehörigkeit und verwenden Sie das von Adobe bereitgestellte Vorlagen-Authoring-Tool.
Nachdem Sie eine Vorlage für die Nachrichtenumwandlung erstellt haben, die Ihren Anforderungen entspricht, fügen Sie sie der Server- und Vorlagenkonfiguration hinzu, die Sie in Schritt 1 erstellt haben.
{
"name":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{\n \"users\": [\n {% for profile in input.profiles %}\n {{profile|raw}}{% if not loop.last %},{% endif %}\n {% endfor %}\n ]\n}"
},
"contentType":"application/json"
}
}
Schritt 4: Erstellen der Zielgruppen-Metadatenkonfiguration create-audience-metadata-configuration
Für einige Ziele erfordert das Destination SDK, dass Sie eine Zielgruppen-Metadatenkonfiguration konfigurieren, um Zielgruppen in Ihrem Ziel programmgesteuert zu erstellen, zu aktualisieren oder zu löschen. Informationen dazu, wann Sie diese Konfiguration einrichten müssen und wie Sie sie durchführen, finden Sie unter Zielgruppen-Metadatenverwaltung.
Wenn Sie eine Zielgruppen-Metadatenkonfiguration verwenden, müssen Sie diese mit der Zielkonfiguration verbinden, die Sie in Schritt 2 erstellt haben. Fügen Sie Ihrer Zielkonfiguration die Instanz-ID Ihrer Zielgruppen-Metadatenkonfiguration als audienceTemplateId hinzu.
{
"name":"Moviestar",
"description":"Moviestar is a fictional destination, used for this example.",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
],
"customerDataFields":[
{
"name":"endpointsInstance",
"type":"string",
"title":"Select Endpoint",
"description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
"isRequired":true,
"enum":[
"US",
"EU",
"APAC",
"NZ"
]
},
{
"name":"customerID",
"type":"string",
"title":"Moviestar Customer ID",
"description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
"isRequired":true,
"pattern":""
}
],
"uiAttributes":{
"documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
"category":"mobile",
"connectionType":"Server-to-server",
"frequency":"Streaming"
},
"identityNamespaces":{
"external_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
},
"another_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
}
},
"audienceMetadataConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"aggregation":{
"aggregationType":"CONFIGURABLE_AGGREGATION",
"configurableAggregation":{
"aggregationPolicyId":null,
"aggregationKey":{
"includeSegmentId":true,
"includeSegmentStatus":true,
"includeIdentity":true,
"oneIdentityPerGroup":true,
"groups":null
},
"splitUserById":true,
"maxBatchAgeInSecs":2400,
"maxNumEventsInBatch":5000
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
]
}
Schritt 5: Einrichten der Authentifizierung set-up-authentication
Je nachdem, ob Sie In der obigen Zielkonfiguration "authenticationRule": "CUSTOMER_AUTHENTICATION" oder "authenticationRule": "PLATFORM_AUTHENTICATION" angeben, können Sie unter Verwendung des Endpunkts /destination oder /credentials die Authentifizierung für Ihr Ziel einrichten.
CUSTOMER_AUTHENTICATION ist die gängigere der beiden Authentifizierungsregeln und die zu verwendende, wenn Sie von Benutzern verlangen, dass sie für Ihr Ziel eine bestimmte Form der Authentifizierung bereitstellen, bevor sie eine Verbindung herstellen und Daten exportieren können.Wenn Sie in der Zielkonfiguration ""authenticationRule": "CUSTOMER_AUTHENTICATION""ausgewählt haben und Ihr Ziel die OAuth 2-Authentifizierungsmethode unterstützt, lesen Sie den Abschnitt "OAuth 2-Authentifizierung".
Wenn Sie ""authenticationRule": "PLATFORM_AUTHENTICATION""ausgewählt haben, müssen Sie eine Konfiguration der Anmeldedaten erstellen.
Schritt 6: Testen des Ziels test-destination
Nachdem Sie das Ziel mit den Konfigurationsendpunkten in den vorherigen Schritten eingerichtet haben, können Sie das Zieltest-Tool verwenden, um die Integration zwischen Adobe Experience Platform und Ihrem Ziel zu testen.
Im Rahmen des Testvorgangs Ihres Ziels müssen Sie die Experience Platform-Benutzeroberfläche zum Erstellen von Segmenten verwenden, die Sie für Ihr Ziel aktivieren. Anweisungen zum Erstellen von Zielgruppen in Experience Platform finden Sie in den beiden unten stehenden Ressourcen:
Schritt 7: Veröffentlichen des Ziels publish-destination
Verwenden Sie nach dem Konfigurieren und Testen Ihres Ziels die Zielveröffentlichungs-API, um Ihre Konfiguration zur Überprüfung an Adobe zu senden.
Schritt 8: Dokumentieren des Ziels document-destination
Wenn Sie ein unabhängiger Software-Anbieter (ISV) oder Systemintegrator (SI) sind, der eine produktbezogene Integration erstellt, verwenden Sie den Self-Service-Dokumentationsprozess, um eine Produktdokumentationsseite für Ihr Ziel im Experience Platform-Zielkatalog zu erstellen.
Schritt 9: Senden des Ziels für die Adobe submit-for-review
Bevor das Ziel im Experience Platform-Katalog veröffentlicht und für alle Experience Platform-Kunden sichtbar ist, müssen Sie das Ziel offiziell zur Adobe-Überprüfung einreichen. Finden Sie vollständige Informationen darüber, wie Sie ein in Destination SDK erstelltes produktionalisiertes Ziel zur Überprüfung einreichen können.