DSN の作成
このセクションでは、DSN 設定の編集方法と、Klaviyo 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 のような許可された場所にしかアクセスできないためです。
Klaviyo への接続
Klaviyo に接続するには、まず以下のプロパティを設定して認証方法を選択します。
- AuthScheme:Klaviyo に接続する際に使用する認証の種類。
選択した方法に応じて、追加の接続プロパティが必要です。サポートされている各認証タイプの設定手順については、以下を参照してください。
カスタムフィールドへのアクセス
デフォルトでは、本製品 はシステムフィールドのみ表示します。カスタムフィールドを検出して含めるには、IncludeCustomFields をtrue に設定します。 IncludeCustomFields がtrue に設定されている場合、本製品 はRowScanDepth レコードをスキャンしてカスタムフィールドを検出し、そのデータ型を判定します。 すべてのレコードをスキャンしてカスタムフィールドを検出するには、RowScanDepth を0 に設定します。カスタムフィールドを有効にし、RowScanDepth を0 または大きな値に設定すると、パフォーマンスに影響を与える可能性があることに注意してください。
List_{ListName} とSegment_{SegmentName} を個別のビューとしてアクセスする
デフォルトでは、本製品 はシステムテーブルとビューのみを表示します。 Klaviyo インターフェースと同様に、各リストとセグメントを個別のビューとしてモデル化するには、ListDynamicViews をtrue に設定します。
Klaviyo への認証
Klaviyo への認証には、API キーまたはOAuth PKCE のいずれかを使用できます。
API キー
まだAPI キーを生成していない場合は、はじめに生成します。
- ユーザーアカウントにログインします。
- Private API Key creation page に移動します。
- Create Private API Key をクリックします。
- Private API Key Name で、キーに名前を割り当てます。
- Select Access Level で、必要なアクセスレベルを選択します。接続テストを成功させるには、最低限Accounts: Read アクセスが必要です。
- Create をクリックしてAPI キーを生成します。生成されたAPI キーは一度しか表示されないので、コピーして保存してください。
次に、以下のプロパティを設定します。
- AuthScheme:APIKey に設定。
- APIKey:生成したPrivate API Key の値に設定。
OAuth PKCE
AuthScheme をOAuthPKCE に設定します。
デスクトップアプリケーション
OAuth PKCE を使用して認証するには、カスタムOAuth アプリケーションを作成する必要があります。手順については、カスタムOAuth アプリの作成 を参照してください。OAuth アクセストークンの取得およびリフレッシュ
次のプロパティを設定して、接続してください。
- OAuthClientId アプリの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret アプリの登録時に割り当てられたクライアントシークレットに設定。アプリ登録時にシークレットが生成されなかった場合、これはオプションです。
- CallbackURL アプリの登録時に定義されたリダイレクトURI に設定。例: http://localhost:3333
接続すると、本製品 はデフォルトブラウザでKlaviyo のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。
本製品 はアクセストークンの期限が切れると自動的にリフレッシュします。
ヘッドレスマシン
本製品 を設定するため、ヘッドレスマシンでユーザーアカウントにOAuth を使用します。インターネットブラウザに対応した別の端末で認証する必要があります。
- 以下のオプションから選択します。
- オプション1:後述の「Verifier code を取得および交換」に従い、OAuthVerifier およびPKCEVerifier 値を取得します。
- オプション2:インターネットブラウザに対応したマシンに本製品 をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。
- 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。
オプション1:Verifier code を取得および交換
Verifier code およびPKCE verifier を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
- 以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
- InitiateOAuth:OFF に設定。
- OAuthClientId:アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret:アプリケーションの登録時に割り当てられたクライアントシークレットに設定。アプリ登録時にシークレットが生成されなかった場合、これはオプションです。
- ログインして、本製品 にアクセス許可を与えます。リダイレクトURI にリダイレクトされます。
リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
- InitiateOAuth:REFRESH に設定。
- OAuthVerifier:控えておいたverifier code(リダイレクトURI のcode パラメータの値)に設定。
- PKCEVerifier:ステップ1で先にメモした値に設定。
- OAuthClientId:(カスタムアプリケーションのみ)カスタムOAuth アプリケーション設定のクライアントId に設定。
- OAuthClientSecret:(カスタムアプリアプリケーションのみ)カスタムOAuth アプリケーション設定のクライアントシークレットに設定。アプリ登録時にシークレットが生成されなかった場合、これはオプションです。
- OAuthSettingsLocation:これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。
接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。
- InitiateOAuth:REFRESH に設定。
- OAuthClientId:(カスタムアプリのみ)アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret:(カスタムアプリケーションのみ)アプリケーションの登録時に割り当てられたクライアントシークレットに設定。アプリ登録時にシークレットが生成されなかった場合、これはオプションです。
- OAuthSettingsLocation:暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
オプション2:OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスで本製品 との接続をインストールし、作成する必要があります。 上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。 デフォルトのファイル名はOAuthSettings.txt です。
接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
- InitiateOAuth:REFRESH に設定。
- OAuthClientId:(カスタムアプリケーションのみ)アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret:(カスタムアプリケーションのみ)アプリケーションの登録時に割り当てられたクライアントシークレットに設定。アプリ登録時にシークレットが生成されなかった場合、これはオプションです。
- OAuthSettingsLocation:ブラウザでマシンからコピーしたOAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。