概要

物理アーキテクチャ

CitrusAd Reporting API は、CitrusAd データウェアハウスへの安全なアクセスを提供します。データウェアハウス自体には、CitrusAd プラットフォームから取得したデータとインサイトが含まれています。

CitrusAd のデータウェアハウスは分散モデルです。一部のデータは CitrusAd プラットフォームインスタンス内でローカルに保管され、その他のデータは一元化されたグローバルデータウェアハウスに保管されます。

次の図では、データモデルの構造を示しています。

レイヤー	説明
プラットフォームデータ	CitrusAd プラットフォームからのソースデータ。プラットフォーム自体は複数の物理インスタンスに分散されています。インスタンスは大規模小売業者ごとに存在するか、場合によっては複数の小規模小売業者間で安全に共有されます。外部接続に対してプラットフォームデータへの直接アクセスは許可されていません。
ステージングされたデータ	関連するプラットフォームデータは、ほぼリアルタイムでデータウェアハウスにステージングされます。ステージングされたデータは、プラットフォームデータと同じ物理的な場所にプラットフォームインスタンスごとに保持されます。通常、外部接続に対してステージングされたデータへの直接アクセスは許可されません。
コアデータセット	毎日、バッチプロセスでステージングデータを取得し、コアデータセットと呼ばれる使いやすいスノーフレークスキーマにモデル化されます。コアデータセットも、ステージングされたデータやプラットフォームデータと同じ物理的な場所で、プラットフォームインスタンスごとに保持されます。各コアデータセットファクトは、個別のトランザクションレベルと集約された詳細レベルの両方で確認できます。変更の追跡は、さまざまな次元でも行われています。コアデータセットへの直接アクセスは、特定のクライアントに対して（要求に応じて）主に小売業者レベルで許可されています (承認が必要です)。
集約コアデータセット	コアデータセットの更新後、バッチプロセスにより個々のコアデータセットが取得され、一元化された場所 (グローバルデータウェアハウス) に転送します。個々のコアデータセットは、単一の統一された集約コアデータセットに統合されます。グローバルデータウェアハウスには、(トランザクションデータではない) 集約されたファクトデータのみが保存されるのでご注意ください。通常、外部接続では集約コアデータセットへの直接アクセスは許可されません。
レポートデータマート	集約コアデータセットの更新後、毎日のバッチプロセスにより、さらに簡素化されて集約されたレポートデータマートが計算されます。コアデータセットと同様、レポートデータマートもスノーフレークスキーマです。現在のディメンションバージョンのみが提供されます。クライアントは、毎日のスナップショットに基づいて、必要に応じて、独自のデータウェアハウス内で変更履歴をローカルに維持する必要があります。レポートデータマートには、特定のファクトを装飾し、クライアントのクエリをさらに簡素化するビューも入っています。レポートデータマートへの直接アクセスは、小売業者とサプライヤー (承認が必要) の両方を含む、幅広いクライアントに (要求に応じて) 許可されます。
インサイト [近日公開]	レポートデータマート上に構築された一連のビューで、クライアントからよく要求される事前構築済みのインサイトを提供します。たとえばキャンペーン効果 (CTR/ROASなどの実現済み広告統計) 在庫充足率 (有料広告で埋まっているリクエストの割合) シェア・オブ・ボイス（カテゴリ/検索用語などによるインプレッションのサプライヤーシェア）課金 (期間ごと、キャンペーンごとのウォレット消費額) インサイトレイヤーへのアクセスは、小売業者とサプライヤーの両方の幅広いクライアントに許可されています (承認が必要) 。このドキュメントでは、レポートデータマートをデータウェアハウスにコピーするクライアントがロジックを簡単に複製する方法を理解できるよう、インサイトレイヤーの構築に使用される SQL コードも共有しています。
視覚化 [限定リリース]	レポートデータマートおよびインサイトレイヤー上に構築された一連のビューで、レガシーの BI プラットフォームと同等のデータを提供します。現在、視覚化レイヤーへのアクセスは、従来の BI プラットフォームで提供されていたものと、まったく同じデータにアクセスする必要がある小売業者とサプライヤーの両方のクライアントに (リクエストに応じて) 許可されています (承認が必要)。注: レガシーの BI プラットフォームと正確に整合させる必要がない限り、同等のレポートデータマートまたはインサイトレイヤーを代わりに使用することをお勧めします。これにはまた、より長い時間軸にわたる詳細なデータも含まれています。

論理データモデル

アクセスタイプに応じて、利用可能なデータには、次のような一般的に要求される CitrusAd プラットフォームのサブジェクト領域が多数含まれます。

(詳細な定義については、用語集を参照してください)

寸法データ
- キャンペーン
- 製品カタログ
- 商品
- チーム
  - 小売業者
  - サプライヤー
- ウォレット
- 検索語
- カテゴリ
- プレースメント
ファクトデータ
- 広告リクエストの統計 (検索用語やカテゴリ別のリクエスト数など)
- 実現済み広告統計 (検索用語やカテゴリ別のインプレッション数/クリック数/広告費など)
- 拡張されたアトリビューション統計 (設定されている場合のみ - インプレッションビュースルー、ハロークリックアトリビューションなど)
- FTA キャンペーン支出統計
- 元帳取引サマリー (請求情報、ウォレットトップアップなど)
- 注文統計

Reporting API は通常、コアデータセットやレポートデータマート内でスキーマを共有するために使用されます。これらのスキーマはどちらも前述のサブジェクト領域をカバーしていますが、集約レベルが異なります (コアデータセットはファクトと集約のトランザクションレベルの詳細を提供します)。

名前空間図

ユーザータイプ

表示できるサブジェクト領域は、組織が表示する権利内容に応じて制限されます。組織のアクセスには、次の 4 つのタイプがあります。

名前空間レベル: チーム (サプライヤーチームと小売業者チームの両方) のネットワーク全体を制御するクライアント。名前空間レベルのアクセスにより、CitrusAd の特定の実装のすべてのデータに対する可視性が付与されます。
小売業者レベル : 特定の小売業者チーム (または小売業者チームのグループ) のみのクライアント。
サプライヤーレベル : 特定のサプライヤーチーム (またはサプライヤーチームのグループ) のみのクライアント。
- インテグレーターレベル: サプライヤーレベルの拡張。ただし、特定の小売業者レベルのオブジェクトに完全にアクセスできる点が異なります (小売業者の裁量のみ)。

カバーされる主要なサブジェクト領域と、それらが 3 種類のアクセスにどのように適用されるかをこちらで示しています。

サブジェクト領域	名前空間	販売店	サプライヤー	インテグレーター
キャンペーン	すべてのデータ	小売業者チーム関連	サプライヤーチーム関連	サプライヤーチーム関連
製品カタログ	すべてのデータ	小売業者チーム関連	データなし	インテグレーターに承認を与えた小売業者チーム関連。
商品	すべてのデータ	小売業者チーム関連	実現済み広告統計 supplier_product テーブルのみに表示される製品の場合のみ	インテグレーターに承認を与えた小売業者チーム関連。
チーム	すべてのデータ	小売業者チーム関連	サプライヤーチーム関連	サプライヤーチーム関連
小売業者	すべてのデータ	小売業者チーム関連	実現済み広告統計 supplier_retailer テーブルに表示される小売業者の場合のみ	実現済み広告統計に表示される小売業者の場合のみ
サプライヤー	すべてのデータ	実現済み広告統計の retailer_supplier テーブルに表示されるサプライヤーの場合のみ	サプライヤーチーム関連	サプライヤーチーム関連
ウォレット	すべてのデータ	小売業者チームウォレットのみ	サプライヤーチームウォレットのみ	サプライヤーチームウォレットのみ
検索語	すべてのデータ	小売業者チーム関連	実現済み広告統計に表示される検索用語の場合のみ (ファクトテーブルにそのまま表示されるもののみ)	実現済み広告統計に表示される検索用語の場合のみ (ファクトテーブルにそのまま表示されるもののみ)
カテゴリ	すべてのデータ	小売業者チーム関連	実現済み広告統計に表示されるカテゴリの場合のみ (ファクトテーブルにそのまま表示されるもののみ)	実現済み広告統計に表示されるカテゴリの場合のみ (ファクトテーブルにそのまま表示されるもののみ)
広告リクエストの統計情報	すべてのデータ	小売業者チーム関連	データなし	データなし
拡張アトリビューション統計情報	すべてのデータ	小売業者チーム関連	サプライヤーチーム関連	サプライヤーチーム関連
FTA キャンペーン支出統計	すべてのデータ	小売業者チーム関連	サプライヤーチーム関連	サプライヤーチーム関連
台帳トランザクションのサマリー	すべてのデータ	小売業者チームウォレットのみ	サプライヤーチームウォレットのみ	サプライヤーチームウォレットのみ
注文統計	すべてのデータ	小売業者チーム関連	データなし	データなし
実現済み広告統計 (インプレッション数/クリック広告費など)	すべてのデータ	小売業者チーム関連	サプライヤーチーム関連	サプライヤーチーム関連
プレースメント	すべてのデータ	小売業者チーム関連	広告リクエストおよび実現済み広告統計に表示されるプレースメントの場合のみ。	インテグレーターに承認を与えた小売業者チーム関連。

ユーザーのアクセス方法

使用するクラウドプラットフォームに応じて、2 種類のアクセス方法があります。

ユーザータイプ	アクセス方法
Google Cloud Platform (GCP) ネイティブユーザー	直接アクセス当社のデータウェアハウスは BigQuery (GCP のデータウェアハウスサービス) にデプロイされているため、GCP 自体にいるクライアントはデータセットに直接アクセスできます。これにより、独自の GCP プロジェクトで BigQuery UI を介してオブジェクトを表示し、クエリを実行できるようになります。GCP プロジェクトのメールアドレスを提供するだけで、それに応じて権限が付与されます (承認待ち)。直接アクセスユーザーは、(BigQuery API の使用に加えて) スクリプトなどを介して BigQuery API を呼び出すこともできます。
その他の (非 GCP) ユーザー	API GCP (Azure や AWS など) を使用していない場合、CitrusAd はアカウント (サービスアカウント) を作成し、認証情報を提供します (承認待ち)。このアカウントでは、BigQuery API レベルのアクセスのみが許可されます (クラウドコンソールにはアクセスできません)。

ユーザータイプ

アクセス方法

Google Cloud Platform (GCP) ネイティブユーザー

直接アクセス当社のデータウェアハウスは BigQuery (GCP のデータウェアハウスサービス) にデプロイされているため、GCP 自体にいるクライアントはデータセットに直接アクセスできます。これにより、独自の GCP プロジェクトで BigQuery UI を介してオブジェクトを表示し、クエリを実行できるようになります。GCP プロジェクトのメールアドレスを提供するだけで、それに応じて権限が付与されます (承認待ち)。直接アクセスユーザーは、(BigQuery API の使用に加えて) スクリプトなどを介して BigQuery API を呼び出すこともできます。

その他の (非 GCP) ユーザー

API GCP (Azure や AWS など) を使用していない場合、CitrusAd はアカウント (サービスアカウント) を作成し、認証情報を提供します (承認待ち)。このアカウントでは、BigQuery API レベルのアクセスのみが許可されます (クラウドコンソールにはアクセスできません)。

バージョン: f34ea10