Bulk API 開発者ガイド
jデータ項目の対応付け
Microsoft Outlook、Google コンタクト、およびその他のサードパーティソースから直接エクスポートされたデータを Bulk API を使用してインポートするには、CSV インポートファイルのデータ項目をすべて Salesforce データ項目に対応付けます。CSV インポートファイルは、Bulk API に準拠している必要はありません。
たとえば、CSV インポートファイルに含まれている Number という項目を、標準の Salesforce 項目である AccountNumber に対応付けるとします。Bulk API を使用する一括処理ジョブを追加すると、Number 項目からのデータは、Salesforce の AccountNumber 項目にインポートされるか、項目を更新します。
データ項目を Salesforce データ項目に対応付ける一括処理ジョブを追加する手順は、次のとおりです。
- データ項目の対応付けを定義する変換仕様 (spec.csv) を作成します (これは、データが含まれる CSV インポートファイルとは異なります)。
- 他の Bulk API ジョブと同様に、オブジェクトとアクションを指定する新しいジョブを作成します。
- 変換仕様をアップロードします。
- データをバッチでサーバに送信します。
対応付けを定義する変換仕様の作成
変換仕様 (spec.csv) は、インポートファイルのデータを、Salesforce データ項目に対応付ける手順を提供します。
spec.csv ファイルには次の 4 つの項目が含まれます。
| 項目 | 説明 |
|---|---|
| Salesforce 項目 | 対応付け先の Salesforce 項目。 |
| Csv Header | 対応付けるインポートファイル内の項目。 |
| Value | デフォルト値。 Bulk API は、この値を次の 2 つの場合に使用します。
この項目は省略可能です。 |
| Hint | Bulk API に、インポートファイルのデータ解釈方法を指示します。 Bulk API は、この値を使用して次の 2 つの処理を実行できます。
この項目は省略可能です。 |
次に、サンプルの spec.csv ファイルを示します。
1Salesforce Field,Csv Header,Value,Hint
2Name,Full Name,,
3Title,Job Title,,
4LeadSource,Lead Source,Import,
5Description,,Imported from XYZ.csv,
6Birthdate,Date of Birth,,dd MM yyこの spec.csv ファイルは、Bulk API に次の処理を行うように指示します。
- インポートファイルの [Full Name] 項目を、Salesforce の LastName 項目と FirstName 項目に対応付ける。
- インポートファイルの Title 項目を、Salesforce の Title 項目に対応付ける。
- インポートファイルの [Lead Source] 項目を、Salesforce の LeadSource 項目に対応付け、さらに、インポートファイルに値がない場合は Import as the default value を使用する。
- Imported from XYZ.csv を、Salesforce の Description 項目のデフォルト値として使用する。
- インポートファイルの [Date of Birth] 項目を、Salesforce の Birthdate 項目に対応付け、さらに、dd MM yy 形式を使用して [Date of Birth] 項目形式を Bulk API で受け入れ可能な形式に変換する。
インポートファイルの対応する内容は次のようになります。
1Full Name,Job Title,Lead Source,Date of Birth,Comment
2"Cat, Tom",DSH,Interview,10 Feb 40,likes Jerry
3Jerry Mouse,House Mouse,,10 Feb 40,likes Tom変換後の対応するリクエストボディは次のようになります。
1LastName,FirstName,Title,LeadSource,Description,Birthdate
2Cat,Tom,DSH,Interview,Imported from XYZ.csv,1940-02-10Z
3Mouse,Jerry,House Mouse,Import,Imported from XYZ.csv,1940-02-10Z変換仕様のアップロード
変換仕様をアップロードするには、POST 要求を次の URI に送信します。
1https://instance_name—api.salesforce.com/services/async/APIversion/job/jobid/spec考慮事項
- 変換仕様は、CSV ファイルである必要があります。XML および JSON ファイルはサポートされていません。
- 変換仕様 (spec.csv ファイル) は、UTF-8 文字コードを使用する必要があります。CSV インポートファイルは、UTF-8 文字コードを使用する必要はありません (文字コードを Content-Type ヘッダーに指定できます)。
- 変換仕様は、永続的ではなく、その範囲は現在のジョブに限定されています。