Account Engagement API を知る
学習の目的
この単元を完了すると、次のことができるようになります。
- Account Engagement API について説明する。
- Account Engagement API の機能を特定する。
Account Engagement API を拡張する
REST API を使用すると、Account Engagement データにさまざまな方法でアクセスして操作することができます。この API は、Plus Edition、Premium Edition、Advanced Edition で利用できます。このクイックルックでは、さまざまな API バージョン、認証、Account Engagement で提供される API について学習します。
Account Engagement API では、次のことができます。
- Account Engagement を拡張する — 独自のカスタムインテグレーションを構築することで、ビジネスニーズに応じた適切なサポートを提供できます。
- Account Engagement データを補強する — プロスペクトデータのクリーンアップと強化を行い、営業担当者が面倒な作業に費やす時間を削減できます。
- レポート機能を強化する — Account Engagement API を使用して、独自の外部分析ツールへのビジターデータのエクスポートを自動化し、より豊富なインサイトを取得できます。
- ビジネス価値を高める — タスクの自動化、外部データを使用したプロスペクトのセグメント化、カスタム外部スコアリングモデルの作成、プロスペクトの更新を行えます。
API バージョン
Account Engagement API には 3 つのバージョンがあります。どのバージョンを使用するかは、Account Engagement アカウントのタイプと目標によって異なります。
|
バージョン |
対象 |
詳細 |
|
3 |
メールアドレスが同一の複数のプロスペクトを許可しないアカウント (AMPSEA 以外のアカウント) |
バージョン 3 とバージョン 4 はほとんど同じです。どちらを使用するかは、アカウントで AMPSEA が有効になっているかどうかによって決まります。相違点は、エンドポイント URI とプロスペクトオブジェクトで利用できるエンドポイントの 2 つのみです。 |
|
4 |
メールアドレスが同一の複数のプロスペクトを許可するアカウント (AMPSEA アカウント) |
|
|
5 |
すべてのアカウント |
バージョン 5 は未来の Account Engagement API であり、ファイルやレイアウトテンプレートなどのアセットにアクセスできます。このバージョンでは、一部のオブジェクトがまだ利用できません。 |
認証
Account Engagement API の認証には、Salesforce OAuth フローを接続アプリケーションで使用します。OAuth ではトークンが使用されるため、アクセス認証情報を共有することなく、サーバーから別のサーバー上のリソースにアクセスできます。
OAuth フローはさまざまな方法で設定することができますので、「OAuth 認証フロー」をよく読み、使用事例に最適なフローを選択することをお勧めします。
オブジェクト API
キャンペーン、商談、プロスペクトなどの Account Engagement オブジェクトを操作するには、オブジェクト API を使用します。使用可能なアクションは、オブジェクトによって異なります。ビジターアクティビティのような参照のみが可能なオブジェクトもあれば、プロスペクトのような参照、割り当て、作成、更新、削除が可能なオブジェクトもあります。
インポート API
インポート API を使用すると、Account Engagement で大量のプロスペクトデータをプログラムによって挿入または更新できます。この API では、Account Engagement API の既存の構造、パターン、用語が使用されます。また、インポート API では、プロスペクトの CSV ファイルをインポートできます。CSV の列は Account Engagement の項目名に対応します。行は挿入または更新されるプロスペクトに対応します。各列は有効な項目名と一致している必要があります。一致していない場合は、検証が失敗し、CSV が拒否されます。
エクスポート API
同期完了応答が必要ない場合や、クエリ制限が厳しすぎる場合は、エクスポート API を使用して、大きなデータセットを取得します。
エクスポートは、Account Engagement のクエリとデータセットに関連付けられています。エクスポートを作成すると、クエリは小さなクエリに分割され、小さなデータセットが返されます。このような小さなクエリは並行して処理され、取得されたデータは CSV ファイルに保存されます。エクスポートが完了すると、CSV ファイルをダウンロードできるようになります。現在サポートされているオブジェクトについては、Account Engagement の開発者ドキュメントを参照してください。
まとめ
Account Engagement API で実行できること、使用するバージョン、利用可能な API、認証の基本など、多くのことを学習しました。これで、Account Engagement API の使用を開始して、ビジネスニーズを満たす準備が整いました。