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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Adobe Commerce への接続を設定

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

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

    Import-Module AdobeCommerceCmdlets;

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

    $conn = Connect-AdobeCommerce  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL" -Url "$Url"

Adobe Commerce はOAuth 1 認証標準を使用します。Adobe Commerce REST API に接続するには、Adobe Commerce システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

また、Adobe Commerce システムへのURL を提供する必要があります。URL は、Adobe Commerce REST API を顧客として使用しているか管理者として使用しているかによって異なります。

• Customer: Adobe Commerce を顧客として使用するには、事前にAdobe Commerce のホームページで顧客アカウントを作成します。これを行うには、「アカウント」->「登録」をクリックします。それからURL 接続プロパティをAdobe Commerce システムのエンドポイントに設定します。

• Administrator: Adobe Commerce を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、「Admin」メニューの「Advanced」設定で取得できます。「System」->「Configuration」->「Advanced」->「Admin」->「Admin Base URL」を選択することでアクセスできます。

  このページ上の「Use Custom Admin Path」設定がYES に設定されている場合、値は「Custom Admin Path」テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

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

Adobe Commerce データを取得してCSV にパイプライン

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

Select-AdobeCommerce -Connection $conn -Table Products | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myProductsData.csv -NoTypeInformation

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

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

データの削除

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

Select-AdobeCommerce -Connection $conn -Table Products -Where "Style = High Tech" | Remove-AdobeCommerce

データの挿入と更新

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

Import-Csv -Path C:\MyProductsUpdates.csv | %{
  $record = Select-AdobeCommerce -Connection $AdobeCommerce -Table Products -Where ("EntityId = `'"+$_.EntityId+"`'")
  if($record){
    Update-AdobeCommerce -Connection $adobecommerce -Table Products -Columns ("Name","Price") -Values ($_.Name, $_.Price) -Where ("EntityId = `'"+$_.EntityId+"`'")
  }else{
    Add-AdobeCommerce -Connection $adobecommerce -Table Products -Columns ("Name","Price") -Values ($_.Name, $_.Price)
  }
}

おわりに

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