ODBC Driver for Salesforce Marketing Cloud

Build 23.0.8839

Linux DSN の構成

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

Linux の最小バージョン

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

OSMin. Version
Ubuntu11.04
Debian7
RHEL6.9
CentOS6.9
Fedora13
SUSE12.1

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

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

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

本製品 が必要とする対応ライブラリは以下のとおりです。

Debian/Ubuntu PackageRHEL/CentOS/Fedora PackageFile
libc6glibclinux-vdso.1
libc6glibclibm.so.6
libc6glibclibrt.so.1
libc6glibclibdl.so.2
libc6glibclibpthread.so.0
libc6glibclibc.so.6
libc6glibcld-linux-x86-64.so.2
libstdc++6libstdc++libstdc++.so.6
zlib1gzliblibz.so.1
libgcc1libgcclibgcc_s.so.1

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

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

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

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

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

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

ドライバーのライセンス

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

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

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

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

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

DSN の作成

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

Salesforce Marketing Cloud への接続

REST API およびSOAP API の両方で、次のプロパティを使用してデータアクセスを絞り込むことができます。

  • Instance：使用されるSalesforce Marketing Cloud API のインスタンス。デフォルトのインスタンスはWeb Services API のs7 ですが、このプロパティを使用して別のインスタンスを指定することができます。
  • Subdomain：インスタンスがs10 より大きい場合は、サブドメインも指定する必要があります。

REST API

接続するには、Schema をREST に設定します。

Salesforce Marketing Cloud REST API はOAuth 認証標準を使用しています。OAuth を使って認証するには、カスタムOAuth アプリケーションを作成してOAuthClientId およびOAuthClientSecret 接続プロパティの値を取得する必要があります。詳しくは、カスタムOAuth アプリの作成 を参照してください。

SOAP API

接続するには、Schema をSOAP に設定します。

Salesforce Marketing Cloud SOAP API は、OAuth を使用して接続できます。従来のログイン資格情報の使用もサポートしています。

Note：Salesforce Marketing Cloud のデータ拡張オブジェクトは、SOAP API 経由でのみアクセスできます。

Salesforce Marketing Cloud への認証

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

AuthScheme をOAUTH に設定します。また、すべてのOAuth フローで、AccountId をターゲットビジネスユニットの特定のMID に設定します。 NOTE： これはレガシーパッケージでは利用できません。 次のOAuth セクションでは、これら両方の接続プロパティを設定済みであることを前提としています。

デスクトップアプリ

下記の手順に従って、カスタムOAuth アプリケーションの資格情報を使用して認証します。カスタムOAuth アプリケーションについては、カスタムOAuth アプリの作成 を参照してください。 OAuth アクセストークンの取得

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

  • OAuthClientId：アプリケーション設定のクライアントId。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレット。
  • CallbackURL：アプリケーション設定のリダイレクトURL。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 OAuthAccessToken 接続プロパティをストアドプロシージャで返されたアクセストークンに設定し、データに接続します。ExpiresIn 秒後に、アクセストークンの期限が切れたときは、GetOAuthAccessToken を呼び出し、新しいアクセストークンを取得します。

ヘッドレスマシン

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

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

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

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

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

  1. 以下のオプションから選択します。
    • 埋め込みOAuth アプリケーションを使用する場合は、Salesforce Marketing Cloud OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
      • InitiateOAuth：OFF に設定。
      • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
      • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
      次に、適切なCallbackURL を指定してrpgrestsp-getoauthauthorizationurl ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
  2. ログインして、本製品 にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
  3. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

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

  • InitiateOAuth：REFRESH。
  • OAuthVerifier：verifier code。
  • OAuthClientId：（カスタムアプリケーションのみ）カスタムOAuth アプリケーション設定のクライアントId。
  • OAuthClientSecret：（カスタムアプリケーションのみ）カスタムOAuth アプリケーション設定のクライアントシークレット。
  • OAuthSettingsLocation：InitiateOAuth がGETANDREFRESH、またはREFRESH に設定されている場合に、OAuth 値が保存される設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。この接続プロパティを設定すると、データは接続間で永続化されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

  • InitiateOAuth：REFRESH。
  • OAuthClientId：（カスタムアプリケーションのみ）アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret：（カスタムアプリケーションのみ）アプリケーションの登録時に割り当てられたクライアントシークレット。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

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

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

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

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

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

  • OAuthClientId：（カスタムアプリケーションのみ）アプリケーションの登録時に割り当てられたクライアントId。
  • OAuthClientSecret：（カスタムアプリケーションのみ）アプリケーションの登録時に割り当てられたクライアントシークレット。
  • OAuthSettingsLocation：OAuth 設定ファイルの場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

サーバー間（OAuthClient）

Salesforce Marketing Cloud でアプリケーションを作成する際、サーバー間認証を選択できます。この場合、アプリケーションの権限はSalesforce Marketing Cloud UI で直接設定されます。そのため、ユーザーコンテキストが存在せず、ブラウザベースのログインや権限付与はありません。このスキームでは、独自のクレデンシャルを作成する必要があります。

アプリケーションでサーバー間OAuth 認証を有効にするには、次のプロパティを指定します。

  • AuthScheme：OAuthClient。
  • InitiateOAuth：GETANDREFRESH。
  • OAuthClientId：クライアントId。
  • OAuthClientSecret：クライアントシークレット。
  • Subdomain：Salesforce Marketing Cloud API サブドメインを指定。

ユーザー名 / パスワード アカウント（Basic）

Salesforce Marketing Cloud SOAP API は、ログイン資格情報またはOAuth 認証のいずれかを使用して接続できます。 この認証スキームは、REST API ベースのアプリケーションでは利用できないことに注意してください。

ログイン資格情報認証を使用してデータに接続するには、以下を設定します。

  • AuthScheme：Basic。
  • User：Salesforce Marketing Cloud ユーザーアカウント。
  • Password：ユーザーの認証に使用するパスワード。
  • UseLegacyAuthentication：True。

OAuth 値のリフレッシュ

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

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

    OAuthSettingsLocation=/tmp/oauthsettings.txt

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

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

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

Debian/Ubuntu PackageRHEL/CentOS/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-sfmarketingcloud/lib/cdata.odbc.sfmarketingcloud.ini' でコードページを指定できます。 

[Driver]
AnsiCodePage = 932

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839