More than 5 years have passed since last update.

Bulk APIで参照項目を含むＣＳＶファイルをUpsertする方法

Last updated at 2020-02-24Posted at 2019-08-12

はじめに

最近では外部データを取り込む際に、データ連携ツールのデータローダーやＥＴＬを利用するプロジェクトが多く、ツールが提供している標準の補助機能によってBulk APIの考慮事項を意識せず実装できます。
手組みで実装する場合、具体的に主従や参照項目が設定されている親子関係のオブジェクトで、親の外部ＩＤを指定して子レコードを登録する項目の対応付けなど、明確に定義せず設計時に見落とされがちだと感じます。
ここでは、BulkAPIでSFIDを使わずに親の外部ＩＤでこのレコードを登録する方法を説明します。

概要

API開発ツールのPostmanを使用してBulk APIにアクセスします。BulkAPIの処理の流れは、ジョブ登録、データ項目の対応付け登録、バッチ実行の順に実行します。今回はジョブの終了を割愛し、サードパーティーのデータを想定してデータ項目の対応付けの登録を行います。

1. オブジェクト構成

契約に取引先名が参照項目として設定されており、取引先と契約は親子関係になっている。

2. 登録データ(CSV)の説明

　サードパーティーのデータからSalesforceのリレーションを設定する場合、SFIDではなくサードパーティーのキー項目として外部ＩＤで登録するのが一番簡単な方法です。
　今回利用する登録データ（CSV)のヘッダー項目のAccountIDには、親オブジェクトの取引先の外部ＩＤの契約番号Ａ（ContractA__c）の値が設定されています。※AccountIdはCSVのヘッダー項目であり、Salesforceとは関係がない項目です。

リレーションの説明

各参照項目毎に項目作成時に親オブジェクトのリレーションが作成されます。リレーションを識別する最も確実な方法は、describeSObjects() コールを実行することですが、Enterprise WSDLやAJAX Toolkitでも確認することができます。
今回、標準の取引先オブジェクトと契約オブジェクトを利用し、契約オブジェクトの取引先名（AccountId）は標準項目で、取引先オブジェクトへの親リレーションは”Account”が利用できます。その他、カスタムの参照項目の場合、”__r”のサフィックスが付きます。

3. ジョブの登録

BulkAPIで、データを処理する場合ジョブの作成、項目の対応付け（任意）、バッチの登録、ジョブの終了の処理を順次実行します。まず最初に、ジョブの作成を行います。
以下のエンドポイントを利用します。
https://instance_name—api.salesforce.com/services/async/APIversion/job
ジョブの作成:Salesforcehelp

ジョブの内容は、下記の４つを記載します。

JSON形式でレコード操作（insert|update|delete|upsert）
登録オブジェクト
レコードのキー項目（外部ＩＤ）（※upsert時にのみ）
登録データ形式

正常に登録されると、下図のレスポンスが返ってきます。

Salesforceからも確認できます。

4. 項目の対応付けの登録

サードパーティのデータを利用する場合、登録データのヘッダー行はSalesforceの項目名で設定されてない場合、Salesforceの項目と登録データのヘッダー項目を紐づけるために、項目の対応付けを登録します。

//instance_name—api.salesforce.com/services/async/APIversion/job/jobid/spec

項目の対応付け：SalesforceHelp

CSV形式で項目の対応付けの登録します。

Salesforce Field,Csv Header
ContractNum__c,ContractNum__c
Name,Name
Account.ContractB__c,AccountId

正常処理のレスポンスはありませんが登録できています。２回登録するとエラーが返却されます。

5. バッチの登録

実際に登録データを送信します。
今回は物理ファイルではなく、ボディーにＣＳＶのテキストを張り付けて送信します。
https://instance_name—api.salesforce.com/services/async/APIversion/job/jobid/batch
ジョブへのバッチの追加:SalesforceHelp

メッセージボディーにＣＳＶ形式のデータを貼り付けます。
データは、親の取引先の外部IDがあるパーターンとないパターンで作成しました。

正常に登録されると下図のレスポンスが返却されます。

6. 結果の確認

登録データからSalesforceでBulk実行される際の、要求と結果を確認できます。
Salesforceの[設定]画面 > クイック検索[一括データ読み込みジョブ] > 対象の[ジョブID]をクリック

登録されたデータがジョブ実行される際の要求と結果を確認できます。

[要求]リンクをクリックすると、CSV形式のバッチ登録したデータが表示され、項目の対応づけで登録したマッピングデータでヘッダー部分が置換されていることが確認できます。

[結果]リンクをクリックすると、CSVデータがレコードごとに登録の状態を確認できます。先ほど登録したCSVデータの２レコードは親の取引先の外部IDが存在するパターンと、しないパターンでしないパターンは、外部IDが見つからなかったとエラーでそのレコードが登録できなかったことが確認できます。

画面からも確認できます。