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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でZendesk データをモデル化

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

engine = create_engine("zendesk///?URL=https://subdomain.zendesk.com&User=my@email.com&Password=test123&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Connecting to Zendesk

接続するには、URL を設定して認証を提供します。URL は、Zendesk Support のURL：https://{subdomain}.zendesk.com です。

Zendesk への接続

Zendesk は、Basic 認証またはOAuth 2 認証標準を利用しています。

ベーシック認証

ベーシック認証では、E メールアドレスとパスワード、もしくは、E メールアドレスとAPI token で接続します。User をE メールアドレスに設定し、次の方法でPassword とAPI Token を提供します。

• Admin、Channels、API でZendesk Support Admin からパスワードを有効化します。
• Zendesk Support Admin からAdmin->Channels->API と操作し、API token を管理します。同時に複数のトークンを有効化させることが可能です。

OAuth 認証

詳細はヘルプドキュメントを参照してください。

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

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

base = declarative_base()
class Tickets(base):
	__tablename__ = "Tickets"
	Id = Column(String,primary_key=True)
	Subject = Column(String)
	...

Zendesk データをクエリ

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

query メソッドを使う

engine = create_engine("zendesk///?URL=https://subdomain.zendesk.com&User=my@email.com&Password=test123&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Tickets).filter_by(Industry="Floppy Disks"):
	print("Id: ", instance.Id)
	print("Subject: ", instance.Subject)
	print("---------")

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

execute メソッドを使う

Tickets_table = Tickets.metadata.tables["Tickets"]
for instance in session.execute(Tickets_table.select().where(Tickets_table.c.Industry == "Floppy Disks")):
	print("Id: ", instance.Id)
	print("Subject: ", instance.Subject)
	print("---------")

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

Zendesk データの挿入（INSERT）

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

new_rec = Tickets(Id="placeholder", Industry="Floppy Disks")
session.add(new_rec)
session.commit()

Zendesk データを更新（UPDATE）

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

updated_rec = session.query(Tickets).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Industry = "Floppy Disks"
session.commit()

Zendesk データを削除（DELETE）

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

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

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

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

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