Konfigurieren eines Datensatz-Exportziels

Überblick overview

Auf dieser Seite wird beschrieben, wie Sie mit Destination SDK ein Ziel konfigurieren, das Datensatzexporte) ​. Verwenden Sie ein Ziel für den Datensatzexport, um Rohdatensätze aus Experience Platform für Berichte, Datenwissenschafts-Workflows und viele andere Anwendungsfälle in externe Speicherorte zu exportieren.

In diesem Handbuch wird Amazon S3 als Beispiel verwendet, aber die gleichen Konfigurationsprinzipien gelten für alle dateibasierten Zieltypen, die von Destination SDK unterstützt werden (Azure Blob Storage, SFTP, Azure Data Lake Storage Gen2, Google Cloud Storage und Data Landing Zone).

Detaillierte Beschreibungen aller in diesem Handbuch verwendeten Parameter finden Sie unter Konfigurationsoptionen in Destination SDK.

Voraussetzungen prerequisites

Bevor Sie mit den unten beschriebenen Schritten fortfahren, informieren Sie sich auf der Seite Erste Schritte mit Destination SDK , wie Sie die erforderlichen Adobe I/O-Authentifizierungsdaten und andere Voraussetzungen für die Arbeit mit Destination SDK-APIs erhalten.

Schritt 1: Erstellen einer Server- und Dateikonfiguration create-server-file-configuration

Verwenden Sie zunächst den /destination-servers-Endpunkt, um eine Server- und Dateikonfiguration zu erstellen.

API-Format

POST platform.adobe.io/data/core/activation/authoring/destination-servers

Anfrage

Die folgende Anfrage erstellt eine neue Ziel-Server-Konfiguration für ein Amazon S3. Die fileType- und compression werden als Vorlagen erstellt, d. h. sie werden vom Kunden zur Zielverbindungszeit über die customerDataFields bereitgestellt, die Sie im nächsten Schritt definieren.

curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
 -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 dataset export destination server",
   "destinationServerType":"FILE_BASED_S3",
   "fileBasedS3Destination":{
      "bucket":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.bucketName}}"
      },
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      }
   },
   "fileConfigurations":{
      "compression":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.compression}}"
      },
      "fileType":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.fileType}}"
      },
      "csvOptions":{
         "quoteAll":{
            "templatingStrategy":"NONE",
            "value":"false"
         },
         "header":{
            "templatingStrategy":"NONE",
            "value":"true"
         },
         "ignoreLeadingWhiteSpace":{
            "templatingStrategy":"NONE",
            "value":"true"
         },
         "ignoreTrailingWhiteSpace":{
            "templatingStrategy":"NONE",
            "value":"true"
         },
         "nullValue":{
            "templatingStrategy":"NONE",
            "value":""
         },
         "dateFormat":{
            "templatingStrategy":"NONE",
            "value":"yyyy-MM-dd"
         },
         "timestampFormat":{
            "templatingStrategy":"NONE",
            "value":"yyyy-MM-dd'\''T'\'':mm:ss[.SSS][XXX]"
         }
      }
   }
}'

Eine erfolgreiche Antwort gibt die neue Ziel-Server-Konfiguration zurück, einschließlich der eindeutigen Kennung (instanceId) der Konfiguration. Speichern Sie diesen Wert, da er im nächsten Schritt erforderlich ist.

Schritt 2: Erstellen einer Zielkonfiguration create-destination-configuration

Nachdem Sie im vorherigen Schritt die Ziel-Server-Konfiguration erstellt haben, verwenden Sie den API-Endpunkt /destinations , um die Zielkonfiguration zu erstellen.

Um die Server-Konfiguration von Schritt 1 mit dieser Zielkonfiguration zu verbinden, ersetzen Sie den destinationServerId in der unten stehenden API-Anfrage durch den instanceId, der beim Erstellen Ihres Ziel-Servers in Schritt 1 wurde.

API-Format

POST platform.adobe.io/data/core/activation/authoring/destinations

Anfrage

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 dataset export destination",
   "description":"Amazon S3 destination for exporting Experience Platform datasets.",
   "status":"TEST",
   "sources":[
      "DATASETS"
   ],
   "customerAuthenticationConfigurations":[
      {
         "authType":"S3"
      }
   ],
   "customerDataFields":[
      {
         "name":"bucketName",
         "title":"Enter the name of your Amazon S3 bucket",
         "description":"Amazon S3 bucket name",
         "type":"string",
         "isRequired":true,
         "pattern":"(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)",
         "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":"^[0-9a-zA-Z\\/\\!\\-_\\.\\*\\''\\(\\)]*((\\%SEGMENT_(NAME|ID)\\%)?\\/?)+$",
         "readOnly":false,
         "hidden":false
      },
      {
         "name":"compression",
         "title":"Compression format",
         "description":"Select the desired file compression format.",
         "type":"string",
         "isRequired":true,
         "readOnly":false,
         "enum":[
            "GZIP",
            "NONE"
         ]
      },
      {
         "name":"fileType",
         "title":"File type",
         "description":"Select the exported file type.",
         "type":"string",
         "isRequired":true,
         "readOnly":false,
         "hidden":false,
         "enum":[
            "json",
            "parquet"
         ],
         "default":"parquet"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-amazon-s3-en",
      "category":"cloudStorage",
      "connectionType":"S3",
      "flowRunsSupported":true,
      "monitoringSupported":true,
      "frequency":"Batch"
   },
   "destinationDelivery":[
      {
         "deliveryMatchers":[
            {
               "type":"SOURCE",
               "value":[
                  "batch"
               ]
            }
         ],
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"{{destinationServerId}}"
      }
   ],
   "schemaConfig":{
      "profileRequired":false,
      "segmentRequired":false,
      "identityRequired":false
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT"
   },
   "batchConfig":{
      "allowMandatoryFieldSelection":false,
      "allowDedupKeyFieldSelection":false,
      "defaultExportMode":"FIRST_FULL_THEN_INCREMENTAL",
      "allowedExportModes":[
         "DAILY_FULL_EXPORT",
         "FIRST_FULL_THEN_INCREMENTAL"
      ],
      "allowedScheduleFrequency":[],
      "defaultFrequency":"EVERY_6_HOURS",
      "defaultStartTime":"00:00",
      "filenameConfig":{
         "allowedFilenameAppendOptions":[],
         "defaultFilenameAppendOptions":[],
         "defaultFilename":""
      },
      "datasetBatchConfig":{
         "allowedFoldernameAppendOptions":[
            "DESTINATION",
            "DATASET_ID",
            "DATASET_NAME",
            "DESTINATION_INSTANCE_ID",
            "DESTINATION_INSTANCE_NAME",
            "ORGANIZATION_NAME",
            "SANDBOX_NAME",
            "DATETIME",
            "EXPORT_TIME",
            "CUSTOM_TEXT"
         ],
         "defaultFoldernameAppendOptions":[
            "DATASET_ID",
            "EXPORT_TIME"
         ],
         "allowedExportModes":[
            "DAILY_FULL_EXPORT",
            "FIRST_FULL_THEN_INCREMENTAL"
         ],
         "allowedScheduleFrequency":[
            "DAILY",
            "EVERY_3_HOURS",
            "EVERY_6_HOURS",
            "EVERY_8_HOURS",
            "EVERY_12_HOURS",
            "ONCE"
         ]
      }
   },
   "maxProfileAttributes":9000,
   "maxIdentityAttributes":1000,
   "backfillHistoricalProfileData":true
}'

Die wichtigsten Unterschiede zu einer Zielgruppen-Export-Zielkonfiguration sind oben hervorgehoben:

Parameter
Wert für Datensatzexporte
Beschreibung
sources
["DATASETS"]
Markiert dieses Ziel als Ziel für den Datensatzexport. Siehe Konfigurieren des Zielgruppen-Datentyps für Details.
schemaConfig.profileRequired
false
Datensätze erfordern keine Profilzuordnung.
schemaConfig.segmentRequired
false
Datensätze erfordern keine Zielgruppenauswahl.
schemaConfig.identityRequired
false
Datensätze erfordern keine Identitätszuordnung.
aggregation.aggregationType
BEST_EFFORT
Datensatzexporte verwenden eine Best-Effort-Aggregation.
batchConfig.datasetBatchConfig
Siehe oben
Steuert für Datensatzexporte spezifische Ordnerbenennungs- und Planungsoptionen. Siehe Konfiguration des Datensatzexports für vollständige Parameterdetails.

Eine erfolgreiche Antwort gibt die neue Zielkonfiguration zurück, einschließlich der eindeutigen Kennung (instanceId) der Konfiguration.

Schritt 3: Einrichten der Authentifizierung set-up-authentication

Je nachdem, ob Sie in der obigen Zielkonfiguration "authenticationRule": "CUSTOMER_AUTHENTICATION" oder "authenticationRule": "PLATFORM_AUTHENTICATION" angegeben haben, können Sie die Authentifizierung mit dem Endpunkt /destination oder /credentials einrichten.

NOTE
CUSTOMER_AUTHENTICATION ist die häufigere der beiden Authentifizierungsregeln und ist die zu verwendende, wenn Sie möchten, dass Benutzerinnen und Benutzer beim Herstellen einer Verbindung mit Ihrem Ziel ihre eigenen Speicheranmeldeinformationen angeben.

Schritt 4: Überprüfen der Experience Platform Benutzeroberfläche verify-ui

Basierend auf den oben genannten Konfigurationen wird im Experience Platform-Katalog jetzt eine neue private Zielkarte angezeigt, die Sie verwenden können.

Wenn Benutzerinnen und Benutzer eine Verbindung zum Ziel herstellen und Datensätze zum Exportieren auswählen, sehen sie die Planungs- und Ordnerbenennungsoptionen, die Sie in datasetBatchConfig definiert haben.

Schritt 5: (Optional) Veröffentlichen des Ziels publish-destination

NOTE
Dieser Schritt ist nicht erforderlich, wenn Sie ein privates Ziel für Ihre eigene Verwendung erstellen und es nicht im Zielkatalog veröffentlichen möchten, damit andere Kundinnen und Kunden es verwenden können.

Verwenden Sie nach dem Konfigurieren Ihres Ziels die Zielveröffentlichungs-API, um Ihre Konfiguration zur Überprüfung an Adobe zu senden.

Schritt 6: (Optional) Dokumentieren des Ziels document-destination

NOTE
Dieser Schritt ist nicht erforderlich, wenn Sie ein privates Ziel für Ihre eigene Verwendung erstellen und es nicht im Zielkatalog veröffentlichen möchten, damit andere Kundinnen und Kunden es verwenden können.

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.

Nächste Schritte next-steps

Durch das Lesen dieses Artikels wissen Sie jetzt, wie Sie ein Datensatzexportziel mit Destination SDK erstellen. Als Nächstes kann Ihr Team den Workflow für den Datensatzexport zum Exportieren von Datensätzen an Ihr Ziel verwenden.

Weitere Informationen zu den Funktionen von Destination SDK finden Sie in den folgenden Artikeln:

recommendation-more-help
experience-platform-help-destinations