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

CData Python Connector とpetl モジュールを使って、Zendesk のデータを変換後にCSV ファイルに吐き出すETL 処理を実装します。

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

最終更新日:2023-09-23

この記事で実現できるZendesk 連携のシナリオ

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

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")")

Zendesk 接続プロパティの取得・設定方法

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL(Zendesk Support URL)を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証(レガシー)です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthSchemeAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

  1. Token アクセスを有効にします。
  2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
最後に、APIToken をアクティブなAPI トークンに設定します。

その他の認証方法についてはヘルプドキュメントを参照してください。

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')

関連コンテンツ

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

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