OData SDK for PHP を使ってAdobe Analytics のデータを取得

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

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

Connect AI を構成

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

Adobe Analytics に接続したら、目的のテーブルのOData エンドポイントを作成します。

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

必要であれば、Connect AI 経由でAdobe Analytics に接続するユーザーを作成します。

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 からAdobe Analytics に接続

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

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

   Adobe Analytics への接続

   それでは、Adobe Analytics に接続していきましょう。接続するには、GlobalCompanyId およびRSID を識別する必要があります。デフォルトでは、ドライバーが会社とレポートスイートの識別を自動で試みますが、これらの値を明示的に指定することも可能です。詳しい手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「Adobe Analytics への接続」セクションをご確認ください。

   Adobe Analytics への認証

   続いて、認証方法を設定しましょう。Adobe Analytics はOAuth 認証標準を利用しており、OAuth またはサービスアカウントで認証できます。

   ユーザーアカウント（OAuth）

   ユーザーアカウントでの認証では、すべてのフローでAuthScheme をOAuth に設定する必要があります。詳しい認証手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「Adobe Analytics への認証」セクションをご参照ください。

   サービスアカウント

   サービスアカウントではサイレント認証が利用でき、ブラウザでのユーザー認証が不要です。このフローを使用するには、アプリケーションを作成する必要があります。アプリケーションの作成および認可については、ドキュメントの「カスタムOAuth アプリの作成」をご確認ください。これにより、サービスアカウントにアクセス権があるAdobe Analytics データに接続できるようになります。

   サービスアカウントを使用したServer-to-Server OAuth で認証するには、AuthScheme をOAuthClient に設定します。接続には以下のプロパティを設定してください。

   • InitiateOAuth：GETANDREFRESH に設定
   • OAuthClientId：アプリケーション設定のクライアントId に設定
   • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定

   接続すると、CData 製品がサービスアカウントでのOAuth フローを以下の手順で完了します。

   1. クライアントクレデンシャルOAuth フローで指定されたOAuthClientId およびOAuthClientSecret を使用して、アクセストークンを取得します
   2. OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします
   3. トークンが期限切れになった際に、新しいアクセストークンを要求します
   
4. Create & Test をクリックします。
5. 「Add Adobe Analytics Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にAdobe Analytics OData エンドポイントを追加する

Adobe Analytics に接続したら、目的のテーブルのOData エンドポイントを作成します。

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

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

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\AdobeAnalyticsEntities.php
   	    

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

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

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

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

   require_once 'AdobeAnalyticsEntities.php';
   try{
     $svc = new CDataAPI();
     $adsreport = new AdsReport();
     $adsreport->City = 'Chapel Hill';
     $svc->AddToAdsReport($adsreport);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->adsreport()->Execute();
     foreach($response->Result as $adsreport)
       echo $adsreport->Page."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }