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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でPayPal データをモデル化

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

engine = create_engine("paypal///?Schema=SOAP&Username=sandbox-facilitator_api1.test.com&Password=xyz123&Signature=zx2127&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

CData 製品は、2つのPayPal API のテーブルを表示します。API は異なる認証方法を使用します。

• REST API はOAuth 標準を使用します。REST API を認証するには、OAuthClientId、OAuthClientSecret、CallbackURL プロパティを設定する必要があります。
• Classic API にはSignature API 認証情報が必要です。Classic API を認証するにはUsername、Password、およびSignature プロパティを設定する必要があります。

必要なAPI 資格情報の取得については、ヘルプドキュメントの「はじめに」を参照してください。

使用するAPI を選択するには、Schema プロパティをREST またはSOAP に設定します。デフォルトでは、SOAP スキーマが使われます。

テスト目的では、UseSandbox をtrue に設定してSandbox 資格情報を使用できます。

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

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

base = declarative_base()
class Transactions(base):
	__tablename__ = "Transactions"
	Date = Column(String,primary_key=True)
	GrossAmount = Column(String)
	...

PayPal データをクエリ

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

query メソッドを使う

engine = create_engine("paypal///?Schema=SOAP&Username=sandbox-facilitator_api1.test.com&Password=xyz123&Signature=zx2127&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Transactions).filter_by(TransactionClass="Received"):
	print("Date: ", instance.Date)
	print("GrossAmount: ", instance.GrossAmount)
	print("---------")

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

execute メソッドを使う

Transactions_table = Transactions.metadata.tables["Transactions"]
for instance in session.execute(Transactions_table.select().where(Transactions_table.c.TransactionClass == "Received")):
	print("Date: ", instance.Date)
	print("GrossAmount: ", instance.GrossAmount)
	print("---------")

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

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

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

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