各製品の資料を入手。
詳細はこちら →
製品をチェック
SQLAlchemy ORM を使って、Python でZoho Books のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でZoho Books にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるZoho Books 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for ZohoBooks は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Zoho Books にデータ連携するPython アプリケーションを構築し、Zoho Books のデータを可視化できます。 本記事では、SQLAlchemy でZoho Books に連携して、データを取得、 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Zoho Books をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにZoho Books のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてZoho Books の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でZoho Books のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、Zoho Books のデータに連携するEngne を作成します。
engine = create_engine("zohobooks///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=myOAuthClientSecret&CallbackURL=https://localhost:33333&OrganizationId=MyOrganizationId&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
Zoho Books 接続プロパティの取得・設定方法
以下の接続プロパティを使用して、取得されるZoho Books データを正確に絞り込むことができます。
- Region：サーバーURL のトップレベルドメイン（TLD）。アカウントが米国以外のドメインにある場合は、リージョンを適宜変更してください。
- OrganizationId（オプション）：接続先の特定のZoho Books 組織に関連付けられたID。
- Organization Id の値が接続文字列で指定されていない場合、ドライバーは利用可能なすべての組織を自動的に取得し、最初のOrganization Id をデフォルトとして選択します。
Zoho Books への認証
Zoho Books はOAuth 認証標準を使用します。詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。
Zoho Books のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、INVOICES テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class INVOICES(base): __tablename__ = "INVOICES" InvoiceId = Column(String,primary_key=True) InvoiceNumber = Column(String) ...
Zoho Books のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("zohobooks///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=myOAuthClientSecret&CallbackURL=https://localhost:33333&OrganizationId=MyOrganizationId&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(INVOICES).filter_by(CustomerName="NewTech Industries"):
print("InvoiceId: ", instance.InvoiceId)
print("InvoiceNumber: ", instance.InvoiceNumber)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
INVOICES_table = INVOICES.metadata.tables["INVOICES"]
for instance in session.execute(INVOICES_table.select().where(INVOICES_table.c.CustomerName == "NewTech Industries")):
print("InvoiceId: ", instance.InvoiceId)
print("InvoiceNumber: ", instance.InvoiceNumber)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Zoho Books からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
