CSV ファイルの準備
CSV ファイルのヘッダー行には、処理するオブジェクトの項目名を記述します。それ以降の行は、Salesforce の各レコードに対応します。
CSV ファイル内のレコードは、すべて同一オブジェクトのレコードである必要があります。オブジェクトは、バッチに関連付けられたジョブで指定します。
Bulk API 2.0 で CSV ファイルを使用する場合は、次の点に注意します。
- レコードを作成するときは、必須項目はもれなく含める必要があります。その他の項目は、必要に応じて含めることができます。
- ファイルの各項目名ヘッダーは、項目の項目名 (標準項目の場合) または API 名 (カスタム項目の場合) と同じにする必要があります。結果には、一致した列のみが含まれます。
- レコードの更新では、CSV ファイルで定義されていない項目は無視されます。
- ファイルでは UTF-8 形式を使用します。ファイルは Salesforce で受信されるときに base64 に変換されます。この変換により、データサイズが約 50% 増加する可能性があります。base64 変換による増加を考慮し、アップロードするデータは 100 MB 以下にします。
- Bulk API 2.0 では、複数の項目区切り文字 (バッククォート (`)、キャレット (^)、カンマ、パイプ (|)、セミコロン、タブ) がサポートされます。デフォルトの区切り文字はカンマです。使用する区切り文字は、ジョブの作成時に columnDelimiter 要求項目を使用して指定します。
- Bulk API 2.0 のジョブを作成する際は、lineEnding 要求項目を使用して、CSV ファイルの作成に使用した行末と同じ行末を指定してください。Bulk API 2.0 では、行末形式として改行 (LF)、および行頭復帰と改行 (CRLF) の 2 つがサポートされています。指定されない場合、デフォルトの行末は LF です。行末を示すために使用される文字は、オペレーティングシステムによって異なります。
- UNIX/Linux/OS X では、LF (改行、「\n」、0x0A) が使用されます。
- Windows/DOS では、CRLF (行頭復帰および改行、「\r\n」、0x0D0A) が使用されます。
- 項目区切り文字または行末と解釈される項目値内の文字は、二重引用符を使用してエスケープします。たとえば、項目値にカンマが含まれていて、カンマがそのジョブの現在の列区切り文字である場合、CSV データ内の項目値を二重引用符で囲む必要があります。たとえば、"Director, Marketing" のようにします。
- 値は切り詰められることはありません。区切り文字の前後に空白文字が挿入されている場合、それらも項目値の一部とみなされます。ただし、二重引用符の前後に空白文字が挿入されている場合は、その行がエラーになります。たとえば、John,Smith は有効な値です。John, Smith も、空白文字が含まれていますが有効です。一方、" Smith"、"John", "Smith" は無効な値となります。
- 項目の値が空である場合、レコードの更新時にはその項目は無視されます。値を null に設定するには、項目値 #N/A を使用します。
- double 型の項目には、小数値を含めることができます。W3C XML Schema Part 2: Datatypes Second Edition の仕様に記載されているとおり、相応に大きな数値の場合は、値を科学的記数法で保存できます。
項目名を検索するには、以下のようにします。
- 『SOAP API 開発者ガイド』に記載されている describeSObjects() コール、または『REST API 開発者ガイド』に記載されている sObject Describe リソースを使用する。
- Salesforce の [設定] ページを使用する。
- オブジェクトリファレンスの、該当するオブジェクトの項目を参照する (各オブジェクトの項目名、データ型、説明がリストされています)。
Salesforce の [設定] ページを使用した項目名の検索
Salesforce の [設定] ページでオブジェクトの項目名を検索する手順は、次のとおりです。
- [設定] から、[クイック検索] ボックスに「オブジェクトマネージャー」と入力します。[オブジェクトマネージャー] をクリックします。
- リスト内のオブジェクトをクリックします。
- オブジェクトの管理設定から、[項目とリレーション] をクリックします。
- Field Label の下の項目をクリックして、項目名を検索します。
標準項目の場合は、項目の詳細ページで [項目名] を確認します。この値が CSV ファイルの列ヘッダーとして使用されます。
カスタム項目の場合は、[API 参照名] を確認します。この値が、CSV ファイル内の項目列ヘッダー、また、XML または JSON ファイル内の項目名 ID として使用されます。(API 参照名を確認するには、項目名をクリックします)。