各製品の資料を入手。
詳細はこちら →
製品をチェック
PowerShell からZuora のデータに接続してデータの取得・更新・挿入・削除・CSV エクスポートを実行する方法
CData PowerShell Cmdlets を使って、Zuora のデータに接続、データの取得・更新・挿入・削除・CSV エクスポートを実行する方法を紹介します。
最終更新日：2023-09-26
この記事で実現できるZuora 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
CData Cmdlets for Zuora を使えば、PowerShell からZuora に手軽に連携して、データのCRUD やエクスポートを実行できます。
本記事では、Zuora への接続方法からCSV エクスポート、データの操作までサンプルコード付きで解説していきます。
Zuora への接続を設定
それでは、まずはZuora への接続設定からはじめていきましょう。接続設定にはCData Zuora Cmdlets が必要となります。右側のサイドバーから製品の全機能が使える30日間の無償トライアルがダウンロードできるので、ぜひご利用ください。
インストールが完了したら、プロファイルに以下の行を追加してください。次のPowerShell セッションでモジュールがロードされます。
Import-Module ZuoraCmdlets;
Connect-Zuora コマンドを使ってZuora との接続を設定します。各接続プロパティの取得方法は次に説明します。
$conn = Connect-Zuora -OAuthClientID "$OAuthClientID" -OAuthClientSecret "$OAuthClientSecret" -Tenant "$Tenant" -ZuoraService "$ZuoraService"
Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。
Tenant プロパティの設定
プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。
- USProduction：リクエストはhttps://rest.zuora.com に送信されます。
- USAPISandbox：リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
- USPerformanceTest：リクエストはhttps://rest.pt1.zuora.com に送信されます。
- EUProduction：リクエストはhttps://rest.eu.zuora.com に送信されます。
- EUSandbox：リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。
デフォルトではUSProduction テナントを使用します。
Zuora サービスの選択
データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。DataQuery
データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。制限
- フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
- 出力レコードの最大数： 100,000
- テナントごとの、実行用に送信される同時クエリの最大数： 5
- テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
- 1時間単位での、各クエリの最大処理時間： 1
- GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
- Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000
AQuADataExport
AQuA API のエクスポートは、すべてのオブジェクト（テーブル）のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。制限
- AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
- 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。
これで接続設定は完了です。
Zuora のデータを取得してCSV にパイプライン
接続が完了したので、Invoices テーブルデータを取得して結果をCSV ファイルにエクスポートします。
Select-Zuora -Connection $conn -Table Invoices | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myInvoicesData.csv -NoTypeInformation
このコードでは、Select-Zuora から取得した結果をSelect-Object に流して、Export-Csv に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報を結果セットのそれぞれの行に挿入するためです。それらの情報を表示したくない場合に、Export-Csv コマンドに渡す前に除外を先に行い、そのあとでCSV ファイルにエクスポートします。
それでは、続いてデータの削除や挿入・更新を実行してみます。
データの削除
以下のように、フィルタリングで合致するレコードを削除することができます。
Select-Zuora -Connection $conn -Table Invoices -Where "BillingState = CA" | Remove-Zuora
データの挿入と更新
データの挿入や更新を使って、加工やクレンジングも行えます。以下の手順では、CSV ファイルのデータを読み込んで挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータを更新、存在しない場合にはデータの挿入を行います。
Import-Csv -Path C:\MyInvoicesUpdates.csv | %{
$record = Select-Zuora -Connection $Zuora -Table Invoices -Where ("Id = `'"+$_.Id+"`'")
if($record){
Update-Zuora -Connection $zuora -Table Invoices -Columns ("Id","BillingCity") -Values ($_.Id, $_.BillingCity) -Where ("Id = `'"+$_.Id+"`'")
}else{
Add-Zuora -Connection $zuora -Table Invoices -Columns ("Id","BillingCity") -Values ($_.Id, $_.BillingCity)
}
}
おわりに
このように、CData Cmdlets を使えばPowerShell でのZuora のデータへの連携をシンプルに実現できます。ぜひCData PowerShell Cmdlets の30日間無償トライアルをダウンロードして、シンプルかつパワフルなデータ連携をお試しください。
関連コンテンツ
