SQLAlchemy ORM を使って、Python でSalesforce Pardot データに連携

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for SalesforcePardot は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Salesforce Pardot にデータ連携するPython アプリケーションを構築し、Salesforce Pardot データをビジュアライズできます。 本記事では、SQLAlchemy でSalesforce Pardot に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムSalesforce Pardot データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Salesforce Pardot に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Salesforce Pardot 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

Salesforce Pardot への接続

Salesforce Pardot データへの連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Salesforce Pardot はUsername、Password、およびUser Key を指定して接続します。

• ApiVersion: 提供されたアカウントがアクセス可能なSalesforcePardot API バージョン。 デフォルトは4です。
• User: Salesforce Pardot アカウントのユーザー名。
• Password: Salesforce Pardot アカウントのパスワード。
• UserKey: SalesforcePardot アカウントの一意のユーザーキー。このキーは永久的に利用できます。
• IsDemoAccount (optional): でもアカウントの場合は、TRUE に設定。

Pardot User Key へのアクセス

現在のアカウントのUser Key にアクセスするには、「設定」->「My Profile」の「API User Key」行にアクセスします。

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからSalesforce Pardot に接続します。

必要なモジュールのインストール

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でSalesforce Pardot データをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Salesforce Pardot データに連携するEngne を作成します。

engine = create_engine("salesforcepardot///?ApiVersion=4&User=YourUsername&Password=YourPassword&UserKey=YourUserKey")

Salesforce Pardot データのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Prospects テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class Prospects(base):
	__tablename__ = "Prospects"
	Id = Column(String,primary_key=True)
	Email = Column(String)
	...

Salesforce Pardot データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("salesforcepardot///?ApiVersion=4&User=YourUsername&Password=YourPassword&UserKey=YourUserKey")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Prospects).filter_by(ProspectAccountId="703"):
	print("Id: ", instance.Id)
	print("Email: ", instance.Email)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Prospects_table = Prospects.metadata.tables["Prospects"]
for instance in session.execute(Prospects_table.select().where(Prospects_table.c.ProspectAccountId == "703")):
	print("Id: ", instance.Id)
	print("Email: ", instance.Email)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Salesforce Pardot データの挿入（INSERT）

Salesforce Pardot データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Salesforce Pardot にすべての追加インスタンスを送ります。

new_rec = Prospects(Id="placeholder", ProspectAccountId="703")
session.add(new_rec)
session.commit()

Salesforce Pardot データを更新（UPDATE）

Salesforce Pardot データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Salesforce Pardot にレコードを追加します。

updated_rec = session.query(Prospects).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ProspectAccountId = "703"
session.commit()

Salesforce Pardot データを削除（DELETE）

Salesforce Pardot データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Prospects).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

製品の無償トライアル情報

Salesforce Pardot Python Connector の30日の無償トライアル をぜひダウンロードして、Salesforce Pardot データへの接続をPython アプリやスクリプトから簡単に作成しましょう。