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

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



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

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

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

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

pip install petl
pip install pandas

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

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

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

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

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

cnxn = mod.connect("Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;")

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

Yotpo API プロファイル設定

Yotpo への認証には、Yotpo の AppKey と AppSecret を使った OAuth 2.0 クライアントクレデンシャルフローを利用できます。

Yotpo API を使用するには、AppKey と AppSecret を持つ Yotpo ストアアカウントが必要です。これらの認証情報は、Yotpo ダッシュボードの「Account Settings」>「Store」で確認できます。

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

  • AuthScheme：OAuthClient に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId：Yotpo の AppKey に設定します。
  • OAuthClientSecret：Yotpo の AppSecret に設定します。

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

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

sql = "SELECT TotalReview, AverageScore FROM ProductBottomLine WHERE ExternalProductId = 'my-product-sku'"

Yotpo データのETL 処理

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

table1 = etl.fromdb(cnxn,sql)

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

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

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

おわりに

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


フルソースコード

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

cnxn = mod.connect("Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;")

sql = "SELECT TotalReview, AverageScore FROM ProductBottomLine WHERE ExternalProductId = 'my-product-sku'"

table1 = etl.fromdb(cnxn,sql)

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

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

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

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

Yotpo に接続

この記事の内容

関連記事