Skip to content

事件目錄與驗證

對象: 工程師、技術整合人員

v3 由一個型別化事件目錄管治:事件及其欄位會預先登記,且每個傳入的事件在儲存前都會對照目錄進行驗證。

為何要型別化?

在 v2 中,event_name 是一個自由字串,事件可以攜帶任意類型的任意屬性 — 因此 depositDepositdepo 全都會落地,而 amount 可能以字串 "50" 的形式傳來。v3 修正了這一點:

  1. 已登記事件 — 只接受目錄事件;未知名稱會被拒絕。
  2. 型別化欄位 — 每個欄位都有固定的類型(String / Number / Boolean),並在相關時有一份允許值清單。
  3. 匯入時驗證 — 每個事件都會對照目錄進行檢查;只有符合的事件才會被儲存。

這讓下游的分析、歸因及 AI 功能持續在乾淨、可信賴的資料上運作。

Standard 與 iGaming

事件被組織成預設集(preset)。你產品的有效目錄是 Standard 預設集,加上其所訂閱的任何行業預設集。

預設集範圍可用性類別
Standard (general.core)通用自動啟用於每個產品用戶生命週期 · 驗證與授權 · 應用生命週期
iGaming (igaming)行業按訂閱 — 由 RevoSurge 團隊為你的產品啟用用戶生命週期 · 驗證與授權 · 資金 · 遊戲 · 獎金生命週期
Legacy (legacy)通用相容性(寬鬆)page_viewpurchasedownload_click
  • 標準事件(瀏覽)開箱即用,適用於所有廣告主。
  • iGaming 事件(瀏覽)要求你的產品已訂閱 iGaming 預設集。如果你在未訂閱的情況下傳送 iGaming 事件,它會被拒絕為 EVENT_DISABLED — 請聯絡你的 RevoSurge 代表以啟用。

欄位要求等級

每個欄位都帶有一個要求等級:

等級含義
必填必須存在且類型正確,否則事件會被拒絕。
建議強烈建議以提升資料品質/歸因;不強制。
可選有最好。

哪些內容會被驗證

驗證分兩個階段執行:

  1. 結構性 — 信封格式正確:eventtimestamp 存在、timestamp 為有效的 UTC 毫秒、identity 有一個穩定 ID,且任何 PII 都符合 SHA-256 格式。
  2. 目錄 — 事件已登記且為你的產品啟用、每個必填欄位都存在且類型正確,且 enum 欄位使用允許的值。
失敗回應
信封/類型/PII 格式錯誤400 VALIDATION_ERROR
未知事件名稱422 UNKNOWN_EVENT_TYPE
事件未為你的產品啟用422 EVENT_DISABLED

所有欄位違規都會被收集並一起在 violations[] 中回傳(不會 fail-fast),因此你可以一次過修正所有問題。回應結構請參閱 API 參考

TIP

在整合期間使用測試模式X-Test-Mode: true),以準確查看哪些欄位驗證失敗,而不會儲存任何內容。

目錄更新

目錄由 RevoSurge 團隊集中管理。當事件或欄位變更時,更新會自動傳播到匯入(通常在一分鐘內)— 你方無需重新部署。如果目錄短暫不可用,匯入會優雅地降級,而不會丟棄你的流量。

自訂事件

除了內建的預設集外,當你有標準目錄未涵蓋的使用案例時,RevoSurge 團隊可以登記範圍限定於你產品的自訂事件。請提供事件名稱、其欄位及其類型與我們聯絡。