PHP のOData SDK を使用したSpotify のデータのクエリ

加藤龍彦
デジタルマーケティング

API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でSpotify エンティティを手軽に使用。

CData API Server は、ADO.NET Provider for API（またはその他の240+ ADO.NET Providers のデータ）と組み合わせることで、Spotify のデータをWeb サービスとして公開します。下記の手順に従って、Spotify のデータをPHP オブジェクトとして使用しましょう。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSpotify OData サービスを作成していきましょう。

Spotify への接続

PHP からSpotify のデータを操作するには、まずSpotify への接続を作成・設定します。

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Spotify」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、Spotify への接続設定を行っていきましょう！
OAuth 認証の設定

Spotify は認証に OAuth 2.0 を使用します。クライアント認証情報を取得するには、Spotify Developer Dashboard でアプリケーションを作成する必要があります。

Spotify アプリケーションのセットアップ
1. Spotify Developer Dashboard にアクセスします。
2. Spotify アカウントでログインして Create app をクリックします。
3. アプリ名、説明を入力し、Redirect URI を設定します（デスクトップアプリケーションの場合は
```
http://localhost:33333
```
  など）。
4. アプリ設定から 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：ユーザーのトップアーティストとトラックへの読み取りアクセス。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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：ユーザーのトップアーティストとトラックへの読み取りアクセス。

API Server のユーザー設定

次に、API Server 経由でSpotify にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Spotify 用のAPI エンドポイントの作成

ユーザーを作成したら、Spotify のデータ用のAPI エンドポイントを作成していきます。

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でSpotify への接続を設定してユーザーを作成し、API Server でSpotify データのAPI を追加しました。これで、OData 形式のSpotify データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

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：ユーザーのトップアーティストとトラックへの読み取りアクセス。

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「Users」をクリックして任意のユーザーをクリックし、ユーザーの認証トークンを取得します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。

[Application]
AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

Windows：C:\ProgramData\CData\API\
Unix or Mac OS X：~/cdata/API/

Spotify エンティティをPHP オブジェクトとして使用する

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

以下のようなコマンドにURL を渡します。
```
php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\APIEntities.php
```
上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

許可されたユーザーは、API Server の「Users」セクションで設定できます。

PHP のオブジェクト指向インターフェースを使用して、Spotify のデータへのアクセスを開始できます。以下のコードは、Albums テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。

require_once 'APIEntities.php';
try{
  $svc = new CData();
  $albums = new Albums();
  $albums->Id = '4aawyAB9vmqN3uQ7FjRGTy';
  $svc->AddToAlbums($albums);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->albums()->Execute();
  foreach($response->Result as $albums)
    echo $albums->."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server

CData は、AI を本番環境で機能させるデータレイヤーです。数百の主要エンタープライズソースへのライブコネクティビティとレプリケーション、セマンティックコンテキスト、組み込みガバナンスを提供。Databricks、Microsoft、Google、Palantir をはじめ、世界中の 10,000 以上のお客様の AI を支えています。

お問い合わせ

PHP のOData SDK を使用したSpotify のデータのクエリ

API Server の設定

Spotify への接続

OAuth 認証の設定

Spotify アプリケーションのセットアップ

接続プロパティ

接続文字列の例

利用可能な OAuth スコープ

OAuth 認証の設定

Spotify アプリケーションのセットアップ

接続プロパティ

接続文字列の例

利用可能な OAuth スコープ

API Server のユーザー設定

Spotify 用のAPI エンドポイントの作成

OData のエンドポイントを取得

OAuth 認証の設定

Spotify アプリケーションのセットアップ

接続プロパティ

接続文字列の例

利用可能な OAuth スコープ

API Server に接続するユーザーの認証トークンを取得

Spotify エンティティをPHP オブジェクトとして使用する

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

この記事の内容

関連記事