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

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

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

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

Xero への接続を設定

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

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

    Import-Module XeroCmdlets;

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

    $conn = Connect-Xero 

接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、 パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、 およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。

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

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

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

Select-Xero -Connection $conn -Table Items | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myItemsData.csv -NoTypeInformation

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

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

データの削除

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

Select-Xero -Connection $conn -Table Items -Where "Name = Golf balls - white single" | Remove-Xero

データの挿入と更新

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

Import-Csv -Path C:\MyItemsUpdates.csv | %{
  $record = Select-Xero -Connection $Xero -Table Items -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Xero -Connection $xero -Table Items -Columns ("Name","QuantityOnHand") -Values ($_.Name, $_.QuantityOnHand) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Xero -Connection $xero -Table Items -Columns ("Name","QuantityOnHand") -Values ($_.Name, $_.QuantityOnHand)
  }
}

おわりに

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