WCF アプリケーションで Smartsheet のデータ の OData サービスを公開
CData ADO.NET Provider for Smartsheet を使用すると、Windows Communication Foundation(WCF)フレームワークを活用してサービス指向アプリケーションを素早く開発し、Smartsheet のデータを OData コンシューマーに提供できます。この記事では、接続用の Entity Data Model を作成し、WCF Data Service を構成して OData サービスを公開する方法を解説します。公開したフィードは、Power Pivot や CData ADO.NET Provider for OData を使用するアプリケーションなど、さまざまな OData クライアントから利用できます。
Smartsheet データ連携について
CData は、Smartsheet のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています:
- 添付ファイル、カラム、コメント、ディスカッションの読み取りと書き込みができます。
- 個々のセルのデータを表示したり、セルの履歴をレポートしたりできます。
- 添付ファイルの削除やダウンロード、シートの作成・コピー・削除・移動、行の別のシートへの移動やコピーなど、Smartsheet 固有のアクションを実行できます。
ユーザーは、Tableau、Crystal Reports、Excel などの分析ツールと Smartsheet を統合しています。また、当社のツールを活用して Smartsheet データをデータベースやデータウェアハウスにレプリケートしているお客様もいます。
はじめに
OData サービスの作成
以下の手順で、OData 経由でSmartsheet のデータへの接続を提供する WCF サービスアプリケーションを作成します。
- Visual Studio を開き、新しいプロジェクトを作成します。WCF Service Application テンプレートを選択します。
- 自動生成された IService.cs と Service1.svc を削除します。
- Entity Framework 6 をインストールします:
Visual Studio のパッケージマネージャーコンソールを使用して、最新バージョンの Entity Framework をインストールします。以下のコマンドを実行すると、Entity Framework が自動的にダウンロード・インストールされます。
Install-Package EntityFramework
- Entity Framework プロバイダーを登録します:
- App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。
<configuration> ... <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Smartsheet" type="System.Data.CData.Smartsheet.SmartsheetProviderServices, System.Data.CData.Smartsheet.Entities.EF6" /> </providers> </entityFramework> </configuration> - インストールディレクトリの lib/4.0 にある System.Data.CData.Smartsheet.Entities.dll への参照を追加します。
- プロジェクトをビルドして、EF6 のセットアップを完了します。
- App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。
- Project -> Add New Item -> ADO.NET Entity Data Model をクリックします。
- 表示される Entity Data Model ウィザードで、'EF Designer from Database' オプションを選択します。
- Choose Your Connection ダイアログが表示されたら、New Connection をクリックします。
Connection properties ダイアログで、CData Smartsheet Data Source を選択し、必要な認証情報を入力します。
一般的な接続文字列は以下のとおりです:
OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;
個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。
- Smartsheet にログインします。
- 「アカウント」をクリックして「個人用の設定」を選択します。
- 「API アクセス」をクリックし、フォームを使用して新しいアクセストークンを生成するか、既存のアクセストークンを管理します。
その後、OAuthAccessToken を生成したトークンに設定します。

- OData クライアントからアクセスさせたい Smartsheet のテーブルとビューを選択します。

- Project -> Add New Item -> WCF Data Service をクリックします。
データソースクラスを指定し、新しい WCF Data Service へのアクセスを構成します。以下の例では、エンティティの Access Rule が All に設定されています。これは、すべてのユーザーがデータの読み取りと変更を行えることを意味します。
using System; using System.Collections.Generic; using System.Data.Services; using System.Data.Services.Common; using System.Linq; using System.ServiceModel.Web; using System.Web; namespace SmartsheetService{ public class SmartsheetDataService : DataService<SmartsheetEntities> { public static void InitializeService(DataServiceConfiguration config) { config.SetEntitySetAccessRule("*", EntitySetRights.All); config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3; } } }-
プロジェクトを実行します。これで、OData 対応アプリケーションから Salesforce データにアクセスし、変更を反映できるようになります。ブラウザでフィードにアクセスできます。フィードは次のように表示されます:
Power Pivot から OData サービスを利用する
これで、任意の OData クライアント(例:Excel Power Pivot)からサービスを利用できます。
- Excel を開き、Power Pivot Window ボタンをクリックします。
- 新しいポップアップが表示されます。From Data Feeds オプションを選択します。
- 表示される Table Import Wizard で、OData URL を入力します(例:http://localhost:12449/SmartsheetDataService.svc/)。
- OData サービスへの接続後、ウィンドウ下部の Next ボタンをクリックします。
- ウィザードの次のウィンドウに、利用可能なテーブルの一覧が表示されます。インポートするテーブルを選択し、Finish をクリックします。
- Close をクリックして、Power Pivot にデータをインポートします。