DocumentatieExperience PlatformHandleiding voor bestemmingen

Batchconfiguratie batch-configuration

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Beheerder
  • Gebruiker

Gebruik de opties voor batchconfiguratie in Destination SDK om gebruikers toe te staan de geëxporteerde bestandsnamen aan te passen en het exportschema te configureren volgens hun voorkeur.

Wanneer u op dossier-gebaseerde bestemmingen door Destination SDK creeert, kunt u standaarddossier het noemen en de uitvoerprogramma's vormen, of u kunt gebruikers de optie geven om deze montages van het Platform UI te vormen. U kunt bijvoorbeeld gedragingen configureren, zoals:

  • Specifieke informatie in de bestandsnaam opnemen, zoals gebruikers-id's, doel-id's of aangepaste informatie.
  • Gebruikers toestaan de bestandsnaamgeving aan te passen vanuit de gebruikersinterface van het platform.
  • Configureer het exporteren van bestanden zodat deze bij ingestelde tijdintervallen kunnen optreden.
  • Definieer welke opties voor het aanpassen van bestandsnamen en exportschema's gebruikers kunnen zien in de interface van het platform.

De de configuratiemontages van de partij maken deel uit van de bestemmingsconfiguratie voor op dossier-gebaseerde bestemmingen.

Om te begrijpen waar deze component in een integratie past die met Destination SDK wordt gecreeerd, zie het diagram in de configuratieoptiesdocumentatie of zie de gids op hoe te gebruiken Destination SDK om een op dossier-gebaseerde bestemmingte vormen.

U kunt de instellingen voor de bestandsnaam en het exportschema configureren via het eindpunt van /authoring/destinations . Zie de volgende API verwijzingspagina's voor gedetailleerde API vraagvoorbeelden waar u de componenten kunt vormen die in deze pagina worden getoond.

Dit artikel beschrijft alle gesteunde opties van de partijconfiguratie die u voor uw bestemming kunt gebruiken, en toont welke klanten in Platform UI zullen zien.

IMPORTANT
Alle parameternamen en waarden die door Destination SDK worden gesteund zijn gevoelig geval. Om fouten in hoofdlettergevoeligheid te voorkomen, gebruikt u de namen en waarden van parameters exact zoals in de documentatie wordt getoond.

Ondersteunde integratietypen supported-integration-types

Raadpleeg de onderstaande tabel voor meer informatie over de integratietypen die de op deze pagina beschreven functionaliteit ondersteunen.

Type integratie
Ondersteunt functionaliteit
Integraties in realtime (streaming)
Nee
Op bestanden gebaseerde (batch) integratie
Ja

Ondersteunde parameters supported-parameters

De waarden die u opstelling hier wordt aangehaald in de stap van de de publieksuitvoer van het Programmavan het op dossier-gebaseerde werkschema van de bestemmingsactivering.

"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
Type
Beschrijving
allowMandatoryFieldSelection
Boolean
Ingesteld op true zodat klanten kunnen opgeven welke profielkenmerken verplicht zijn. De standaardwaarde is false . Zie Verplicht attributenvoor meer informatie.
allowDedupeKeyFieldSelection
Boolean
Ingesteld op true zodat klanten deduplicatietoetsen kunnen opgeven. De standaardwaarde is false . Zie de sleutels van de Deduplicatievoor meer informatie.
defaultExportMode
Enum

Definieert de standaardmodus voor het exporteren van bestanden. Ondersteunde waarden:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL

De standaardwaarde is DAILY_FULL_EXPORT . Zie de documentatie van de partijactiveringvoor details over dossieruitvoer die plannen.

allowedExportModes
Lijst

Hiermee definieert u de exportmodi voor bestanden die beschikbaar zijn voor klanten. Ondersteunde waarden:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequency
Lijst

Hiermee definieert u de exportfrequentie voor bestanden die beschikbaar is voor klanten. Ondersteunde waarden:

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

Definieert de standaard exportfrequentie voor bestanden.Ondersteunde waarden:

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

De standaardwaarde is DAILY .

defaultStartTime
String
Hiermee definieert u de standaardbegintijd voor het exporteren van het bestand. Gebruikt een bestandsindeling van 24 uur. De standaardwaarde is "00:00".
filenameConfig.allowedFilenameAppendOptions
String

Vereiste. Lijst met beschikbare bestandsnaammacro's waaruit gebruikers kunnen kiezen. Op deze manier bepaalt u welke items aan geëxporteerde bestandsnamen worden toegevoegd (gebruikers-id, naam van de organisatie, datum en tijd van export, enzovoort). Zorg er bij het instellen van defaultFilename voor dat dubbele macro's worden vermeden.

Gesteunde waarden:

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

Ongeacht de orde waarin u de macro's bepaalt, zal Experience Platform UI altijd hen in de hier voorgestelde orde tonen.

Als defaultFilename leeg is, moet de lijst allowedFilenameAppendOptions minstens één macro bevatten.

filenameConfig.defaultFilenameAppendOptions
String
Vereiste. Vooraf geselecteerde standaardbestandsnaammacro's die gebruikers kunnen uitschakelen.

De macro's in deze lijst zijn een subset van de gedefinieerde macro's in allowedFilenameAppendOptions .
filenameConfig.defaultFilename
String
Facultatief. Hiermee definieert u de standaardbestandsnamen van macro's voor de geëxporteerde bestanden. Deze kunnen niet worden overschreven door gebruikers.

Om het even welke macro die door allowedFilenameAppendOptions wordt bepaald zal na de defaultFilename macro's worden toegevoegd.

Als defaultFilename leeg is, moet u minstens één macro in allowedFilenameAppendOptions bepalen.
segmentGroupingEnabled
Boolean

Bepaalt of het geactiveerde publiek in één enkel dossier of veelvoudige dossiers zou moeten worden uitgevoerd, die op publiek wordt gebaseerd fusiebeleid. Ondersteunde waarden:

  • true : exporteert één bestand per samenvoegbeleid.
  • false : exporteert één bestand per publiek, ongeacht het samenvoegbeleid. Dit is het standaardgedrag. U kunt hetzelfde resultaat bereiken door deze parameter volledig in te zetten.

Configuratie bestandsnaam file-name-configuration

Gebruik de configuratiesymbolen voor bestandsnamen om te definiëren wat de geëxporteerde bestandsnamen moeten bevatten. De macro's in de lijst hieronder beschrijven elementen die in UI in het worden gevonden dossier - noem configuratiescherm.

TIP
U kunt het beste de macro SEGMENT_ID altijd opnemen in de namen van geëxporteerde bestanden. Segment-id's zijn uniek, dus het opnemen ervan in de bestandsnaam is de beste manier om ervoor te zorgen dat bestandsnamen ook uniek zijn.
Macro
UI-label
Beschrijving
Voorbeeld
DESTINATION
Destination
Doelnaam in de gebruikersinterface.
Amazon S3
SEGMENT_ID
Segment ID
Unieke, door het platform gegenereerde gebruikers-id
ce5c5482-2813-4a80-99bc-57113f6acde2
SEGMENT_NAME
Segment Name
Door gebruiker gedefinieerde publieksnaam
VIP abonnee
DESTINATION_INSTANCE_ID
Destination ID
Unieke, door het platform gegenereerde id van de doelinstantie
7b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
Destination Name
Door gebruiker gedefinieerde naam van de doelinstantie.
Mijn Advertising-bestemming van 2022
ORGANIZATION_NAME
Organization Name
Naam van de klantenorganisatie in Adobe Experience Platform.
Naam van mijn organisatie
SANDBOX_NAME
Sandbox Name
Naam van de sandbox die de klant gebruikt.
prod
DATETIME / TIMESTAMP
Date and time

DATETIME en TIMESTAMP beide definiëren wanneer het bestand is gegenereerd, maar in verschillende indelingen.

  • DATETIME gebruikt de volgende indeling: YYYMMDD_HMMSS.
  • TIMESTAMP gebruikt de Unix-indeling van 10 cijfers.

DATETIME en TIMESTAMP sluiten elkaar uit en kunnen niet gelijktijdig worden gebruikt.

  • DATETIME: 20220509_210543
  • TIMESTAMP: 1652131584
CUSTOM_TEXT
Custom text
Door de gebruiker gedefinieerde aangepaste tekst die in de bestandsnaam moet worden opgenomen. Kan niet worden gebruikt in defaultFilename .
Mijn_Aangepaste_tekst
TIMESTAMP
Date and time
Tijdstempel van 10 cijfers van het tijdstip waarop het bestand is gegenereerd, in Unix-indeling.
1652131584
MERGE_POLICY_ID
Merge Policy ID
Identiteitskaart van het samenvoegbeleidwordt gebruikt om het uitgevoerde publiek te produceren dat. Gebruik deze macro wanneer u geëxporteerde soorten publiek in bestanden groepeert op basis van het samenvoegbeleid. Gebruik deze macro samen met segmentGroupingEnabled:true .
e8591fdb-2873-4b12-b63e-15275b1c1439
MERGE_POLICY_NAME
Merge Policy Name
De naam van het samenvoegbeleidwordt gebruikt om het uitgevoerde publiek te produceren dat. Gebruik deze macro wanneer u geëxporteerde soorten publiek in bestanden groepeert op basis van het samenvoegbeleid. Gebruik deze macro samen met segmentGroupingEnabled:true .
Mijn aangepaste samenvoegingsbeleid

Voorbeeld van configuratie bestandsnaam

In het onderstaande configuratievoorbeeld ziet u de overeenkomst tussen de configuratie die wordt gebruikt in de API-aanroep en de opties die worden weergegeven in de UI.

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

beeld UI die het scherm van de het configuratieconfiguratie van de dossiernaam met vooraf geselecteerde macros toont

Volgende stappen next-steps

Na het lezen van dit artikel, zou u een beter inzicht in moeten hebben hoe u dossier het noemen en de uitvoerprogramma's voor uw op dossier-gebaseerde bestemmingen kunt vormen.

Raadpleeg de volgende artikelen voor meer informatie over de andere doelcomponenten:

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