SQLAlchemy ORM を使って、Python でAdobe Analytics データに連携

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムAdobe Analytics データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Adobe Analytics に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Adobe Analytics 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

Adobe Analytics への接続

Adobe Analytics データへの連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Adobe Analytics はOAuth 認証標準を利用しています。 OAuth 統合またはサービスアカウント統合で認証できます。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

GlobalCompanyIdの取得

GlobalCompanyId は必須の接続プロパティです。Global Company ID がわからない場合は、Swagger UI のusers/me エンドポイントのリクエストURL で見つけることができます。Swagger UI にログインした後、ユーザーエンドポイントを展開し、「GET users/me」ボタンをクリックします。「Try it out」ボタンと「Execute」ボタンをクリックします。リクエストURL のusers/me エンドポイントの直前に表示されるGlobal Company ID をメモします。

Report Suite Id の取得

Report Suite ID （RSID）は必須の接続プロパティです。Adobe Analytics UI で、「管理者」->「レポートスイート」に進むと、名前の横にある識別子とともにレポートスイートのリストが表示されます。

GlobalCompanyId、RSID、およびOAuth 接続プロパティを設定して、Adobe Analytics に接続してください。

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからAdobe Analytics に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でAdobe Analytics データをモデル化

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

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

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

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、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、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

製品の無償トライアル情報

Adobe Analytics Python Connector の30日の無償トライアル をぜひダウンロードして、Adobe Analytics データへの接続をPython アプリやスクリプトから簡単に作成しましょう。