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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でZoho CRM データをモデル化

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

engine = create_engine("zohocrm///?AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988")

Zoho CRM はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

Zoho CRM CData 製品はパフォーマンスを向上させるためにデフォルトでUseServerSideFiltering がTrue に設定されていますが、誤った結果が返される場合があります。詳しくは、ヘルプドキュメントの「高度な設定」を参照してください。

Zoho CRM データのマッピングクラスの宣言

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

base = declarative_base()
class Accounts(base):
	__tablename__ = "Accounts"
	Account_Name = Column(String,primary_key=True)
	Annual_Revenue = Column(String)
	...

Zoho CRM データをクエリ

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

query メソッドを使う

engine = create_engine("zohocrm///?AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(Industry="Data/Telecom OEM"):
	print("Account_Name: ", instance.Account_Name)
	print("Annual_Revenue: ", instance.Annual_Revenue)
	print("---------")

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

execute メソッドを使う

Accounts_table = Accounts.metadata.tables["Accounts"]
for instance in session.execute(Accounts_table.select().where(Accounts_table.c.Industry == "Data/Telecom OEM")):
	print("Account_Name: ", instance.Account_Name)
	print("Annual_Revenue: ", instance.Annual_Revenue)
	print("---------")

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

Zoho CRM データの挿入（INSERT）

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

new_rec = Accounts(Account_Name="placeholder", Industry="Data/Telecom OEM")
session.add(new_rec)
session.commit()

Zoho CRM データを更新（UPDATE）

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

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Industry = "Data/Telecom OEM"
session.commit()

Zoho CRM データを削除（DELETE）

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

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

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

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

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