接続の確立

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

インストールおよび接続

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

Install-Module EbayCmdlets

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

Import-Module EbayCmdlets;

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

$conn = Connect-Ebay -DevID 'MyDevID' -OAuthClientId 'MyAppID' -OAuthClientSecret 'MyCertID' -RuName 'MyRuName' -SiteID 0

eBay API への接続

eBay に接続するには以下を設定します。

SiteID：eBay サイトID に設定。デフォルト値は"0"（U.S. のサイト）です。
UseSandbox：eBay sandbox アカウントを使用する場合True に設定。デフォルトでは、本製品は本番環境に接続します。
RuName：サインインに使用するRuName（eBay Redirect URL 名）に設定。eBay のサインイン設定で検索します。

eBay への認証

本製品は、OAuth 2.0 認証規格またはeBay APIで使用されている従来の認証方法であるAuth'n'Auth のいずれかを使用して、eBay を認証できます。

ユーザーアカウント（OAuth）

AuthScheme をOAuth に設定。

デスクトップアプリケーション

カスタムOAuth アプリケーションを作成する必要があります。カスタムアプリケーションの作成については、カスタムOAuth アプリの作成を参照してください。

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

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

InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
OAuthClientId：キーセットのApp ID（Client ID）に設定。
OAuthClientSecret：キーセットのCert ID（Client Secret)）に設定。
CallbackURL：本製品を実行しているデバイスのサーバー名とポートを含むURL に設定。localhost のアドレスはどれでも使用可能です。デフォルトのコールバックURL はhttp://localhost:33333 です。

接続すると、本製品はデフォルトブラウザでeBay のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品はこれでOAuth プロセスを完了します。

本製品はeBay からアクセストークンを取得し、それを使ってデータをリクエストします。
OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。

本製品はアクセストークンの期限が切れると自動的にリフレッシュします。

ヘッドレスマシン

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

以下のオプションから選択します。
- オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2：インターネットブラウザに対応したマシンに本製品をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。
次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品を設定します。

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

Verifier code を取得するには、OAuth authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

以下のオプションから選択します。
- 次のプロパティを設定します。
  - InitiateOAuth：OFF に設定。
  - OAuthClientId：キーセットのApp ID（Client ID）に設定。
  - OAuthClientSecret：キーセットのCert ID（Client Secret)）に設定。
  次に、適切なCallbackURL およびRuName を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、本製品にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。推奨値https://oauth.cdata.com/oauth/ を"auth accepted URL" として使用する場合、この値はBASE64 エンコードされます。この値をデコードしてから先に進む必要があります。後ほどこれをOAuthVerifier 接続プロパティに設定します。

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

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

InitiateOAuth：REFRESH に設定。
OAuthVerifier：これを、控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定します。
OAuthClientId：キーセットのApp ID（Client ID）に設定。
OAuthClientSecret：キーセットのCert ID（Client Secret)）に設定。
OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

InitiateOAuth：REFRESH に設定。
OAuthClientId：キーセットのApp ID（Client ID）に設定。
OAuthClientSecret：キーセットのCert ID（Client Secret)）に設定。
OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。

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

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

InitiateOAuth：REFRESH に設定。
OAuthClientId：キーセットのApp ID（Client ID）に設定。
OAuthClientSecret：キーセットのCert ID（Client Secret)）に設定。
OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品に読み書きのアクセス許可を与えることを確認してください。

レガシーアプリのユーザーアカウント（Auth'n'Auth）

本製品は、eBay のレガシーAuth'n Auth プロトコルを使用して認証することができます。Auth'n'Auth を使用するように構築された古いアプリケーションを使用している場合は、この認証スキームを選択します。

AuthScheme をAuthNAuth に設定します。

カスタムOAuth アプリケーションを作成する必要があります。詳しくは、カスタムOAuth アプリの作成を参照してください。

アクセストークン

OAuthAccessToken はAuth'n'Auth で認証する場合に必要となります。次の接続プロパティを設定し、OAuthAccessToken を取得します。

OAuthClientId：キーセットのApp ID（Client ID）に設定。
OAuthClientSecret：キーセットのCert ID（Client Secret)）に設定。
DevID：キーセットのDeveloper ID に設定。

続いてストアドプロシージャを呼び出し、トークンの交換を完了します。

GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。RuName インプットをアプリ設定で指定したeBay Redirect URL に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
ステップ1でストアドプロシージャが返したURL に移動します。ログインして、Web アプリケーションを認可します。認証後、ブラウザはリダイレクトURI にリダイレクトします。リダイレクトURI にはsessionid というパラメータが付加されます。このパラメータの値を控えておきます。推奨値https://oauth.cdata.com/oauth/ を"auth accepted URL" として使用する場合、この値はBASE64 エンコードされているため、デコードしてから次に進む必要があります。
GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。SessionId インプットパラメータを、認可URL のクエリ文字列の'sessionid' 値、またはCallback URL からBASE64 デコードしたセッションID に設定します。

次の接続プロパティを設定し、データに接続します。

OAuthClientId：キーセットのApp ID（Client ID）に設定。
OAuthClientSecret：キーセットのCert ID（Client Secret)）に設定。
OAuthAccessToken：GetOAuthAccessToken によって返されたAuth'n'Auth トークンに設定。
Note： Auth'n'Auth トークンは18ヶ月後に失効します。トークンの期限が切れたら、新しいトークンを発行する必要があります。
DevID：キーセットのDeveloper ID に設定。

データの取得

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

$results = Select-Ebay -Connection $conn -Table "ItemListing" -Columns @("HitCount, Title") -Where "AdminEndedItemsOnly='true'"

Invoke-Ebay cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

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

Select-Ebay -Connection $conn -Table ItemListing -Where "AdminEndedItemsOnly = 'true'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myItemListingData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-Ebay -DevID 'MyDevID' -OAuthClientId 'MyAppID' -OAuthClientSecret 'MyCertID' -RuName 'MyRuName' -SiteID 0
PS C:\> $row = Select-Ebay -Connection $conn -Table "ItemListing" -Columns (HitCount, Title) -Where "AdminEndedItemsOnly = 'true'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "ItemListing",
  "Columns":  [

  ],
  "HitCount":  "MyHitCount",
  "Title":  "MyTitle"
}

データの削除

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

Select-Ebay -Connection $conn -Table ItemListing -Where "AdminEndedItemsOnly = 'true'" | Remove-Ebay

データの変更

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

Import-Csv -Path C:\MyItemListingUpdates.csv | %{
  $record = Select-Ebay -Connection $conn -Table ItemListing -Where ("ItemId = `'"+$_.ItemId+"`'")
  if($record){
    Update-Ebay -Connection $conn -Table ItemListing -Columns @("HitCount","Title") -Values @($_.HitCount, $_.Title) -Where "ItemId  = `'$_.ItemId`'"
  }else{
    Add-Ebay -Connection $conn -Table ItemListing -Columns @("HitCount","Title") -Values @($_.HitCount, $_.Title)
  }
}

Cmdlets for eBay