ODBC Driver for Klaviyo

Build 25.0.9434

Linux DSN の構成

このセクションでは、以下のいくつかのLinux ディストリビューションでODBC 接続をセットアップしDSN を設定する方法を説明します：Ubuntu のようなDebian ベースのシステム、Red Hat Enterprise Linux (RHEL)、およびFedora のようなRed Hat Linux プラットフォーム。

Linux の最小バージョン

Red Hat ベースおよびDebian ベースシステムでサポートされる最小バージョンは以下のとおりです。

OSMin. Version
Ubuntu18.04
Debian10
RHEL8
Fedora28
SUSE15

ドライバー依存関係のインストール

必要な依存関係をインストールするには、次のコマンドをルートとしてまたはsudo で実行します。

  • Debian/Ubuntu: 
    apt-get install libc6 libstdc++6 zlib1g libgcc1
  • RHEL/Fedora: 
    yum install glibc libstdc++ zlib libgcc

ドライバーのインストール

標準のパッケージ管理システムを使用してドライバーをインストールできます。

Ubuntu のようなDebian ベースのシステムでは、次のコマンドをroot またはsudo で実行します。 

dpkg -i /path/to/driver/setup/KlaviyoODBCDriverforUnix.deb

RPM パッケージ形式をサポートするシステムでは、次のコマンドをroot またはsudo で実行します。 

rpm -ivh /path/to/driver/KlaviyoODBCDriverforUnix.rpm

ドライバーのライセンス

次のコマンドを実行して本製品 のライセンスを取得します。評価版をアクティベートするには、<key> の入力を省略してください。 

cd /opt/cdata/cdata-odbc-driver-for-klaviyo/bin/
sudo ./install-license.sh <key>

ドライバーマネージャー経由の接続

ドライバーマネージャーはドライバーをロードし、アプリケーションからドライバーに関数呼び出しを渡します。本製品 をドライバーマネージャーに登録して、ドライバーマネージャーのコンフィギュレーションファイルにDSN を定義する必要があります。

本製品 のインストールでは、本製品 をunixODBC ドライバーマネージャーに登録し、システムDSN を作成します。UnixODBC ドライバーマネージャーは、Python やその他多くのアプリケーションから使用できます。アプリケーションに別のドライバーマネージャーが組み込まれている可能性があります。

DSN の作成

unixODBC をインストールしてDSN を設定するには、unixODBC の使用 を参照してください。OBIEE、Informatica、およびSAS に接続するDSN を作成するには、DataDirect ドライバーマネージャーの使用 を参照してください。

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 キーを生成していない場合は、はじめに生成します。

  1. ユーザーアカウントにログインします。
  2. Private API Key creation page に移動します。
  3. Create Private API Key をクリックします。
  4. Private API Key Name で、キーに名前を割り当てます。
  5. Select Access Level で、必要なアクセスレベルを選択します。接続テストを成功させるには、最低限Accounts: Read アクセスが必要です。
  6. 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. 以下のオプションから選択します。
    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier およびPKCEVerifier 値を取得します。
    • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

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

Verifier code およびPKCE verifier を取得するには、OAuth Authorization URL で認証する必要があります。

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

  1. 以下のオプションから選択します。
    • 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
      • InitiateOAuth：OFF に設定。
      • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
      • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。アプリ登録時にシークレットが生成されなかった場合、これはオプションです。
      次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャがOAuth エンドポイントのURL とPKCEVerifier 値を返します。後で使用するためにこの値をメモします。ストアドプロシージャによって返されたURL をブラウザで開きます。
  2. ログインして、本製品 にアクセス許可を与えます。リダイレクト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 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

OAuth 値のリフレッシュ

本製品 は、ブラウザベースのOAuth 認証交換中に取得されたテンポラリーOAuth アクセストークンをリフレッシュできます。デフォルトでは、本製品 は暗号化されたトークンを、DSN に対応するodbc.ini ファイルに保存します。System DSN の場合、このodbc.ini ファイルへのアクセスを制限できます。

トークンの自動交換を有効にするには、本製品 にシステムodbc.ini への書き込みアクセス権を与えます。または、OAuthSettingsLocation 接続プロパティを、ドライバーが読み書きアクセス権を持つ別のファイルパスに設定することもできます。 

    OAuthSettingsLocation=/tmp/oauthsettings.txt

OAuth 認証の依存関係のインストール

OAuth 認証標準は、認証するユーザーにWeb ブラウザを使用したKlaviyo との通信を要求します。最初のOAuth インタラクションがドライバーがインストールされている同じマシン上で行われる場合（例えばデスクトップアプリケーションの場合）、本製品 はデフォルトブラウザを立ち上げるxdg-open プログラムにアクセスする必要があります。

この依存関係を満たすには、パッケージマネージャーに対応するパッケージをインストールします。

Debian/Ubuntu PackageRHEL/Fedora PackageFile
xdg-utilsxdg-utilsxdg-open

ドライバーエンコーディングの設定

ODBC ドライバーは、ODBC ドライバーマネージャーで使用するエンコーディングを指定する必要があります。デフォルトでは、Unix 用のCData ODBC ドライバーはunixODBC と互換性のあるUTF-16 を使用するように設定されていますが、他のドライバーマネージャーでは代替エンコーディングが必要な場合があります。

また、ANSI ODBC API を使用するアプリケーションからODBC ドライバーを使用している場合は、ANSI コードページを設定する必要があります。例えば、ANSI アプリケーションに日本語の文字をインポートするには、設定ファイル'/opt/cdata/cdata-odbc-driver-for-klaviyo/lib/cdata.odbc.klaviyo.ini' でコードページを指定できます。 

[Driver]
AnsiCodePage = 932

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