接続の確立
接続プロファイルの設定
[CData]リボンから[データの取得]をクリックし、[取得元:QuickBooks Online]> 設定済みの接続 を選択してCData クエリウィンドウを起動します。新しい接続を設定するには、[新しいQuickBooks Online 接続]をクリックします。ここでは、接続の設定、接続のテスト、および接続プロファイルの保存を行うことができます。
QuickBooks Online への認証
QuickBooks Online は、デスクトップアプリケーション、Web ブラウザ、またはヘッドレスマシン経由での接続と認証をサポートしています。 CData Excel Add-In for QuickBooks Online には、デスクトップまたはヘッドレスマシンからの接続を簡素化し、限定的な機能を提供する埋め込みOAuth 認証情報が含まれています。 ただし、デスクトップまたはヘッドレスマシン接続経由でより完全な機能を利用する場合、またはWeb 経由で接続する場合は、カスタムOAuth アプリケーションの作成 で説明するようにカスタムOAuth アプリケーションを作成する必要があります。以下のサブセクションでは、すべてのOAuth ワークフローからQuickBooks Online に認証する方法を説明します。 カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 QuickBooks Online で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
デスクトップアプリケーション
接続に必要なプロパティは、埋め込みOAuth 認証情報(限定的な使用)経由で接続するか、カスタムOAuth アプリケーション(完全な機能)経由で接続するかによって異なります。接続する前に、必要なプロパティを設定してください。
- InitiateOAuth(全ユーザー):GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
- OAuthClientId (カスタムOAuth のみ):カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID(カスタムOAuth アプリケーションの作成 参照)。
- OAuthClientSecret (カスタムOAuth のみ):カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット(カスタムOAuth アプリケーションの作成 参照)。
- CallbackURL (カスタムOAuth のみ):カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI(カスタムOAuth アプリケーションの作成 参照)。
接続すると、本製品 はデフォルトブラウザでQuickBooks Online のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。
アクセストークンの期限が切れたときは、本製品 は自動でアクセストークンをリフレッシュします。
OAuth アクセストークンの自動リフレッシュ:
本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。
- はじめてデータに接続する際、次の接続プロパティを設定します。
- InitiateOAuth:REFRESH。
- OAuthClientId:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID(カスタムOAuth アプリケーションの作成 参照)。
- OAuthClientSecret:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット(カスタムOAuth アプリケーションの作成 参照)。
- OAuthAccessToken:GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation:本製品 がOAuth 値を保存する場所のパス。これは接続間で維持されます。
- その後のデータ接続では、以下を設定します。
OAuth アクセストークンの手動リフレッシュ:
OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。
- ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
- 次の接続プロパティを設定します。
- OAuthClientId:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID(カスタムOAuth アプリケーションの作成 参照)。
- OAuthClientSecret:カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット(カスタムOAuth アプリケーションの作成 参照)。
- RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
- 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。
OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
接続プロパティ
最後に、Connection プロパティを参照してください。接続の確立に使用できるさまざまなオプションの説明があります。
接続の管理
QuickBooks Online への認証に成功すると、インポートするデータをカスタマイズすることができます。詳しくは、接続の管理 を参照してください。
関連項目
- データのクエリ:[データ選択]ウィザードを使用してスプレッドシートにデータをプルします。また、ここではスケジュールされたデータのリフレッシュも設定できます。
- Excel アドインの使用:利用可能なCData Excel 関数 を使用するなど、QuickBooks Online データとやり取りする他の方法が見つかります。