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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でMisoca データをモデル化

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

engine = create_engine("api///?Profile=Misoca.apip&Authscheme=OAuth&InitiateOAuth=GETANDREFRESH&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

まず、OAuth アプリを作成する必要があります。 https://app.misoca.jp/oauth2/applications に移動し、「新しいアプリケーションを作成する」ボタンをクリックしてください。アプリケーション名を入力し、リダイレクトURL を指定して、「登録する」をクリックします。そうすると、クライアントシークレットとクライアントID が表示されます。

次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

以下の接続プロパティを設定した後、接続の準備が整います。

• AuthScheme：OAuth に設定してください。
• OAuthClientID：アプリケーション設定で指定されたOAuth クライアントID に設定してください。
• OAuthClientSecret：アプリケーション設定で指定されたOAuth クライアントシークレットに設定してください。
• CallbackURL：アプリケーション設定で指定したリダイレクトURI に設定してください。
• InitiateOAuth：GETANDREFRESH に設定してください。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。

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

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

base = declarative_base()
class Contacts(base):
	__tablename__ = "Contacts"
	RecipientName = Column(String,primary_key=True)
	RecipientMailAddress = Column(String)
	...

Misoca データをクエリ

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

query メソッドを使う

engine = create_engine("api///?Profile=Misoca.apip&Authscheme=OAuth&InitiateOAuth=GETANDREFRESH&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Contacts).filter_by(Id="1"):
	print("RecipientName: ", instance.RecipientName)
	print("RecipientMailAddress: ", instance.RecipientMailAddress)
	print("---------")

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

execute メソッドを使う

Contacts_table = Contacts.metadata.tables["Contacts"]
for instance in session.execute(Contacts_table.select().where(Contacts_table.c.Id == "1")):
	print("RecipientName: ", instance.RecipientName)
	print("RecipientMailAddress: ", instance.RecipientMailAddress)
	print("---------")

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

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

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

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