Salesforce Data 360 のデータにPythonで接続する方法|CData Connect AI SDK

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
PythonのDB-API 2.0準拠コードでリアルタイムのSalesforce Data 360 のデータを読み取る方法を解説。CData Connect AI Python SDKとPAT認証で、pip install1つから10分で接続を実現します。

CData Connect AI Python SDK を使うと、標準的なDB-API 2.0のPythonコードでSalesforce Data 360 のデータをそのまま読み書きできます。プログラミング不要の他ツールと異なり、pandasやpetlなど既存のPythonエコシステムにそのまま組み込めます。パッケージのインストールからクエリ実行まで3ステップで完了します。

CData Connect AI Python SDK(cdata-connect-ai)は DB-API 2.0(PEP 249)に準拠したクライアントで、標準的な Python のデータベースコードでリアルタイムのSalesforce Data 360 のデータを取得・操作できます。接続まわりは Connect AI が引き受けてくれるので、パッケージを1つインストールしてパーソナルアクセストークンで認証するだけで、Salesforce Data 360(および Connect AI に接続済みのその他すべてのソース)にクエリを実行できます。しかも sqlite3 や psycopg2 といったライブラリでおなじみの connect() / cursor() / fetchall() という同じパターンをそのまま使えます。

この記事では、Connect AI で Salesforce Data 360 に接続し、パーソナルアクセストークンを生成して SDK をインストールし、リアルタイムのSalesforce Data 360 のデータを読み取る(対応している場合は書き込む)までの流れをご紹介します。

事前準備

  • CData Connect AI のアカウント
  • Python 3.8 以降
  • 有効な認証情報を持つアクティブな Salesforce Data 360 アカウント

Connect AI で Salesforce Data 360 に接続する方法は?

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします
  2. 接続の追加
  3. 「Add Connection」パネルから「Salesforce Data 360」を選択します
  4. データソースの選択
  5. Salesforce Data 360 に接続するために必要な認証プロパティを入力します。

    それでは、Salesforce Data 360 への認証方法を設定していきましょう。Salesforce Data 360 では、OAuth 標準による認証をサポートしています。

    OAuth 認証

    AuthScheme をOAuth に設定してください。

    デスクトップアプリケーション

    CData 製品では、デスクトップでの認証を簡略化する埋め込みOAuth アプリケーションを提供しています。

    また、Salesforce Data 360 コンソールで設定および登録するカスタムOAuth アプリケーションを使ってデスクトップから認証することもできます。詳しくは、ヘルプドキュメントのカスタムOAuth アプリの作成をご確認ください。

    接続する前に、以下のプロパティを設定してください。

    • InitiateOAuth:GETANDREFRESH。InitiateOAuth を使用すれば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要がなくなります
    • OAuthClientId(カスタムアプリケーションのみ):カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID
    • OAuthClientSecret(カスタムアプリケーションのみ):カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット

    接続すると、CData 製品がデフォルトブラウザでSalesforce Data 360 のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

    以下のようにドライバーがOAuth プロセスを完了します。

    • コールバックURL からアクセストークンを取得します
    • 古いトークンの期限が切れた際は、新しいアクセストークンを取得します
    • OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します

    Web アプリケーションやヘッドレスマシンを含むその他のOAuth 認証方法については、ヘルプドキュメントをご確認ください。

    接続の設定(Salesforce の例)
  6. 「Save & Test」をクリックします
  7. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。 権限の更新

パーソナルアクセストークン(PAT)を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン(PAT)を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

  1. Connect AI アプリの右上にある歯車アイコン()をクリックして、設定ページを開きます。
  2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
  3. PAT に名前を付けて Create をクリックします。 新しい PAT の作成
  4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

SDK をインストールする

pip を使って PyPI から SDK をインストールします。

pip install cdata-connect-ai

接続して最初のクエリを実行する

アカウントのメールアドレスと PAT で接続したら、sys_tables にクエリを実行して、接続済みのソース全体で利用可能なテーブルを確認してみましょう。Connect AI の識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名(例:SalesforceDataCloud1)になります。

import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)
cur = conn.cursor()

# Discover what's available across your connected sources
cur.execute("SELECT CatalogName, SchemaName, TableName FROM sys_tables LIMIT 25")

for row in cur.fetchall():
    print(row)

結果から任意のテーブルを選び、直接クエリを実行してみましょう。

cur.execute(
    "SELECT [Account ID], [Account Name] "
    "FROM [SalesforceDataCloud1].[SalesforceDataCloud].[Account] "
    "LIMIT 10"
)

for row in cur.fetchall():
    print(row)

Salesforce Data 360 は Connect AI では読み取り専用のソースのため、SDK はクエリには対応していますが、INSERT、UPDATE、DELETE には対応していません。作業が終わったら接続を閉じましょう。

conn.close()

これがワークフローのすべてです。パッケージが1つ、PAT、そして標準的な DB-API 呼び出しだけ。SDK は通常の DB-API 接続を返すので、Python のデータエコシステムのほかのツールにもそのまま組み込めます。ここから先は、この同じ接続を使って、Salesforce Data 360 のデータを pandas に読み込んだり、petl で ETL パイプラインを構築したり、Dash の Web アプリを動かしたりできます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を通じて Python からリアルタイムのSalesforce Data 360 のデータをクエリできるようになりました。Salesforce Data 360(および数百種類のその他のデータソース)への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください:

無料トライアル お問い合わせ

はじめる準備はできましたか?

CData Connect AI の詳細、または無料トライアルにお申し込みください:

無料トライアル