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

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

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

Zoho CRM への接続を設定

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

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

    Import-Module ZohoCRMCmdlets;

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

    $conn = Connect-Zoho  -AuthToken "$AuthToken"

Zoho CRM への接続

それでは、Zoho CRM に接続していきましょう。データに接続するには、以下の接続パラメータを設定します。

• Region：Zoho CRM サーバーURL のドメインに関連付けられたリージョン
• Schema：Zoho CRM のバージョン（v2、v2.1、またはv4）。Zoho CRM のバージョンごとに独自のデータモデルがあります

これらのプロパティに加えて、認可時にサンドボックスまたは開発者インスタンスのいずれかを選択した場合は、InstanceType 接続プロパティでも同じ設定を行ってください。

Zoho CRM への認証

Zoho CRM では、データへの認証に2つの方法が用意されています。お使いの環境に応じて適切な方法を選択てください。

デスクトップ経由で自分のローカルデータに認証を行う場合（非ブラウザ接続）：CData 製品が提供する埋め込みOAuth アプリケーションを使用

CData 製品はすでにZoho CRM にOAuth アプリケーションとして登録されています。そのため、デスクトップアプリケーションを介したローカルデータへの接続では、自動的に組み込みアプリケーションが使用されます。 OAuth 交換の繰り返しを避け、ローカルデータにアクセスするたびにOAuthAccessToken を手動で設定する手間を省くには、InitiateOAuth をGETANDREFRESH に設定してください。

ネットワーク経由で共有データに認証を行う場合（ブラウザ接続）：カスタムOAuth アプリケーションを使用

すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

より詳細な認証手順については、ヘルプドキュメントの「Zoho CRM への認証」をご確認ください。

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

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

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

Select-ZohoCRM -Connection $conn -Table Accounts | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountsData.csv -NoTypeInformation

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

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

データの削除

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

Select-ZohoCRM -Connection $conn -Table Accounts -Where "Industry = Data/Telecom OEM" | Remove-ZohoCRM

データの挿入と更新

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

Import-Csv -Path C:\MyAccountsUpdates.csv | %{
  $record = Select-ZohoCRM -Connection $ZohoCRM -Table Accounts -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ZohoCRM -Connection $zohocrm -Table Accounts -Columns ("Account_Name","Annual_Revenue") -Values ($_.Account_Name, $_.Annual_Revenue) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-ZohoCRM -Connection $zohocrm -Table Accounts -Columns ("Account_Name","Annual_Revenue") -Values ($_.Account_Name, $_.Annual_Revenue)
  }
}

おわりに

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