Zendesk のデータをPowerShell でMySQL にレプリケーションする方法

PowerShell のシンプルなスクリプトで、Zendesk のデータ をMySQL データベースにレプリケーション(複製)する方法を紹介します。

古川えりか
コンテンツスペシャリスト

最終更新日:2023-09-26

この記事で実現できるZendesk 連携のシナリオ

こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。

CData Cmdlets for Zendesk を使えば、PowerShell からZendesk のデータ データにリアルタイムで連携できます。データ同期などのタスクの連携にぴったりの製品です。 本記事では、PowerShell からCData Cmdlets for Zendesk およびCData Cmdlets for MySQL を使って、同期スクリプトを作成して実行します。

まずは、PowerShell でZendesk への接続を行います。レプリケーションは4つのステップがあります。

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

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL(Zendesk Support URL)を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証(レガシー)です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthSchemeAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

  1. Token アクセスを有効にします。
  2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
最後に、APIToken をアクティブなAPI トークンに設定します。

その他の認証方法についてはヘルプドキュメントを参照してください。

Zendesk のデータの取得

  1. モジュールのインストール:

    Install-Module ZendeskCmdlets
  2. Zendesk への接続:

    $zendesk = Connect-Zendesk -URL $URL -User $User -Password $Password
  3. 取得ターゲットのリソースの取得:

    $data = Select-Zendesk -Connection $zendesk -Table "Tickets"

    Invoke-Zendesk cmdlet を使って、SQL-92 クエリを使用することもできます:

    $data = Invoke-Zendesk -Connection $zendesk -Query 'SELECT * FROM Tickets WHERE Industry = @Industry' -Params @{'@Industry'='Floppy Disks'}
  4. 戻り値からカラム名のリストを保存します。

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Zendesk のデータをMySQL データベースにレプリケーション

カラム名を指定できるようにして、データをMySQL データベースにレプリケーションします。

  1. モジュールのインストール:

    Install-Module MySQLCmdlets
  2. MySQL DB に、MySQL Server 名、ユーザー、パスワード、レプリケーション先のデータベース名を指定して、接続します:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Zendesk、保存された値、そしてAdd-MySQL Cmdlet を使って、MySQL にデータを1レコードずつ挿入します。この例では、MySQL 側のテーブルは、Zendesk のリソース(Tickets)と同じテーブル名を持っている必要があります。

    $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Tickets" -Columns $columns -Values $values }

次回以降のレプリケーションをシンプルに実現

  • 一度PowerShell でZendesk とMySQL に接続したら、次からは1行のコマンドでレプリケーションを実施できます:

    Select-Zendesk -Connection $zendesk -Table "Tickets" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Tickets" -Columns $columns -Values $values }
  • 別のPowerShell モジュールで、Zendesk を別のデータベースに複製する場合、Select-Zendesk cmdlet のデータから、カラム、接続およびテーブルを除外しておきましょう。これらのデータはデータ移動のときだけ必要となるためです。

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}

おわりに

これで、Zendesk のデータをMySQL に複製できました。分析、BI などでZendesk のデータをMySQL から使うことができるようになります。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。