Erstellen einer Zielkonfiguration
- Themen:
- Ziele
Erstellt für:
- Admin
- Benutzende
Diese Seite veranschaulicht die API-Anfrage und die Payload, die Sie verwenden können, um Ihre eigene Zielkonfiguration unter Verwendung des API-Endpunkts /authoring/destinations
zu erstellen.
Eine ausführliche Beschreibung der Funktionen, die Sie über diesen Endpunkt konfigurieren können, finden Sie in den folgenden Artikeln:
- Konfiguration der Kundenauthentifizierung
- OAuth2-Autorisierung
- Benutzerdefinierte Datenfelder
- Benutzeroberflächenattribute
- Schemakonfiguration
- Konfiguration von Identity-Namespaces
- Zielbereitstellung
- Konfiguration von Zielgruppen-Metadaten
- Konfiguration von Zielgruppen-Metadaten
- Aggregationsrichtlinie
- Batch-Konfiguration
- Historische Profilqualifikationen
Erste Schritte mit API-Vorgängen für die Zielkonfiguration
Bevor Sie fortfahren, lesen Sie Erste Schritte. Dort finden Sie die nötigen Informationen für den erfolgreichen Aufruf der API, einschließlich Details für den Abruf der erforderlichen Authoring-Berechtigung für Ziele und zu den erforderlichen Kopfzeilen.
Erstellen einer Zielkonfiguration
Sie können eine neue Zielkonfiguration erstellen, indem Sie eine POST-Anfrage an den Endpunkt /authoring/destinations
senden.
platform.adobe.io/data/core/activation/authoring/destinations
API-Format
POST /authoring/destinations
Die folgende Anfrage erstellt eine neue Amazon S3-Zielkonfiguration, die durch die in der Payload bereitgestellten Parameter konfiguriert wird. Die nachstehende Payload enthält alle Parameter für dateibasierte Ziele, die vom Endpunkt /authoring/destinations
akzeptiert werden.
Beachten Sie, dass Sie nicht alle Parameter für den API-Aufruf hinzufügen müssen und dass die Payload entsprechend Ihren API-Anforderungen angepasst werden kann.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
-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":"Amazon S3 destination with predefined CSV formatting options",
"description":"Amazon S3 destination with predefined CSV formatting options",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"S3"
}
],
"customerDataFields":[
{
"name":"bucket",
"title":"Enter the name of your Amazon S3 bucket",
"description":"Amazon S3 bucket name",
"type":"string",
"isRequired":true,
"readOnly":false,
"hidden":false
},
{
"name":"path",
"title":"Enter the path to your S3 bucket folder",
"description":"Enter the path to your S3 bucket folder",
"type":"string",
"isRequired":true,
"pattern":"^[A-Za-z]+$",
"readOnly":false,
"hidden":false
},
{
"name":"compression",
"title":"Compression format",
"description":"Select the desired file compression format.",
"type":"string",
"isRequired":true,
"readOnly":false,
"enum":[
"SNAPPY",
"GZIP",
"DEFLATE",
"NONE"
]
},
{
"name":"fileType",
"title":"Select a fileType",
"description":"Select fileType",
"type":"string",
"isRequired":true,
"readOnly":false,
"hidden":false,
"enum":[
"csv",
"json",
"parquet"
],
"default":"csv"
}
],
"uiAttributes":{
"documentationLink":"https://www.adobe.com/go/destinations-amazon-s3-en",
"category":"cloudStorage",
"icon":{
"key":"amazonS3"
},
"connectionType":"S3",
"frequency":"Batch"
},
"destinationDelivery":[
{
"deliveryMatchers":[
{
"type":"SOURCE",
"value":[
"batch"
]
}
],
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"{{destinationServerId}}"
}
],
"schemaConfig":{
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
},
"batchConfig":{
"allowMandatoryFieldSelection":true,
"allowDedupeKeyFieldSelection":true,
"defaultExportMode":"DAILY_FULL_EXPORT",
"allowedExportMode":[
"DAILY_FULL_EXPORT",
"FIRST_FULL_THEN_INCREMENTAL"
],
"allowedScheduleFrequency":[
"DAILY",
"EVERY_3_HOURS",
"EVERY_6_HOURS",
"EVERY_8_HOURS",
"EVERY_12_HOURS",
"ONCE"
],
"defaultFrequency":"DAILY",
"defaultStartTime":"00:00",
"filenameConfig":{
"allowedFilenameAppendOptions":[
"SEGMENT_NAME",
"DESTINATION_INSTANCE_ID",
"DESTINATION_INSTANCE_NAME",
"ORGANIZATION_NAME",
"SANDBOX_NAME",
"DATETIME",
"CUSTOM_TEXT"
],
"defaultFilenameAppendOptions":[
"DATETIME"
],
"defaultFilename":"%DESTINATION%_%SEGMENT_ID%"
},
"backfillHistoricalProfileData":true
}
}'
name
description

status
TEST
, PUBLISHED
und DELETED
. Verwenden Sie TEST
, wenn Sie Ihr Ziel zum ersten Mal konfigurieren.customerAuthenticationConfigurations.authType
customerDataFields.name
Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen.

customerDataFields.type
string
, object
, integer
.Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen.
customerDataFields.title
Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen.
customerDataFields.description
customerDataFields.isRequired
Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen.
customerDataFields.enum
Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen.
customerDataFields.default
enum
-Liste.customerDataFields.pattern
^[A-Za-z]+$
ein.Siehe Kundendatenfelder für detaillierte Informationen zu diesen Einstellungen.
uiAttributes.documentationLink
https://www.adobe.com/go/destinations-YOURDESTINATION-en
, wobei YOURDESTINATION
für den Namen Ihres Ziels steht. Für ein Ziel mit dem Namen „Moviestar“ würden Sie https://www.adobe.com/go/destinations-moviestar-en
verwenden. Beachten Sie, dass dieser Link nur funktioniert, wenn Adobe Ihr Ziel live stellt und die Dokumentation veröffentlicht wird.Siehe Benutzeroberflächenattribute für detaillierte Informationen zu diesen Einstellungen.

uiAttributes.category
adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments
.Siehe Benutzeroberflächenattribute für detaillierte Informationen zu diesen Einstellungen.
uiAttributes.connectionType
Der Verbindungstyp, je nach Ziel. Unterstützte Werte:
Server-to-server
Cloud storage
Azure Blob
Azure Data Lake Storage
S3
SFTP
DLZ
uiAttributes.frequency
Streaming
für API-basierte Integrationen oder auf Batch
, wenn Sie Dateien in Ihre Ziele exportieren.identityNamespaces.externalId.acceptsAttributes
identityNamespaces.externalId.acceptsCustomNamespaces
identityNamespaces.externalId.transformation
identityNamespaces.externalId.acceptedGlobalNamespaces
Wenn Sie
acceptedGlobalNamespaces
verwenden, können Sie E-Mail-Adressen oder Telefonnummern mithilfe von "requiredTransformation":"sha256(lower($))"
in Kleinbuchstaben umwandeln und hashen.destinationDelivery.authenticationRule
Gibt an, wie Platform-Kundinnen und -Kunden eine Verbindung zu Ihrem Ziel herstellen. Akzeptierte Werte sind CUSTOMER_AUTHENTICATION
, PLATFORM_AUTHENTICATION
, NONE
.
- Verwenden Sie
CUSTOMER_AUTHENTICATION
, wenn sich Platform-Kundinnen und -Kunden über einen Benutzernamen und ein Kennwort, ein Bearer-Token oder eine andere Authentifizierungsmethode bei Ihrem System anmelden. Sie würden diese Option beispielsweise auswählen, wenn Sie auchauthType: OAUTH2
oderauthType:BEARER
incustomerAuthenticationConfigurations
ausgewählt haben. - Verwenden Sie
PLATFORM_AUTHENTICATION
, wenn ein globales Authentifizierungssystem zwischen Adobe und Ihrem Ziel existiert und der Platform-Kunde keine Authentifizierungs-Anmeldedaten bereitstellen muss, um eine Verbindung zu Ihrem Ziel herzustellen. In diesem Fall müssen Sie ein Anmeldedaten-Objekt mithilfe der Konfiguration der Anmeldedaten-API erstellen. - Verwenden Sie
NONE
, wenn keine Authentifizierung erforderlich ist, um Daten an Ihre Zielplattform zu senden.
destinationDelivery.destinationServerId
instanceId
der Ziel-Server-Vorlage, die für dieses Ziel verwendet wird.backfillHistoricalProfileData
true
.segmentMappingConfig.mapUserInput
segmentMappingConfig.mapExperiencePlatformSegmentId
segmentMappingConfig.mapExperiencePlatformSegmentName
segmentMappingConfig.audienceTemplateId
instanceId
der Zielgruppen-Metadatenvorlage, die für dieses Ziel verwendet wird.schemaConfig.profileFields
profileFields
wie in der obigen Konfiguration können Benutzerinnen und Benutzer die Attribute von Experience Platform den vordefinierten Attributen Ihres Ziels zuordnen.schemaConfig.profileRequired
true
, wenn Benutzerinnen und Benutzer die Zuordnung von Profilattributen aus Experience Platform zu benutzerdefinierten Attributen des Ziels vornehmen dürfen, wie in der obigen Beispielkonfiguration dargestellt.schemaConfig.segmentRequired
segmentRequired:true
.schemaConfig.identityRequired
true
, wenn Benutzerinnen und Benutzer die Zuordnung von Identity-Namespaces von Experience Platform zu Ihrem gewünschten Schema vornehmen dürfen.Umgang mit API-Fehlern
Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen von Experience Platform API-Fehlermeldungen. Siehe API-Status-Codes und Fehler im Anfrage-Header in der Anleitung zur Fehlerbehebung für Platform.
Nächste Schritte
Nach dem Lesen dieses Dokuments wissen Sie jetzt, wie Sie über den API-Endpunkt /authoring/destinations
von Destination SDK eine neue Zielkonfiguration erstellen.
Weitere Informationen dazu, was Sie mit diesem Endpunkt tun können, finden Sie in den folgenden Artikeln:
Informationen dazu, wo dieser Endpunkt in den Prozess zur Zielbearbeitung passt, finden Sie in den folgenden Artikeln: