パートナーAPI
APIリファレンス

Validation & Troubleshooting

テストと検証

開始前検証チェックリスト

技術統合

  • API :POST /ads/v3/brand-pages returns 200 with contentData.
  • Rendering : Content modules render correctly on your site in the correct order.
  • Theme: theme fields are applied correctly; null values fall back to retailer style guide defaults.
  • Optional fields: Renderer and tracking logic must tolerate omitted, null, or empty optional module fields, as well as omitted tracking nodes, without errors (validate using multiple live templates, not just a single demo brand page).
  • Styling : Brand page matches your site's design system.
  • Mobile : Brand page displays correctly on mobile devices.
  • Cache-busting : {TS} value changes on every request.

トラッキング検証

  • Impression pixel (C2S) : Every entry in trackingTemplates.client.impressionPixelUrls fires and returns 200 image/gif
  • Impression notification (S2S) : Composed server impression URL; GET or POST direct to Epsilon tracking host returns 204 No Content.
  • Click tracking (C2S) : Either the composed client.clickRedirect URL returns 302 to the correct destination, or the composed client.clickEvent returns 204 No Content (whichever option your flow uses - not both)
  • Click notification (S2S) : GET or POST direct to the composed server URL returns 204 No Content
  • Add-to-cart (C2S) : Composed client.addToCartEvent fired as event beacon returns 204 No Content
  • Add-to-cart (S2S) : Composed server.addToCartEvent called direct to tracking host returns 204 No Content

インフラストラクチャーとプライバシー

  • Reverse proxy : C2S tracking requests forwarded through your domain; S2S is not sent through the proxy
  • Headers : RP-Host, X-Forwarded-For, X-Forwarded-Request-Path, Referer are present on proxied requests
  • プライバシー：どのパラメータやURLにもPIIが含まれない
  • HTTPS：すべてのリクエストは安全な接続を使用する
  • 商品ページ：クリックリダイレクト後にページが正しく表示される

推奨ツール

  • ブラウザ開発者ツール：ピクセルの読み込みとリダイレクトを検査するためのネットワークタブ。
  • FiddlerまたはCharles Proxy：リバースプロキシの動作とヘッダー転送を確認します。

トラブルシューティング

問題確認
ピクセルが読み込まれないVerify DNS/SSL, confirm proxy path rewrite, check reachability to the Epsilon tracking host.
リダイレクトが転送されないEnsure {RURL} is URL-encoded, verify proxy preserves query string.
APIがコンテンツを返さないVerify catalogId and urlSlug match an active brand page campaign.
広告ブロッカーによってトラッキングがブロックされたConfirm reverse proxy is configured - tracking should route through your domain.
カートに追加しても追跡ないEnsure you fire the composed client or server add-to-cart URL after the cart action.
Page throws when loading some brand pagesLikely treating doc/example fields as always required. Log raw module JSON, add guards for optional keys and missing tracking, and confirm the template allows or disables those fields.
Theme colors not applying correctlyCheck that null theme fields fall back to your style guide defaults, rather than being rendered as literal null values or empty strings.

用語集

ブランドページ統合のための重要な用語

期間定義例
APIキーEpsilonサービス用の認証情報Basic abc123xyz...
ブランドページサイト上のブランディングされたランディングページ体験yoursite.com/brands/nike
C2SトラッキングClient-to-Server: Browser-based tracking. Impressions use 1x1 pixels; clicks use a 302 redirect or an event beacon; add-to-cart uses an event beacon.<img src="impression-pixel">, navigator.sendBeacon(clickEvent)
S2Sトラッキングサーバー間：バックエンドトラッキング（作成されたトラッキングURLへのGETまたはPOST）お客様のサーバー → Epsilonサーバー
コンテンツモジュール個々のコンテンツブロック(ヒーロー、テキスト、製品など）ヒーローバナー、製品グリッド
Module TagsOptional string labels on a module (e.g., ["header"]) set in the template. Used by retailers for layout routing, analytics, or mapping to their own components. Omitted from the response when empty."tags": ["header"]
ThemeAlways present on success in the API response: nested colors (background + seven text roles) and buttons (primary / secondary with background and text). All theme color fields are required (hex6). See Theme Object."theme": {"colors": { ... }, "buttons": { ... }}
インプレッションユーザーがブランドページを閲覧したときページ読み込み＝1インプレッション
クリックユーザーがブランドページのコンテンツをクリックしたときCTAボタンのクリック
コンバージョンユーザーがブランドページから商品をカートに追加したときカートに追加アクション
リバースプロキシ広告ブロッカーを回避するためにトラッキングをドメイン経由でルーティングyoursite.com/epsilon/ → Epsilon
URLスラッグURLパスにあるブランド識別子nike で /brands/nike
catalogIdお客様固有の商品カタログ識別子Epsilon提供
マクロResponse placeholders ({TS}, {RURL}) in tracking.params that you replace at runtime;{TS} → 1737485823910
IAB TCFInteractive Advertising Bureau Transparency & Consent FrameworkGDPRコンプライアンス基準
PII個人を特定できる情報（絶対に送信しないでください）メールアドレス、電話番号、本名
キャッシュバスティングキャッシュされた応答を防ぐためにタイムスタンプを追加?ts=1737485823910

技術的な略語

頭字語正式名称意味
RMNリテールメディアネットワークEpsilonの広告プラットフォーム
CTACall To Actionクリック可能なボタン/リンク
JSONJavaScript Object NotationAPIリクエスト/レスポンスのデータ形式
HTTPSHTTP Secure暗号化ウェブプロトコル
GDPRGeneral Data Protection RegulationEUのプライバシー法
TLSトランスポート層セキュリティ暗号化プロトコル
DNSドメインネームシステムインターネットアドレスシステム
SSLSecure Sockets Layer暗号化プロトコル
RFCRequest for CommentsTechnical standards documents

更新： 約1か月前

更新： 約1か月前