Jaspersoft Studio から Spotify のデータに接続
この記事では、CData JDBC Driver for Spotify を使って、Jaspersoft Studio からSpotify に標準JDBC データソースとして接続する方法を説明します。標準のJaspersoft ウィザードを使ってSpotify へのSQL クエリを作成していきます。クエリは直接Spotify API に実行されるため、Spotify のデータへのリアルタイム接続が可能になります。
Spotify のデータにJDBC データソースとして接続
Jaspersoft Studio でJDBC データソースを作成するには、データアダプタを作成します。
- Repository Explorer ビューで、Data Adapters ノードを右クリックし、Create Data Adapter をクリックします。
- Database JDBC Connection を選択します。
- ドライバーのわかりやすい名前を入力します。
- Driver Classpath タブで、Add をクリックします。表示されたダイアログで、インストールディレクトリのlib サブフォルダに移動し、ドライバーJAR を選択します。
- Database Location タブで、JDBC ドライバーのクラス名を入力します：cdata.jdbc.api.APIDriver
- JDBC URL を入力します。
OAuth 認証の設定
Spotify は認証に OAuth 2.0 を使用します。クライアント認証情報を取得するには、Spotify Developer Dashboard でアプリケーションを作成する必要があります。
Spotify アプリケーションのセットアップ
- Spotify Developer Dashboard にアクセスします。
- Spotify アカウントでログインして Create app をクリックします。
- アプリ名、説明を入力し、Redirect URI を設定します（デスクトップアプリケーションの場合は
http://localhost:33333
など）。 - アプリ設定から Client ID と Client Secret をコピーします。
接続プロパティ
以下の接続プロパティを設定して接続を確立してください：
- AuthScheme：OAuth に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId：Spotify アプリケーションの Client ID に設定します。
- OAuthClientSecret：Spotify アプリケーションの Client Secret に設定します。
- Scope：必要な OAuth スコープ（スペース区切り）に設定します。デフォルトには、このプロファイルのテーブルに必要なすべての読み取りスコープが含まれます。
- CallbackURL：Spotify アプリケーションで設定したリダイレクト URI に設定します（例：http://localhost:33333）。
接続文字列の例
Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;
利用可能な OAuth スコープ
- user-read-private：ユーザーのサブスクリプション詳細と露骨なコンテンツ設定への読み取りアクセス。
- user-read-email：ユーザーのメールアドレスへの読み取りアクセス。
- user-library-read：ユーザーが保存したトラック、アルバム、エピソード、ショー、オーディオブックへの読み取りアクセス。
- playlist-read-private：ユーザーの非公開プレイリストへの読み取りアクセス。
- playlist-read-collaborative：ユーザーがフォローしているコラボレーティブプレイリストへの読み取りアクセス。
- user-follow-read：現在のユーザーがフォローしているアーティストの一覧への読み取りアクセス。
- user-read-playback-state：ユーザーのプレーヤー状態（デバイス、現在のトラック、再生位置）への読み取りアクセス。
- user-read-currently-playing：ユーザーが現在再生中のコンテンツへの読み取りアクセス。
- user-read-playback-history：ユーザーが最近再生したトラックへの読み取りアクセス。
- user-top-read：ユーザーのトップアーティストとトラックへの読み取りアクセス。
組み込みの接続文字列デザイナー
JDBC URL の構成をサポートするために、Spotify JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティに値を入力して、接続文字列をクリップボードにコピーします。
JDBC URL を構成する際に、Max Rows 接続プロパティも設定できます。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時のパフォーマンス向上に役立ちます。
以下はSpotify の一般的なJDBC URL です：
jdbc:api:Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;
Spotify のデータでレポートを作成
以下のステップに従って、Spotify へのSQL クエリを作成します。これはシンプルなレポートの基礎となります。
- File -> New Jasper Report をクリックします。テンプレートを選択し、親プロジェクトを選択して、レポートファイルを指定します。
- Data Adapter メニューで、前のセクションで作成したデータアダプタを選択します。
- Diagram タブで、テーブルをボックスにドラッグして、使用したいカラムをクリックします。または、Texts タブでカスタムクエリを入力します。例：
SELECT , FROM Albums WHERE Id = '4aawyAB9vmqN3uQ7FjRGTy'
- データセットに含めるフィールドを選択します。この例では、すべてのフィールドを使用します。
- Group By ステップをスキップして、ウィザードを完了します。
Preview タブで、現在のSpotify のデータでレポートがどのように表示されるかをプレビューできます。
チャートを作成
以下のセクションでは、独自のSQL クエリに紐づいたチャートを作成する方法を説明します。リモートデータソースからデータを取得する際、特定のレポートオブジェクト用に作成したより制限的なクエリを使用すると、パフォーマンスが向上する場合があります。
DataSet を作成
以下のステップに従って、チャートを入力する新しいデータセットを作成します。
- レポートの編集エリアで、Design タブをクリックします。
- Outline ビューで、レポートのルートノードを右クリックし、Create Dataset をクリックします。
- データセットの名前を入力し、接続またはデータソースから新しいデータセットを作成するオプションをクリックします。
- Data Adapter メニューで、最初のセクションで作成したデータアダプタを選択します。
- 次のようなクエリを入力します：
SELECT , FROM Albums WHERE Id = '4aawyAB9vmqN3uQ7FjRGTy'
- データセットに含めるフィールドを選択します。この例では と を使用します。
- フィールドによるグループ化のステップをスキップして、ウィザードを完了します。
チャートを構成
データセットを追加した後、以下のステップに従ってチャートウィザードでカラム値をチャートの軸にマッピングします。
- Outline ビューでSummary ノードをクリックします。Properties ビューで、高さを400ピクセルに設定します。Summary バンドはレポートの最後に印刷されます。
- パレットからチャートをSummary にドラッグします。チャートウィザードが表示されます。
- チャートのタイプを選択します。この例では棒グラフを使用します。
- Dataset メニューで、チャート用に作成したデータセットを選択します。
- Dataset タブで、マスターレポートの入力に使用されたものと同じJDBC 接続を使用するオプションを選択します。
- チャートのシリーズを指定します：Series メニューの横にあるボタンをクリックし、Add をクリックします。表示されたExpression Editor で、 カラムをダブルクリックして、式を$F{} に設定します。
y 軸の値を指定します：チャートウィザードで、Value ボックスの横にあるボタンをクリックします。Expression Editor で、 をダブルクリックして、式を$F{} に設定します。
- シリーズ要素のラベルを指定します：チャートウィザードで、Label ボックスの横にあるボタンをクリックします。Expression Editor で、 カラムをダブルクリックして、式を$F{} に設定します。必要に応じて、以下の式のようにカラムの型を文字列に変換します：
$F{}.toString()
- チャートを拡大してSummary セクションを埋めます：チャートを右クリックして、Size to Container -> Fit Both をクリックします。
レポートの実行
他のJDBC データソースと同様に、Spotify のデータでレポートを生成できるようになりました。Jaspersoft Studio はレポートの実行ごとにデータを定期的に更新します。
