PowerShell からAha のデータに接続してデータの取得・CSV エクスポートを実行する方法
CData Cmdlets for API を使えば、PowerShell からAha に手軽に連携して、データのCRUD やエクスポートを実行できます。
本記事では、Aha への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。
Aha への接続を設定
それでは、まずはAha への接続設定からはじめていきましょう。接続設定にはCData Aha Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。
インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。
Import-Module APICmdlets;
Connect-API コマンドを使ってAha との接続を設定します。各接続プロパティの取得方法は次に説明します。
$conn = Connect-API -Profile "$Profile" -ProfileSettings "$ProfileSettings" -Authscheme "$Authscheme" -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackUrl "$CallbackUrl"
まず、Profile 接続プロパティをディスク上のAha! プロファイルの場所に設定します（例：C:\profiles\aha.apip）。次に、ProfileSettings 接続プロパティをAha! の接続文字列に設定します（以下を参照）。
Aha! API プロファイル設定
Aha! API はOAuth ベースの認証を使用します。
まず、Aha! でOAuth アプリを登録する必要があります。これはAha! アカウントの「Settings」>「Personal」>「Developer」>「OAuth Applications」から行えます。また、Aha アカウントのドメイン名にあるDomain を設定します。例えば、Aha アカウントがacmeinc.aha.io の場合、Domain は「acmeinc」となります。
以下の項目を接続文字列に設定すると、接続できるようになります。
- AuthScheme：OAuth に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId：アプリ設定で指定されたclient_id に設定します。
- OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
- CallbackURL：アプリ設定で指定したRedirect URI に設定します。
- Domain：ProfileSettings でAha ドメインに設定します。
これで接続設定は完了です。
Aha のデータを取得してCSV にパイプライン
接続が完了したので、Ideas テーブルデータを取得して結果をCSV ファイルにエクスポートします。
Select-API -Connection $conn -Table Ideas | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myIdeasData.csv -NoTypeInformation
このコードでは、Select-API から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。
おわりに
このように、CData Cmdlets を使えばPowerShell でのAha のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。