ドキュメントExperience Platform宛先ガイド

バッチ設定 batch-configuration

最終更新日： 2026年9月10日

作成対象：

  • ユーザー
  • 管理

Destination SDKのバッチ設定オプションを使用して、ユーザーが書き出されたファイル名をカスタマイズし、好みに応じて書き出しスケジュールを設定できるようにします。

Destination SDKを使用してファイルベースの宛先を作成する場合、デフォルトのファイル命名と書き出しスケジュールを設定するか、ユーザーにExperience Platform UIからこれらの設定を設定するオプションを提供できます。 例えば、以下のような動作を設定できます。

  • ファイル名に、オーディエンス ID、宛先ID、カスタム情報などの特定の情報を含めます。
  • ユーザーがExperience Platform UIからファイル名をカスタマイズできるようにします。
  • 設定した間隔でファイル書き出しが発生するように設定する。
  • ユーザーがExperience Platform UIで表示できるファイルの命名と書き出しスケジュールのカスタマイズ オプションを定義します。

バッチ設定は、ファイルベースの宛先に対する宛先設定の一部です。

このコンポーネントがDestination SDKで作成された統合にどの程度適合するかを理解するには、configuration options ドキュメントの図を参照するか、Destination SDKを使用してファイルベースの宛先を設定する方法に関するガイドを参照してください。

/authoring/destinations エンドポイントを介してファイル名および書き出しスケジュールを設定できます。 このページに表示されるコンポーネントを設定できる、詳細な API 呼び出しの例については、以下の API リファレンスページを参照してください。

この記事では、宛先に使用できるサポートされているすべてのバッチ設定オプションについて説明し、Experience Platform UIで表示される内容を示します。

IMPORTANT
Destination SDKでサポートされているすべてのパラメーター名と値は​大文字と小文字が区別されます。 大文字と小文字の区別エラーを回避するには、ドキュメントに示すように、パラメーター名と値を正確に使用します。

サポートされる統合タイプ supported-integration-types

このページで説明される機能をサポートする統合のタイプについて詳しくは、以下の表を参照してください。

統合タイプ
機能のサポート
リアルタイム（ストリーミング）統合
×
ファイルベースの（バッチ）統合
○

batchConfig対datasetBatchConfig batchconfig-vs-datasetbatchconfig

このページでは、次の2つの関連する異なる設定オブジェクトについて説明します。

  • batchConfig: オーディエンス​を書き出す宛先（人物、アカウント、見込み客オーディエンス）のファイルの命名設定と書き出しスケジュール設定を制御します。
  • datasetBatchConfig: batchConfig内のネストされたオブジェクトで、データセット​を書き出す宛先に特化した、フォルダーの命名規則と書き出しスケジュール設定を制御します。 宛先がデータセットの書き出しをサポートしている場合（つまり、宛先設定で"sources": ["DATASETS"]が設定されている場合）に使用します。

サポートされるパラメーター supported-parameters

ここで設定する値は、ファイルベース宛先アクティブ化ワークフローのオーディエンスの書き出しスケジュールを設定ステップで表示されます。

"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
   }
パラメーター
タイプ
説明
allowMandatoryFieldSelection
ブール
true に設定すると、顧客は必須のプロファイル属性を指定できます。 デフォルト値は false です。 詳しくは、必須の属性を参照してください。
allowDedupeKeyFieldSelection
ブール
true に設定すると、顧客は重複排除キーを指定できます。 デフォルト値は false です。 詳しくは、重複排除キーを参照してください。
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
  • WEEKLY
  • MONTHLY
defaultFrequency
列挙

デフォルトのファイル書き出し頻度を定義します。サポートされている値：

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

デフォルト値は DAILY です。

defaultStartTime
文字列
ファイルエクスポートのデフォルトの開始時間を定義します。 24 時間のファイル形式を使用します。 デフォルト値は「00:00」です。
filenameConfig.allowedFilenameAppendOptions
文字列

必須。 ユーザーが選択できる、使用可能なファイル名マクロのリスト。 書き出されたファイル名に追加される項目を決定します（オーディエンス ID、組織名、書き出し日時など）。 defaultFilename を設定する場合、必ずマクロが重複するのを避けてください。

サポートされている値：

  • DESTINATION
  • SEGMENT_ID
  • SEGMENT_NAME
  • DESTINATION_INSTANCE_ID
  • DESTINATION_INSTANCE_NAME
  • ORGANIZATION_NAME
  • SANDBOX_NAME
  • DATETIME
  • CUSTOM_TEXT

マクロを定義する順序に関係なく、Experience Platform UIは常にここに表示される順序でマクロを表示します。

defaultFilenameが空の場合、allowedFilenameAppendOptions リストには少なくとも1つのマクロが含まれている必要があります。

filenameConfig.defaultFilenameAppendOptions
文字列
必須。 ユーザーがチェックを解除できる、事前に選択された既定のファイル名マクロ。

このリストのマクロは、allowedFilenameAppendOptionsで定義されているマクロのサブセットです。
filenameConfig.defaultFilename
文字列
オプション。 書き出されたファイル用にデフォルトのファイル名マクロを定義します。 ユーザーは、これらを上書きできません。

allowedFilenameAppendOptions で定義されたマクロは、defaultFilename マクロの後に追加されます。

defaultFilename が空の場合、allowedFilenameAppendOptions に少なくとも 1 つのマクロを定義する必要があります。
segmentGroupingEnabled
ブール

オーディエンス結合ポリシーに基づいて、アクティブ化されたオーディエンスを単一のファイルで書き出すか複数のファイルで書き出すかを定義します。 サポートされている値：

  • true：結合ポリシーごとに 1 つのファイルを書き出します。
  • false：結合ポリシーに関係なく、オーディエンスごとに 1 つのファイルを書き出します。 これはデフォルトの動作です。 このパラメーターを完全に省略しても、同じ結果を得ることができます。

ファイル名設定 file-name-configuration

ファイル名設定マクロを使用して、書き出されたファイル名に含まれる必要があるものを定義します。 以下の表にあるマクロは、ファイル名設定画面の UI で見つかる要素を記述します。

TIP
ベストプラクティスとして、常に、書き出されたファイル名に SEGMENT_ID マクロを含める必要があります。 セグメント ID は一意なので、ファイル名にそれらを含めることは、ファイル名も必ず一意にするための最適な方法です。
マクロ
UI ラベル
説明
例
DESTINATION
宛先
UI の宛先名。
Amazon S3
SEGMENT_ID
​ セグメント ID
Experience Platformで生成された一意のオーディエンス ID
ce5c5482-2813-4a80-99bc-57113f6acde2
SEGMENT_NAME
​ セグメント名
ユーザー定義のオーディエンス名
VIP subscriber
DESTINATION_INSTANCE_ID
宛先ID
宛先インスタンスの一意のExperience Platform生成ID
77b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
宛先名
宛先インスタンスのユーザー定義の名前。
My 2022 Advertising Destination
ORGANIZATION_NAME
組織名
Adobe Experience Platformの顧客組織の名前。
My Organization Name
SANDBOX_NAME
​ サンドボックス名
顧客によって使用されるサンドボックスの名前。
prod
DATETIME / TIMESTAMP
日時

DATETIME と TIMESTAMP は両方とも、ファイルが生成されたタイミングを定義しますが、形式が異なります。

  • DATETIME は、YYYYMMDD_HHMMSS の形式を使用します。
  • TIMESTAMP は、10 桁の Unix 形式を使用します。

DATETIME と TIMESTAMP は、相互に排他的で、同時に使用できません。

  • DATETIME：20220509_210543
  • TIMESTAMP：1652131584
CUSTOM_TEXT
​ カスタムテキスト ​
ファイル名に含まれる、ユーザー定義のカスタムテキスト。 defaultFilename で使用することはできません。
My_Custom_Text
TIMESTAMP
日時
ファイルが生成された時間の 10 桁のタイムスタンプ（Unix 形式）。
1652131584
MERGE_POLICY_ID
結合ポリシーID
書き出されたオーディエンスを生成するために使用される結合ポリシーの ID。 このマクロは、結合ポリシーに基づいてファイル内の書き出されたオーディエンスをグループ化する際に使用します。 このマクロは segmentGroupingEnabled:true と併用してください。
e8591fdb-2873-4b12-b63e-15275b1c1439
MERGE_POLICY_NAME
結合ポリシー名
書き出されたオーディエンスの生成に使用される結合ポリシーの名前。 このマクロは、結合ポリシーに基づいてファイル内の書き出されたオーディエンスをグループ化する際に使用します。 このマクロは segmentGroupingEnabled:true と併用してください。
カスタム結合ポリシー

ファイル名設定の例 file-name-configuration-example

以下の設定例に、API 呼び出しで使用される設定と UI に表示されるオプションの対応を示します。

"filenameConfig":{
   "allowedFilenameAppendOptions":[
      "CUSTOM_TEXT",
      "SEGMENT_ID",
      "DATETIME"
   ],
   "defaultFilenameAppendOptions":[
      "SEGMENT_ID",
      "DATETIME"
   ],
   "defaultFilename": "%DESTINATION%"
}

事前選択されたマクロを含むファイル名設定画面を示す UI 画像

データセット書き出し設定 dataset-export-configuration

batchConfig内にネストされたdatasetBatchConfig オブジェクトを使用して、​ データセットの書き出しをサポートする宛先のフォルダー命名と書き出しスケジュールを設定します。

IMPORTANT
このオブジェクトは、宛先設定に"sources": ["DATASETS"]が含まれている場合にのみ適用されます。 完全な宛先設定例については、​ オーディエンスデータタイプの設定を参照するか、​ データセット書き出し先の設定のステップバイステップガイドに従ってください。
"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.allowedFoldernameAppendOptions
リスト

必須。 ユーザーが選択できるフォルダー名マクロのリスト。 これらは、書き出しフォルダーのパスに追加される項目を決定します。 defaultFoldernameAppendOptionsが空の場合、ここで少なくとも1つのマクロを指定する必要があります。 サポートされている値：

  • DESTINATION
  • DATASET_ID
  • DATASET_NAME
  • EXPORT_TIME
  • DESTINATION_INSTANCE_ID
  • DESTINATION_INSTANCE_NAME
  • ORGANIZATION_NAME
  • SANDBOX_NAME
  • DATETIME
  • CUSTOM_TEXT
datasetBatchConfig.defaultFoldernameAppendOptions
リスト
必須。 事前に選択されたデフォルトのフォルダー名マクロ。 allowedFoldernameAppendOptionsで定義された値のサブセットである必要があります。
datasetBatchConfig.allowedExportModes
リスト

データセットの書き出しにユーザーが使用できる書き出しモードを定義します。 サポートされている値：

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
datasetBatchConfig.allowedScheduleFrequency
リスト

データセットの書き出しにユーザーが使用できる書き出し頻度オプションを定義します。 サポートされている値：

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

フォルダー名マクロ folder-name-macros

次の表のマクロは、allowedFoldernameAppendOptionsおよびdefaultFoldernameAppendOptionsで使用して、データセット書き出しフォルダーのパスの構造を定義できます。

マクロ
説明
例
DESTINATION
UI の宛先名。
Amazon S3
DATASET_ID
書き出されたデータセットの一意のExperience Platform生成ID。
6966075d-f6b4-4a04-bd35-d438e1ebd1c3
DATASET_NAME
書き出されたデータセットの名前。
マイデータセット
EXPORT_TIME
時間をexportTime=YYYYMMDDHHMM形式で書き出します。
exportTime=202212091200
DESTINATION_INSTANCE_ID
宛先インスタンスの一意のExperience Platform生成ID。
77b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
宛先インスタンスのユーザー定義の名前。
My 2024 Advertising Destination
ORGANIZATION_NAME
Adobe Experience Platformの顧客組織の名前。
My Organization Name
SANDBOX_NAME
顧客によって使用されるサンドボックスの名前。
prod
DATETIME
形式YYYYMMDD_HHMMSSの日時。
20220509_210543
CUSTOM_TEXT
フォルダー名に含めるユーザー定義カスタムテキスト。
My_Custom_Text

次の手順 next-steps

この記事を読むことで、ファイルベースの宛先に対するファイル名および書き出しスケジュールの設定方法について、理解を深めることができました。

その他の宛先コンポーネントについて詳しくは、以下の記事を参照してください。

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