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

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

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

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Profile=C:\profiles\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")

まず、Profile 接続プロパティにTypeForm プロファイルのディスク上の場所を設定します（例：C:\profiles\TypeForm.apip）。次に、ProfileSettings 接続プロパティにTypeForm の接続文字列を設定します（以下を参照）。

TypeForm API プロファイル設定

TypeForm への認証にはOAuth 標準を使用します。

TypeForm に認証するには、まずTypeForm でOAuth アプリケーションを登録および設定する必要があります：https://admin.typeform.com/account#/section/tokens。アプリにはclient ID とclient secret が割り当てられ、接続文字列で設定できます。OAuth アプリケーションの設定の詳細については、https://developer.typeform.com/get-started/ をご参照ください。

使用シナリオによって異なるリダイレクトURI が必要です：

CData デスクトップアプリケーション：CData デスクトップアプリケーション（Sync、API Server、ArcESB）は/src/oauthCallback.rst でOAuth トークンを受け入れます。ホストとポートはアプリケーションが使用するデフォルトポートと同じです。例えば、http://localhost:8019/ でCData Sync にアクセスする場合、リダイレクトURI はhttp://localhost:8019/src/oauthCallback.rst になります。
CData クラウドアプリケーション：CData クラウドアプリケーションはデスクトップ版と同様です。https://1.2.3.4/ でConnect AI にアクセスする場合、リダイレクトはhttps://1.2.3.4/src/oauthCallback.rst を使用します。
デスクトップアプリケーション：デスクトップアプリケーションを使用する場合、URI はhttps://localhost:33333 を推奨します。
Web アプリケーション：ドライバーを使用してWeb アプリケーションを開発する場合、https://my-website.com/oauth のような独自のURI を使用します。

以下の接続プロパティを設定すると、接続の準備が整います：

AuthScheme：OAuth に設定します。
InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
OAuthClientId：アプリ設定で指定されているClient Id を設定します。
OAuthClientSecret：アプリ設定で指定されているClient Secret を設定します。
CallbackURL：アプリ設定で指定したRedirect URI を設定します。

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

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

sql = "SELECT Id, Title FROM Tags WHERE SettingsIsPublic = 'true'"

Typeform データのETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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

フルソースコード

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

cnxn = mod.connect("Profile=C:\profiles\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")

sql = "SELECT Id, Title FROM Tags WHERE SettingsIsPublic = 'true'"

table1 = etl.fromdb(cnxn,sql)

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

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

はじめる準備はできましたか？

API Driver で Typeform のライブデータに接続

Typeform に接続お問い合わせ