ファイル形式設定
Destination SDK は、統合のニーズに応じて設定できる、柔軟な機能のセットをサポートします。その中に、CSV ファイル形式をサポートする機能があります。
Destination SDK でファイルベースの宛先を作成する場合、書き出された CSV ファイルがどのように書式設定されるべきかを定義できます。以下のように、多くの形式オプションをカスタマイズできます（ただし、これに限定されません）。
- CSV ファイルにヘッダーが含まれる必要があるかどうか
- 値の引用にどの文字を使用するか
- 空の値をどのように表示すべきか。
宛先設定に応じて、ファイルベースの宛先に接続する際に、ユーザーには UI で特定のオプションが表示されます。これらのオプションがどのように見えるかを確認するには、ファイルベースの宛先に対するファイル形式オプションドキュメントを参照してください。
ファイル形式設定は、ファイルベースの宛先に対する宛先サーバー設定の一部です。
このコンポーネントがDestination SDKで作成される統合のどこに適合するかを把握するには、 設定オプションドキュメントの図を参照するか、Destination SDKを使用したファイルベースの宛先の設定方法に関するガイドを参照してください。
/authoring/destination-servers エンドポイントを介してファイル形式オプションを設定できます。このページに表示されるコンポーネントを設定できる、詳細な API 呼び出しの例については、以下の API リファレンスページを参照してください。
このページでは、書き出された CSV ファイルでサポートされるすべてのファイル形式設定を説明します。
IMPORTANT
Destination SDK でサポートされているすべてのパラメーター名および値は、大文字と小文字が区別 されます。大文字と小文字を区別することに関するエラーを避けるために、ドキュメントに示すように、パラメーター名および値を正確に使用してください。
サポートされる統合タイプ supported-integration-types
このページで説明される機能をサポートする統合のタイプについて詳しくは、以下の表を参照してください。
統合タイプ
機能のサポート
リアルタイム（ストリーミング）統合
×
ファイルベースの（バッチ）統合
○
サポートされるパラメーター supported-parameters
Experience Platform から受け取ったファイルを最適に読み取り、解釈するために、書き出されたファイルのいくつかのプロパティを、宛先のファイル受け取りシステムの要件に合わせて変更できます。
NOTE
CSV オプションは、CSV ファイルの書き出し時にのみサポートされます。新しい宛先サーバーを設定する際、
fileConfigurations セクションは必須ではありません。CSV オプションの API 呼び出しで値を渡さない場合、後述の参照テーブルのデフォルト値が使用されます。ユーザーが設定オプションを選択できない CSV オプション file-configuration-templating-none
以下の設定例では、すべての CSV オプションが事前定義済みです。各 csvOptions パラメーターで定義された書き出し設定は、最終的なもので、ユーザーが変更することはできません。
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
},
"maxFileRowCount":5000000,
"includeFileManifest": {
"templatingStrategy":"PEBBLE_V1",
"value":"{{ customerData.includeFileManifest }}"
}
}
ユーザーが設定オプションを選択できる CSV オプション file-configuration-templating-pebble
以下の設定例では、どの CSV オプションも事前定義されていません。各 csvOptions パラメーターの value は、/destinations エンドポイントを通じて、対応する顧客データフィールドで設定され（例：quote ファイル形式オプションの customerData.quote）、ユーザーは、Experience Platform UI を使用して、対応する顧客データフィールドで設定する様々なオプションを選択できます。これらのオプションがどのように見えるかを確認するには、ファイルベースの宛先に対するファイル形式オプションドキュメントを参照してください。
{
"fileConfigurations":{
"compression":{
"templatingStrategy":"PEBBLE_V1",
"value":"{% if customerData contains 'compression' and customerData.compression is not empty %}{{customerData.compression}}{% else %}NONE{% endif %}"
},
"fileType":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.fileType}}"
},
"csvOptions":{
"sep":{
"templatingStrategy":"PEBBLE_V1",
"value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'delimiter' %}{{customerData.csvOptions.delimiter}}{% else %},{% endif %}"
},
"quote":{
"templatingStrategy":"PEBBLE_V1",
"value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'quote' %}{{customerData.csvOptions.quote}}{% else %}\"{% endif %}"
},
"escape":{
"templatingStrategy":"PEBBLE_V1",
"value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'escape' %}{{customerData.csvOptions.escape}}{% else %}\\{% endif %}"
},
"nullValue":{
"templatingStrategy":"PEBBLE_V1",
"value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'nullValue' %}{{customerData.csvOptions.nullValue}}{% else %}null{% endif %}"
},
"emptyValue":{
"templatingStrategy":"PEBBLE_V1",
"value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'emptyValue' %}{{customerData.csvOptions.emptyValue}}{% else %}{% endif %}"
}
},
"maxFileRowCount":5000000,
"includeFileManifest": {
"templatingStrategy":"PEBBLE_V1",
"value":"{{ customerData.includeFileManifest }}"
}
}
}
サポートされるファイル形式オプションの完全なリファレンスおよび例 file-formatting-reference-and-example
TIP
後述の CSV ファイル形式オプションは、CSV ファイル用 Apache Spark ガイドにもドキュメント化されています。以下で使用される説明は、Apache Spark ガイドから引用しています。
以下は、各オプションの出力例を含む、Destination SDK で使用できるすべてのファイル形式オプションの完全なリファレンスです。
フィールド
必須／オプション
説明
デフォルト値
出力例 1
出力例 2
templatingStrategy必須
設定する各ファイル形式オプションについて、パラメーター templatingStrategy を追加する必要があります。このパラメーターは、以下の 2 つの値を持つことができます。
-
-
-
compression.valueオプション
データをファイルに保存する際に使用する圧縮コーデック。サポートされている値：
none、bzip2、gzip、lz4、snappy。none-
-
fileType.valueオプション
出力ファイル形式を指定します。サポートされている値：
csv、parquet、json。csv-
-
csvOptions.quote.valueオプション
"fileType.value": "csv" の場合のみ。引用された値をエスケープするために使用する 1 文字を設定します。区切り記号を値の一部として使用することもできます。nullデフォルト値の例：
quote.value: "u0000" —> male,NULJohn,LastNameNULカスタムの例：
quote.value: "\"" —> male,"John,LastName"csvOptions.quoteAll.valueオプション
"fileType.value": "csv" の場合のみ。すべての値を常に引用符で囲む必要があるかどうかを示します。デフォルトでは、引用符文字を含む値のみをエスケープします。falsequoteAll:false --> male,John,"TestLastName"quoteAll:true -->"male","John","TestLastName"csvOptions.delimiter.valueオプション
"fileType.value": "csv" の場合のみ。各フィールドと値の区切り文字を設定します。この区切り文字には、1 つまたは複数の文字を指定できます。,delimiter:, --> comma-separated values"delimiter:\t --> tab-separated valuescsvOptions.escape.valueオプション
"fileType.value": "csv" の場合のみ。既に引用されている値の内部で引用符をエスケープするために使用する 1 文字を設定します。\"escape":"\\" --> male,John,"Test,\"LastName5""escape":"'" --> male,John,"Test,'''"LastName5"csvOptions.escapeQuotes.valueオプション
"fileType.value": "csv" の場合のみ。引用符を含む値を、常に引用符で囲む必要があるかどうかを示します。デフォルトでは、引用符文字を含むすべての値をエスケープします。true-
-
csvOptions.header.valueオプション
"fileType.value": "csv" の場合のみ。列の名前を書き出されたファイルの最初の行として記述するかどうかを示します。true-
-
csvOptions.ignoreLeadingWhiteSpace.valueオプション
"fileType.value": "csv" の場合のみ。値から先頭の空白をトリミングするかどうかを示します。trueignoreLeadingWhiteSpace:true --> "male","John","TestLastName"ignoreLeadingWhiteSpace:false–> " male","John","TestLastName"csvOptions.ignoreTrailingWhiteSpace.valueオプション
"fileType.value": "csv" の場合のみ。値から末尾の空白をトリミングするかどうかを示します。trueignoreTrailingWhiteSpace:true --> "male","John","TestLastName"ignoreTrailingWhiteSpace:false–> "male ","John","TestLastName"csvOptions.nullValue.valueオプション
"fileType.value": "csv" の場合のみ。null 値の文字列表現を設定します。""nullvalue:"" --> male,"",TestLastNamenullvalue:"NULL" --> male,NULL,TestLastNamecsvOptions.dateFormat.valueオプション
"fileType.value": "csv" の場合のみ。日付の形式を示します。yyyy-MM-dddateFormat:yyyy-MM-dd --> male,TestLastName,John,2022-02-24dateFormat:MM/dd/yyyy --> male,TestLastName,John,02/24/2022csvOptions.timestampFormat.valueオプション
"fileType.value": "csv" の場合のみ。タイムスタンプ形式を示す文字列を設定します。yyyy-MM-dd'T'HH:mm:ss[.SSS][XXX]-
-
csvOptions.charToEscapeQuoteEscaping.valueオプション
"fileType.value": "csv" の場合のみ。引用符文字のエスケープに使用する 1 文字を設定します。エスケープ文字と引用符文字が異なる場合は
\。エスケープ文字と引用符文字が同じ場合は \0 を使用します。-
-
csvOptions.emptyValue.valueオプション
"fileType.value": "csv" の場合のみ。空の値の文字列表現を設定します。"""emptyValue":"" --> male,"",John"emptyValue":"empty" --> male,empty,JohnmaxFileRowCountオプション
書き出されるファイルごとの最大行数を 1,000,000～10,000,000 行の範囲で示します。
5,000,000
includeFileManifestオプション
ファイルの書き出しと共にファイル マニフェストの書き出しのサポートを有効にします。 マニフェスト JSON ファイルには、エクスポートの場所、エクスポートサイズなどに関する情報が含まれています。 マニフェストには、形式
manifest-<<destinationId>>-<<dataflowRunId>>.json を使用して名前を付けます。サンプル マニフェスト ファイルを表示します。 マニフェストファイルには、次のフィールドが含まれています。
flowRunId：書き出されたファイルを生成した データフロー実行。scheduledTime: ファイルが書き出された時間（UTC 単位）。exportResults.sinkPath：書き出されたファイルが格納されるストレージの場所のパス。exportResults.name：書き出すファイルの名前。size：書き出されたファイルのサイズ（バイト単位）。
次の手順 next-steps
この記事を読むことで、宛先サーバー設定でのファイル形式の仕組み、およびどのように設定できるかについて、理解を深めることができました。
その他の宛先サーバーコンポーネントについて詳しくは、以下の記事を参照してください。
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6