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

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

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Domain=MyDomain;APIKey=myAPIKey;")

FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。

• Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
• APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。

Freshdesk をクエリするSQL 文の作成

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

sql = "SELECT Id, Name FROM Tickets WHERE Status = '2'"

Freshdesk データ のETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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

フルソースコード

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

cnxn = mod.connect("Domain=MyDomain;APIKey=myAPIKey;")

sql = "SELECT Id, Name FROM Tickets WHERE Status = '2'"

table1 = etl.fromdb(cnxn,sql)

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

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