各製品の資料を入手。
詳細はこちら →
製品をチェック
PowerShell からFreshdesk のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法
CData PowerShell Cmdlets を使って、Freshdesk のデータに接続、データの取得・更新・挿入・削除・CSV エクスポートを実行する方法を紹介します。
最終更新日：2023-09-26
この記事で実現できるFreshdesk 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
CData Cmdlets for FreshDesk を使えば、PowerShell からFreshdesk に手軽に連携して、データのCRUD やエクスポートを実行できます。
本記事では、Freshdesk への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。
Freshdesk への接続を設定
それでは、まずはFreshdesk への接続設定からはじめていきましょう。接続設定にはCData Freshdesk Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。
インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。
Import-Module FreshDeskCmdlets;
Connect-FreshDesk コマンドを使ってFreshdesk との接続を設定します。各接続プロパティの取得方法は次に説明します。
$conn = Connect-FreshDesk -Domain "$Domain" -APIKey "$APIKey"
FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。
- Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
- APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。
これで接続設定は完了です。
Freshdesk のデータを取得してCSV にパイプライン
接続が完了したので、Tickets テーブルデータを取得して結果をCSV ファイルにエクスポートします。
Select-FreshDesk -Connection $conn -Table Tickets | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTicketsData.csv -NoTypeInformation
このコードでは、Select-FreshDesk から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。
それでは、続いてデータの削除や挿入・更新を実行してみます。
データの削除
以下のように、フィルタリングで合致するレコードを削除することができます。
Select-FreshDesk -Connection $conn -Table Tickets -Where "Status = 2" | Remove-FreshDesk
データの挿入と更新
データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。
Import-Csv -Path C:\MyTicketsUpdates.csv | %{
$record = Select-FreshDesk -Connection $FreshDesk -Table Tickets -Where ("Id = `'"+$_.Id+"`'")
if($record){
Update-FreshDesk -Connection $freshdesk -Table Tickets -Columns ("Id","Name") -Values ($_.Id, $_.Name) -Where ("Id = `'"+$_.Id+"`'")
}else{
Add-FreshDesk -Connection $freshdesk -Table Tickets -Columns ("Id","Name") -Values ($_.Id, $_.Name)
}
}
おわりに
このように、CData Cmdlets を使えばPowerShell でのFreshdesk のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。
関連コンテンツ
