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