R から JDBC 経由でPipedriveののデータを分析

R と Java がインストールされている環境であれば、純粋な R スクリプトと標準的な SQL を使用してPipedrive のデータにアクセスできます。CData JDBC Driver for Pipedrive と RJDBC パッケージを使えば、R からリモートのPipedrive のデータを操作できます。CData Driver を使用することで、業界で実績のある標準規格に準拠したドライバーを活用し、人気のオープンソース言語 R でデータにアクセスできます。この記事では、ドライバーを使ってPipedriveに SQL クエリを実行し、標準的な R 関数を呼び出してPipedrive のデータを可視化する方法を説明します。

R のインストール

マルチスレッドとマネージドコードによるドライバーのパフォーマンス向上を最大限に活かすには、マルチスレッド対応の Microsoft R Open を使用するか、BLAS/LAPACK ライブラリとリンクされたオープンソース R を使用します。この記事では Microsoft R Open 3.2.3 を使用しています。このバージョンは、2016年1月1日時点の CRAN リポジトリのスナップショットからパッケージをインストールするように事前設定されており、再現性が確保されています。

RJDBC パッケージの読み込み

ドライバーを使用するには、RJDBC パッケージをダウンロードしてください。 RJDBC パッケージをインストールしたら、以下のコードでパッケージを読み込みます。

library(RJDBC)

Pipedriveに JDBC データソースとして接続

Pipedriveに JDBC データソースとして接続するには、以下の情報が必要です。

• Driver Class: cdata.jdbc.pipedrive.PipedriveDriver に設定します。
• Classpath: ドライバー JAR ファイルの場所を設定します。デフォルトでは、インストールフォルダの lib サブフォルダです。

dbConnect や dbSendQuery などの DBI 関数は、R でデータアクセスコードを記述するための統一されたインターフェースを提供します。以下のコードで、CData JDBC Driver for Pipedrive に JDBC リクエストを行う DBI ドライバーを初期化します。

driver <- JDBC(driverClass = "cdata.jdbc.pipedrive.PipedriveDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.pipedrive.jar", identifier.quote = "'")

これで DBI 関数を使用してPipedriveに接続し、SQL クエリを実行できます。dbConnect 関数で JDBC 接続を初期化します。

Pipedrive 接続プロパティの取得・設定方法

Pipedrive には、接続および認証する2つの方法があります。Basic およびOAuth です。

Basic 認証

1. API トークンを取得します。
   1. Pipedrive ポータルを開きます。
   2. ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
   3. 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
   4. 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。（これは会社の開発者用サンドボックスのURL です。）
2. 次の接続プロパティを設定します。
   • APIToken：取得したAPI トークンの値。
   • CompanyDomain：開発者サンドボックスURL のCompanyDomain。
   • AuthScheme：Basic。
3. 承認されたユーザー名とパスワードでログインします。

API トークンはPipedrive ポータルに保存されます。これを取得するには、会社名をクリックし、ドロップダウンリストを使用して会社設定 -> Personal Preferences -> API に移動します。

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth 認証」セクションを参照してください。

組み込みの接続文字列デザイナー

JDBC URL の構築には、Pipedrive JDBC Driver に組み込まれている接続文字列デザイナーが便利です。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。

java -jar cdata.jdbc.pipedrive.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

以下は、一般的な JDBC 接続文字列を含む dbConnect 呼び出しの例です。

conn <- dbConnect(driver,"jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;")

スキーマの検出

このドライバーは、Pipedrive API をリレーショナルテーブル、ビュー、ストアドプロシージャとしてモデル化します。以下のコードでテーブルの一覧を取得できます。

dbListTables(conn)

SQL クエリの実行

dbGetQuery 関数を使用して、Pipedrive API でサポートされている任意の SQL クエリを実行できます。

deals <- dbGetQuery(conn,"SELECT PersonName, UserEmail FROM Deals WHERE Value > 50000")

以下のコマンドで、結果をデータビューアウィンドウに表示できます。

View(deals)

Pipedrive のデータのプロット

これで、CRAN リポジトリで利用可能なデータ可視化パッケージを使ってPipedrive のデータを分析できます。組み込みのバープロット関数でシンプルな棒グラフを作成できます。

par(las=2,ps=10,mar=c(5,15,4,2))
barplot(deals$UserEmail, main="Pipedrive Deals", names.arg = deals$PersonName, horiz=TRUE)