各製品の資料を入手。
詳細はこちら →
Entity Framework 6 からSmartsheet のデータに連携
この記事は、Entity Framework のcode-first アプローチを使って、Smartsheet に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。
最終更新日：2022-04-04
この記事で実現できるSmartsheet 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでSmartsheet にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、Smartsheet Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。
- Smartsheet にログインします。
- 「アカウント」をクリックして「個人用の設定」を選択します。
- 「API アクセス」をクリックし、フォームを使用して新しいアクセストークンを生成するか、既存のアクセストークンを管理します。
その後、OAuthAccessToken を生成したトークンに設定します。
<configuration> ... <connectionStrings> <add name="SmartsheetContext" connectionString="Offline=False;OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;" providerName="System.Data.CData.Smartsheet" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Smartsheet" type="System.Data.CData.Smartsheet.SmartsheetProviderServices, System.Data.CData.Smartsheet.Entities.EF6" /> </providers> <entityFramework> </configuration> </code> - インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Smartsheet.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
- この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
- プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSmartsheetContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
- PluralizingTableNameConvention をModelBuilder Conventions から削除。
- MigrationHistory テーブルへのリクエストを削除。
using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SmartsheetContext :DbContext { public SmartsheetContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SmartsheetContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } } - もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSmartsheet のエンティティ、例えばSheet_Event_Plan_Budget にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Sheet_Event_Plan_Budget { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String TaskName { get; set; } } public class Sheet_Event_Plan_BudgetMap :EntityTypeConfiguration<Sheet_Event_Plan_Budget> { public Sheet_Event_Plan_BudgetMap() { this.ToTable("Sheet_Event_Plan_Budget"); this.HasKey(Sheet_Event_Plan_Budget => Sheet_Event_Plan_Budget.Id); this.Property(Sheet_Event_Plan_Budget => Sheet_Event_Plan_Budget.TaskName); } } - エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：
public DbSet<Sheet_Event_Plan_Budget> Sheet_Event_Plan_Budget { set; get; } - コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：
SmartsheetContext context = new SmartsheetContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Sheet_Event_Plan_Budget select line;
関連コンテンツ
