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

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

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

Pipedrive への接続を設定

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

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

    Import-Module PipedriveCmdlets;

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

    $conn = Connect-Pipedrive  -AuthScheme "$AuthScheme" -CompanyDomain "$CompanyDomain" -APIToken "$APIToken"

Pipedrive 接続プロパティの取得・設定方法

Pipedrive には、接続および認証する2つの方法があります。Basic およびOAuth です。

Basic 認証

1. API トークンを取得します。
   1. Pipedrive ポータルを開きます。
   2. ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
   3. 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
   4. 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。（これは会社の開発者用サンドボックスのURL です。）
2. 次の接続プロパティを設定します。
   • APIToken：取得したAPI トークンの値。
   • CompanyDomain：開発者サンドボックスURL のCompanyDomain。
   • AuthScheme：Basic。
3. 承認されたユーザー名とパスワードでログインします。

API トークンはPipedrive ポータルに保存されます。これを取得するには、会社名をクリックし、ドロップダウンリストを使用して会社設定 -> Personal Preferences -> API に移動します。

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth 認証」セクションを参照してください。

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

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

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

Select-Pipedrive -Connection $conn -Table Deals | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDealsData.csv -NoTypeInformation

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

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

データの削除

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

Select-Pipedrive -Connection $conn -Table Deals -Where "Value = 50000" | Remove-Pipedrive

データの挿入と更新

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

Import-Csv -Path C:\MyDealsUpdates.csv | %{
  $record = Select-Pipedrive -Connection $Pipedrive -Table Deals -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Pipedrive -Connection $pipedrive -Table Deals -Columns ("PersonName","UserEmail") -Values ($_.PersonName, $_.UserEmail) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Pipedrive -Connection $pipedrive -Table Deals -Columns ("PersonName","UserEmail") -Values ($_.PersonName, $_.UserEmail)
  }
}

おわりに

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