DokumentationExperience PlatformZielhandbuch

Batch-Konfiguration batch-configuration

Last update: Tue Nov 07 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Admin
  • User

Verwenden Sie die Batch-Konfigurationsoptionen in Destination SDK, um Benutzerinnen und Benutzern die Möglichkeit zu geben, die exportierten Dateinamen anzupassen und den Exportzeitplan nach ihren Wünschen zu konfigurieren.

Wenn Sie dateibasierte Ziele über Destination SDK erstellen, können Sie Standarddateinamen konfigurieren und Zeitpläne exportieren. Alternativ können Sie Benutzerinnen und Benutzern über die Platform-Benutzeroberfläche die Option zum Konfigurieren dieser Einstellungen geben. Sie können beispielsweise Verhaltensweisen wie die folgenden konfigurieren:

  • Einschließen spezifischer Informationen in den Dateinamen, z. B. Zielgruppen-IDs, Ziel-IDs oder benutzerdefinierte Informationen.
  • Benutzerinnen und Benutzer können die Dateibenennung über die Platform-Benutzeroberfläche anpassen.
  • Konfigurieren von Dateiexporten für bestimmte Zeitintervalle.
  • Definieren, welche Anpassungsoptionen für die Dateibenennung und den Export von Zeitplänen für Benutzerinnen und Benutzer in der Platform-Benutzeroberfläche angezeigt werden.

Batch-Konfigurationseinstellungen sind Teil der Zielkonfiguration für dateibasierte Ziele.

Informationen dazu, wo diese Komponente in eine mit Destination SDK erstellte Integration passt, finden Sie im Diagramm im Konfigurationsoptionen Dokumentation oder lesen Sie das Handbuch zu Destination SDK zum Konfigurieren eines dateibasierten Ziels verwenden.

Sie können die Dateibenennungs- und Exportzeitplaneinstellungen über den Endpunkt /authoring/destinations 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.

In diesem Artikel werden alle unterstützten Batch-Konfigurationsoptionen beschrieben, die Sie für Ihr Ziel verwenden können, und es wird gezeigt, was Kundinnen und Kunden in der Platform-Benutzeroberfläche sehen werden.

IMPORTANT
Bei allen von Destination SDK unterstützten Parameternamen und Werten wird nach Groß-/Kleinschreibung unterschieden. Um Fehler bei der Groß-/Kleinschreibung zu vermeiden, verwenden Sie bitte die Parameternamen und -werte genau wie in der Dokumentation dargestellt.

Unterstützte Integrationstypen supported-integration-types

Die nachstehende Tabelle beschreibt ausführlich, welche Integrationstypen die auf dieser Seite beschriebenen Funktionen unterstützen.

Integrationstyp
Unterstützt Funktionen
Echtzeit-Integrationen (Streaming)
Nein
Dateibasierte (Batch-)Integrationen
Ja

Unterstützte Parameter supported-parameters

Die Werte, die Sie hier festlegen, werden im Schritt Zielgruppenexport planen des dateibasierten Zielaktivierungs-Workflows angezeigt.

"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%"
      },
   "segmentGroupingEnabled": true
   }
Parameter
Typ
Beschreibung
allowMandatoryFieldSelection
Boolesch
Wenn auf true eingestellt, können Kundinnen und Kunden festlegen, welche Profilattribute obligatorisch sind. Der Standardwert ist false. Weitere Informationen finden Sie unter Obligatorische Attribute.
allowDedupeKeyFieldSelection
Boolesch
Wenn auf true eingestellt, können Kundinnen und Kunden Deduplizierungsschlüssel angeben. Der Standardwert ist false. Weitere Informationen finden Sie unter Deduplizierungsschlüssel.
defaultExportMode
Enum

Definiert den standardmäßigen Dateiexportmodus. Unterstützte Werte:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL

Der Standardwert ist DAILY_FULL_EXPORT. Weitere Informationen zur Planung von Dateiexporten finden Sie in der Dokumentation zur Batch-Aktivierung.

allowedExportModes
Liste

Definiert die für Kundinnen und Kunden verfügbaren Dateiexportmodi. Unterstützte Werte:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequency
Liste

Definiert die für Kundinnen und Kunden verfügbare Dateiexportfrequenz. Unterstützte Werte:

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY
defaultFrequency
Enum

Definiert die standardmäßige Dateiexportfrequenz. Unterstützte Werte:

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY

Der Standardwert ist DAILY.

defaultStartTime
Zeichenfolge
Definiert die standardmäßige Startzeit für den Dateiexport. Verwendet das 24-Stunden-Dateiformat. Der Standardwert ist „00:00“.
filenameConfig.allowedFilenameAppendOptions
Zeichenfolge

Erforderlich. Liste der verfügbaren Dateinamenmakros, aus denen Benutzerinnen und Benutzer auswählen können. Dadurch wird bestimmt, welche Elemente an exportierte Dateinamen angehängt werden (Zielgruppen-ID, Organisationsname, Datum und Uhrzeit des Exports usw.). Wenn Sie defaultFilenamefestlegen, sollten Sie darauf achten, dass Makros nicht dupliziert werden.

Unterstützte Werte:

  • DESTINATION
  • SEGMENT_ID
  • SEGMENT_NAME
  • DESTINATION_INSTANCE_ID
  • DESTINATION_INSTANCE_NAME
  • ORGANIZATION_NAME
  • SANDBOX_NAME
  • DATETIME
  • CUSTOM_TEXT

Unabhängig von der Reihenfolge, in der Sie die Makros definieren, zeigt die Experience Platform-Benutzeroberfläche sie immer in der hier dargestellten Reihenfolge an.

Wenn defaultFilename leer ist, muss die Liste allowedFilenameAppendOptions mindestens ein Makro enthalten.

filenameConfig.defaultFilenameAppendOptions
Zeichenfolge
Erforderlich. Vorausgewählte Standardmakros für Dateinamen, die von Benutzerinnen und Benutzern deaktiviert werden können.

Die Makros in dieser Liste sind eine Teilmenge der in allowedFilenameAppendOptions definierten.
filenameConfig.defaultFilename
Zeichenfolge
Optional. Definiert die standardmäßigen Dateinamenmakros für die exportierten Dateien. Diese können von Benutzerinnen und Benutzern nicht überschrieben werden.

Jedes von allowedFilenameAppendOptions definierte Makro wird nach den defaultFilename-Makros angehängt.

Wenn defaultFilename leer ist, müssen Sie mindestens ein Makro in allowedFilenameAppendOptions definieren.
segmentGroupingEnabled
Boolesch

Definiert anhand der Zusammenführungsrichtlinie für Zielgruppen, ob die aktivierten Zielgruppen in einer oder mehreren Dateien exportiert werden sollen. Unterstützte Werte:

  • true: Exportiert eine Datei pro Zusammenführungsrichtlinie.
  • false: Exportiert eine Datei pro Zielgruppe, unabhängig von der Zusammenführungsrichtlinie. Dies ist das Standardverhalten. Sie können dasselbe Ergebnis erzielen, indem Sie diesen Parameter vollständig ausschließen.

Dateinamenkonfiguration file-name-configuration

Verwenden Sie Makros zur Dateinamenkonfiguration, um zu definieren, was die Namen der exportierten Dateien enthalten sollen. Die Makros in der folgenden Tabelle beschreiben Elemente, die in der Benutzeroberfläche des Bildschirms Dateinamenkonfiguration angezeigt werden.

TIP
Als Best Practice sollten Sie immer das SEGMENT_ID-Makro in den Namen der exportierten Dateien aufnehmen. Segment-IDs sind eindeutig. Daher lässt sich am besten sicherstellen, dass Dateinamen auch eindeutig sind, indem Sie sie in den Dateinamen aufnehmen.
Makro
UI-Bezeichnung
Beschreibung
Beispiel
DESTINATION
Ziel
Zielname in der Benutzeroberfläche.
Amazon S3
SEGMENT_ID
Segment-ID
Eindeutige, von Platform generierte Zielgruppen-ID
ce5c5482-2813-4a80-99bc-57113f6acde2
SEGMENT_NAME
Segmentname
Benutzerdefinierter Zielgruppenname
VIP
DESTINATION_INSTANCE_ID
Ziel-ID
Eindeutige, von Platform generierte ID der Zielinstanz
7b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
Zielname
Benutzerdefinierter Name der Zielinstanz.
Mein Werbeziel 2022
ORGANIZATION_NAME
Organisationsname
Name der Kundenorganisation in Adobe Experience Platform.
Mein Organisationsname
SANDBOX_NAME
Sandbox-Name
Name der von der Kundinnen oder dem Kunden verwendeten Sandbox.
prod
DATETIME / TIMESTAMP
Datum und Uhrzeit

DATETIME und TIMESTAMP definieren beide den Zeitpunkt der Erstellung der Datei, jedoch in verschiedenen Formaten.

  • DATETIME verwendet das folgende Format: JJJJMMTT_HHMMSS.
  • TIMESTAMP verwendet das 10-stellige Unix-Format.

DATETIME und TIMESTAMP schließen sich gegenseitig aus und können nicht gleichzeitig verwendet werden.

  • DATETIME: 20220509_210543
  • TIMESTAMP: 1652131584
CUSTOM_TEXT
Benutzerdefinierter Text
Benutzerdefinierter Text, der in den Dateinamen eingefügt werden soll. Kann nicht in defaultFilename verwendet werden.
Mein_Benutzerdefinierter_Text
TIMESTAMP
Datum und Uhrzeit
10-stelliger Zeitstempel der Zeit, zu der die Datei generiert wurde, im Unix-Format.
1652131584
MERGE_POLICY_ID
Zusammenführungsrichtlinien-ID
Die ID der Zusammenführungsrichtlinie, die zum Generieren der exportierten Zielgruppe verwendet wird. Verwenden Sie dieses Makro, wenn Sie exportierte Zielgruppen anhand der Zusammenführungsrichtlinie in Dateien gruppieren. Verwenden Sie dieses Makro zusammen mit segmentGroupingEnabled:true.
e8591fdb-2873-4b12-b63e-15275b1c1439
MERGE_POLICY_NAME
Name der Zusammenführungsrichtlinie
Der Name der Zusammenführungsrichtlinie, die zum Generieren der exportierten Zielgruppe verwendet wird. Verwenden Sie dieses Makro, wenn Sie exportierte Zielgruppen anhand der Zusammenführungsrichtlinie in Dateien gruppieren. Verwenden Sie dieses Makro zusammen mit segmentGroupingEnabled:true.
Meine benutzerdefinierte Zusammenführungsrichtlinie

Beispiel für eine Dateinamenkonfiguration

Das folgende Konfigurationsbeispiel zeigt die Korrespondenz zwischen der im API-Aufruf verwendeten Konfiguration und den in der Benutzeroberfläche angezeigten Optionen.

"filenameConfig":{
   "allowedFilenameAppendOptions":[
      "CUSTOM_TEXT",
      "SEGMENT_ID",
      "DATETIME"
   ],
   "defaultFilenameAppendOptions":[
      "SEGMENT_ID",
      "DATETIME"
   ],
   "defaultFilename": "%DESTINATION%"
}

UI-Bild mit dem Konfigurationsbildschirm für Dateinamen mit vorab ausgewählten Makros

Nächste Schritte next-steps

Nach dem Lesen dieses Artikels sollten Sie besser verstehen, wie Sie die Dateibenennung und Exportzeitpläne für Ihre dateibasierten Ziele konfigurieren können.

Weitere Informationen zu den anderen Zielkomponenten finden Sie in den folgenden Artikeln:

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6