【徹底解説】Dash を使ってPython からOutlook のデータに連携するアプリを簡単に開発

Python エコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for API を使うことで、pandas モジュールとDash フレームワークでOutlook にデータ連携するアプリケーションを効率的に開発することができます。本記事では、pandas、Dash とCData Connector を使って、Outlook に連携して、Outlook のデータ をビジュアライズするシンプルなウェブアプリを作る方法をご紹介します。

CData Python Connectors の特徴

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

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

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

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

pip install pandas
pip install dash
pip install dash-daq

Python でOutlook のデータを可視化

必要なモジュールとフレームワークがインストールされたら、ウェブアプリを開発していきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に掲載しているので、参考にしてください。

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

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.api as mod
import plotly.graph_objs as go

接続文字列を使ってデータへの接続を確立します。connect 関数を使ってCData Outlook Connector からOutlook のデータ との接続を確立します。

cnxn = mod.connect("Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;")

OAuth 認証の設定

Microsoft Graph API は認証に OAuth 2.0 を使用します。OAuth 認証情報（Client ID と Client Secret）を取得するには、Microsoft Azure Portal でアプリケーションを登録する必要があります。

OAuth 認証情報の取得

1. Azure Portal にログインします。
2. Azure Active Directory > App registrations に移動します。
3. New registration をクリックして新しいアプリケーションを作成します。
4. アプリケーション名を入力し、適切なアカウントの種類を選択します。
5. Redirect URI をアプリケーションのコールバック URL に設定します（デスクトップアプリの場合は http://localhost:33333 など）。
6. Register をクリックしてアプリケーションを作成します。
7. アプリケーションの概要ページで Application (client) ID をコピーします。これが OAuthClientId になります。
8. Certificates & secrets に移動して、新しいクライアントシークレットを作成します。
9. クライアントシークレットの値をコピーします。これが OAuthClientSecret になります。
10. API permissions に移動して、必要な Microsoft Graph API の権限を追加します：
    • Mail.Read - メールメッセージへのアクセス用
    • Contacts.Read - 連絡先へのアクセス用
    • Calendars.Read - カレンダーイベントへのアクセス用
    • Tasks.Read - To Do タスクへのアクセス用
    • offline_access - リフレッシュトークンの取得用
11. Grant admin consent をクリックして、これらの権限を付与します。

OAuth での接続

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：OAuth に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。CData API Profile for Outlook が OAuth プロセスを自動的に進め、アクセストークンを取得します。
• OAuthClientId：Azure Portal の Application (client) ID に設定します。
• OAuthClientSecret：Azure Portal のクライアントシークレットの値に設定します。
• TenantId：Azure AD のテナント識別子（GUID または 'contoso.onmicrosoft.com' のようなドメイン名）に設定します。
• CallbackURL：アプリ登録で指定したリダイレクト URI に設定します（デスクトップアプリの場合は http://localhost:33333 など）。

接続文字列の例

Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;

Outlook にクエリを実行

read_sql 関数を使って、padas からSQL 文を発行し、DataFrame に結果を格納します。

df = pd.read_sql("""SELECT ,  FROM CalendarGroupCalendars WHERE CalendarGroupId = 'group_id'""", cnxn)

ウェブアプリケーションの設定

DataFrame に格納されたクエリ結果を使って、ウェブアプリにname、stylesheet、title を設定していきます。

app_name = 'dash-apiedataplot'

external_stylesheets = ['https://codepen.io/chriddyp/pen/bWLwgP.css']

app = dash.Dash(__name__, external_stylesheets=external_stylesheets)
app.title = 'CData + Dash'

Layout 設定

次に、Outlook のデータ をベースにした棒グラフを作詞し、アプリのレイアウトを設定します。

trace = go.Bar(x=df., y=df., name='')

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='Outlook CalendarGroupCalendars Data', barmode='stack')
		})
], className="container")

アプリをセットアップして実行

接続、アプリ、レイアウトを定義したら、アプリを実行してみましょう。以下のコードで実行できます。

if __name__ == '__main__':
    app.run_server(debug=True)

最後に、Python でウェブアプリを起動してブラウザでOutlook のデータ を見てみましょう。

python api-dash.py

ちゃんとデータが表示できてますね！

おわりに

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

import os
import dash
import dash_core_components as dcc
import dash_html_components as html
import pandas as pd
import cdata.api as mod
import plotly.graph_objs as go

cnxn = mod.connect("Profile=C:\profiles\Outlook.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;TenantId=your_tenant_id;CallbackUrl=http://localhost:33333;")

df = pd.read_sql("SELECT ,  FROM CalendarGroupCalendars WHERE CalendarGroupId = 'group_id'", cnxn)
app_name = 'dash-apidataplot'

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., y=df., name='')

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='Outlook CalendarGroupCalendars Data', barmode='stack')
		})
], className="container")

if __name__ == '__main__':
    app.run_server(debug=True)