各製品の資料を入手。
詳細はこちら →
製品をチェック
SQLAlchemy ORM を使って、Python でFreshdesk のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でFreshdesk にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるFreshdesk 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for FreshDesk は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Freshdesk にデータ連携するPython アプリケーションを構築し、Freshdesk のデータを可視化できます。 本記事では、SQLAlchemy でFreshdesk に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Freshdesk をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにFreshdesk のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてFreshdesk の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でFreshdesk のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、Freshdesk のデータに連携するEngne を作成します。
engine = create_engine("freshdesk///?Domain=MyDomain&APIKey=myAPIKey")
FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。
- Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
- APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。
Freshdesk のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Tickets テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class Tickets(base): __tablename__ = "Tickets" Id = Column(String,primary_key=True) Name = Column(String) ...
Freshdesk のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("freshdesk///?Domain=MyDomain&APIKey=myAPIKey")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Tickets).filter_by(Status="2"):
print("Id: ", instance.Id)
print("Name: ", instance.Name)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Tickets_table = Tickets.metadata.tables["Tickets"]
for instance in session.execute(Tickets_table.select().where(Tickets_table.c.Status == "2")):
print("Id: ", instance.Id)
print("Name: ", instance.Name)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Freshdesk のデータの挿入（INSERT）
Freshdesk のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Freshdesk にすべての追加インスタンスを送ります。
new_rec = Tickets(Id="placeholder", Status="2") session.add(new_rec) session.commit()
Freshdesk のデータを更新（UPDATE）
Freshdesk のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Freshdesk にレコードを追加します。
updated_rec = session.query(Tickets).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Status = "2" session.commit()
Freshdesk のデータを削除（DELETE）
Freshdesk のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Tickets).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
Freshdesk からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
