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

Active Query Builder SQL インターフェースビルダーと、.NET データアクセスの簡単さを活用し、データ駆動型のWinForms とASP.NET アプリを作成します。

古川えりか
コンテンツスペシャリスト

最終更新日:2022-05-26

この記事で実現できるPipedrive 連携のシナリオ

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

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

CData ODBC ドライバとは?

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

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

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

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

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

未指定の場合は、初めにODBC DSN (data source name) で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC Data Source Administrator を使用して、ODBC DSN を作成および構成できます。

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

Pipedrive には、接続および認証する2つの方法があります。Basic およびOAuth です。

Basic 認証

Basic 認証で認証するには:
  1. API トークンを取得します。
    1. Pipedrive ポータルを開きます。
    2. ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
    3. 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
    4. 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。(これは会社の開発者用サンドボックスのURL です。)
  2. 次の接続プロパティを設定します。
    • APIToken:取得したAPI トークンの値。
    • CompanyDomain:開発者サンドボックスURL のCompanyDomain
    • AuthSchemeBasic
  3. 承認されたユーザー名とパスワードでログインします。

API トークンはPipedrive ポータルに保存されます。これを取得するには、会社名をクリックし、ドロップダウンリストを使用して会社設定 -> Personal Preferences -> API に移動します。

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth 認証」セクションを参照してください。

SQL を使用してPipedrive と対話

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

  1. 新しいWindows Forms プロジェクトで、QueryBuilder を[Toolbox]からフォームにドラッグします。
  2. ActiveQueryBuilder.ODBCMetadataProvider への参照を追加します。
  3. OdbcConnection を追加し、最初のセクションで作成したDSN に接続文字列を設定します。 OdbcConnection connection = new OdbcConnection(); connection.ConnectionString = "DSN=Pipedrive"
  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 メソッドを呼び出してPipedrive メタデータを取得し、Pipedrive テーブルのツリーデビューを生成します。 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]に表示されます。ダイアグラムで選択したカラムがクエリに追加されます。

Building queries interactively with Active Query Builder.

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。