SQLAlchemy ORM を使用して Python で Facebook Ads のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for Facebook Ads と SQLAlchemy ツールキットを使用して、Facebook Ads に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して Facebook Ads のデータ に接続し、クエリを実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの Facebook Ads のデータ を操作する際に比類のないパフォーマンスを提供します。Facebook Ads に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 Facebook Ads にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

Facebook Ads のデータ への接続

Facebook Ads のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

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

ほとんどのテーブルで、アプリケーション認証と同様にユーザー認証を必要とします。Facebook Ads はユーザー認証にOAuth 標準を使用しています。Facebook への認証には、組み込み認証を使用してブラウザ経由で完結することもできますし、Facebook にアプリを登録することで独自のOAuthClientId、OAuthClientSecret、CallbackURL を取得することもできます。

の設定方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

任意で以下の項目を設定して、フィルタリングや集計を行うもできます。必要に応じてご利用ください。

• Target：Facebook データのテーブルのいくつかはターゲットでフィルタリングできます。例えば、動画のコメントを取得するにはターゲットに動画のID を指定します。このプロパティは、クエリ結果を指定されたターゲットに合致するレコードにフィルタリングします。Target カラムを使ってクエリ毎にこの制限をかけることができます。
• AggregateFormat：CData 製品は、いくつかのカラムを文字列集合として返します。例えば、エンティティのいいねデータは集計されて返されます。デフォルトでは、CData 製品はJSON で集計カラムを返します。集計をXML で返すことも可能です。
• RetryLevel：このプロパティを使用して、特定の広告インサイトのクエリとエラーに対するクエリの自動再試行を制御します。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて Facebook Ads にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での Facebook Ads のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、Facebook Ads のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("facebookads:///?")

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

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、AdAccounts テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

base = declarative_base()
class AdAccounts(base):
	__tablename__ = "AdAccounts"
	AccountId = Column(String,primary_key=True)
	Name = Column(String)
	...

Facebook Ads のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("facebookads:///?")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AdAccounts).filter_by(Name="Acct Name"):
	print("AccountId: ", instance.AccountId)
	print("Name: ", instance.Name)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

AdAccounts_table = AdAccounts.metadata.tables["AdAccounts"]
for instance in session.execute(AdAccounts_table.select().where(AdAccounts_table.c.Name == "Acct Name")):
	print("AccountId: ", instance.AccountId)
	print("Name: ", instance.Name)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

無料トライアルと詳細情報

CData Python Connector for Facebook Ads の30日間の無料トライアルをダウンロードして、Facebook Ads のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。