各製品の資料を入手。
詳細はこちら →
製品をチェック
Python のDash ライブラリを使って、Zendesk のデータ に連携するウェブアプリケーションを開発する方法
CData Python Connector を使って、Zendesk にデータ連携するPython ウェブアプリケーションを開発できます。pandas とDash を使って作成してみます。
最終更新日：2023-09-23
この記事で実現できるZendesk 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Python エコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Zendesk を使うことで、pandas モジュールとDash フレームワークでZendesk にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、Zendesk に連携して、Zendesk のデータ をビジュアライズするシンプルなウェブアプリを作る方法をご紹介します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Zendesk をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Dash をはじめとする多様なデータ分析・BI ツールにZendesk のデータを連携
- ノーコードでの手軽な接続設定
必要なモジュールのインストール
まずは、pip で必要なモジュールおよびフレームワークをインストールします：
pip install pandas pip install dash pip install dash-daq
Python でZendesk のデータを可視化
必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に掲載しているので、参考にしてください。
まず、CData Connector を含むモジュールをインポートします：
import os import dash import dash_core_components as dcc import dash_html_components as html import pandas as pd import cdata.zendesk as mod import plotly.graph_objs as go
接続文字列を使ってデータへの接続を確立します。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 を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。
- Token アクセスを有効にします。
- Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
その他の認証方法についてはヘルプドキュメントを参照してください。
Zendesk にクエリを実行
read_sql 関数を使って、padas からSQL 文を発行し、DataFrame に結果を格納します。
df = pd.read_sql("""SELECT Id, Subject FROM Tickets WHERE Industry = 'Floppy Disks'""", cnxn)
ウェブアプリケーションの設定
DataFrame に格納されたクエリ結果を使って、ウェブアプリにname、stylesheet、title を設定していきます。
app_name = 'dash-zendeskedataplot' external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css'] app = dash.Dash(__name__, external_stylesheets=external_stylesheets) app.title = 'CData + Dash'
Layout 設定
次に、Zendesk のデータ をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。
trace = go.Bar(x=df.Id, y=df.Subject, name='Id')
app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
dcc.Graph(
id='example-graph',
figure={
'data': [trace],
'layout':
go.Layout(alt='Zendesk Tickets Data', barmode='stack')
})
], className="container")
アプリをセットアップして実行
接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。以下のコードで実行できます。
if __name__ == '__main__':
app.run_server(debug=True)
最後に、Python でウェブアプリを起動してブラウザでZendesk のデータ を見てみましょう。
python zendesk-dash.py
ちゃんとデータが表示できてますね！
おわりに
Zendesk Python Connector の30日の無償トライアル をぜひダウンロードして、Zendesk のデータ への接続をPython アプリやスクリプトから簡単に作成してみてください。
import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.zendesk as mod
import plotly.graph_objs as go
cnxn = mod.connect("URL=https://subdomain.zendesk.com;[email protected];Password=test123;InitiateOAuth=GETANDREFRESH;OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
df = pd.read_sql("SELECT Id, Subject FROM Tickets WHERE Industry = 'Floppy Disks'", cnxn)
app_name = 'dash-zendeskdataplot'
external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']
app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'
trace = go.Bar(x=df.Id, y=df.Subject, name='Id')
app.layout = html.Div(children=[html.H1("CData Extention + Dash", style={'textAlign': 'center'}),
dcc.Graph(
id='example-graph',
figure={
'data': [trace],
'layout':
go.Layout(alt='Zendesk Tickets Data', barmode='stack')
})
], className="container")
if __name__ == '__main__':
app.run_server(debug=True)
関連コンテンツ
