Configurazione batch

Ultimo aggiornamento: 2023-11-07
  • Argomenti:
  • Destinations
    Visualizza ulteriori informazioni su questo argomento
  • Creato per:
  • Developer
    User
    Admin
    Leader

Utilizza 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 loro preferenze.

Quando crei destinazioni basate su file tramite Destination SDK, puoi configurare la denominazione file predefinita e le pianificazioni di esportazione, oppure puoi dare agli utenti la possibilità di configurare queste impostazioni dall’interfaccia utente di Platform. Ad esempio, puoi configurare comportamenti quali:

  • Includere informazioni specifiche nel nome del file, ad esempio ID pubblico, ID destinazione o informazioni personalizzate.
  • Consente agli utenti di personalizzare la denominazione dei file dall’interfaccia utente di Platform.
  • Configura le esportazioni di file in modo che avvengano a intervalli di tempo impostati.
  • Definisci le opzioni di denominazione dei file e di personalizzazione della pianificazione di esportazione che gli utenti possono visualizzare nell’interfaccia utente di 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 riportato di seguito. opzioni di configurazione o 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 /authoring/destinations endpoint. 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 Platform.

IMPORTANTE

Tutti i nomi e i valori dei parametri supportati da Destination SDK sono distinzione maiuscole/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

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)

Parametri supportati

I valori impostati qui vengono visualizzati in Pianificare l’esportazione del pubblico passaggio del flusso di lavoro di attivazione delle destinazioni basate su file.

"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
   }
Parametro Tipo Descrizione
allowMandatoryFieldSelection Booleano Imposta su true per consentire ai clienti di specificare quali attributi di profilo sono obbligatori. Il valore predefinito è false. Consulta Attributi obbligatori per ulteriori informazioni.
allowDedupeKeyFieldSelection Booleano Imposta su true per consentire ai clienti di specificare le chiavi di deduplicazione. Il valore predefinito è false. Consulta Chiavi di deduplicazione per ulteriori informazioni.
defaultExportMode Enum 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
defaultFrequency Enum Definisce la frequenza di esportazione predefinita dei file. Valori supportati:
  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY
Il valore predefinito è DAILY.
defaultStartTime Stringa Definisce l'ora di inizio predefinita per l'esportazione del file. Utilizza il formato file a 24 ore. Il valore predefinito è "00:00".
filenameConfig.allowedFilenameAppendOptions Stringa Obbligatorio. 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, l'interfaccia utente di Experienci Platform le visualizzerà sempre nell'ordine presentato qui.

Se defaultFilename è vuoto, il allowedFilenameAppendOptions l'elenco deve contenere almeno una macro.
filenameConfig.defaultFilenameAppendOptions Stringa Obbligatorio. Macro dei nomi di file predefiniti preselezionate che gli utenti possono deselezionare.

Le macro di 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à aggiunto dopo il defaultFilename macro.

Se defaultFilename è vuoto, è necessario definire almeno una macro in allowedFilenameAppendOptions.
segmentGroupingEnabled Booleano Definisce se i tipi di pubblico attivati devono essere esportati in un singolo file o in più file, in base al pubblico criterio di unione. 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

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 presenti nell’interfaccia utente di configurazione del nome file schermo.

SUGGERIMENTO

Come best practice, devi sempre includere 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 dalla piattaforma 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 dalla piattaforma 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 pubblicitaria 2022
ORGANIZATION_NAME Nome organizzazione Nome dell’organizzazione del 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 entrambi definiscono 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 utilizzate simultaneamente.
  • DATETIME: 20220509_210543
  • TIMESTAMP: 1652131584
CUSTOM_TEXT Testo personalizzato Testo personalizzato definito dall'utente da includere nel nome del file. Non può essere utilizzato 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 Il 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

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

Passaggi successivi

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:

In questa pagina