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.

IMPORTANT
Tutti i nomi e i valori dei parametri supportati da Destination SDK sono con distinzione tra maiuscole e minuscole. Per evitare errori di distinzione tra maiuscole e minuscole, utilizza i nomi e i valori dei parametri esattamente come mostrato nella documentazione.

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.

Tipo di integrazione
Supporta la funzionalità
Integrazioni in tempo reale (streaming)
No
Integrazioni basate su file (batch)
Sì

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 di batchConfig che 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
   }
Parametro
Tipo
Descrizione
allowMandatoryFieldSelection
Booleano
Imposta su true per consentire ai clienti di specificare quali attributi di profilo sono obbligatori. Il valore predefinito è false. Per ulteriori informazioni, vedere Attributi obbligatori.
allowDedupeKeyFieldSelection
Booleano
Impostare su true per consentire ai clienti di specificare le chiavi di deduplicazione. Il valore predefinito è false. Per ulteriori informazioni, vedere Chiavi di deduplicazione.
defaultExportMode
Enumerazione

Definisce la modalità di esportazione predefinita del file. Valori supportati:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL

Il valore predefinito è DAILY_FULL_EXPORT. Consulta la documentazione sull’attivazione batch per informazioni dettagliate sulla pianificazione delle esportazioni di file.

allowedExportModes
Elenco

Definisce le modalità di esportazione dei file disponibili per i clienti. Valori supportati:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequency
Elenco

Definisce la frequenza di esportazione dei file disponibile per i clienti. Valori supportati:

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY
  • WEEKLY
  • MONTHLY
defaultFrequency
Enumerazione

Definisce la frequenza predefinita di esportazione dei file.Valori supportati:

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY
  • WEEKLY
  • MONTHLY

Il valore predefinito è DAILY.

defaultStartTime
Stringa
Definisce l’ora di inizio predefinita per l’esportazione del file. Utilizza il formato ora 24 ore. Il valore predefinito è “00:00”.
filenameConfig.allowedFilenameAppendOptions
Stringa

Richiesto. 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:

  • DESTINATION
  • SEGMENT_ID
  • SEGMENT_NAME
  • DESTINATION_INSTANCE_ID
  • DESTINATION_INSTANCE_NAME
  • ORGANIZATION_NAME
  • SANDBOX_NAME
  • DATETIME
  • CUSTOM_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.defaultFilenameAppendOptions
Stringa
Richiesto. Macro dei nomi di file predefiniti preselezionate che gli utenti possono deselezionare.

Le macro in questo elenco sono un sottoinsieme di quelle definite in allowedFilenameAppendOptions.
filenameConfig.defaultFilename
Stringa
Facoltativo. Definisce le macro dei nomi di file predefiniti per i file esportati. Non possono essere sovrascritti dagli utenti.

Qualsiasi macro definita da allowedFilenameAppendOptions verrà aggiunta dopo le macro defaultFilename.

Se defaultFilename è vuoto, definire almeno una macro in allowedFilenameAppendOptions.
segmentGroupingEnabled
Booleano

Definisce 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.

TIP
È consigliabile includere sempre la macro 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.
Macro
Etichetta interfaccia utente
Descrizione
Esempio
DESTINATION
Destinazione
Nome della destinazione nell’interfaccia utente.
Amazon S3
SEGMENT_ID
ID segmento
ID pubblico univoco generato da Experience Platform
ce5c5482-2813-4a80-99bc-57113f6acde2
SEGMENT_NAME
Nome segmento
Nome del pubblico definito dall’utente
abbonato VIP
DESTINATION_INSTANCE_ID
ID destinazione
ID univoco generato da Experience Platform dell’istanza di destinazione
7b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
Nome destinazione
Nome definito dall’utente dell’istanza di destinazione.
La mia destinazione Advertising 2022
ORGANIZATION_NAME
Nome organizzazione
Nome dell’organizzazione cliente in Adobe Experience Platform.
Nome organizzazione
SANDBOX_NAME
Nome Sandbox
Nome della sandbox utilizzato dal cliente.
prod
DATETIME / TIMESTAMP
Data e ora

DATETIME e TIMESTAMP definiscono entrambi quando il file è stato generato, ma in formati diversi.

  • DATETIME utilizza il seguente formato: YYYYMMDD_HHMMSS.
  • TIMESTAMP utilizza il formato Unix a 10 cifre.

DATETIME e TIMESTAMP si escludono a vicenda e non possono essere utilizzati contemporaneamente.

  • DATETIME: 20220509_210543
  • TIMESTAMP: 1652131584
CUSTOM_TEXT
Testo personalizzato
Testo personalizzato definito dall’utente da includere nel nome del file. Impossibile utilizzare in defaultFilename.
My_Custom_Text
TIMESTAMP
Data e ora
Timestamp a 10 cifre dell’ora in cui è stato generato il file, in formato Unix.
1652131584
MERGE_POLICY_ID
ID criterio di unione
ID del criterio di unione utilizzato per generare il pubblico esportato. Utilizzare questa macro quando si raggruppano i tipi di pubblico esportati in file in base al criterio di unione. Utilizzare questa macro insieme a segmentGroupingEnabled:true.
e8591fdb-2873-4b12-b63e-15275b1c1439
MERGE_POLICY_NAME
Nome criterio di unione
Nome del criterio di unione utilizzato per generare il pubblico esportato. Utilizzare questa macro quando si raggruppano i tipi di pubblico esportati in file in base al criterio di unione. Utilizzare questa macro insieme a segmentGroupingEnabled:true.
Il mio criterio di unione personalizzato

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%"
}

Immagine dell'interfaccia utente che mostra la schermata di configurazione del nome file con le macro preselezionate

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.

IMPORTANT
Questo oggetto è applicabile solo quando la configurazione di destinazione include "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"
      ]
   }
}
Parametro
Tipo
Descrizione
datasetBatchConfig.allowedFoldernameAppendOptions
Elenco

Richiesto. 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:

  • DESTINATION
  • DATASET_ID
  • DATASET_NAME
  • EXPORT_TIME
  • DESTINATION_INSTANCE_ID
  • DESTINATION_INSTANCE_NAME
  • ORGANIZATION_NAME
  • SANDBOX_NAME
  • DATETIME
  • CUSTOM_TEXT
datasetBatchConfig.defaultFoldernameAppendOptions
Elenco
Richiesto. Macro del nome cartella predefinito preselezionate. Deve essere un sottoinsieme dei valori definiti in allowedFoldernameAppendOptions.
datasetBatchConfig.allowedExportModes
Elenco

Definisce le modalità di esportazione disponibili per gli utenti per le esportazioni dei set di dati. Valori supportati:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
datasetBatchConfig.allowedScheduleFrequency
Elenco

Definisce le opzioni di frequenza di esportazione disponibili per gli utenti per le esportazioni dei set di dati. Valori supportati:

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

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.

Macro
Descrizione
Esempio
DESTINATION
Nome della destinazione nell’interfaccia utente.
Amazon S3
DATASET_ID
ID univoco generato da Experience Platform del set di dati esportato.
6966075 d-f6b4-4a04-bd35-d438e1ebd1c3
DATASET_NAME
Nome del set di dati esportato.
Il mio set di dati
EXPORT_TIME
Tempo di esportazione nel formato exportTime=YYYYMMDDHHMM.
exportTime=202212091200
DESTINATION_INSTANCE_ID
ID univoco generato da Experience Platform dell’istanza di destinazione.
7b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
Nome definito dall’utente dell’istanza di destinazione.
La mia destinazione Advertising 2024
ORGANIZATION_NAME
Nome dell’organizzazione cliente in Adobe Experience Platform.
Nome organizzazione
SANDBOX_NAME
Nome della sandbox utilizzato dal cliente.
prod
DATETIME
Data e ora nel formato YYYYMMDD_HHMMSS.
20220509_210543
CUSTOM_TEXT
Testo personalizzato definito dall’utente da includere nel nome della cartella.
My_Custom_Text

Passaggi 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:

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