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

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

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

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

Connect Cloud を構成

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

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

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

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

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 からFacebook Ads に接続

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

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

   Facebook Ads 接続プロパティの取得・設定方法

   ほとんどのテーブルで、アプリケーション認証と同様にユーザー認証を必要とします。Facebook Ads はユーザー認証にOAuth 標準を使用しています。Facebook への認証には、組み込み認証を使用してブラウザ経由で完結することもできますし、Facebook にアプリを登録することで独自のOAuthClientId、OAuthClientSecret、CallbackURL を取得することもできます。

   の設定方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

   任意で以下の項目を設定して、フィルタリングや集計を行うもできます。必要に応じてご利用ください。

   • Target：Facebook データのテーブルのいくつかはターゲットでフィルタリングできます。例えば、動画のコメントを取得するにはターゲットに動画のID を指定します。このプロパティは、クエリ結果を指定されたターゲットに合致するレコードにフィルタリングします。Target カラムを使ってクエリ毎にこの制限をかけることができます。
   • AggregateFormat：CData 製品は、いくつかのカラムを文字列集合として返します。例えば、エンティティのいいねデータは集計されて返されます。デフォルトでは、CData 製品はJSON で集計カラムを返します。集計をXML で返すことも可能です。
   • RetryLevel：このプロパティを使用して、特定の広告インサイトのクエリとエラーに対するクエリの自動再試行を制御します。
   
4. Create & Test をクリックします。
5. 「Add Facebook Ads Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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

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

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

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

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

   require_once 'FacebookAdsEntities.php'; try{ $svc = new CDataAPI(); $adaccounts = new AdAccounts(); $adaccounts->Name = 'Acct Name'; $svc->AddToAdAccounts($adaccounts); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->adaccounts()->Execute(); foreach($response->Result as $adaccounts) echo $adaccounts->AccountId."
"; } catch (Exception $e) { //CData Connect Cloud からのエラーをキャッチ echo $e->getError(), "\n"; }