2019.12.23

Pardot APIを利用する方法

  • このエントリーをはてなブックマークに追加
  • follow us in feedly
gettyimages (13679)

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 APIの利用例

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

Pardotの連携例

  • 定期的にプロスペクトを外部のデータベースに保存し、データの処理を行う
  • プロスペクトのウェブサイト訪問情報とSearch Consoleのウェブサイト訪問回数を比較分析する
  • PardotのデータをBIツールなどで分析する
後の章で詳しく説明しますが、Pardot APIはREST APIのルールで作成されているので多くのサービスと連携できます。

Pardot APIの紹介

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

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

プロスペクト

プロスペクトの処理を行えます。
全ての処理でAPIユーザーキーとAPIキーをヘッダーに指定し、使用します。
処理 プロスペクト一覧を取得する
URLフォーマット /api/prospect/version/4/do/query
必須パラメーター user_key, api_key
他のパラメーター score_greater_than,created_afterなどが使用可能*
* 検索パラメータに、一部の標準項目やカスタム項目は使用できません。それらの項目を指定して検索する場合、取得したデータに対して、ご自身で絞り込みを行う必要があります。
処理 プロスペクトを一括作成する
URLフォーマット /api/prospect/version/4/do/batchCreate
必須パラメーター user_key, api_key,JSONもしくはXML形式のプロスペクト
処理 プロスペクトを一括更新する
URLフォーマット /api/prospect/version/4/do/batchUpdate
必須パラメーター user_key, api_key,JSONもしくはXML形式のプロスペクト
処理 プロスペクトを一括作成更新する
URLフォーマット /api/prospect/version/4/do/batchUpsert
必須パラメーター user_key, api_key,JSONもしくはXML形式のプロスペクト

商談

処理 商談一覧を取得する
URLフォーマット /api/opportunity/version/4/do/query
必須パラメーター user_key, api_key
他のパラメーター created_after,probability_greater_than,value_greater_thanなどが使用可能

ビジター

処理 ビジター一覧取得する
URLフォーマット /api/visitor/version/4/do/query
必須パラメーター user_key, api_key
他のパラメーター created_after、prospect_idsなどが使用可能

アカウント

処理 アカウント情報を取得する
URLフォーマット /api/prospect/version/4/do/query
必須パラメーター user_key, api_key

キャンペーン

処理 キャンペーン一覧を取得する
URLフォーマット /api/campaign/version/4/do/query
必須パラメーター user_key, api_key
他のパラメーター created_after、nameなどが使用可能
* 一覧取得系のAPIについて注意点
Pardotの取得系APIは一度に200件まで取得可能です。
それ以上のデータを取得する場合、オフセットパラメーターに数値を指定し、処理を行います。

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

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

Pardot APIを使用するには?

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

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

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

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

1. APIユーザーキーを確認する

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

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


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

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

PardotのAPIユーザーキー

2. Pardot APIにログインする(APIキーを取得する)

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

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

  1. Eメール、パスワード、APIユーザーキーの3つを使用し、ログインする(APIキーを取得する)
  2. APIユーザーキーとAPIキーを使用して処理を行う
という順番です。

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

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

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

InsomniaでPardot APIにログイン

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

3. プロスペクト一覧を取得する

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

Pardot APIを使用してプロスペクトを取得

HeaderにAuthorizationを指定

4. プロスペクトを更新する

一括更新するプロスペクト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を設定しています。

Pardot APIを使用してプロスペクトを更新

プロスペクトの更新内容を設定

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

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


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


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

まとめ

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

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

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

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

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

関連する記事