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

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

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

   Adobe Target に接続するには、以下に記載されているOAuth 接続プロパティとともにTenant プロパティを指定する必要があります。他の接続プロパティは処理動作に影響を与える可能性がありますが、接続には影響しません。

   以下のステップでTenant 名を確認できます。

   1. Adobe Experience にログインします。URL は「https://experience.adobe.com/#/@mycompanyname/preferences/general-section」です。
   2. 「/#/@」の後の値を抽出します。この例では「mycompanyname」です。
   3. Tenant 接続プロパティをその値に設定します。

   ユーザーアカウント（OAuth）

   すべてのユーザーアカウントフローでAuthScheme をOAuthClient に設定する必要があります。

   注意：OAuth を介したAdobe 認証では、2週間ごとにトークンを更新する必要があります。

   すべてのアプリケーション

   CData では、OAuth 認証を簡素化する組み込みOAuth アプリケーションを提供しています。または、カスタムOAuth アプリケーションを作成することもできます。詳細については、ヘルプドキュメントの「カスタムOAuthアプリの作成」をご確認ください。

   OAuth アクセストークンの取得

   接続するには以下のプロパティを設定します：

   • InitiateOAuth：GETANDREFRESH に設定して、OAuth 交換を自動的に実行し、必要に応じてOAuthAccessToken を更新します。
   • OAuthClientId：アプリを登録した際に割り当てられたクライアントID に設定します。
   • OAuthClientSecret：アプリを登録した際に割り当てられたクライアントシークレットに設定します。
   • CallbackURL：アプリを登録した際に定義されたリダイレクトURI に設定します。例：https://localhost:3333

   これらの設定により、プロバイダーはAdobe Target からアクセストークンを取得し、それを使用してデータを要求します。OAuth値はOAuthSettingsLocation で指定された場所に保存され、接続間で確実に保持されます。

   
   <configuration>
      ... <connectionStrings>
       <add name="AdobeTargetContext" connectionString="Offline=False;Tenant=mycompanyname;" providerName="System.Data.CData.AdobeTarget" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.AdobeTarget" type="System.Data.CData.AdobeTarget.AdobeTargetProviderServices, System.Data.CData.AdobeTarget.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.AdobeTarget.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAdobeTargetContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class AdobeTargetContext :DbContext {
   	public AdobeTargetContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<AdobeTargetContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているAdobe Target のエンティティ、例えばActivities にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class Activities {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String Id { get; set; }
   }
   public class ActivitiesMap :EntityTypeConfiguration<Activities> {
   	public ActivitiesMap() {
   		this.ToTable("Activities");
   		this.HasKey(Activities => Activities.Id);
   		this.Property(Activities => Activities.Id);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<Activities> Activities { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   AdobeTargetContext context = new AdobeTargetContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Activities select line;