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

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

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

Adobe Analytics のデータ への接続

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

Adobe Analytics への接続

それでは、Adobe Analytics に接続していきましょう。接続するには、GlobalCompanyId およびRSID を識別する必要があります。デフォルトでは、ドライバーが会社とレポートスイートの識別を自動で試みますが、これらの値を明示的に指定することも可能です。詳しい手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「Adobe Analytics への接続」セクションをご確認ください。

Adobe Analytics への認証

続いて、認証方法を設定しましょう。Adobe Analytics はOAuth 認証標準を利用しており、OAuth またはサービスアカウントで認証できます。

ユーザーアカウント（OAuth）

ユーザーアカウントでの認証では、すべてのフローでAuthScheme をOAuth に設定する必要があります。詳しい認証手順については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「Adobe Analytics への認証」セクションをご参照ください。

サービスアカウント

サービスアカウントではサイレント認証が利用でき、ブラウザでのユーザー認証が不要です。このフローを使用するには、アプリケーションを作成する必要があります。アプリケーションの作成および認可については、ドキュメントの「カスタムOAuth アプリの作成」をご確認ください。これにより、サービスアカウントにアクセス権があるAdobe Analytics データに接続できるようになります。

サービスアカウントを使用したServer-to-Server OAuth で認証するには、AuthScheme をOAuthClient に設定します。接続には以下のプロパティを設定してください。

• InitiateOAuth：GETANDREFRESH に設定
• OAuthClientId：アプリケーション設定のクライアントId に設定
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定

接続すると、CData 製品がサービスアカウントでのOAuth フローを以下の手順で完了します。

1. クライアントクレデンシャルOAuth フローで指定されたOAuthClientId およびOAuthClientSecret を使用して、アクセストークンを取得します
2. OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします
3. トークンが期限切れになった際に、新しいアクセストークンを要求します

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

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

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 での Adobe Analytics のデータ のモデリング

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

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

engine = create_engine("adobeanalytics:///?GlobalCompanyId=myGlobalCompanyId& RSID=myRSID& OAuthClientId=myOauthClientId& OauthClientSecret=myOAuthClientSecret& CallbackURL=myCallbackURL")

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

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

base = declarative_base()
class AdsReport(base):
	__tablename__ = "AdsReport"
	Page = Column(String,primary_key=True)
	PageViews = Column(String)
	...

Adobe Analytics のデータ のクエリ

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

query メソッドの使用

engine = create_engine("adobeanalytics:///?GlobalCompanyId=myGlobalCompanyId& RSID=myRSID& OAuthClientId=myOauthClientId& OauthClientSecret=myOAuthClientSecret& CallbackURL=myCallbackURL")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AdsReport).filter_by(City="Chapel Hill"):
	print("Page: ", instance.Page)
	print("PageViews: ", instance.PageViews)
	print("---------")

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

execute メソッドの使用

AdsReport_table = AdsReport.metadata.tables["AdsReport"]
for instance in session.execute(AdsReport_table.select().where(AdsReport_table.c.City == "Chapel Hill")):
	print("Page: ", instance.Page)
	print("PageViews: ", instance.PageViews)
	print("---------")

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

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

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