批次設定 :headding-anchor:batch-configuration
使用Destination SDK中的批次組態選項可讓使用者自訂匯出的檔案名稱,並根據其偏好設定匯出排程。
當您透過Destination SDK建立以檔案為基礎的目的地時,可以設定預設的檔案命名和匯出排程,也可以讓使用者選擇從Platform UI中設定這些設定。 例如,您可以設定行為指令,例如:
- 在檔案名稱中包含特定資訊,例如對象ID、目的地ID或自訂資訊。
- 允許使用者從Platform UI自訂檔案命名。
- 設定檔案匯出,使其以設定的時間間隔進行。
- 定義使用者可在平台UI中看到的檔案命名和匯出排程自訂選項。
批次組態設定是以檔案為基礎的目的地目的地組態的一部分。
若要瞭解此元件在何處適合使用Destination SDK建立的整合,請參閱設定選項檔案中的圖表,或參閱如何使用Destination SDK設定檔案型目的地的指南。
您可以透過/authoring/destinations
端點設定檔案命名和匯出排程設定。 請參閱下列API參考頁面,以取得詳細的API呼叫範例,您可在此範例設定本頁面中顯示的元件。
本文會說明您可用於目的地的所有支援批次設定選項,並顯示客戶在Platform UI中會看到的內容。
支援的整合型別 :headding-anchor:supported-integration-types
如需瞭解哪些型別的整合支援本頁面所述功能的詳細資訊,請參閱下表。
支援的引數 :headding-anchor:supported-parameters
您在此處設定的值出現在檔案型目的地啟用工作流程的排程對象匯出步驟中。
"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
}
defaultExportMode
定義預設檔案匯出模式。 支援的值:
DAILY_FULL_EXPORT
FIRST_FULL_THEN_INCREMENTAL
預設值為DAILY_FULL_EXPORT
。 如需檔案匯出排程的詳細資訊,請參閱批次啟用檔案。
allowedExportModes
定義客戶可用的檔案匯出模式。 支援的值:
DAILY_FULL_EXPORT
FIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequency
定義客戶可用的檔案匯出頻率。 支援的值:
ONCE
EVERY_3_HOURS
EVERY_6_HOURS
EVERY_8_HOURS
EVERY_12_HOURS
DAILY
defaultFrequency
定義預設檔案匯出頻率。支援的值:
ONCE
EVERY_3_HOURS
EVERY_6_HOURS
EVERY_8_HOURS
EVERY_12_HOURS
DAILY
預設值為 DAILY
。
defaultStartTime
filenameConfig.allowedFilenameAppendOptions
必要。 可供使用者選擇的可用檔案名稱巨集清單。 這會決定要將哪些專案附加至匯出的檔案名稱(對象ID、組織名稱、匯出的日期和時間等)。 設定defaultFilename
時,請務必避免重複巨集。
支援的值:
DESTINATION
SEGMENT_ID
SEGMENT_NAME
DESTINATION_INSTANCE_ID
DESTINATION_INSTANCE_NAME
ORGANIZATION_NAME
SANDBOX_NAME
DATETIME
CUSTOM_TEXT
無論定義巨集的順序為何,Experience PlatformUI一律會依此處呈現的順序顯示巨集。
如果defaultFilename
是空的,則allowedFilenameAppendOptions
清單必須至少包含一個巨集。
filenameConfig.defaultFilenameAppendOptions
此清單中的巨集是
allowedFilenameAppendOptions
中定義的巨集子集。filenameConfig.defaultFilename
allowedFilenameAppendOptions
所定義的任何巨集都會附加到defaultFilename
巨集之後。如果
defaultFilename
是空的,您必須在allowedFilenameAppendOptions
中至少定義一個巨集。segmentGroupingEnabled
根據對象合併原則,定義啟用的對象應匯出為單一檔案還是多個檔案。 支援的值:
true
:每個合併原則匯出一個檔案。false
:無論合併原則為何,都會為每個對象匯出單一檔案。 這是預設行為。 完全忽略此引數也能達到相同的結果。
檔案名稱組態 :headding-anchor:file-name-configuration
使用檔案名稱組態巨集來定義匯出的檔案名稱應包含的內容。 下表中的巨集說明在檔案名稱組態畫面的UI中找到的元素。
SEGMENT_ID
巨集。 區段ID是唯一的,因此將其納入檔案名稱中,也是確保檔案名稱唯一的最佳方式。DESTINATION
SEGMENT_ID
SEGMENT_NAME
DESTINATION_INSTANCE_ID
DESTINATION_INSTANCE_NAME
ORGANIZATION_NAME
SANDBOX_NAME
DATETIME
/ TIMESTAMP
DATETIME
和TIMESTAMP
都定義產生檔案的時間,但格式不同。
DATETIME
使用以下格式: YYYYMMDD_HHMMSS。TIMESTAMP
使用10位數Unix格式。
DATETIME
與TIMESTAMP
互斥,不能同時使用。
DATETIME
: 20220509_210543TIMESTAMP
: 1652131584
CUSTOM_TEXT
defaultFilename
中使用。TIMESTAMP
MERGE_POLICY_ID
segmentGroupingEnabled:true
。MERGE_POLICY_NAME
segmentGroupingEnabled:true
。檔案名稱設定範例
以下設定範例顯示API呼叫中使用的設定與UI中顯示的選項之間的對應。
"filenameConfig":{
"allowedFilenameAppendOptions":[
"CUSTOM_TEXT",
"SEGMENT_ID",
"DATETIME"
],
"defaultFilenameAppendOptions":[
"SEGMENT_ID",
"DATETIME"
],
"defaultFilename": "%DESTINATION%"
}
後續步驟 :headding-anchor:next-steps
閱讀本文後,您應該更瞭解如何為檔案型目的地設定檔案命名和匯出排程。
若要深入瞭解其他目的地元件,請參閱下列文章: