Active Query Builder を使用してAdobe Analytics 駆動型アプリを素早く開発

SQL インターフェースを介してAdobe Analytics を公開する標準.NET を記述します。Active Query Builder は、開発者がSQL インターフェースを作成するのに役立ちます。CData ODBC Driver for AdobeAnalytics は、Adobe Analytics への標準ベースのアクセスを可能にします。この統合では、ODBC ドライバーとActive Query Builder オブジェクト間のブリッジとして、Microsoft ADO.NET Provider for ODBC を使用してビジュアルSQL コンポーザーを構築します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持った製品です。

1. Adobe Analytics をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. 多様なアプリケーション、ツールにAdobe Analytics のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてAdobe Analytics の接続を設定、2.Active Query Builder 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとAdobe Analytics への接続設定

まずは、本記事右側のサイドバーからAdobeAnalytics ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

未指定の場合は、初めに ODBC DSN（データソース名）で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使用して、ODBC DSN を作成および設定できます。

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

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

SQL を使用してAdobe Analytics と対話

以下のステップに従ってWinForms ビジュアルクエリビルダーを作成します。

1. 新しいWindows Forms プロジェクトで、QueryBuilder を［Toolbox］からフォームにドラッグします。
2. ActiveQueryBuilder.ODBCMetadataProvider への参照を追加します。
3. OdbcConnection を追加し、最初のセクションで作成したDSN に接続文字列を設定します。

   OdbcConnection connection = new OdbcConnection();
   connection.ConnectionString = "DSN=AdobeAnalytics"
   

4. ODBCMetadataProvider インスタンスとGeneralSyntaxProvider インスタンスを初期化し、ODBCMetadataProvider オブジェクトのConnection プロパティをOdbcConnection に設定します。

   GenericSyntaxProvider syntaxProvider = new GenericSyntaxProvider();
   ODBCMetadataProvider metadataProvider = new ODBCMetadataProvider();
   metadataProvider.Connection = connection;
   

5. QueryBuilder オブジェクトの、対応するMetadataProvider プロパティとSyntaxProvider プロパティを設定します。

     queryBuilder1.MetadataProvider = metadataProvider;
     queryBuilder1.SyntaxProvider = syntaxProvider;
   

6. QueryBuilder クラスのInitiatelizeDatabaseSchemaTree メソッドを呼び出してAdobe Analytics メタデータを取得し、Adobe Analytics テーブルのツリーデビューを生成します。

   queryBuilder1.InitializeDatabaseSchemaTree();

7. QueryBuilder を作成したら、それをTextBox に接続するか、使用する場合は、ActiveQueryBuilder SQLTextEditor に接続しますSQLTextEditor をデザイナにドラッグし、ドロップします。

8. 以下のコードをSQLTextEditor のValidating イベントに追加します。

   private void sqlTextEditor1_Validating(object sender, CancelEventArgs e) {
     try {
   
       // Update the query builder with manually edited query text:
       queryBuilder1.SQL = sqlTextEditor1.Text;
     }
     catch (SQLParsingException ex) {
       e.Cancel = true;
   
       // Set caret to error position
       sqlTextEditor1.SelectionStart = ex.ErrorPos.pos;
   
       // Report error
       MessageBox.Show(ex.Message, "Parsing error");
     }
   }
   

9. SQLUpdated イベントに以下を追加します。

   private void queryBuilder1_SQLUpdated(object sender, EventArgs e) {
     sqlTextEditor1.Text = queryBuilder1.FormattedSQL;
   }
   

10. これで、クエリをビジュアルに作成できます。［Columns Pane Area］のテーブルをダブルクリックすると、［entity/relationship］ダイアグラムが［Query Building Area］に表示されます。ダイアグラムで選択したカラムがクエリに追加されます。