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

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

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

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

Gmail への接続を設定

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

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

    Import-Module GmailCmdlets;

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

    $conn = Connect-Gmail  -User "$User" -Password "$Password"

Gmail に接続する方法は2つあります。ログインクレデンシャルかOAuth のいずれかを選択する前に、まずGmail のアカウント設定でIMAP アクセスを有効にしてください。詳しくは、ヘルプドキュメントの「はじめに」-「Gmail への接続」を参照してください。

Authentication セクションのUser とPassword プロパティに、有効なGmail ユーザー資格情報を設定します。

あるいは、Password を指定する代わりに、OAuth 認証標準を使います。 個々のユーザーに代わってGoogle API にアクセスするには、埋め込みクレデンシャルを使用するか、独自のOAuth アプリを登録することができます。

また、OAuth を利用することで、Google Apps ドメイン内のユーザーに代わってサービスアカウントを使用して接続することができます。サービスアカウントで認証するには、アプリケーションを登録してOAuth JWT 値を取得する必要があります。

OAuth 値に加え、User を指定する必要があります。詳しくは、ヘルプドキュメントの「はじめに」を参照してください。

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

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

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

Select-Gmail -Connection $conn -Table Inbox | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myInboxData.csv -NoTypeInformation

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

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

データの削除

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

Select-Gmail -Connection $conn -Table Inbox -Where "From = test@test.com" | Remove-Gmail

データの挿入と更新

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

Import-Csv -Path C:\MyInboxUpdates.csv | %{
  $record = Select-Gmail -Connection $Gmail -Table Inbox -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Gmail -Connection $gmail -Table Inbox -Columns ("Subject","Size") -Values ($_.Subject, $_.Size) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Gmail -Connection $gmail -Table Inbox -Columns ("Subject","Size") -Values ($_.Subject, $_.Size)
  }
}

おわりに

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