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

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

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

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

API Server の設定

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

eBay Analytics への接続

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

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

OAuth 2.0プロトコルを使用した認証方法について、詳しい手順はヘルプドキュメントを参考にしてください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

OAuth 2.0認証方法でのみeBay Analytics へ認証することができます。eBay Analytics API では、リクエストの認可に、認証コード付与フローで作成されたアクセストークンが必要です。

OAuth 2.0プロトコルを使用した認証方法について、詳しい手順はヘルプドキュメントを参考にしてください。

API Server のユーザー設定

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

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

eBay Analytics 用のAPI エンドポイントの作成

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

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

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

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

OAuth 2.0プロトコルを使用した認証方法について、詳しい手順はヘルプドキュメントを参考にしてください。

さらに、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\EbayAnalytics\
Unix or Mac OS X：~/cdata/EbayAnalytics/

eBay Analytics エンティティを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\EbayAnalyticsEntities.php
```
上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

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

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

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

require_once 'EbayAnalyticsEntities.php';
try{
  $svc = new CData();
  $trafficreportbylisting = new TrafficReportByListing();
  $trafficreportbylisting->ListingId = '201284405428';
  $svc->AddToTrafficReportByListing($trafficreportbylisting);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->trafficreportbylisting()->Execute();
  foreach($response->Result as $trafficreportbylisting)
    echo $trafficreportbylisting->ListingName."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

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

CData API Server お問い合わせ