各製品の資料を入手。
詳細はこちら →
製品をチェック
PowerShell からZendesk のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法
CData PowerShell Cmdlets を使って、Zendesk のデータに接続、データの取得・更新・挿入・削除・CSV エクスポートを実行する方法を紹介します。
最終更新日：2023-09-26
この記事で実現できるZendesk 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
CData Cmdlets for Zendesk を使えば、PowerShell からZendesk に手軽に連携して、データのCRUD やエクスポートを実行できます。
本記事では、Zendesk への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。
Zendesk への接続を設定
それでは、まずはZendesk への接続設定からはじめていきましょう。接続設定にはCData Zendesk Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。
インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。
Import-Module ZendeskCmdlets;
Connect-Zendesk コマンドを使ってZendesk との接続を設定します。各接続プロパティの取得方法は次に説明します。
$conn = Connect-Zendesk -URL "$URL" -User "$User" -Password "$Password"
Zendesk 接続プロパティの取得・設定方法
Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。
また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。
Zendesk への認証
Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。
API トークン認証
API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。
- Token アクセスを有効にします。
- Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
その他の認証方法についてはヘルプドキュメントを参照してください。
これで接続設定は完了です。
Zendesk のデータを取得してCSV にパイプライン
接続が完了したので、Tickets テーブルデータを取得して結果をCSV ファイルにエクスポートします。
Select-Zendesk -Connection $conn -Table Tickets | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTicketsData.csv -NoTypeInformation
このコードでは、Select-Zendesk から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。
それでは、続いてデータの削除や挿入・更新を実行してみます。
データの削除
以下のように、フィルタリングで合致するレコードを削除することができます。
Select-Zendesk -Connection $conn -Table Tickets -Where "Industry = Floppy Disks" | Remove-Zendesk
データの挿入と更新
データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。
Import-Csv -Path C:\MyTicketsUpdates.csv | %{
$record = Select-Zendesk -Connection $Zendesk -Table Tickets -Where ("Id = `'"+$_.Id+"`'")
if($record){
Update-Zendesk -Connection $zendesk -Table Tickets -Columns ("Id","Subject") -Values ($_.Id, $_.Subject) -Where ("Id = `'"+$_.Id+"`'")
}else{
Add-Zendesk -Connection $zendesk -Table Tickets -Columns ("Id","Subject") -Values ($_.Id, $_.Subject)
}
}
おわりに
このように、CData Cmdlets を使えばPowerShell でのZendesk のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。
関連コンテンツ
