はじめに

Bulk API を使用するケース

Bulk API は、REST 規則に基づいており、大規模データセットの読み込みまたは削除用に最適化されています。 Bulk API を使用すると、Salesforce のバックグラウンド処理で複数のバッチを送信することにより、多数のレコードを非同期にクエリ、挿入、更新、更新/挿入または削除できます。

SOAP API は、一度に少数のレコードを更新するリアルタイムのクライアントアプリケーション用に最適化されています。SOAP API を使用しても多数のレコードを処理することはできますが、数百、数千のレコードがデータセットに含まれている場合には実用性に欠けます。 Bulk API は、千から百万単位のレコードのデータを簡単に読み込めるように設計されています。

Bulk API の最も簡単な使用方法は、CSV ファイルを使ってデータローダでレコードの処理ができるようにすることです。これにより、独自のクライアントアプリケーションを作成する必要がなくなります。

SOAP API を使用するケース

SOAP API では、Salesforce を操作するための強力��便利で、使いやすい SOAP ベースの Web サービスインターフェースを提供します。SOAP API を使用して、レコードを作成、取得、更新、または削除できます。また、SOAP API を使用して、検索の実行などを行うことができます。SOAP API は、Web サービスをサポートしている言語で使用できます。

たとえば、SOAP API を使用して Salesforce を組織の ERP や会計システムに統合し、リアルタイムの販売情報やサポート情報を会社のポータルに配信して、重要なビジネスシステムに顧客情報を投入します。

REST API を使用するケース

REST API では、Salesforce を操作するための強力で便利で、使いやすい REST ベースの Web サービスインターフェースを提供します。インテグレーションや開発が容易になるという利点があり、モバイルアプリケーションや Web プロジェクトで使用するための技術の選択としては最適です。ただし、処理するレコード件数が多い場合、REST 規則に基づいており、大規模データセットの処理用に最適化されている Bulk API を使用することをお勧めします。

メタデータ API を使用するケース

メタデータ API を使用して、組織のカスタマイズを取得、リリース、作成、更新、または削除します。最も一般的な使い方は、Sandbox またはテスト組織から本番環境への変更の移行です。メタデータ API は、カスタマイズを管理し、データ自体ではなくメタデータモデルを管理可能なツールを構築することを目的とします。

Force.com IDE または Force.com 移行ツールを使用すると、最も簡単にメタデータ API の機能にアクセスできます。これらのツールはメタデータ API の上位に構築され、メタデータ API との連携タスクを簡略化するために標準 Eclipse および Ant ツールを使用します。Eclipse プラットフォームで開発された Force.com IDE は、統合された開発環境に慣れているプログラマに快適な環境を提供し、IDE 内でコード記述、コンパイル、テスト、リリースのすべてを行うことができます。Force.com 移行ツールは、スクリプトまたはコマンドラインユーティリティを使用してローカルディレクトリと Salesforce 組織間でメタデータを移動する場合に最適です。

Bulk API によって可能になること

REST Bulk API では、大量のレコードを非同期でクエリ、挿入、更新、更新/挿入、削除できます。レコードには、Attachment オブジェクトや Salesforce CRM Content などのバイナリ型の添付ファイルを含めることができます。まず、HTTP POST を使用して、サーバに一連のバッチを送信します。バッチを受け取ったサーバは、バックグラウンドで処理を実行します。バッチの処理が行われている間は、HTTP GET コールを使用してジョブの状況を確認し、進行状況を追跡できます。すべての処理では、HTTP GET メソッドまたは HTTP POST メソッドを使用して、XML データや CSV データが送受信されます。

Bulk API のしくみ

一連のレコードを処理するには、1 つ以上のバッチを含むジョブを作成します。このジョブは、処理されるオブジェクトと使用されるアクションのタイプ (クエリ、挿入、更新/挿入、更新、または削除) を指定します。 バッチは、HTTP POST 要求でサーバに送信されるレコードセットです。各バッチはサーバによって独自に処理されます。受信した順序で処理されるとは限りません。 バッチは並列処理が可能です。データセット全体をどのように適切な数のバッチに分割するかは、クライアント側で決定されます。

ジョブは JobInfo リソースで表されます。このリソースは、新規ジョブの作成、既存のジョブの状況の取得、ジョブの状況の変更に使用します。 バッチを作成するには、レコードのセット、およびバイナリ型添付ファイルへの参照を表す、CSV ファイルまたは XML ファイルを HTTP POST 要求で送信します。作成したバッチの状況は BatchInfo リソースで表されます。バッチの処理が完了すると、各レコードの結果が結果セットのリソースとして提供されます。

このプロセス中には、いつでもジョブを中止できます。ジョブを中止すると、その時点で未処理のバッチは処理されなくなります。すでに処理されたバッチが元に戻されることはありません。