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

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

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

Stripe への接続を設定

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

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

    Import-Module StripeCmdlets;

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

    $conn = Connect-Stripe  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Stripeへの接続

それでは、Stripe への接続について説明していきましょう。Stripe では、本番API キーまたはOAuth のいずれかによる認証をサポートしています。

本番API キー

本番API キーで接続するには、以下の2つの設定パラメータを設定する必要があります。

• AuthScheme = APIKey
• LiveAPIKey = 本番API キーの値

本番API キーの値を取得するには、以下の手順で確認できます：

1. Stripe ダッシュボードにログインします
2. 開発者 → API キー → シークレットキー → 本番環境のキーを表示 に移動します

Stripe では、テストモードで作成されたシークレットキーを使用して、'StripeV2' データモデルのエンティティにはアクセスできませんのでご注意ください。ライブモードまたはサンドボックスモードで作成されたシークレットキーをご利用ください。 さらに、制限付きキーを使用して'StripeV2' データモデルのエンティティにアクセスすることも許可されていません。

OAuth については、ヘルプドキュメントの「接続の確立」をご確認ください。

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

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

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

Select-Stripe -Connection $conn -Table Customers | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

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

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

データの削除

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

Select-Stripe -Connection $conn -Table Customers -Where "Delinquent = False" | Remove-Stripe

データの挿入と更新

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

Import-Csv -Path C:\MyCustomersUpdates.csv | %{
  $record = Select-Stripe -Connection $Stripe -Table Customers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Stripe -Connection $stripe -Table Customers -Columns ("Email","Discount") -Values ($_.Email, $_.Discount) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Stripe -Connection $stripe -Table Customers -Columns ("Email","Discount") -Values ($_.Email, $_.Discount)
  }
}

おわりに

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