製品をチェック

Square Connector の30日間無償トライアルをダウンロード

 ダウンロードはこちら

製品の詳細

Square アイコン Square Python Connector 相談したい

Square へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにSquare をシームレスに統合。

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

CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でSquare にOR マッピング可能に。

加藤龍彦
ウェブデベロッパー

最終更新日:2023-09-23
square ロゴ

CData

python ロゴ画像
Python ロゴ

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSquare データをモデル化

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

engine = create_engine("square///?OAuthClientId=MyAppId&OAuthClientSecret=MyAppSecret&CallbackURL=http://localhost:33333&LocationId=MyDefaultLocation&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。

追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。

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

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

base = declarative_base()
class Refunds(base):
	__tablename__ = "Refunds"
	Reason = Column(String,primary_key=True)
	RefundedMoneyAmount = Column(String)
	...

Square データをクエリ

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

query メソッドを使う

engine = create_engine("square///?OAuthClientId=MyAppId&OAuthClientSecret=MyAppSecret&CallbackURL=http://localhost:33333&LocationId=MyDefaultLocation&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Refunds).filter_by(Type="FULL"):
	print("Reason: ", instance.Reason)
	print("RefundedMoneyAmount: ", instance.RefundedMoneyAmount)
	print("---------")

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

execute メソッドを使う

Refunds_table = Refunds.metadata.tables["Refunds"]
for instance in session.execute(Refunds_table.select().where(Refunds_table.c.Type == "FULL")):
	print("Reason: ", instance.Reason)
	print("RefundedMoneyAmount: ", instance.RefundedMoneyAmount)
	print("---------")

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

Square データの挿入(INSERT)

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

new_rec = Refunds(Reason="placeholder", Type="FULL")
session.add(new_rec)
session.commit()

Square データを更新(UPDATE)

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

updated_rec = session.query(Refunds).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Type = "FULL"
session.commit()

Square データを削除(DELETE)

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

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

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

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

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。