JDBI からAdobe Analytics データのデータアクセスオブジェクトを作成

加藤龍彦
デジタルマーケティング

JDBI でAdobe Analytics のデータ用のSQL オブジェクトAPIを作成する方法を概説します。

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for AdobeAnalytics は、Java アプリケーションとリアルタイムAdobe Analytics のデータのデータ連携を実現します。これらの技術を組み合わせることによって、Adobe Analytics のデータへのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するAdobe Analytics のデータの読み書きのためのコードの作成について説明します。

Adobe Analytics AdsReport Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。

public interface MyAdsReportDAO {
  //request specific data from Adobe Analytics (String type is used for simplicity)
  @SqlQuery("SELECT PageViews FROM AdsReport WHERE City = :city")
  String findPageViewsByCity(@Bind("city") String city);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Adobe Analytics への接続を開く

必要な接続プロパティを収集し、Adobe Analytics に接続するための適切なJDBC URL を作成します。

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 フローを以下の手順で完了します。

クライアントクレデンシャルOAuth フローで指定されたOAuthClientId およびOAuthClientSecret を使用して、アクセストークンを取得します
OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします
トークンが期限切れになった際に、新しいアクセストークンを要求します

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

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

java -jar cdata.jdbc.adobeanalytics.jar

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

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Adobe Analytics の接続文字列は、通常次のようになります。

jdbc:adobeanalytics:GlobalCompanyId=myGlobalCompanyId; RSID=myRSID; OAuthClientId=myOauthClientId; OauthClientSecret=myOAuthClientSecret; CallbackURL=myCallbackURL;

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。

DBI dbi = new DBI("jdbc:adobeanalytics:GlobalCompanyId=myGlobalCompanyId; RSID=myRSID; OAuthClientId=myOauthClientId; OauthClientSecret=myOAuthClientSecret; CallbackURL=myCallbackURL;");
MyAdsReportDAO dao = dbi.open(MyAdsReportDAO.class);

//do stuff with the DAO

dao.close();

Adobe Analytics データについて

Adobe Analytics への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Adobe Analytics のAdsReport エンティティからデータを取得できます。

//disply the result of our 'find' method
String pageViews = dao.findPageViewsByCity("Chapel Hill");
System.out.println(pageViews);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for AdobeAnalytics と統合することで、SQL Object API for AdobeAnalytics を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムAdobe Analytics を操作しましょう。