RevenueUI ドキュメント

収益トラッキング

Stripe収益を接続し、決済履歴を取り込み、検証済みの訪問者ジャーニーを決済結果へ関連付けます。

Stripeを接続する

セットアップまたは収益設定で、リンク先からStripe制限付きキーを作成します。

権限目的
Charges and refunds: Read成功した決済と返金を照合する。
Subscriptions: Readサブスクリプションと継続収益の状態を計算する。
Balance: Read決済手数料と残高への影響を読み取る。
Disputes: Readチャージバック、紛争手数料、返還資金を追跡する。
Credit Notes: Read返金との二重計上を避けて請求書クレジットを含める。
Webhook endpoints: WriteRevenueUIの署名付きエンドポイントを作成・削除する。

保存前にキーを検証し、接続後は履歴インポートを開始して状態を画面に表示します。

Stripe ConnectのDirect Charge

通常は詳細設定 → Stripe Connect → Connected Account IDを空欄にします。Webサイトの決済が接続アカウント上のStripe Connect Direct Chargeとして作成される場合だけacct_...を設定してください。RevenueUIはStripe APIへ接続アカウントのコンテキストを付け、そのアカウントの決済、サブスクリプション、紛争、Credit Note、WebhookをこのWebサイトへ関連付けます。

この設定はStripe内の決済を移動・割り当てません。通常のStripeアカウントやプラットフォーム側のDestination Chargeには設定しないでください。

ユーザー・訪問者・セッションのメタデータを付ける

Stripe Checkout Session、PaymentIntent、Subscriptionを作成する際に利用可能なIDをコピーします。ファーストパーティCookieを使う場合、バックエンドは次を読み取れます。

cookie.revenueui_visitor_id -> metadata.revenueui_visitor_id
cookie.revenueui_session_id -> metadata.revenueui_session_id

Cookieなしの場合はブラウザからタブ単位のセッションIDをバックエンドへ送ります。

const identifiers = window.revenueUI?.getIdentifiers();

await fetch("/api/checkout", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ revenueui_session_id: identifiers?.sessionId }),
});

バックエンドで検証済み入力をmetadata.revenueui_session_idへコピーします。ブラウザにStripe資格情報を公開したり、ブラウザコードでCheckoutを作成したりしないでください。IDはWebサイトに対して検証されるため、生成したり別サイトからコピーしたりしないでください。

ログインユーザーは明示的な同意後にidentify()を呼び、同じ不透明な内部IDを付けます。

window.revenueUI?.identify(currentUser.id);
currentUser.id -> metadata.revenueui_user_id

直接識別子は使用しません。同じサイトでidentify()により観測されたIDだけを受理し、サイト単位のハッシュだけを保存します。

データ範囲を理解する

ブラウザ帰属がなくても決済をインポートでき、プロバイダー由来の収益には含まれますが、訪問者ジャーニー、流入元、ランディングページには割り当てられません。Cookieなしセッションは同じセッション内の決済を帰属できますが、後日の訪問、別タブ、別端末を安定して結べません。

トライアル価値はサブスクリプションデータに基づく期待値で、売上ではありません。返金は決済収益を減らし、Credit Noteの返金以外の部分は別調整として認識収益を減らします。

収益とStripe決済指標

  • 返金後収益: Charge金額から成功した返金を引いたCharge通貨の値。
  • Stripe手数料: 関連するBalance Transactionの値。
  • 紛争影響: チャージバックで引き出し・返還された資金と手数料を含むBalance Transactionの符号付き影響。
  • Credit Note調整: 決済後の請求書クレジット。同じCredit Noteが返金も作る場合は二重に差し引きません。
  • Stripe純額: Charge、成功した返金、関連する紛争のBalance Transaction影響を決済通貨で合算した値。

総額/純額チャートはCharge総額、返金後収益、Stripe純額を同じ時間軸に表示します。返金と紛争は元の決済日に割り当てます。決済データが部分的な場合は、選択通貨で同期済みの項目だけを含め、その範囲を明示します。

RevenueUIはCharge通貨と異なる決済通貨を合算せず、為替レートも推定しません。Balanceまたは紛争データが不足、処理中、別通貨の場合は部分的な範囲として表示します。

Webhookの復旧

削除したStripeエンドポイントの古いURLを手動で再作成しないでください。インポート済み収益を保持して切断し、制限付きキーで再接続します。新しい署名付きエンドポイントが登録され、照合が再開します。

切断する

切断時は、インポート済み収益を保持するか、接続とともに完全削除するかを選べます。削除するとWebサイトの分析履歴が変わるため、確認内容をよく読んでください。