Batchkonfiguration batch-configuration

Använd alternativen för gruppkonfiguration i Destinationen SDK för att tillåta användare att anpassa de exporterade filnamnen och konfigurera exportschemat efter sina önskemål.

När du skapar filbaserade mål via Destination SDK kan du konfigurera standardprogram för filnamngivning och -export, eller så kan du ge användarna möjlighet att konfigurera dessa inställningar från plattformsgränssnittet. Du kan till exempel konfigurera beteenden som:

  • Inkludera specifik information i filnamnet, till exempel målgrupps-ID, mål-ID:n eller anpassad information.
  • Användare kan anpassa filnamnsgivningen från plattformens användargränssnitt.
  • Konfigurera filexporten så att den sker i angivna tidsintervall.
  • Definiera vilka alternativ för filnamngivning och anpassning av exportschema som användarna kan se i användargränssnittet för plattformen.

Batchkonfigurationsinställningarna ingår i målkonfigurationen för filbaserade mål.

Mer information om var den här komponenten passar in i en integrering som skapas med Destination SDK finns i diagrammet i konfigurationsalternativ eller se guiden om hur du använd Destination SDK för att konfigurera ett filbaserat mål.

Du kan konfigurera inställningarna för filnamngivning och exportscheman via /authoring/destinations slutpunkt. På följande API-referenssidor finns detaljerade API-anropsexempel där du kan konfigurera komponenterna som visas på den här sidan.

I den här artikeln beskrivs alla gruppkonfigurationsalternativ som stöds och som du kan använda för ditt mål. Artikeln innehåller även information om vad kunderna kommer att se i användargränssnittet för plattformen.

IMPORTANT
Alla parameternamn och värden som stöds av Destinationen SDK är skiftlägeskänslig. Undvik skiftlägeskänslighetsfel genom att använda parameternamn och värden exakt som de visas i dokumentationen.

Integrationstyper som stöds supported-integration-types

Se tabellen nedan för mer ingående information om vilka typer av integreringar som stöder de funktioner som beskrivs på den här sidan.

Integrationstyp
Stöder funktioner
Integrering i realtid (direktuppspelning)
Nej
Filbaserade (batch) integreringar
Ja

parametrar som stöds supported-parameters

Värdena som du ställer in här visas i Schemalägg målgruppsexport steg i det filbaserade arbetsflödet för målaktivering.

"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
Beskrivning
allowMandatoryFieldSelection
Boolean
Ange till true så att kunderna kan ange vilka profilattribut som är obligatoriska. Standardvärdet är false. Se Obligatoriska attribut för mer information.
allowDedupeKeyFieldSelection
Boolean
Ange till true så att kunderna kan ange dedupliceringsnycklar. Standardvärdet är false. Se Dedupliceringsnycklar för mer information.
defaultExportMode
Enum

Definierar standardläget för filexport. Värden som stöds:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL

Standardvärdet är DAILY_FULL_EXPORT. Se batchaktiveringsdokumentation om du vill ha mer information om schemaläggning av filexport.

allowedExportModes
Lista

Definierar vilka filexportlägen som är tillgängliga för kunderna. Värden som stöds:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequency
Lista

Definierar den filexportfrekvens som är tillgänglig för kunder. Värden som stöds:

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

Definierar standardexportfrekvensen för filer.Värden som stöds:

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

Standardvärdet är DAILY.

defaultStartTime
Sträng
Definierar standardstarttiden för filexporten. Använder 24-timmars filformat. Standardvärdet är "00:00".
filenameConfig.allowedFilenameAppendOptions
Sträng

Obligatoriskt. Lista över tillgängliga filnamnsmappar som användare kan välja mellan. Detta avgör vilka objekt som läggs till i de exporterade filnamnen (målgrupps-ID, organisationsnamn, exportdatum och exporttid med mera). Vid inställning defaultFilenamebör du se till att du inte duplicerar makron.

Värden som stöds:

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

Oavsett i vilken ordning du definierar makrona visas de alltid i den ordning som de anges här i användargränssnittet för Experience Platform.

If defaultFilename är tom, allowedFilenameAppendOptions listan måste innehålla minst ett makro.

filenameConfig.defaultFilenameAppendOptions
Sträng
Obligatoriskt. Förvalda standardmakron för filnamn som användare kan avmarkera.

Makrona i den här listan är en delmängd av de som definieras i allowedFilenameAppendOptions.
filenameConfig.defaultFilename
Sträng
Valfritt. Definierar standardmakron för filnamn för de exporterade filerna. Användarna kan inte skriva över dem.

Alla makron som definieras av allowedFilenameAppendOptions läggs till efter defaultFilename makron.

If defaultFilename är tom, du måste definiera minst ett makro i allowedFilenameAppendOptions.
segmentGroupingEnabled
Boolean

Definierar om de aktiverade målgrupperna ska exporteras i en eller flera filer, baserat på målgrupp sammanfogningsprincip. Värden som stöds:

  • true: exporterar en fil per sammanfogningsprincip.
  • false: exporterar en fil per målgrupp, oavsett kopplingsregel. Detta är standardbeteendet. Du kan uppnå samma resultat genom att helt utelämna den här parametern.

Filnamnskonfiguration file-name-configuration

Använd konfigurationsmakron för filnamn för att definiera vad de exporterade filnamnen ska innehålla. Makrona i tabellen nedan beskriver element som finns i användargränssnittet i filnamnskonfiguration skärm.

TIP
Som en god praxis bör du alltid inkludera SEGMENT_ID makro i de exporterade filnamnen. Segment-ID:n är unika, så om du tar med dem i filnamnet är det bästa sättet att se till att filnamnen också är unika.
Makro
Gränssnittsetikett
Beskrivning
Exempel
DESTINATION
Destination
Målnamn i användargränssnittet.
Amazon S3
SEGMENT_ID
Segment ID
Unikt, plattformsgenererat målgrupps-ID
ce5c5482-2813-4a80-99bc-57113f6acde2
SEGMENT_NAME
Segment Name
Användardefinierat publiknamn
VIP prenumerant
DESTINATION_INSTANCE_ID
Destination ID
Unikt, plattformsgenererat ID för målinstansen
7b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
Destination Name
Användardefinierat namn för målinstansen.
Mål för min 2022-annons
ORGANIZATION_NAME
Organization Name
Namn på kundorganisationen i Adobe Experience Platform.
Organisationsnamn
SANDBOX_NAME
Sandbox Name
Namn på den sandlåda som används av kunden.
prod
DATETIME / TIMESTAMP
Date and time

DATETIME och TIMESTAMP båda definierar när filen skapades, men i olika format.

  • DATETIME använder följande format: YYYMMDD_HMMSS.
  • TIMESTAMP använder det 10-siffriga Unix-formatet.

DATETIME och TIMESTAMP utesluter varandra och kan inte användas samtidigt.

  • DATETIME: 20220509_210543
  • TIMESTAMP: 1652131584
CUSTOM_TEXT
Custom text
Användardefinierad egen text som ska inkluderas i filnamnet. Kan inte användas i defaultFilename.
Min_egen_text
TIMESTAMP
Date and time
10-siffrig tidsstämpel i Unix-format för den tid då filen skapades.
1652131584
MERGE_POLICY_ID
Merge Policy ID
ID:t för sammanfogningsprincip används för att generera den exporterade målgruppen. Använd det här makrot när du grupperar exporterade målgrupper i filer, baserat på kopplingsprofilen. Använd makrot tillsammans med segmentGroupingEnabled:true.
e8591fdb-2873-4b12-b63e-15275b1c1439
MERGE_POLICY_NAME
Merge Policy Name
Namnet på sammanfogningsprincip används för att generera den exporterade målgruppen. Använd det här makrot när du grupperar exporterade målgrupper i filer, baserat på kopplingsprofilen. Använd makrot tillsammans med segmentGroupingEnabled:true.
Min egen sammanfogningsprincip

Exempel på filnamnskonfiguration

I konfigurationsexemplet nedan visas korrespondensen mellan konfigurationen som används i API-anropet och alternativen som visas i användargränssnittet.

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

Användargränssnittsbild som visar konfigurationsskärmen för filnamn med förvalda makron

Nästa steg next-steps

När du har läst den här artikeln bör du få en bättre förståelse för hur du kan konfigurera filnamnsscheman och exportscheman för dina filbaserade mål.

Mer information om de andra målkomponenterna finns i följande artiklar:

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