製品をチェック

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

 30日間の無償トライアルへ

製品の詳細

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

TaxJar データ連携用Python コネクタライブラリ。TaxJar データをPandas、SQLAlchemy、Dash、petl などの人気のPython ツールにシームレスに統合。

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

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

加藤龍彦
デジタルマーケティング

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

CData

python ロゴ画像
Python ロゴ

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でTaxJar データをモデル化

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

engine = create_engine("taxjar///?APIKey=3bb04218ef8t80efdf1739abf7257144")

TaxJar API への認証には、まず初めにTaxJar UI からAPI キーを取得する必要があります。

NOTE:API の利用は、Professional およびPremium TaxJar プランでのみ可能です。

すでにProfessional またはPremium プランをお持ちの方は、TaxJar UI にログインして、「アカウント」->「TaxJar API」に移動するとAPI キーを確認することができます。 API キーを取得したら、APIKey 接続プロパティに設定できます。

その他の注意事項

  • デフォルトでは、エンティティが日付範囲フィルタをサポートしている場合、CData コネクタは過去3か月のデータを取得します。StartDate を設定して、取得するデータの最小作成日を指定することができます。
  • API キーがサンドボックスAPI アカウント用に作成されている場合は、UseSandbox をtrue に設定してください。ただし、すべてのエンドポイントが期待どおりに機能するとは限りません。詳しくは、TaxJar 開発者用ドキュメントを参照してください。

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

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

base = declarative_base()
class Orders(base):
	__tablename__ = "Orders"
	TransactionID = Column(String,primary_key=True)
	UserID = Column(String)
	...

TaxJar データをクエリ

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

query メソッドを使う

engine = create_engine("taxjar///?APIKey=3bb04218ef8t80efdf1739abf7257144")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(TransactionID="123"):
	print("TransactionID: ", instance.TransactionID)
	print("UserID: ", instance.UserID)
	print("---------")

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

execute メソッドを使う

Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.TransactionID == "123")):
	print("TransactionID: ", instance.TransactionID)
	print("UserID: ", instance.UserID)
	print("---------")

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

TaxJar データの挿入(INSERT)

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

new_rec = Orders(TransactionID="placeholder", TransactionID="123")
session.add(new_rec)
session.commit()

TaxJar データを更新(UPDATE)

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

updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.TransactionID = "123"
session.commit()

TaxJar データを削除(DELETE)

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

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

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

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

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

関連コンテンツ

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

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