OData SDK for PHP を使ってYahoo! JAPAN DATA SOLUTION のデータを取得

CData Connect AI はYahoo! JAPAN DATA SOLUTION のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Yahoo! JAPAN DATA SOLUTION のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect AI はYahoo! JAPAN DATA SOLUTION のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からYahoo! JAPAN DATA SOLUTION のデータへのリアルタイム連携を実現します。

Connect AI を構成

ODataPHP SDK でYahoo! JAPAN DATA SOLUTION のデータを操作するには、Connect AI からYahoo! JAPAN DATA SOLUTION に接続し、コネクションにユーザーアクセスを提供してYahoo! JAPAN DATA SOLUTION のデータのOData エンドポイントを作成する必要があります。

Yahoo! JAPAN DATA SOLUTION に接続したら、目的のテーブルのOData エンドポイントを作成します。

（オプション）新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でYahoo! JAPAN DATA SOLUTION に接続するユーザーを作成します。

1. 「Users」ページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
3. 「Users」ページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
3. PAT の名前を入力して Create をクリックします。
4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からYahoo! JAPAN DATA SOLUTION に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

1. Connect AI にログインし、 Add Connection をクリックします。
2. 「Add Connection」パネルから「Yahoo! JAPAN DATA SOLUTION」を選択します。
3. 必要な認証プロパティを入力し、Yahoo! JAPAN DATA SOLUTION に接続します。

   認証するには、次のプロパティを指定する必要があります。

   • AppID：アプリケーションID は認証に使用されます。取得するには、Yahoo! JAPAN データソリューションのサポートチームにリクエストを送信してください。
   
4. Create & Test をクリックします。
5. 「Add Yahoo! JAPAN DATA SOLUTION Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にYahoo! JAPAN DATA SOLUTION OData エンドポイントを追加する

Yahoo! JAPAN DATA SOLUTION に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
2. Yahoo! JAPAN DATA SOLUTION 接続（例：YahooDS1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、「Confirm」をクリックします。

コネクションとOData エンドポイントを設定したら、ODataPHP SDK からYahoo! JAPAN DATA SOLUTION のデータに接続できます。

1. まずは、ODataPHP SDK を使用してCData Connect AI が公開したWeb サービスに接続するプロキシクラスを作成します。

   URI 部分を書き換えて、次のようなコマンドを実行してください。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\YahooDSEntities.php
   	    

   このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

   CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

   認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。

2. これで、PHP のオブジェクト指向インターフェースを使ってYahoo! JAPAN DATA SOLUTION のデータにアクセスできます。以下のコードはSearchRanking テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

   require_once 'YahooDSEntities.php';
   try{
     $svc = new CDataAPI();
     $searchranking = new SearchRanking();
     $searchranking->SearchKeyword = 'yahoo';
     $svc->AddToSearchRanking($searchranking);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->searchranking()->Execute();
     foreach($response->Result as $searchranking)
       echo $searchranking->Rank."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }