SQLAlchemy ORM を使って、Python でau PAY Market のデータに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でau PAY Market のデータをモデル化

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

engine = create_engine("aupaymarket///?ApiKey=MyApiKey&ShopId=MyShopId")

au PAY マーケットに接続するには、ShopId およびApiKey が必要です。

au PAY マーケットへのアクセスの設定

ShopId およびApiKey を取得するには、以下の手順に従ってください。

• Wow! manager サイトにログインして、「各種お申し込み」メニューの「API利用申請」に移動します。
• API利用規約に同意します。
• 「APIキーの発行はこちら」をクリックします。
• 「発行」ボタンをクリックして、API キーを生成します。
• 「接続元IPアドレスを登録」に、対象とするIP アドレスを入力します。
• 「登録」ボタンをクリックして、設定を保存します。

au PAY マーケットアカウントの認証

次の接続プロパティを設定して接続します。

• ShopId：接続先のau PAY マーケットShop ID を設定。
• ApiKey：API キーを設定。au PAY マーケットストアアカウントから取得したAPI キーです。
• UseSandbox：Sandbox 環境に接続する場合はTrue を設定。

au PAY Market のデータのマッピングクラスの宣言

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

base = declarative_base()
class Items(base):
	__tablename__ = "Items"
	ItemCode = Column(String,primary_key=True)
	Price = Column(String)
	...

au PAY Market のデータをクエリ

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

query メソッドを使う

engine = create_engine("aupaymarket///?ApiKey=MyApiKey&ShopId=MyShopId")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Items).filter_by(ItemCode="99a87c0x3"):
	print("ItemCode: ", instance.ItemCode)
	print("Price: ", instance.Price)
	print("---------")

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

execute メソッドを使う

Items_table = Items.metadata.tables["Items"]
for instance in session.execute(Items_table.select().where(Items_table.c.ItemCode == "99a87c0x3")):
	print("ItemCode: ", instance.ItemCode)
	print("Price: ", instance.Price)
	print("---------")

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

au PAY Market のデータの挿入（INSERT）

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

new_rec = Items(ItemCode="placeholder", ItemCode="99a87c0x3")
session.add(new_rec)
session.commit()

au PAY Market のデータを更新（UPDATE）

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

updated_rec = session.query(Items).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ItemCode = "99a87c0x3"
session.commit()

au PAY Market のデータを削除（DELETE）

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

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

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

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

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