Configurazione batch batch-configuration
Utilizzare le opzioni di configurazione batch in Destination SDK per consentire agli utenti di personalizzare i nomi dei file esportati e configurare la pianificazione dell’esportazione in base alle proprie preferenze.
Quando si creano destinazioni basate su file tramite Destination SDK, è possibile configurare la denominazione dei file e le pianificazioni di esportazione predefinite oppure consentire agli utenti di configurare queste impostazioni dall’interfaccia utente di Experience Platform. Ad esempio, puoi configurare comportamenti quali:
- Includi informazioni specifiche nel nome del file, ad esempio ID pubblico, ID destinazione o informazioni personalizzate.
- Consenti agli utenti di personalizzare la denominazione dei file dall’interfaccia utente Experience Platform.
- Configura le esportazioni di file in modo che avvengano a intervalli di tempo impostati.
- Definire le opzioni di personalizzazione della pianificazione di esportazione e denominazione dei file che gli utenti possono visualizzare nell’interfaccia utente Experience Platform.
Le impostazioni di configurazione batch fanno parte della configurazione di destinazione per le destinazioni basate su file.
Per capire dove questo componente si inserisce in un’integrazione creata con Destination SDK, consulta il diagramma nella documentazione delle opzioni di configurazione oppure consulta la guida su come utilizzare Destination SDK per configurare una destinazione basata su file.
È possibile configurare le impostazioni di denominazione ed esportazione dei file tramite l’endpoint /authoring/destinations. Consulta le seguenti pagine di riferimento API per esempi dettagliati di chiamate API, in cui puoi configurare i componenti mostrati in questa pagina.
Questo articolo descrive tutte le opzioni di configurazione batch supportate che puoi utilizzare per la tua destinazione e mostra cosa vedranno i clienti nell’interfaccia utente di Experience Platform.
Tipi di integrazione supportati supported-integration-types
Consulta la tabella seguente per informazioni dettagliate sui tipi di integrazioni che supportano le funzionalità descritte in questa pagina.
batchConfig rispetto a datasetBatchConfig batchconfig-vs-datasetbatchconfig
Questa pagina descrive due oggetti di configurazione correlati ma distinti:
batchConfig: controlla le impostazioni di denominazione ed esportazione dei file per le destinazioni che esportano tipi di pubblico (persone, account o gruppi di destinatari potenziali).datasetBatchConfig: oggetto nidificato all’interno dibatchConfigche controlla la denominazione delle cartelle e le impostazioni di pianificazione per l’esportazione specifiche per le destinazioni che esportano set di dati. Utilizzalo quando la tua destinazione supporta le esportazioni di set di dati (ad esempio,"sources": ["DATASETS"]è impostato nella tua configurazione di destinazione).
Parametri supportati supported-parameters
I valori impostati qui vengono visualizzati nel passaggio Pianifica esportazione pubblico del flusso di lavoro di attivazione delle destinazioni basate su file.
"batchConfig":{
"allowMandatoryFieldSelection":true,
"allowDedupeKeyFieldSelection":true,
"defaultExportMode":"DAILY_FULL_EXPORT",
"allowedExportModes":[
"DAILY_FULL_EXPORT",
"FIRST_FULL_THEN_INCREMENTAL"
],
"allowedScheduleFrequency":[
"DAILY",
"EVERY_3_HOURS",
"EVERY_6_HOURS",
"EVERY_8_HOURS",
"EVERY_12_HOURS",
"ONCE",
"WEEKLY",
"MONTHLY"
],
"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
}
allowMandatoryFieldSelectiontrue per consentire ai clienti di specificare quali attributi di profilo sono obbligatori. Il valore predefinito è false. Per ulteriori informazioni, vedere Attributi obbligatori.allowDedupeKeyFieldSelectiontrue per consentire ai clienti di specificare le chiavi di deduplicazione. Il valore predefinito è false. Per ulteriori informazioni, vedere Chiavi di deduplicazione.defaultExportModeDefinisce la modalità di esportazione predefinita del file. Valori supportati:
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
Il valore predefinito è DAILY_FULL_EXPORT. Consulta la documentazione sull’attivazione batch per informazioni dettagliate sulla pianificazione delle esportazioni di file.
allowedExportModesDefinisce le modalità di esportazione dei file disponibili per i clienti. Valori supportati:
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequencyDefinisce la frequenza di esportazione dei file disponibile per i clienti. Valori supportati:
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILYWEEKLYMONTHLY
defaultFrequencyDefinisce la frequenza predefinita di esportazione dei file.Valori supportati:
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILYWEEKLYMONTHLY
Il valore predefinito è DAILY.
defaultStartTimefilenameConfig.allowedFilenameAppendOptionsRichiesto. Elenco delle macro di nomi file disponibili tra cui gli utenti possono scegliere. Questo determina quali elementi vengono aggiunti ai nomi dei file esportati (ID pubblico, nome organizzazione, data e ora di esportazione e altri). Quando si imposta defaultFilename, assicurarsi di evitare la duplicazione delle macro.
Valori supportati:
DESTINATIONSEGMENT_IDSEGMENT_NAMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIMECUSTOM_TEXT
Indipendentemente dall’ordine in cui si definiscono le macro, nell’interfaccia utente di Experience Platform queste vengono sempre visualizzate nell’ordine presentato qui.
Se defaultFilename è vuoto, l’elenco allowedFilenameAppendOptions deve contenere almeno una macro.
filenameConfig.defaultFilenameAppendOptionsLe macro in questo elenco sono un sottoinsieme di quelle definite in
allowedFilenameAppendOptions.filenameConfig.defaultFilenameQualsiasi macro definita da
allowedFilenameAppendOptions verrà aggiunta dopo le macro defaultFilename.Se
defaultFilename è vuoto, definire almeno una macro in allowedFilenameAppendOptions.segmentGroupingEnabledDefinisce se i tipi di pubblico attivati devono essere esportati in uno o più file, in base al criterio di unione del pubblico. Valori supportati:
true: esporta un file per criterio di unione.false: esporta un file per pubblico, indipendentemente dal criterio di unione. Questo è il comportamento predefinito. È possibile ottenere lo stesso risultato omettendo completamente questo parametro.
Configurazione del nome file file-name-configuration
Utilizzare le macro di configurazione dei nomi di file per definire i nomi di file esportati da includere. Le macro nella tabella seguente descrivono gli elementi trovati nell’interfaccia utente nella schermata configurazione nome file.
SEGMENT_ID nei nomi dei file esportati. Poiché gli ID segmento sono univoci, includerli nel nome file è il modo migliore per garantire che anche i nomi dei file siano univoci.DESTINATIONSEGMENT_IDSEGMENT_NAMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIME / TIMESTAMPDATETIME e TIMESTAMP definiscono entrambi quando il file è stato generato, ma in formati diversi.
DATETIMEutilizza il seguente formato: YYYYMMDD_HHMMSS.TIMESTAMPutilizza il formato Unix a 10 cifre.
DATETIME e TIMESTAMP si escludono a vicenda e non possono essere utilizzati contemporaneamente.
DATETIME: 20220509_210543TIMESTAMP: 1652131584
CUSTOM_TEXTdefaultFilename.TIMESTAMPMERGE_POLICY_IDsegmentGroupingEnabled:true.MERGE_POLICY_NAMEsegmentGroupingEnabled:true.Esempio di configurazione del nome file file-name-configuration-example
L’esempio di configurazione seguente mostra la corrispondenza tra la configurazione utilizzata nella chiamata API e le opzioni visualizzate nell’interfaccia utente.
"filenameConfig":{
"allowedFilenameAppendOptions":[
"CUSTOM_TEXT",
"SEGMENT_ID",
"DATETIME"
],
"defaultFilenameAppendOptions":[
"SEGMENT_ID",
"DATETIME"
],
"defaultFilename": "%DESTINATION%"
}
Configurazione dell’esportazione del set di dati dataset-export-configuration
Utilizzare l’oggetto datasetBatchConfig, nidificato in batchConfig, per configurare la denominazione delle cartelle e le pianificazioni di esportazione per le destinazioni che supportano esportazioni di set di dati.
"sources": ["DATASETS"]. Consulta Configurare il tipo di dati del pubblico per l'esempio di configurazione di destinazione completa oppure segui la guida dettagliata per configurare una destinazione di esportazione del set di dati."batchConfig":{
"datasetBatchConfig":{
"allowedFoldernameAppendOptions":[
"DESTINATION",
"DATASET_ID",
"DATASET_NAME",
"EXPORT_TIME",
"DESTINATION_INSTANCE_ID",
"DESTINATION_INSTANCE_NAME",
"ORGANIZATION_NAME",
"SANDBOX_NAME",
"DATETIME",
"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"
]
}
}
datasetBatchConfig.allowedFoldernameAppendOptionsRichiesto. Elenco delle macro dei nomi di cartella disponibili tra cui gli utenti possono scegliere. Questi determinano quali elementi vengono aggiunti al percorso della cartella di esportazione. Se defaultFoldernameAppendOptions è vuoto, è necessario specificare almeno una macro. Valori supportati:
DESTINATIONDATASET_IDDATASET_NAMEEXPORT_TIMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIMECUSTOM_TEXT
datasetBatchConfig.defaultFoldernameAppendOptionsallowedFoldernameAppendOptions.datasetBatchConfig.allowedExportModesDefinisce le modalità di esportazione disponibili per gli utenti per le esportazioni dei set di dati. Valori supportati:
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
datasetBatchConfig.allowedScheduleFrequencyDefinisce le opzioni di frequenza di esportazione disponibili per gli utenti per le esportazioni dei set di dati. Valori supportati:
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILY
Macro nome cartella folder-name-macros
Le macro nella tabella seguente possono essere utilizzate in allowedFoldernameAppendOptions e defaultFoldernameAppendOptions per definire la struttura del percorso della cartella di esportazione del set di dati.
DESTINATIONDATASET_IDDATASET_NAMEEXPORT_TIMEexportTime=YYYYMMDDHHMM.DESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIMEYYYYMMDD_HHMMSS.CUSTOM_TEXTPassaggi successivi next-steps
Dopo aver letto questo articolo, sarai in grado di comprendere meglio come configurare la denominazione dei file e le pianificazioni di esportazione per le destinazioni basate su file.
Per ulteriori informazioni sugli altri componenti di destinazione, consulta i seguenti articoli:
- Configurazione autenticazione cliente
- Autorizzazione OAuth2
- Campi dati cliente
- Attributi dell’interfaccia utente
- Configurazione dello schema
- Configurazione dello spazio dei nomi dell’identità
- Configurazioni di mappatura supportate
- Consegna della destinazione
- Configurazione dei metadati del pubblico
- Criterio di aggregazione
- Qualifiche del profilo storico