LINQPad でBigCommerce のデータを操作する方法

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

CData ADO.NET Provider for BigCommerce は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってBigCommerce の操作を実現します。この記事では、LINQPad から接続してLINQ クエリを実行する方法を説明します。

必要なもの

本記事の手順を実行してLINQPad からBigCommerce に接続するには、以下の3つの製品が必要になります。

• BigCommerce の環境
• LINQPad
• CData ADO.NET Provider for BigCommerce。右側のサイドバーから30日間無償トライアルがダウンロードできます

データモデルの作成

CData ADO.NET Provider for BigCommerce およびLINQPad をダウンロード・インストールしたら、Visual Studio で新しいクラスライブラリプロジェクトを作成します。

ADO.NET Provider の利用に必要となるEF 6を設定する方法については、ヘルプドキュメントを参照してください。

1. プロジェクトを右クリックし、［追加］→［新しい項目］→［ADO.NET Entity Data Model］をクリックします。ダイアログが表示されたら、データベースから［Code First］を選択します。 ［New Connection］をクリックして、表示されたウィザードで接続文字列オプションを指定します。

BigCommerce 認証は標準のOAuth フローに基づいています。

Store ID の取得

BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

1. BigCommerce アカウントにログインします。
2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
4. 画面にAPI Path という名前のテキストボックスが表示されます。
5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

パーソナルアクセストークンの取得

加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

1. BigCommerce アカウントにログインします。
2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
4. アカウント名を入力します。
5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
6. 「保存」をクリックします。

BigCommerce への認証

次に、以下を設定してデータに接続できます。
• StoreId：API Path テキストボックスから取得したStore ID に設定。
• OAuthAccessToken：生成したトークンに設定。
• InitiateOAuth：OFF に設定。

一般的な接続文字列は次のとおりです。

OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'

2. 希望するテーブルおよびビューを選択して［Finish］をクリックし、データモデルを作成します。

3. プロジェクトをビルドします。生成されたファイルを使ってLINQPad でBigCommerce 接続を作成できます。

LINQPad でBigCommerce のデータに接続

必要な接続プロパティを取得してデータモデルアセンブリを作成したら、以下の手順に従ってLINQPad でデータモデルを使いはじめましょう。

1. LINQPad を開き［接続の追加］をクリックします。

2. ［Use a typed data context from your own assembly］オプションを選択します。

3. ［Entity Framework DbContext］を選択します。

4. ［Path to Custom Assembly］ボックスの横にある［参照］をクリックして、プロジェクトフォルダを参照します。bin フォルダの下の.dll または.exe を参照します。

5. DbContext の名前を選択します。
6. 接続文字列をApp.Config に保存した場合は、App.Config へのパスを指定します。

これでLINQPad 経由でBigCommerce にクエリできます。サポートされたLINQ クエリの例は、ヘルプドキュメントの「LINQ およびEntity Framework」を参照してください。