Entity Framework 6 からPipedrive のデータに連携

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

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでPipedrive にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、Pipedrive Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   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。
      • AuthScheme：Basic。
   3. 承認されたユーザー名とパスワードでログインします。

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

   OAuth 認証

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

   <configuration> ... <connectionStrings> <add name="PipedriveContext" connectionString="Offline=False;AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;" providerName="System.Data.CData.Pipedrive" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Pipedrive" type="System.Data.CData.Pipedrive.PipedriveProviderServices, System.Data.CData.Pipedrive.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Pipedrive.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はPipedriveContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class PipedriveContext :DbContext { public PipedriveContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<PipedriveContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているPipedrive のエンティティ、例えばDeals にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Deals { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String PersonName { get; set; } } public class DealsMap :EntityTypeConfiguration<Deals> { public DealsMap() { this.ToTable("Deals"); this.HasKey(Deals => Deals.Id); this.Property(Deals => Deals.PersonName); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Deals> Deals { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： PipedriveContext context = new PipedriveContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Deals select line;