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

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

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

Square への接続を設定

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

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

    Import-Module SquareCmdlets;

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

    $conn = Connect-Square  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL" -LocationId "$LocationId"

Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。

追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。

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

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

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

Select-Square -Connection $conn -Table Refunds | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myRefundsData.csv -NoTypeInformation

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

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

データの削除

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

Select-Square -Connection $conn -Table Refunds -Where "Type = FULL" | Remove-Square

データの挿入と更新

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

Import-Csv -Path C:\MyRefundsUpdates.csv | %{
  $record = Select-Square -Connection $Square -Table Refunds -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Square -Connection $square -Table Refunds -Columns ("Reason","RefundedMoneyAmount") -Values ($_.Reason, $_.RefundedMoneyAmount) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Square -Connection $square -Table Refunds -Columns ("Reason","RefundedMoneyAmount") -Values ($_.Reason, $_.RefundedMoneyAmount)
  }
}

おわりに

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