Pardot APIを利用する方法

Pardot APIとは、Pardotのプロスペクト、ビジター、Eメール等のデータに外部からアクセスするための手段。他のシステムと連携してPardot上のデータを確認したり、更新できるようになります。

今回は、

「Pardot APIを使うとどんなことができるの？！」

と考えるマーケターやエンジニアのために、いざという時に役立つかもしれない？Pardot APIについて紹介します。

1. Pardot APIの利用例
2. Pardot APIの紹介
3. Pardot APIの使用方法

それではまいりましょう。

* 本ブログはPardot API Version4について紹介したものです。Pardot API Version3では呼び出し方法等が異なる場合もありますのでご注意ください。

PardotはSalesforceと組み合わせて使えるので、標準機能だけで様々なことができます。
それらを利用するだけで多くのことが可能になりますが、もしPardotを他のサービスと連携させたい場合にはAPIが必要になるでしょう。

後の章で詳しく説明しますが、Pardot APIはREST APIのルールで作成されているので多くのサービスと連携できます。

ここからはPardot APIについて紹介します。

すべてのPardot APIを確認する場合はこちら

プロスペクトの処理を行えます。
全ての処理でAPIユーザーキーとAPIキーをヘッダーに指定し、使用します。

* 検索パラメータに、一部の標準項目やカスタム項目は使用できません。それらの項目を指定して検索する場合、取得したデータに対して、ご自身で絞り込みを行う必要があります。

* 一覧取得系のAPIについて注意点
Pardotの取得系APIは一度に200件まで取得可能です。
それ以上のデータを取得する場合、オフセットパラメーターに数値を指定し、処理を行います。

例：400件のデータがある場合

1. 200件のデータを取得
2. 取得したデータにオフセット値が入っているので、それを確認（この場合200が入っている）
3. オフセット値である200をパラメーターに指定して残りの200件のデータを取得

これからPardot APIを利用する方法について紹介します。

最初にお伝えしたいことは、Pardot APIがWEB標準のAPIルールで作成されているという点。

APIの名前はREST APIといいます。

Pardot APIの使い方をかんたんに説明するため、REST APIに対応し、MacやWindows上で動作するInsomniaというツールを使用します。

Pardot APIを利用するためには次の3つ情報を集める必要があります。

- Eメール
- パスワード
- APIユーザーキー

Eメールとパスワードは普段利用しているPardotのログインに使用しているものです。
APIユーザーキーはPardotの「私のプロファイル」画面で確認することができます。

Pardotのサイトを開き、APIを利用するユーザーでログインし、画面右上の「設定」⇒「私のプロファイル」⇒「API ユーザーキー」を調べてください。

Eメール、パスワード、APIユーザーキーの3つが揃ったら、Pardot APIを使用してみましょう。

Pardot APIの基本的な使用方法は

という順番です。

まずは、APIキーの取得するための処理を行いましょう。
Insomniaに下記のコマンドを入力します。

メソッド：POST
URL:https://pi.pardot.com/api/login/version/4

Multipart :
email= APIを利用するユーザーのメールアドレス
password= APIを利用するユーザーのパスワード
user_key = APIユーザーキー

取得したAPIキーは1時間有効です。1時間経過後、再度取得する必要があります。

APIキーを取得したら、プロスペクトを取得してみましょう。
このサンプルでは、2019年の12月に作成、スコアが10以上のプロスペクトのみを取得します。

メソッド:POST
URL: https://pi.pardot.com/api/prospect/version/4/do/query
Header: Authorization: Pardot api_key=[APIキーを入力], user_key=[APIユーザーキーを入力]
Query:
created_after=1 Dec 2019
created_before=30 Dec 2019
score_greater_than=10

一括更新するプロスペクトIDを指定します。プロスペクトIDは先ほど紹介した「プロスペクトを一覧で取得する」にて取得できますので、それを利用してください。

メソッド:POST
URL: https://pi.pardot.com/api/prospect/version/4/do/batchUpdate
Header: Authorization: Pardot api_key=[APIキーを入力], user_key=[APIユーザーキーを入力]
Query:
format=JSON
prospects=
{
"prospects": [
  {"id":"1828442","comments":"Test","city":"Kanagawa"},
  {"id":"1828444","comments":"Test","city":"Tokyo"}
]
}

クエリーには更新を行うプロスペクト、項目の値をJSONもしくはXML形式で指定します。
サンプルでは複数のプロスペクトに対して、commentsの項目値にTestという文字を設定、cityにはKanagawaとTokyoを設定しています。

すると以下のように結果が表示されます。

{
"@attributes": {
"stat": "ok",
"version": 1
},
"errors": {}
}

「OK」と表示し、「errors」に何も表示されていないため処理が成功したことがわかります。


* ブログで紹介しているInsomniaのサンプルは弊社で動作を確認したものであり、お客様の環境で動作することを保障するものではありません。お客様ご自身の責任で試してくださいますようお願いいたします。

いかがだったでしょうか。

今回はPardot APIについて紹介しました。

REST APIによりPardot APIが簡単に利用できることがお分かりいただけたかと思います。

もし、Pardotと他のサービスを連携させて処理の自動化などを行う場合には、弊社の取り扱い製品であるDataSpider Cloudのような連携サービスを利用するのも良いでしょう。

最後に、自社の組織で試す場合にはシステム管理者に相談してから使用してくださいね。