Sweepstakes Game Close

Event Key

ootb_sweepstakes_game_close

Marking the closure or completion of a specific sweepstakes game.

Event KeyEvent NameType
ootb_sweepstakes_game_closeOOTB Sweepstakes Game CloseSimple event

Event Structure

The mandatory properties (tenant, timestamp, event, and customer) are required for all events and documented in detail on the Mandatory Properties page. Below is the JSON structure for the context-specific properties of the OOTB Sweepstakes Game Close event:

{
  "context": {
    "ootb_game_close_timestamp": "2024-05-27T10:30:00Z",
    "ootb_game_code": "game456",
    "ootb_game_name": "Blackjack",
    "ootb_game_category": "Table Games",
    "ootb_end_gc_balance": 20.00,
    "ootb_end_sc_balance": 20.00,
    "ootb_gc_stakes": 200.00,
    "ootb_sc_stakes": 200.00,
    "ootb_sc_win_amount": 100.00,
    "ootb_gc_used": 50.00,
    "ootb_gc_win_amount": 100.00,
    "ootb_gross_gaming_revenue": 100.00,
    "ootb_number_of_sc_bets": 2,
    "ootb_number_of_gc_bets": 2,
    "ootb_game_session_reference": "game_ses_456",
    "ootb_language": "English",
    "ootb_country": "USA",
    "ootb_platform": "iOS",
    "ootb_launch_location": "BingoLobby",
    "ootb_launch_location_index": 1,
    "ootb_channel": "Mobile",
    "ootb_brand": "brand123",
    "ootb_license": "USA"
  }
}

Parameters

Parameter KeyParameter NameTypeDescriptionMandatory for Opti-X
ootb_game_close_timestampGame Close TimestampStringISO 8601 datetime of closing a casino gameYes
ootb_game_codeGame CodeStringGame unique identifier/ Game IDYes
ootb_game_nameGame NameStringGame nameNo
ootb_game_categoryGame CategoryStringThe category of the game- division of games into major categories(e.g. Slots, Roulette, Table, etc.)No
ootb_end_gc_balanceEnd Gold Coins BalanceDecimalThe gold coins value of a player’s balance after closing gameNo
ootb_end_sc_balanceEnd Sweep Coins BalanceDecimalThe sweep coins value of a player’s balance after closing gameNo
ootb_sc_stakesSweep Coins StakesDecimalSweep coins value that was wagered- real bet amountYes
ootb_gc_stakesGold Coins StakesDecimalGold coins value that was wagered- real bet amountYes
ootb_sc_win_amountSweep Coins Win AmountDecimalSweep coins value that was wonNo
ootb_gc_usedGold Coins UsedDecimalTotal gold coins amount that was wagered/ used in the gameNo
ootb_gc_win_amountGold Coins Win AmountDecimalTotal gold coins amount that was wonNo
ootb_gross_gaming_revenueGross Gaming RevenueDecimalTotal revenueYes
ootb_number_of_sc_betsNumber of SC BetsNumberTotal number of sweep coins bets/games played in a gameYes
ootb_number_of_gc_betsNumber of GC BetsNumberTotal number of gold coins bets/games played in a gameYes
ootb_game_session_referenceGame Session ReferenceStringReference to the game session event- optionalNo
ootb_languageLanguageStringThe language of the playerNo
ootb_countryCountryStringThe country of the playerNo
ootb_platformPlatformStringThe platform used (e.g., iOS, Android).No
ootb_launch_locationLaunch LocationStringThe container where the game was launched from- home/ recently- played/ new game/ search result/ top games, etc. OptionalNo
ootb_launch_location_indexLaunch Location IndexNumberBased index of where in the container the game was launched from- optionalNo
ootb_channelChannelStringThe channel through which an event was initiated, capturing the device type or platform used Mobile/desktop/tabletNo
ootb_brandBrandStringBrand name or identifier.No
ootb_licenseLicenseStringWhere they’re licensed to operateNo

Explanation

  • event: Set to ootb_sweepstakes_game_close to indicate the termination of the game window.
  • context:
    • ootb_game_close_timestamp: The exact moment the game was closed, used to mark the end of engagement.
    • ootb_game_code: The system ID used to aggregate data for specific game performance.
    • ootb_game_name: The display name used for reporting and personalization tokens.
    • ootb_game_category: Allows for segmentation based on game preference (e.g., "Slots Players").
    • ootb_end_gc_balance: The final Gold Coin balance; comparing this to the start balance validates the session result.
    • ootb_end_sc_balance: The final Sweep Coin balance; comparing this to the start balance validates the session result.
    • ootb_sc_stakes: Total Sweep Coins wagered at the time of closing.
    • ootb_gc_stakes: Total Gold Coins wagered at the time of closing.
    • ootb_sc_win_amount: Total Sweep Coins won at the time of closing.
    • ootb_gc_used: Total Gold Coins used (wagered) at the time of closing.
    • ootb_gc_win_amount: Total Gold Coins won at the time of closing.
    • ootb_gross_gaming_revenue: The total revenue recognized for this game instance.
    • ootb_number_of_sc_bets: Total count of SC bets placed before closing.
    • ootb_number_of_gc_bets: Total count of GC bets placed before closing.
    • ootb_game_session_reference: A unique key linking this event to subsequent session/close events.
    • ootb_language: The language setting of the player during the event.
    • ootb_country: The player's country location during the event.
    • ootb_platform: The platform environment (e.g., iOS, Android) where the event occurred.
    • ootb_launch_location: The UI container/source where the game was initiated (e.g., Homepage, Search).
    • ootb_launch_location_index: The numerical position index within the launch container.
    • ootb_channel: The device type or access channel used.
    • ootb_brand: The specific brand or skin associated with the user/event.
    • ootb_license: The regulatory license under which the operation is occurring.