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

加藤龍彦
加藤龍彦
デジタルマーケティング
CData Python Connector とpetl モジュールを使って、Harvest のデータを変換後にCSV ファイルに吐き出すETL 処理を実装します。

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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';")

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

Harvest API プロファイル設定

Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

トークン認証の使用

トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

OAuth 認証の使用

まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

以下の接続プロパティを設定すると、接続できるようになります。

  • ProfileSettings：ProfileSettings でAccountId を設定します。
  • AuthScheme：OAuth に設定します。
  • OAuthClientId：アプリ設定で指定したclient ID に設定します。
  • OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
  • CallbackURL：アプリ設定で指定したRedirect URI に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。

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

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

sql = "SELECT Id, ClientName FROM Invoices WHERE State = 'open'"

Harvest データのETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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


フルソースコード

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

cnxn = mod.connect("Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';")

sql = "SELECT Id, ClientName FROM Invoices WHERE State = 'open'"

table1 = etl.fromdb(cnxn,sql)

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

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

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

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

Harvest に接続 お問い合わせ

この記事の内容

関連記事