DSN の作成
このセクションでは、DSN 設定の編集方法と、eBay API への認証および接続について説明します。
DSN 設定
Microsoft ODBC データソースアドミニストレーターを使ってDSN 設定を編集できます。インストールプロセスではコネクタのインストール で説明のとおり、ユーザーDSN とシステムDSN の両方が作成されることに注意してください。
Note: 本製品 は、接続情報をWindows レジストリに保存します。本製品 がレジストリに書き込めるようにするには、Power BI を管理者として実行するか、接続にシステムDSN ではなくユーザーDSN を使用します。
ユーザーDSN
DSN 設定を編集するには、次の手順を実行してください。
- スタート -> 検索 を選択し、検索ボックスにODBC データソース と入力します。
- Power BI Desktop インストールのビット数(32-bit または64-bit)に対応するODBC アドミニストレーターのバージョンを選択してください。
- システムデータソースを選択して構成をクリックします。
- 接続タブの情報を編集してOK をクリックします。
システムDSN
システムDSN をユーザーDSN と同じ方法で設定します。ただし、ステップ3を実行する前に、システムDSN タブに切り替える必要があります。
Power BI のOn-Premises Data Gateway をStandard モードで使用している場合、システムDSN を使用する必要があります。
OAuthSettingsLocation(OAuth のプロンプトが繰り返されるのを避けるため、OAuth 認証情報をローカルに保存するパス)にも有効な場所を指定する必要があります。
これは、Standard モードがサービスモードで動作し、C:\Windows\ServiceProfiles\PBIEgwService\AppData\Local\Microsoft\On-premises data gateway のような許可された場所にしかアクセスできないためです。
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 アクセストークンの取得およびリフレッシュ
以下を設定して、接続してください。
- OAuthClientId:キーセットのApp ID(Client ID)に設定。
- OAuthClientSecret:キーセットのCert ID(Client Secret))に設定。
- CallbackURL:本製品 を実行しているデバイスのサーバー名とポートを含むURL に設定。localhost のアドレスはどれでも使用可能です。デフォルトのコールバックURL はhttp://localhost:33333 です。
ヘッドレスマシン
ドライバーを設定するため、ヘッドレスマシンでユーザーアカウントに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))に設定。
- 次のプロパティを設定します。
- ログインして、本製品 にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。推奨値https://oauth.cdata.com/oauth/ を"auth accepted URL" として使用する場合、この値はBASE64 エンコードされます。この値をデコードしてから先に進む必要があります。後ほどこれをOAuthVerifier 接続プロパティに設定します。
ヘッドレスマシンでは、次の接続プロパティを設定して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 に設定。