バッチ設定 batch-configuration
Destination SDK でバッチ設定オプションを使用して、ユーザーに、書き出されたファイル名のカスタマイズと、その環境設定に応じた書き出しスケジュールの設定を許可します。
Destination SDKでファイルベースの宛先を作成する場合、デフォルトのファイル名および書き出しスケジュールを設定したり、Experience Platform UI からこれらの設定を行うオプションをユーザーに与えたりできます。 例えば、以下のような動作を設定できます。
- ファイル名に特定の情報（オーディエンス ID、宛先 ID、カスタム情報など）を含める。
- Experience Platform UI からファイル名をカスタマイズできるようにします。
- 設定した間隔でファイル書き出しが発生するように設定する。
- Experience Platform UI でユーザーに表示されるファイル名および書き出しスケジュールのカスタマイズオプションを定義する。
バッチ設定は、ファイルベースの宛先に対する宛先設定の一部です。
このコンポーネントがDestination SDKで作成される統合のどこに適合するかを把握するには、 設定オプション ドキュメントの図を参照するか、Destination SDKを使用したファイルベースの宛先の設定 方法に関するガイドを参照してください。
/authoring/destinations エンドポイントを介してファイル名および書き出しスケジュールを設定できます。このページに表示されるコンポーネントを設定できる、詳細な API 呼び出しの例については、以下の API リファレンスページを参照してください。
この記事では、宛先に使用できる、サポートされるすべてのバッチ設定オプションを説明し、Experience Platform UI で顧客に何が表示されるかを示します。
サポートされる統合タイプ supported-integration-types
このページで説明される機能をサポートする統合のタイプについて詳しくは、以下の表を参照してください。
サポートされるパラメーター 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",
"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
}
allowMandatoryFieldSelectionallowDedupeKeyFieldSelectiondefaultExportModeデフォルトのファイルのエクスポートモードを定義します。サポートされている値：
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
デフォルト値は DAILY_FULL_EXPORT です。ファイルエクスポートのスケジューリングについて詳しくは、バッチ有効化ドキュメントを参照してください。
allowedExportModes顧客が使用できるファイルのエクスポートモードを定義します。サポートされている値：
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequency顧客が使用できるファイルエクスポートの頻度を定義します。サポートされている値：
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILYWEEKLYMONTHLY
defaultFrequencyデフォルトのファイルエクスポートの頻度を定義します。サポートされている値を以下に示します。
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILYWEEKLYMONTHLY
デフォルト値は DAILY です。
defaultStartTimefilenameConfig.allowedFilenameAppendOptions必須。ユーザーが選択できる、使用可能なファイル名マクロのリスト。書き出されたファイル名に追加される項目を決定します（オーディエンス ID、組織名、書き出し日時など）。defaultFilename を設定する場合、必ずマクロが重複するのを避けてください。
サポートされている値：
DESTINATIONSEGMENT_IDSEGMENT_NAMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIMECUSTOM_TEXT
マクロを定義する順序にかかわらず、Experience Platform UI は、常に、ここに提示された順序で表示します。defaultFilename が空の場合、allowedFilenameAppendOptions リストには、少なくとも 1 つのマクロが含まれている必要があります。
filenameConfig.defaultFilenameAppendOptionsこのリストのマクロは、
allowedFilenameAppendOptions で定義されたもののサブセットです。filenameConfig.defaultFilenameallowedFilenameAppendOptions で定義されたマクロは、defaultFilename マクロの後に追加されます。defaultFilename が空の場合、allowedFilenameAppendOptions に少なくとも 1 つのマクロを定義する必要があります。segmentGroupingEnabledオーディエンス結合ポリシーに基づいて、アクティブ化されたオーディエンスを単一のファイルで書き出すか複数のファイルで書き出すかを定義します。サポートされている値：
true：結合ポリシーごとに 1 つのファイルを書き出します。false：結合ポリシーに関係なく、オーディエンスごとに 1 つのファイルを書き出します。これはデフォルトの動作です。このパラメーターを完全に省略しても、同じ結果を得ることができます。
ファイル名設定 file-name-configuration
ファイル名設定マクロを使用して、書き出されたファイル名に含まれる必要があるものを定義します。以下の表にあるマクロは、ファイル名設定画面の UI で見つかる要素を記述します。
SEGMENT_ID マクロを含める必要があります。セグメント ID は一意なので、ファイル名にそれらを含めることは、ファイル名も必ず一意にするための最適な方法です。DESTINATIONSEGMENT_IDSEGMENT_NAMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIME または TIMESTAMPDATETIME と TIMESTAMP は両方とも、ファイルが生成されたタイミングを定義しますが、形式が異なります。
DATETIMEは、YYYYMMDD_HHMMSS の形式を使用します。TIMESTAMPは、10 桁の Unix 形式を使用します。
DATETIME と TIMESTAMP は、相互に排他的で、同時に使用できません。
DATETIME：20220509_210543TIMESTAMP：1652131584
CUSTOM_TEXTdefaultFilename で使用することはできません。TIMESTAMPMERGE_POLICY_IDsegmentGroupingEnabled:true と併用してください。MERGE_POLICY_NAMEsegmentGroupingEnabled:true と併用してください。ファイル名設定の例
以下の設定例に、API 呼び出しで使用される設定と UI に表示されるオプションの対応を示します。
"filenameConfig":{
"allowedFilenameAppendOptions":[
"CUSTOM_TEXT",
"SEGMENT_ID",
"DATETIME"
],
"defaultFilenameAppendOptions":[
"SEGMENT_ID",
"DATETIME"
],
"defaultFilename": "%DESTINATION%"
}
次の手順 next-steps
この記事を読むことで、ファイルベースの宛先に対するファイル名および書き出しスケジュールの設定方法について、理解を深めることができました。
その他の宛先コンポーネントについて詳しくは、以下の記事を参照してください。