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

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

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

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

スマレジ への接続を設定

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

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

    Import-Module SmaregiCmdlets;

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

    $conn = Connect-Smaregi  -ContractId "$ContractId" -AccessToken "$AccessToken"

スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。

• スマレジにログイン後、「設定」->「システム連携」->「スマレジAPI 設定」に移動します。
• 「API受信設定」セクションにある「受信機能を利用する」を「利用する」に変更し、「アクセストークンの生成」をクリックし、AccessToken を取得します。
• 次に必要なAPI アクセスを有効にするため、「機能設定」セクションで必要な機能を「利用する」に変更します。

ContractId： アカウントの契約ID。これは受信設定セクションでも確認できます。
AccessToken： 受信設定セクションのアクセストークン。

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

スマレジ データを取得してCSV にパイプライン

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

Select-Smaregi -Connection $conn -Table Products | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myProductsData.csv -NoTypeInformation

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

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

データの削除

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

Select-Smaregi -Connection $conn -Table Products -Where "ProductId = 666666" | Remove-Smaregi

データの挿入と更新

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

Import-Csv -Path C:\MyProductsUpdates.csv | %{
  $record = Select-Smaregi -Connection $Smaregi -Table Products -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Smaregi -Connection $smaregi -Table Products -Columns ("ProductName","Description") -Values ($_.ProductName, $_.Description) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Smaregi -Connection $smaregi -Table Products -Columns ("ProductName","Description") -Values ($_.ProductName, $_.Description)
  }
}

おわりに

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