SQLAlchemy ORM を使って、Python でSalesforce Marketing データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Salesforce Marketing をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにSalesforce Marketing データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてSalesforce Marketing の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("sfmarketingcloud///?User=myUser&Password=myPassword&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Salesforce Marketing Cloud API への認証

User およびPassword をログインクレデンシャルに設定するか、sandbox アカウントに接続する場合はsandbox ユーザーのクレデンシャルに設定します。

Salesforce Marketing Cloud API への接続

デフォルトでは、CData 製品は本番環境に接続します。Salesforce Marketing Cloud sandbox アカウントを使用するには、UseSandbox をtrue に設定します。

デフォルトのインスタンスは、Web Services API s7 です。他のインスタンスを使用する場合は、Instance を設定できます。

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

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

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

Salesforce Marketing データをクエリ

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

query メソッドを使う

engine = create_engine("sfmarketingcloud///?User=myUser&Password=myPassword&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Subscriber).filter_by(EmailAddress="john.doe@example.com"):
	print("Id: ", instance.Id)
	print("Status: ", instance.Status)
	print("---------")

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

execute メソッドを使う

Subscriber_table = Subscriber.metadata.tables["Subscriber"]
for instance in session.execute(Subscriber_table.select().where(Subscriber_table.c.EmailAddress == "john.doe@example.com")):
	print("Id: ", instance.Id)
	print("Status: ", instance.Status)
	print("---------")

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

Salesforce Marketing データの挿入（INSERT）

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

new_rec = Subscriber(Id="placeholder", EmailAddress="john.doe@example.com")
session.add(new_rec)
session.commit()

Salesforce Marketing データを更新（UPDATE）

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

updated_rec = session.query(Subscriber).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.EmailAddress = "john.doe@example.com"
session.commit()

Salesforce Marketing データを削除（DELETE）

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

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

Salesforce Marketing からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。