Elasticsearch へLogstash 経由でFacebook Ads のデータをロードする方法

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

Elasticsearch は、人気の分散型全文検索エンジンです。データを一元的に格納することで、超高速検索や、関連性の細かな調整、パワフルな分析が大規模に、手軽に実行可能になります。Elasticsearch にはデータのローディングを行うパイプラインツール「Logstash」があります。CData Drivers を利用することができるので、30日の無償評価版をダウンロードしてあらゆるデータソースを簡単にElasticsearch に取り込んで検索・分析を行うことができます。

この記事では、CData Driver for FacebookAds を使って、Facebook Ads のデータをLogstash 経由でElasticsearch にロードする手順を説明します。

Elasticsearch Logstash でCData JDBC Driver for FacebookAds を使用

• CData JDBC Driver for FacebookAds をLogstash が稼働するマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます（2022J の部分はご利用される製品バージョンによって異なります）。後ほどこのパスを使います。この.jar ファイル（製品版の場合は.lic ファイルも）をLogstash に配置します。
  C:\Program Files\CData\CData JDBC Driver for FacebookAds 2022J\lib\cdata.jdbc.facebookads.jar
  
• 次に、Logstash とCData JDBC ドライバをつなぐ、JDBC Input Plugin をインストールします。JDBC Plugin は最新のLogstash だとデフォルトでついてきますが、バージョンによっては追加する必要があります。
  https://www.elastic.co/guide/en/logstash/5.4/plugins-inputs-jdbc.html
• CData JDBC ドライバの.jar ファイルと.lic ファイルを、Logstashの「/logstash-core/lib/jars/」に移動します。

Logstash でElasticsearch にFacebook Ads のデータを送る

それでは、Logstash でElasticsearch にFacebook Ads のデータの転送を行うための設定ファイルを作成していきます。

• Logstash のデータ処理定義であるlogstash.conf ファイルにFacebook Ads のデータを取得する処理を書きます。Input はJDBC、Output はElasticsearch にします。データローディングジョブの起動間隔は30秒に設定しています。
• CData JDBC ドライバの.jar をjdbc driver ライブラリにして、クラス名を設定、Facebook Ads への接続プロパティを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：このプロパティを使用して、特定の広告インサイトのクエリとエラーに対するクエリの自動再試行を制御します。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.facebookads.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.facebookads.FacebookAdsDriver"
                    jdbc_connection_string => "jdbc:facebookads:InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT AccountId, Name FROM AdAccounts WHERE Name = 'Acct Name'"
                }
            }


            output {
                Elasticsearch {
                    index => "facebookads_AdAccounts"
                    document_id => "xxxx"
                }
            }
        

Logstash でFacebook Ads のローディングを実行

それでは作成した「logstash.conf」ファイルを元にLogstash を実行してみます。

成功した旨のログが出ます。これでFacebook Ads のデータがElasticsearch にロードされました。

例えばKibana で実際にElasticsearch に転送されたデータを見てみます。

        GET facebookads_AdAccounts/_search
        {
            "query": {
                "match_all": {}
            }
        }
    

データがElasticsearch に格納されていることが確認できました。

CData JDBC Driver for FacebookAds をLogstash で使うことで、Facebook Ads コネクタとして機能し、簡単にデータをElasticsearch にロードすることができました。ぜひ、30日の無償評価版をお試しください。