Python でZendesk のデータを変換・出力するETL 処理を作る方法

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

Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for Zendesk とpetl フレームワークを使って、Zendesk のデータにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。

CData Python Connector は効率的なデータ処理によりZendesk のデータ にPython から接続し、高いパフォーマンスを発揮します。Zendesk にデータをクエリする際、ドライバーはフィルタリング、集計などがサポートされている場合SQL 処理を直接Zendesk 側に行わせ、サポートされていないSQL 処理については、組み込みのSQL エンジンによりクライアント側で処理を行います（JOIN やSQL 関数など）。

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

pip で必要なモジュールおよびフレームワークをインストールします：

pip install petl
pip install pandas

Python でZendesk のデータをETL 処理するアプリを構築

モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

CData Connector を含むモジュールをインポートします。

import petl as etl
import pandas as pd
import cdata.zendesk as mod

接続文字列で接続を確立します。connect 関数を使って、CData Zendesk Connector からZendesk への接続を行います

cnxn = mod.connect("URL=https://subdomain.zendesk.com;[email protected];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 をクエリするSQL 文の作成

Zendesk にはSQL でデータアクセスが可能です。Tickets エンティティからのデータを読み出します。

sql = "SELECT Id, Subject FROM Tickets WHERE Industry = 'Floppy Disks'"

Zendesk データ のETL 処理

DataFrame に格納されたクエリ結果を使って、petl でETL（抽出・変換・ロード）パイプラインを組みます。この例では、Zendesk のデータ を取得して、Subject カラムでデータをソートして、CSV ファイルにデータをロードします。

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'Subject')

etl.tocsv(table2,'tickets_data.csv')

CData Python Connector for Zendesk を使えば、データベースを扱う場合と同感覚で、Zendesk のデータ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。

おわりに

Zendesk Python Connector の30日の無償トライアル をぜひダウンロードして、Zendesk のデータ への接続をPython アプリやスクリプトから簡単に作成しましょう。

フルソースコード

import petl as etl
import pandas as pd
import cdata.zendesk as mod

cnxn = mod.connect("URL=https://subdomain.zendesk.com;[email protected];Password=test123;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")")

sql = "SELECT Id, Subject FROM Tickets WHERE Industry = 'Floppy Disks'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'Subject')

etl.tocsv(table2,'tickets_data.csv')