SQLAlchemy ORM を使って、Python でSurveyMonkey データに連携する方法

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

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for SurveyMonkey は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで SurveyMonkey にデータ連携するPython アプリケーションを構築し、SurveyMonkey データを可視化できます。 本記事では、SQLAlchemy でSurveyMonkey に連携して、データを取得、 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. SurveyMonkey をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにSurveyMonkey データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてSurveyMonkey の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でSurveyMonkey データをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、SurveyMonkey データに連携するEngne を作成します。

engine = create_engine("surveymonkey///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:portNumber&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。

SurveyMonkey への接続に使用できる認証方法は2つあります。

• プライベートoauth アプリケーションを登録するときに、パーソナルアクセストークンを使用します。
• パブリックoauth アプリケーションを登録するときに、OAuth を使用します。

パーソナルアクセストークンの使用

個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、ヘルプの「Creating a Custom OAuth App」の手順に従って、次の接続プロパティを設定します。

• OAuthAccessToken：アプリケーション設定で生成されたAccessToken に設定。
• InitiateOAuth：OFF に設定。

OAuth の使用

CData 製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャルを使用して接続します。

独自のカスタムOAuth アプリを使用したい場合は、ヘルプのCustom Credentials を参照してください。

SurveyMonkey データのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、MySurvey_Responses テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class MySurvey_Responses(base):
	__tablename__ = "MySurvey_Responses"
	RespondentId = Column(String,primary_key=True)
	ChoiceId = Column(String)
	...

SurveyMonkey データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("surveymonkey///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:portNumber&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(MySurvey_Responses).filter_by(ChoiceText="blue"):
	print("RespondentId: ", instance.RespondentId)
	print("ChoiceId: ", instance.ChoiceId)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

MySurvey_Responses_table = MySurvey_Responses.metadata.tables["MySurvey_Responses"]
for instance in session.execute(MySurvey_Responses_table.select().where(MySurvey_Responses_table.c.ChoiceText == "blue")):
	print("RespondentId: ", instance.RespondentId)
	print("ChoiceId: ", instance.ChoiceId)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

SurveyMonkey からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。