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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Connect Cloud を構成

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

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

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

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

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

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

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

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

Connect Cloud からSurveyMonkey に接続

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

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

   SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。

   SurveyMonkey への接続に使用できる認証方法は2つあります。

   • プライベートoauth アプリケーションを登録するときに、パーソナルアクセストークンを使用します。
   • パブリックoauth アプリケーションを登録するときに、OAuth を使用します。

   パーソナルアクセストークンの使用

   個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、ヘルプの「Creating a Custom OAuth App」の手順に従って、次の接続プロパティを設定します。

   • OAuthAccessToken：アプリケーション設定で生成されたAccessToken に設定。
   • InitiateOAuth：OFF に設定。

   OAuth の使用

   CData 製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャルを使用して接続します。

   独自のカスタムOAuth アプリを使用したい場合は、ヘルプのCustom Credentials を参照してください。

   
4. Create & Test をクリックします。
5. 「Add SurveyMonkey Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にSurveyMonkey OData エンドポイントを追加する

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

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

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

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

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

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

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

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

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

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

   require_once 'SurveyMonkeyEntities.php'; try{ $svc = new CDataAPI(); $mysurvey_responses = new MySurvey_Responses(); $mysurvey_responses->ChoiceText = 'blue'; $svc->AddToMySurvey_Responses($mysurvey_responses); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->mysurvey_responses()->Execute(); foreach($response->Result as $mysurvey_responses) echo $mysurvey_responses->RespondentId."
"; } catch (Exception $e) { //CData Connect Cloud からのエラーをキャッチ echo $e->getError(), "\n"; }