Cmdlets for BigCommerce

Build 20.0.7654

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でBigCommerce Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module BigCommerceCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module BigCommerceCmdlets;

Connect-BigCommerce cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-BigCommerce -OAuthClientId -OAuthClientSecret -CallbackURL 'http://localhost:33333' -StoreId 'YoUrSToREId'

BigCommerce への接続

BigCommerce 認証は標準のOAuth フローに基づいています。

Store ID の取得

BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

  1. BigCommerce アカウントにログインします。
  2. ホームページから[Advanced Settings]->[API Accounts] を選択します。
  3. [Create API Account]->[Create V2/V3 API Token]をクリックします。
  4. 画面にAPI Path という名前のテキストボックスが表示されます。
  5. テキストボックス内に、次の構造のURL が表示されます:https://api.bigcommerce.com/stores/{Store Id}/v3。
  6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
  7. Store Id を取得したら、[キャンセル] をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

個人用アクセストークンの取得

加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

  1. BigCommerce アカウントにログインします。
  2. ホームページから[Advanced Settings]->[API Accounts] を選択します。
  3. [Create API Account]->[Create V2/V3 API Token]をクリックします。
  4. アカウント名を入力します。
  5. 作成するAPI Account の[OAuth Scopes]を選択します。本製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
  6. [保存]をクリックします。

BigCommerce への認証

次に、以下を設定してデータに接続できます。
  • StoreId:API Path テキストボックスから取得したStore ID に設定。
  • OAuthAccessToken:生成したトークンに設定。

データの取得

Select-BigCommerce cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-BigCommerce -Connection $conn -Table "Customers" -Columns @("FirstName, LastName") -Where "Column2='Bob'"
Invoke-BigCommerce cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-BigCommerce -Connection $conn -Table Customers -Where "Column2 = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

Select-BigCommerce からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-BigCommerce -OAuthClientId -OAuthClientSecret -CallbackURL 'http://localhost:33333' -StoreId 'YoUrSToREId'
PS C:\> $row = Select-BigCommerce -Connection $conn -Table "Customers" -Columns (FirstName, LastName) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Customers",
  "Columns":  [

  ],
  "FirstName":  "MyFirstName",
  "LastName":  "MyLastName"
} 

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-BigCommerce -Connection $conn -Table Customers -Where "Column2 = 'Bob'" | Remove-BigCommerce

データの更新

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをBigCommerce にロードします。

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

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654