SQLAlchemy ORM を使って、Python でPipedrive データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Pipedrive は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Pipedrive にデータ連携するPython アプリケーションを構築し、Pipedrive データを可視化できます。 本記事では、SQLAlchemy でPipedrive に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Pipedrive をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにPipedrive データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてPipedrive の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

必要なモジュールのインストール

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でPipedrive データをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Pipedrive データに連携するEngne を作成します。

engine = create_engine("pipedrive///?AuthScheme=Basic&CompanyDomain=MyCompanyDomain&APIToken=MyAPIToken")

Pipedrive 接続プロパティの取得・設定方法

Pipedrive への接続に使用できる認証方法は、Basic およびOAuth です。

Basic

1. PipeDrive の右上にあるアカウント名をクリックします。
2. 会社設定をクリックし、続いてPersonal Preferences -> API -> Generate Token をクリックします。
3. API トークンを控えておきます。
4. CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。

以下を設定してPipedrive へ認証します。

• APIToken：控えておいたAPI トークンに設定。
• CompanyDomain：控えておいた開発者サンドボックスURL の会社ドメインに設定。
• AuthScheme：Basic に設定。

API トークンは、PipeDrive の右上にあるアカウント名 -> 会社設定 -> Personal preferences -> API に移動して確認できます。

OAuth

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

Pipedrive データのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Deals テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class Deals(base):
	__tablename__ = "Deals"
	PersonName = Column(String,primary_key=True)
	UserEmail = Column(String)
	...

Pipedrive データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("pipedrive///?AuthScheme=Basic&CompanyDomain=MyCompanyDomain&APIToken=MyAPIToken")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Deals).filter_by(Value="50000"):
	print("PersonName: ", instance.PersonName)
	print("UserEmail: ", instance.UserEmail)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Deals_table = Deals.metadata.tables["Deals"]
for instance in session.execute(Deals_table.select().where(Deals_table.c.Value == "50000")):
	print("PersonName: ", instance.PersonName)
	print("UserEmail: ", instance.UserEmail)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Pipedrive データの挿入（INSERT）

Pipedrive データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Pipedrive にすべての追加インスタンスを送ります。

new_rec = Deals(PersonName="placeholder", Value="50000")
session.add(new_rec)
session.commit()

Pipedrive データを更新（UPDATE）

Pipedrive データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Pipedrive にレコードを追加します。

updated_rec = session.query(Deals).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Value = "50000"
session.commit()

Pipedrive データを削除（DELETE）

Pipedrive データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Deals).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Pipedrive からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。