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

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

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

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

   Snapchat Ads はOAuth 認証のみサポートします。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

   定型のクエリを簡略化するために、AccountId にデフォルトのAccountId を指定するように設定することもできます。 これにより、WHERE 句の一部として手動で指定する必要がなくなります。（AccountId が指定されず、WHERE 句にアカウントID が明示的に与えられない場合、CData 製品はAccounts ビューに返されるリストから最初のアカウントを取得しようとします。）

   ヘルプドキュメントでは、以下の3つの一般的な認証フローでのSnapchat Ads への認証について詳しく説明しています。

   • デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。
   • Web：共有ウェブサイト経由でデータにアクセスします。
   • ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。

   カスタムOAuth アプリケーションの作成については、ヘルプドキュメント の「カスタムOAuth アプリケーションの作成」セクションを参照してください。

   
   <configuration>
      ... <connectionStrings>
       <add name="SnapchatAdsContext" connectionString="Offline=False;" providerName="System.Data.CData.SnapchatAds" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.SnapchatAds" type="System.Data.CData.SnapchatAds.SnapchatAdsProviderServices, System.Data.CData.SnapchatAds.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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