SQLAlchemy ORM を使って、Python でユビレジ のデータに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でユビレジ のデータをモデル化

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

engine = create_engine("api///?Profile=C:\profiles\Ubiregi.apip&ProfileSettings='APIKey=your_api_token&MenuId=12345&'InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Ubiregi に接続するには、Ubiregi API トークンとMenuId が必要です。API トークンはUbiregi のシステム統合ページで生成できます。生成したトークンは、ProfileSettings API Key 接続プロパティに設定してください。また、自身のUbiregi メニューページのURL「https://ubiregi.com/a/setting/menus/{MenuId}」でMenuId を確認できます（こちらの例の{MenuId} の箇所）。

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

ユビレジ のデータのマッピングクラスの宣言

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

base = declarative_base()
class Customers(base):
	__tablename__ = "Customers"
	AccountName = Column(String,primary_key=True)
	Fields = Column(String)
	...

ユビレジ のデータをクエリ

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

query メソッドを使う

engine = create_engine("api///?Profile=C:\profiles\Ubiregi.apip&ProfileSettings='APIKey=your_api_token&MenuId=12345&'InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customers).filter_by(Id="1"):
	print("AccountName: ", instance.AccountName)
	print("Fields: ", instance.Fields)
	print("---------")

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

execute メソッドを使う

Customers_table = Customers.metadata.tables["Customers"]
for instance in session.execute(Customers_table.select().where(Customers_table.c.Id == "1")):
	print("AccountName: ", instance.AccountName)
	print("Fields: ", instance.Fields)
	print("---------")

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

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

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

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