ノーコードでクラウド上のデータとの連携を実現。
詳細はこちら →
Salesforce Marketing Cloud Account Engagement (旧 Pardot) API Version 5 を CData Driver で利用する方法・以前のバージョンとの違いについて
こんにちは。CData Software Japan リードエンジニアの杉本です。
現在Salesforce Marketing Cloud Account Engagement (旧 Pardot・本文では以下、Pardotと記載します)ではAPIのバージョンが「3・4・5」の3種類提供されています。
https://developer.salesforce.com/docs/marketing/pardot/guide/overview.html
CData Driver では2022年1月のアップデートでバージョン5に対応し、現在それぞれのバージョンが利用できるようになっています。
https://cdn.cdata.com/help/GPG/jp/jdbc/pg_changelog.htm
このバージョンに関する質問はテクニカルサポートでもよく受ける内容ですので、今回の記事では最新バージョンであるV5の使用方法および以前のバージョンとの違いを解説したいと思います。
なお、この記事を開いている2022年8月現在、古いバージョンである3・4の廃止は今のところ予定されていないようです。後ほど詳しく解説しますが、現在バージョン5ですべての機能に互換性があるわけではないようですので、ユースケースに応じて使うバージョンを切り替えると良いと思います。
https://www.cdata.com/jp/drivers/pardot/
使い方
バージョンの違いを解説する前に、まずCData Driverによるバージョンの切り替え方法について解説しておきます。
今回はCData JDBC Driverを利用していますが、ODBCやADO.NET、Excel Add-inなどそれぞれのテクノロジーで同じように利用できます。
CData Driver で利用するSalesforce Pardot APIのバージョンは以下の「Schema」というプロパティを使用します。
https://cdn.cdata.com/help/GPG/jp/jdbc/RSBSalesforcePardot_p_Schema.htm
ここから任意のバージョンを選び、「BusinessUnitId」と必要に応じて「InitiateOAuth」のプロパティを設定することで接続が可能です。
これで以下のようにDbVisualizerなどのツールから利用できます。
接続時の注意点：利用できる環境の違い
それでは各バージョン毎の違いを確認していきましょう。まず接続時の注意点です。
以下のリファレンスでも記載されていますが、「1 つのメールアドレスに対して複数のプロスペクトを有効化 (AMPSEA) 」がされているかどうかで利用できるAPIが変わります。
https://developer.salesforce.com/docs/marketing/pardot/guide/overview.html
AMPSEAが有効な環境であれば、「3・4・5」どのバージョンでも利用できます。
しかしながら、AMPSEAが無効な環境は「バージョン 4」のAPIでは利用できないので要注意です。
とはいえ、以下のリファレンスでも書かれている通り「2016 年 6 月 14 日」以降に作成された環境ではデフォルトで有効になっており、あまり抵触する環境の人は多くないかもしれません。
https://help.salesforce.com/s/articleView?id=sf.pardot_admin_ampsea_parent.htm&type=5
>2016 年 6 月 14 日より後に作成された Pardot アカウントでは、この機能がデフォルトで有効になっています。
データモデルの違い
続いて利用できるデータモデルの違いです。ここが各APIを使う上で最も大きなポイントになるでしょう。
先のリファレンスでもある通り、「V3 & V4 」はほぼアーキテクチャが変わらないため、CData Driverでも「V3 & V4 」と「V5」で大きな違いを設けています。そのもっとも顕著な違いが扱うことができるデータモデルです。
データモデルとはCData Driverで定義されているテーブルやビューのことを指します。これによって取得や更新ができるデータおよび項目が変わります。詳しくは以下のリンクからどうぞ。
Salesforce Pardot V3 & V4 データモデル
https://cdn.cdata.com/help/GPG/jp/jdbc/pg_SalesforcePardot.htm
Salesforce Pardot V5 データモデル
https://cdn.cdata.com/help/GPG/jp/jdbc/pg_SalesforcePardotV5.htm
せっかくなのでわかりやすいように比較表を作ってみました。もちろんAPIや本体のサービスのアップデートにより廃止される機能、追加される機能もあるので一概な比較は難しいのですが、例えば「V5」では「Files」や「Folders」が追加されており、逆に「Visitors」などがまだ未対応であることがわかります。
|
V3 & V4 データモデル |
V5データモデル |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
また、内部の項目仕様などに変更があるデータモデルもあります。例えばCampaignsのページを見ると以下のように項目や機能に違いがあることがわかります。
「V3・V4」のCampaings
「V5」のCampaings
ストアドプロシージャについても同様で現在のところSendEmailやAssignProspectなどの機能は「V3・V4」のデータモデルでのみサポートしているので注意しましょう。
https://cdn.cdata.com/help/GPG/jp/jdbc/pg_SalesforcePardotV4allsps.htm
内部挙動の違い
最後に内部挙動の違いについても少し触れておきます。
API内部挙動の違いとして一番顕著なのはページネーションの処理です。
このあたりは以下の記事で詳しく記載していますが、「V3・V4」と「V5」で、それぞれ一度のリクエストによる取得レコード数がそれぞれ異なります。
https://www.cdata.com/jp/blog/pardot-apilimit
V3もしくはV4の場合は1API リクエストあたり200レコード取得、Pardot API V5では、1リクエストあたりのLimit が最大1000レコードとなっています。
このリクエスト数は以下のプロパティで変更することができ、デフォルトは200となっています。
https://cdn.cdata.com/help/GPG/jp/jdbc/RSBSalesforcePardot_p_Pagesize.htm
おわりに
このようにSalesforce Pardot のAPI バージョンはデータモデルで大きな違いがあります。
内部で使用しているV5 API がサポートしていないとCData Driver でもサポートできない機能もありますので、今後随時V5 で機能拡充していく予定ですが、もしV5 のAPI であるのに、CData Driver で使えない、といった機能があれば、どうぞお気軽にテクニカルサポートまでリクエストをください。
https://www.cdata.com/jp/support/submit.aspx