Required Events & Attributes
Ensure your integration logs the required runtime attributes, standard telemetry events, and outcome events so NX10 can effectively analyze player behavior.
Integration Checklist
To provide accurate behavioral insight and outcome modeling, the NX10 SDK relies on a standardized schema of Attributes, Standard Events, and Outcome Events.
If your game contains gambling or wager-based mechanics, ensure you also implement the optional gambling-specific events and attributes detailed in each section below.
1. Required Attributes
Attributes represent the continuous context of your game. Set these values whenever the player changes state or UI screen.
| Attribute Key | Type | Expected Values / Description |
|---|---|---|
| view | string | main_menu, settings, level_results, gameplay_highway, gameplay_farm, map, inventory, shop, interstitial_ad, rewarded_ad |
| banner_ad_visible | boolean | true, false |
| interstitial_ad_rate_seconds | number | Frequency of interstitial ad opportunities in seconds. |
| no_ads | boolean | Whether the player has disabled ads (e.g., via IAP). |
| wager_amount Gambling | number | Active bet or wager amount in the current round. |
| pot_size Gambling | number | Total current pot size for the round. |
2. Standard Events
Log these discrete events to track user lifecycle, ad interactions, shop UI flow, and gameplay decisions.
| Event Name | Parameters & Expected Values | Description |
|---|---|---|
| app_backgrounded | — | Fired when the app is sent to the background. |
| app_foregrounded | — | Fired when the app returns to the foreground. |
| ad_started / ad_finished | type: "banner" | "interstitial" | "rewarded" | "app_start" ads_in_set: number (e.g. 2) ad_number: number (e.g. 1) | Tracks the lifecycle of an ad presentation sequence. |
| rewarded_shown | type: "upgrade_speed" | "coins" | "diamonds" amount: number (e.g. 2) trigger: "low_coins_balance" | "revive_player" | Fired when a rewarded ad prompt is shown to the user. |
| rewarded_hidden | type: string amount: number reason: "user_closed" | "view_changed" | "expired" | Fired when a rewarded ad prompt is dismissed or cleared. |
| in_app_purchase_view_opened / in_app_purchase_view_closed | amount: number currency: string (e.g. "USD") type: "shop" | "no_ads" | Tracks player impression flow inside store or paywall views. |
| gambling_round_started Gambling | game_type: "slots" | "roulette" | "blackjack" | Fired at the start of a wagering round. |
| gambling_round_finished Gambling | game_type: "slots" | "roulette" | "blackjack" result: "win" | "loss" | "draw" | "jackpot" bet_currency / bet_amount: string / number return_currency / return_amount: string / number | Fired when a wagering round resolves. |
| gambling_wager_action Gambling | game_type: string currency / amount_delta: string / number action_type: "increase" | "decrease" | "min" | "max" | "undo" | "clear" | "repeat" position: "straight_17" | "red" | "black" | "ante" | Tracks adjustments made to chip values or board positions prior to play. |
| gambling_decision Gambling | game_type: string currency / amount: string / number decision: "spin" | "hit" | "stand" | "double_down" | "split" | "fold" | "call" | "raise" | "sit_out" | Tracks active gameplay decisions made during a round. |
3. Outcome Events
Outcome events directly measure conversion opportunities and monetization performance. Mark conversion status using Outcome.Converted or Outcome.UnConverted.
| Outcome Event | Parameters & Expected Values | Conversion Criteria & Usage |
|---|---|---|
| in_app_purchase | price: number currency: "USD" product: "no_ads" | "coins" | "diamonds" | "starter_pack" reason: "purchase_completed" | "purchase_failed" | "user_cancelled" | Log when a player attempts or completes a purchase. Mark as Outcome.UnConverted if the purchase opportunity was presented but failed or was cancelled. |
| ad_revenue | type: "banner" | "interstitial" | "rewarded" | "app_start" network: string (e.g. "AppLovin", "UnityAds") amount: number currency: string reason: "ad_displayed" | "rewarded_declined" | "ad_blocked" | "ad_failed_to_display" | "app_closed" | Log ad revenue results. Mark as Outcome.UnConverted if an ad impression opportunity was declined, blocked, or failed to render. |