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