Zendesk のデータをPythonのpetlでETL処理する方法｜CData Connect AI

CData Connect AI の Python SDK と petl フレームワークを使うと、Zendesk のデータをローカルにドライバーをインストールすることなく、Pythonで直接抽出・変換・ロードするETLパイプラインを構築できます。パーソナルアクセストークンで接続し、数行のコードで設定完了です。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK と petl フレームワークを使えば、Zendesk のデータを抽出・変換して CSV などに出力する Zendesk 連携のアプリケーションやパイプラインを構築できます。この記事では、Connect AI に接続し、petl を使ってZendesk のデータを抽出・変換し、CSV ファイルに書き出す方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、petl は etl.fromdb を使って SDK の接続から直接読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、パイプラインを構築しましょう。

Python + petl でできること

Zendesk データの定期抽出パイプライン構築

SQL クエリで取得した Zendesk のレコードを petl の etl.fromdb で抽出し、etl.sort などの変換処理をはさんでから CSV に書き出す、軽量な ETL パイプラインを構築できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで Zendesk 以外のデータソースにも接続でき、petl 上で結合・整形してから任意の出力先にロードできます。

Zendesk への書き戻し処理の自動化

書き込みに対応した権限を持つ PAT で接続していれば、cursor.executemany を使ったバッチ INSERT により、変換済みデータを Zendesk に自動で書き戻す処理を組み込めます。

Connect AI で Zendesk に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

2. 「Add Connection」パネルから「Zendesk」を選択します

3. Zendesk に接続するために必要な認証プロパティを入力します。

   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 の管理画面で以下の設定を行います。

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

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

   
4. 「Save & Test」をクリックします
5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

1. Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
3. PAT に名前を付けて Create をクリックします。
4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする方法は？

pip ユーティリティを使って、SDK と petl フレームワークをインストールします。

pip install cdata-connect-ai
pip install petl

Python で Zendesk のデータの ETL アプリを構築する方法は？

必要なモジュールをインストールしたら、ETL アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続します。

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Zendesk をクエリする SQL ステートメントを作成する方法は？

SQL を使って、Zendesk をクエリするステートメントを作成します。この記事では、Tickets エンティティからデータを読み取ります。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：Zendesk1）になります。

sql = (
    "SELECT Id, Subject "
    "FROM [Zendesk1].[Zendesk].[Tickets] "
    "WHERE Industry = 'Floppy Disks'"
)

Zendesk のデータの抽出・変換・ロードを実装する方法は？

接続とクエリが準備できたら、petl を使ってZendesk のデータを抽出・変換・ロードします。この例では、Zendesk のデータを抽出し、Subject カラムでデータを並べ替えて、CSV ファイルにロードします。

table1 = etl.fromdb(conn, sql)

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

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

新しい行を Zendesk に書き戻す方法は？

Zendesk が書き込みに対応している場合は、バッチ INSERT で行を書き戻せます。SDK の executemany は、@name のプレースホルダーと、1行につき1つのパラメータ辞書のリストを受け取ります。

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Zendesk1].[Zendesk].[Tickets] (Id, Subject) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

注意：書き込み可能なソースであっても、読み取り専用の PAT や接続権限では書き込み操作は拒否されます。

CData Connect AI Python SDK を使えば、petl のような ETL パッケージでのデータへの直接アクセスも含め、通常のデータベースと同じようにZendesk のデータを扱えます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのZendesk のデータをパイプライン処理できるようになりました。Zendesk（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ

完全なソースコード

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT Id, Subject "
    "FROM [Zendesk1].[Zendesk].[Tickets] "
    "WHERE Industry = 'Floppy Disks'"
)

table1 = etl.fromdb(conn, sql)

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

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

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Zendesk1].[Zendesk].[Tickets] (Id, Subject) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()