Cmdlets for Amazon Marketplace

Build 25.0.9434

接続の確立

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

Amazon Marketplace への接続

以下のプロパティが必須です。

  • Schema：SellerCentral に設定。
  • InitiateOAuth：GETANDREFRESH に設定。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。

Amazon Marketplace への認証

OAuth

Amazon Marketplace はOAuth 認証標準を利用しています。

OAuth で認証するには、組み込みアプリケーションを使用するか、新しいカスタムOAuth アプリを作成する必要があります。組み込みアプリケーションは、デスクトップアプリケーションおよびヘッドレスマシンをサポートします。Web アプリケーションでは、カスタムOAuth アプリケーションを作成する必要があります。

カスタムOAuth アプリケーションを使用して、サービスアカウントまたはユーザーアカウントで認証できます。詳しくは、カスタムOAuth アプリの作成 を参照してください。

埋め込みクレデンシャルのダウンロード

Amazon Marketplace は埋め込みクレデンシャルを6ヶ月ごとに入れ替える必要があるため、CData のクレデンシャルはoa.cdata.com でホストされます。カスタムクレデンシャルを指定しない場合、CData のWeb サービスから埋め込みクレデンシャルがダウンロードされ、デフォルトでOAuthClientLocation で指定した場所に保存されます。 NOTE：ファイアウォールがoa.cdata.com をブロックしないことを確認してください。

デスクトップアプリ

組み込みアプリケーションを使用するか、カスタムOAuth アプリケーションを作成することが可能です。主要な違いは、カスタムアプリケーションを使用する場合は追加の接続プロパティを設定する必要があることです。

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • AppId：作成したSelling Partner アプリケーションのアプリケーションId に設定。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。
  • AWSAccessKey：OAuthClientId に関連するAWS ユーザーに紐づくアクセスキー。
  • AWSSecretKey：OAuthClientId に関連するAWS ユーザーに紐づくシークレットキー。
  • OAuthClientId（カスタムアプリケーションのみ）：アプリの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret（カスタムアプリケーションのみ）：アプリの登録時に割り当てられたクライアントシークレットに設定。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

ヘッドレスマシン

ドライバーを設定するため、ヘッドレスマシンでユーザーアカウントにOAuth を使用します。ユーザーアカウントまたはサービスアカウントを使って、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下の2つのオプションから選択します。

    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：別のマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。

  2. その後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

別のマシンから認証してOAuthVerifier 接続プロパティを取得するには、次の手順を実行してください。

  1. 以下のオプションから選択します。
    • 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
      • InitiateOAuth：OFF に設定。
      • OAuthClientId（カスタムアプリのみ）：アプリケーション設定のクライアントId に設定。
      • OAuthClientSecret（カスタムアプリのみ）：アプリケーション設定のクライアントシークレットに設定。

        次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。

  2. ログインして、本製品 にアクセス許可を与えます。'spapi_oauth_code' の値としてverifier code を含むコールバックURL にリダイレクトされます。verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定する必要があります。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • OAuthClientId（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーキーに設定。
  • OAuthClientSecret（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーシークレットに設定。
  • OAuthVerifier：verifier code に設定。
  • OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。
  • InitiateOAuth：REFRESH に設定。

OAuth 設定ファイルが生成されたら、次のプロパティを設定してデータに接続します。

  • OAuthClientId（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーキーに設定。
  • OAuthClientSecret（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーシークレットに設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がプロバイダーに読み書きのアクセス許可を与えることを確認してください。
  • InitiateOAuth：REFRESH に設定。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。
  • AppId：作成したSelling Partner アプリケーションのアプリケーションId。
  • AWSAccessKey：OAuthClientId に関連するAWS ユーザーに紐づくアクセスキー。
  • AWSSecretKey：OAuthClientId に関連するAWS ユーザーに紐づくシークレットキー。

オプション2：OAuth 設定を転送

別のマシンに本製品 をインストールして認証し、結果のOAuth 値を転送する方法は次のとおりです。

セカンドマシンに、本製品 をインストールして、次の接続プロパティセットで接続します。

  • OAuthSettingsLocation：書き込み可能な場所に設定。
  • OAuthClientId（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントシークレットに設定。

認証する接続をテストします。生成された認証値は、OAuthSettingsLocation で指定されたパスにあるファイルに暗号化されて書き込まれます。接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーキーに設定。
  • OAuthClientSecret（カスタムアプリケーションのみ）：アプリケーション設定のコンシューマーシークレットに設定。
  • OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
  • Marketplace：販売登録されているマーケットプレイスのリージョンに設定。
  • Schema：Seller Central API に接続するにはSellerCentral に設定。
  • AppId：作成したSelling Partner アプリケーションのアプリケーションId。
  • AWSAccessKey：OAuthClientId に関連するAWS ユーザーに紐づくアクセスキー。
  • AWSSecretKey：OAuthClientId に関連するAWS ユーザーに紐づくシークレットキー。

接続オブジェクトの作成

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

$conn = Connect-AmazonMarketplace -InitiateOAuth "GETANDREFRESH" -Marketplace "United States"

データの取得

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

$results = Select-AmazonMarketplace -Connection $conn -Table "Orders" -Columns @("Id, SellerOrderId") -Where "BuyerEmail='[email protected]'"
Invoke-AmazonMarketplace cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

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

Select-AmazonMarketplace -Connection $conn -Table Orders -Where "BuyerEmail = '[email protected]'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-AmazonMarketplace -InitiateOAuth "GETANDREFRESH" -Marketplace "United States" 
PS C:\> $row = Select-AmazonMarketplace -Connection $conn -Table "Orders" -Columns (Id, SellerOrderId) -Where "BuyerEmail = '[email protected]'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Orders",
  "Columns":  [

  ],
  "Id":  "MyId",
  "SellerOrderId":  "MySellerOrderId"
}

データの削除

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

Select-AmazonMarketplace -Connection $conn -Table Orders -Where "BuyerEmail = '[email protected]'" | Remove-AmazonMarketplace

データの変更

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

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

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434