PowerShell からBigCommerce のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法

CData Cmdlets for BigCommerce を使えば、PowerShell からBigCommerce に手軽に連携して、データのCRUD やエクスポートを実行できます。

本記事では、BigCommerce への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。

BigCommerce への接続を設定

それでは、まずはBigCommerce への接続設定からはじめていきましょう。接続設定にはCData BigCommerce Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。

インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。

    Import-Module BigCommerceCmdlets;

Connect-BigCommerce コマンドを使ってBigCommerce との接続を設定します。各接続プロパティの取得方法は次に説明します。

    $conn = Connect-BigCommerce  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -StoreId "$StoreId" -CallbackURL "$CallbackURL"

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 に設定。

これで接続設定は完了です。

BigCommerce のデータを取得してCSV にパイプライン

接続が完了したので、Customers テーブルデータを取得して結果をCSV ファイルにエクスポートします。

Select-BigCommerce -Connection $conn -Table Customers | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

このコードでは、Select-BigCommerce から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。

それでは、続いてデータの削除や挿入・更新を実行してみます。

データの削除

以下のように、フィルタリングで合致するレコードを削除することができます。

Select-BigCommerce -Connection $conn -Table Customers -Where "FirstName = Bob" | Remove-BigCommerce

データの挿入と更新

データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。

Import-Csv -Path C:\MyCustomersUpdates.csv | %{
  $record = Select-BigCommerce -Connection $BigCommerce -Table Customers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-BigCommerce -Connection $bigcommerce -Table Customers -Columns ("FirstName","LastName") -Values ($_.FirstName, $_.LastName) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-BigCommerce -Connection $bigcommerce -Table Customers -Columns ("FirstName","LastName") -Values ($_.FirstName, $_.LastName)
  }
}

おわりに

このように、CData Cmdlets を使えばPowerShell でのBigCommerce のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。