BIRT でYotpo のデータのレポートを作成

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
組み込み分析にYotpoのリアルタイムデータを提供。

CData JDBC Driver for Yotpo は、データドリブンな Java アプリケーションにYotpo API への接続機能を統合します。CData JDBC Driver for Yotpo を BIRT(Business Intelligence Reporting Tools)プラットフォームと組み合わせることで、データの変更をリアルタイムに反映する BIRT レポートを作成できます。

  1. まだインストールしていない場合は、BIRT Framework プラグインと Database Development プラグインを Eclipse にインストールします。
  2. 「File」->「New」->「Report」をクリックします。Report Design パースペクティブが開きます。
  3. Data Explorer で「Data Sources」を右クリックし、「New Data Source」をクリックします。
  4. 「Create from a Data Source Type in the Following List」オプションを選択し、「JDBC Data Source」を選択します。
  5. 「Manage Drivers」をクリックし、インストールフォルダの lib サブフォルダにあるドライバー JAR を追加します。
  6. 「Database URL」ボックスに、接続文字列を含む JDBC URL を入力します。

    まず、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 に設定します。

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

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

    
    java -jar cdata.jdbc.api.jar
    

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

    組み込みの接続文字列デザイナーを使用して JDBC URL を生成(画像は Salesforce の例)

    JDBC URL を設定する際、Max Rows 接続プロパティも設定しておくと良いでしょう。返される行数が制限されるため、レポートやビジュアライゼーションの設計時のパフォーマンスが向上します。

    一般的な JDBC URL は以下のとおりです:

    
    jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;
    
  7. 「Data Sets」フォルダを右クリックし、Yotpo用の JDBC データソースを選択します。
  8. 表示されるダイアログで、レポート用のデータを取得する SELECT クエリを作成します。この記事では以下のクエリを使用します:
    
    SELECT TotalReview, AverageScore FROM ProductBottomLine WHERE ExternalProductId = 'my-product-sku'
    
  9. 「Palette」からエディターにチャートをドラッグします。チャートウィザードが表示されます。
  10. チャートタイプを選択した後、「Select Data」タブでカラムをチャートフィールドにドラッグします。
  11. 「Run」->「View Report」->「In Web Viewer」をクリックしてレポートを表示します。

これで、BIRT レポートがYotpo のデータの更新を反映できるようになりました。 オンデマンドで更新できる BIRT レポート(画像は Salesforce の例)

レポートをアプリケーションサーバーに公開するには、ドライバー JAR を BIRT Viewer のクラスパスに追加します。詳細については、Java アプリケーションサーバーへの JDBC ドライバのデプロイに関する CData KB ガイドを参照してください。

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

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

Yotpo に接続