SpagoBI でFacebook Ads に連携

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for FacebookAds はJDBC 標準をサポートするビジネスインテリジェンスおよびデータマイニングツールからリアルタイムFacebook Ads に接続することを可能にします。この記事では、Facebook Ads をSpagoBI Studio のレポートに統合し、SpagoBI サーバーでホストする方法を説明します。

SpagoBI サーバーのJDBC ドライバーをデプロイ

以下のステップに従ってSpagoBI サーバーでJDBC data source for FacebookAds を作成します。

1. ドライバーJAR を%CATALINA_BASE%/lib にコピーします。これらのファイルは、インストールディレクトリのlib サブフォルダにあります。

2. Facebook Ads ドライバーリソースをコンテクストに追加します。以下のリソース定義をserver.xml の［GlobalNamingResources］要素に追加できます。 <Resource name="jdbc/facebookads" auth="Container" type="javax.sql.DataSource" driverclassname="cdata.jdbc.facebookads.FacebookAdsDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxactive="20" maxidle="10" maxwait="-1"/>

3. 以下のリソースリンクを追加し、Web アプリケーションへのアクセスを許可します。この記事では、SpagoBI のMETA-INF\context.xml に次の行を追加します。 <ResourceLink global="jdbc/facebookads" name="jdbc/facebookads" type="javax.sql.DataSource"/>
4. サーバーを再起動します。

SpagoBI サーバーのリソースにドライバーを追加した後、データソースを追加します。SpagoBIで［Resources］->［Data Source］->［Add］と進み、以下の情報を入力します。

• Label:ドライバーに独特の識別子を入力します。
• Description:ドライバーにディスクリプションを入力します。
• Dialect:デフォルトの方言を選択します。
• Read Only:読み取り専用オプションを選択します。このオプションは、データソースがエンドユーザーによって作成された、データセットを保存するためのデフォルトデータベースであるかどうかを決定します。
• Type:［JDBC］を選択します。
• URL:
• 必要な接続文字列プロパティを使用してJDBC URLを入力します。

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

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

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

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

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

  ビルトイン接続文字列デザイナ

  JDBC URL の構成については、Facebook Ads JDBC Driver に組み込まれている接続文字列デザイナを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

  java -jar cdata.jdbc.facebookads.jar

  接続プロパティを入力し、接続文字列をクリップボードにコピーします。

  以下は一般的なJDBC URL です。

  jdbc:facebookads:InitiateOAuth=GETANDREFRESH
• Driver:ドライバーのクラス名にcdata.jdbc.facebookads.FacebookAdsDriver を入力します。

SpagoBI Studio でレポートを作成

以下のステップに従い、SpagoBI StudioでFacebook Ads に基づいたレポートを作成します。SQL クエリの結果をチャートに挿入するデータセットを作成します。次のセクションでは、このレポートをSpagoBI サーバーでホストします。

初めに、SpagoBI Studio のレポートからFacebook Ads に接続してください。

1. SpagoBI Studio で、［File］->［New］->［Project］とクリックしていき、［Business Intelligence and Reporting Tools］フォルダで［Report Project］を選択します。
2. ［File］->［New］->［Report］と進み、［Blank Report］を選択します。
3. ［Data Explorer］ビューで［Data Sources］を右クリックし、［New Data Source］をクリックします。
4. ［JDBC Data Source］を選択し、データソース名を入力します。
5. ［Manage Drivers］をクリックし、［Add］をクリックしてドライバーJAR(cdata.jdbc.facebookads.jar) を追加します。
6. ドライバーJAR　は、インストールディレクトリのlib サブフォルダにあります。
7. ［Driver Class］メニューでドライバークラス(cdata.jdbc.facebookads.FacebookAdsDriver)を選択します。
8. ［Database URL］ボックスに、［JDBC URL］を入力します。以下は一般的な接続文字列です。 jdbc:facebookads:InitiateOAuth=GETANDREFRESH 必要な接続プロパティを取得するためのガイドについては、ドライバーヘルプの［Getting Started］チャプターを見てください。

Facebook Ads に接続した後、SQL クエリの結果を含むデータセットを作成します。

1. ［DataSet］フォルダを右クリックし、［New Data Set］をクリックします。JDBC data source for FacebookAds を選択し、データセットの名称を入力します。
2. SQL クエリを構築します。ここでは、このクエリを使用してダッシュボードにチャートを追加します。例： SELECT AccountId, Name FROM AdAccounts WHERE Name = 'Acct Name'

データセットを使用して、レポートオブジェクトにデータを入力できます。以下のステップに従って、チャートを作成します。

1. ［Palette］ビューで、チャートをキャンバスにドラッグします。
2. ［Select Chart Type］タブで棒グラフを選択します。
3. ［Select Data］タブで［Use Data From］オプションをクリックし、メニューからFacebook Ads データセットを選択します。
4. AccountId をテーブルからx 軸の系列にドラッグします。
5. Name をテーブルからy 軸の系列にドラッグします。

SpagoBI サーバーに関するホストFacebook Ads レポート

以下のステップに従って、SpagoBI サーバーでリアルタイムFacebook Ads に基づいてドキュメントをホストできます。前のセクションで作成したレポートをテンプレートとして使用します。レポートユーザーがリアルタイムデータにアクセスできるようにするには、サーバー上のFacebook Ads JDBC データソースに置き換えられるプレースホルダパラメータを作成します。

1. 未実行の場合、SpagoBI Studio で［Report Design］パースペクティブで開きます。
2. ［Data Explorer］ビューで［Report Parameters］フォルダを右クリックし、［New Parameter］をクリックします。url パラメータを追加し、それに空の値を割り当てます。このパラメータはSpagoBI サーバー上のJDBC データソースのプレースホルダです。
3. Facebook Ads データソースを右クリックし、［Edit］をクリックします。

4. ［Property Binding］ノードで、JDBC Driver のURL バインディングプロパティurl パラメータに設定します。プロパティのボックスをクリックします。［Category］セクションで［Report Parameters］を選択します。［Subcategory］セクションで［All］を選択し、パラメータをダブルクリックします。

   JavaScript構文に以下のように入力することもできます。

   params["url"].value

続いて、SpagoBI サーバーでレポート用の新しいドキュメントを作成します。

1. SpagoBI サーバーで、［Documents Development］->［Create Document］->［Generic Document］と進みます。［Document Details］ページが表示されます。
2. 以下の情報を入力し、ドキュメントを作成します。
   • Label:ドキュメントに独自の識別子を入力します。
   • Name:ドキュメントのわかりやすい名前を入力します。
   • Type:メニューから［Report］を選択します。
   • Engine:［BIRT Report Engine］を選択します。
   • Data Source:SpagoBI サーバーのCreate a JDBC Data Source for FacebookAds で作成したFacebook Ads Data Source を選択します。
3. ［Show Document Templates］セクションで、ドキュメントを格納したいフォルダを選択します。

4. ［Template］セクションで、［Choose File］をクリックします。レポートプロジェクトを含むフォルダに移動します。.rptdesign ファイルを選択します。

   Noteプロジェクトへのパスは、プロジェクトプロパティで確認できます。

5. ［Save］ボタンをクリックします。

サーバーでレポートを実行すると、プレースホルダurl パラメータがサーバーで定義されたJDBC URL に置き換えられます。