๐ย Welcome
Getting Started
Sign Up & Add GamesSDK Setup & UpdatesSharing & PermissionsProducts
Popmall (Catalog)Music PlayerData Store EditorCustom EventsAnalyticsProduct OptimizationPopfeedBrand CollabCampaignsCampaign ControlSupport
Questions or FeedbackMetric DefinitionsSDK ChangelogBloxbiz SDK Changelog
Instructions for using a beta version
- Download the rbxm file for the most recent beta (unzip if needed)
- Open your game in Studio and right click on ServerScriptService
- Click "Insert from File" and open the rbxm file you downloaded
- This should replace your old SDK if you had one
Changelog
SDK Version 46 Beta 1 (11/6/2024)
- Popmall Shops
SDK Version 45 Release (9/30/2024)
- Bug fixes
SDK Version 44 Release (8/7/2024)
- Fix bug with 5-option survey questions
- Fix Popmall purchases
SDK Version 43 Beta 1 (7/24/2024)
SDK Version 42 Release (7/23/2024)
- Automatically block purchase of free limiteds in Popmall
- Set
BloxbizConfig.CatalogPurchaseAllowList = { ...itemIds }
to allow purchase of a free limited
SDK Version 42 Beta 1 (7/3/2024)
- Fix bug with directly opening catalog categories
SDK Version 41 Release (7/3/2024)
- Custom Events debug mode
- Bug fixes
SDK Version 40 Release (6/3/2024)
- New Music Player feature. Learn More
- Updated to TopbarPlus v3
- Added a warning message for the outdated TopbarPlus version
- Latest TopbarPlus version: https://devforum.roblox.com/t/v3-topbarplus-v300-construct-intuitive-topbar-icons-customise-them-with-themes-dropdowns-captions-labels-and-much-more/
SDK Version 40 Beta 4 (5/28/2024)
- New Music Player feature. Learn More
SDK Version 40 Beta 2 (5/15/2024)
- Added category banners to Popmall
SDK Version 40 Beta 1 (4/29/2024)
- Updated to TopbarPlus v3
- Added a warning message for the outdated TopbarPlus version
- Latest TopbarPlus version: https://devforum.roblox.com/t/v3-topbarplus-v300-construct-intuitive-topbar-icons-customise-them-with-themes-dropdowns-captions-labels-and-much-more/
SDK Version 39 Release (4/4/2024)
- [Popfeed] New feature: create screenshot posts
- [Popfeed] Various bug fixes and performance improvements
- Fixed SDK memory leak
SDK Version 39 Beta 4 (3/11/2024)
- [Popmall] Fix bug where leaderboard doesnโt reopen after closing Popmall when using outfit rack
SDK Version 39 Beta 3 (2/28/2024)
- Disable auto-localization for item names in Popmall
SDK Version 39 Beta 2 (2/22/2024)
- Temporarily remove Outfit Feed due to moderation concerns
- Games that donโt update to this version will see โThereโs no outfits to showโ in the Outfits category
SDK Version 39 Beta 1 (2/5/2024)
- Warning on server/Studio run startup for games that donโt have API key and AccountID properly configured
- [Popmall] Warning on outfit creation for users to abide by Roblox guidelines
SDK Version 38 Release (1/17/2024)
- [Popmall] Popmall logo fits new topbar
- [Popmall] Allow players to copy outfits from other players by setting
BloxbizConfig.CatalogCopyOutfitsFromPlayersEnabled = true
- [Popmall] User & group search - Show items created by specific Roblox users or groups by adding user: or group: to your search. For example:
- user:roblox
- user:1704318
- group:8668664 beanie
- [Analytics] Bundle purchase reporting
- [NPCs] 3D ad dialogue improvements
- [Popmall/Popfeed] New Roblox experience buttons theme
- If youโre using TopBarPlus in your game, please switch to this version for the new theme: https://github.com/iamEvanYT/TopbarPlus/releases/tag/v.2.9.3
- [Popfeed] Added floating profile banners
- [Popfeed] Added profile followers/following view
- [Popfeed] Added read only mode for non-approved games
- [Popfeed] Added impression collecting to posts
- [Popfeed] Disabled auto localization on posts
SDK Version 38 BETA4 (1/3/2024)
- [Popmall] Popmall logo fits new topbar
- [Popmall] Allow players to copy outfits from other players by setting
BloxbizConfig.CatalogCopyOutfitsFromPlayersEnabled = true
SDK Version 38 BETA3 (12/11/2023)
- [Popmall] User & group search - Show items created by specific Roblox users or groups by adding user: or group: to your search. For example:
- user:roblox
- user:1704318
- group:8668664 beanie
SDK Version 38 BETA2 (12/7/2023)
- [Analytics] Bundle purchase reporting
- [NPCs] 3D ad dialogue improvements
- [Popmall/Popfeed] New Roblox experience buttons theme
- If youโre using TopBarPlus in your game, please switch to this version for the new theme: https://github.com/iamEvanYT/TopbarPlus/releases/tag/v.2.9.3
SDK Version 38 BETA1 (11/14/2023)
- [Popfeed] Added floating profile banners
- [Popfeed] Added profile followers/following view
- [Popfeed] Added read only mode for non-approved games
- [Popfeed] Added impression collecting to posts
- [Popfeed] Disabled auto localization on posts
SDK Version 37 Release (11/13/2023)
- [Popmall] Added buy outfit button
- Shows a prompt with a list of items the player is wearing and the remaining robux price
- Includes an API trigger to use the buy outfit prompt in your game -ย
PublicAPI.promptBuyOutfit()
- [Popmall] Clicking โTry onโ on a dynamic head bundle no longer removes your other items
- [Popmall] Redesigned outfit feed
- You can now see the number of views and try-ons an outfit has
- Removed boosts - boosts from previous versions will still affect outfit rank, but outfits can no longer be boosted
- [Popmall] Added new full-screen camera mode, including a background and pose changer
- [Popmall] Redesigned saved outfits page
- Added โUpdate Avatarโ button which will set your Roblox avatar to your currently worn items
- Added tabs to filter game or Roblox inventory outfits
- [Popmall] Added featured categories view
SDK Version 37 BETA3 (11/9/2023)
- [Popmall] Added buy outfit button
- Shows a prompt with a list of items the player is wearing and the remaining robux price
- Includes an API trigger to use the buy outfit prompt in your game -
PublicAPI.promptBuyOutfit()
- [Popmall] Clicking โTry onโ on a dynamic head bundle no longer removes your other items
- [Popmall] Bug fixes
SDK Version 37 BETA2 (11/1/2023)
- [Popmall] Redesigned outfit feed
- You can now see the number of views and try-ons an outfit has
- Removed boosts - boosts from previous versions will still affect outfit rank, but outfits can no longer be boosted
- [Popmall] Added new full-screen camera mode, including a background and pose changer
- [Popmall] Redesigned saved outfits page
- Added โUpdate Avatarโ button which will set your Roblox avatar to your currently worn items
- Added tabs to filter game or Roblox inventory outfits
SDK Version 37 BETA1 (10/25/23)
- [Popmall] Added featured categories view
- [Popmall] Inventory items now sorted alphabetically
SDK Version 36 Release (10/19/2023)
- [Popmall] Redesigned search, categories, and preview layout
- Improved workflow - enter a search term and swap between categories seamlessly
- [Popmall] Added search to outfit feed
- [Popmall] Added bundle items page
- Click โSee Itemsโ on a bundle or character to see and wear individual items
- [Popmall] Added Roblox inventory outfits to saved outfits page
- [Popmall] Save Popmall outfits to your Roblox inventory
- [Popmall] Category open API
- Use
PublicAPI.openCatalog(categoryOrSearchTerm: string?)
to open a specific category. If the category name doesnโt exist, the parameter is searched for instead.
SDK Version 36 BETA4 (10/16/2023)
- [Popmall] Redesigned search & category bar
- Improved workflow - enter a search term and swap between categories seamlessly
- [Popmall] Outfit search relevance sort
SDK Version 36 BETA3 (10/9/2023)
- [Popmall] Improved preview layout
- [Popmall] Category/search term deep linking
- Use
PublicAPI.openCatalog(categoryOrSearchTerm: string?)
to open a specific category. If the category name doesnโt exist, the parameter is searched for instead. - [Popmall] Saved Outfits screen performance fix
SDK Version 36 BETA2 (10/2/2023)
- [Popmall] Add Roblox inventory outfits to the saved outfits page
- [Popmall] Save to Roblox button for saved outfits
- [Popmall] Layered clothes bug fixes
SDK Version 36 BETA1 (9/22/2023)
- [Popmall] Add outfit feed search
- [Popmall] Add Top feed
SDK Version 35 Release (9/19/2023)
- [Popmall] Outfit feed performance fix
- [General] Add warning for missing API Key
SDK Version 34 Release (9/12/2023)
- [Popmall] Change Super Biz Catalog name to Popmall
- [Popmall] Introduced Outfit Feed - Share your outfits and like & boost others
- [Popmall] Item purchase block list - prevent UGC rewards from being purchased in the catalog
- [Popmall] Support custom labels for toolbar button
- [Popmall] Allow zooming and full rotation in the avatar preview
- [Popmall] Popmall can now be opened immediately upon joining game
- [Popmall] Avatar no longer zoomed out on initial open
SDK Version 34 BETA4 (9/07/2023)
- [Popmall] Support custom labels for toolbar button
- Set
BloxbizConfig.CatalogToolbarButtonLabel
to use a custom label for the Popmall toolbar button - Set to an empty string (
BloxbizConfig.CatalogToolbarButtonLabel = โโ
) to show just the Popmall icon - Button label defaults to โAvatarโ
- [Popmall] Outfit Feed bug fixes
- [Popmall] Switch โTopโ feed to โHotโ
SDK Version 34 BETA3 (8/31/2023)
- [Popmall] Outfit Feed bug fixes
SDK Version 34 BETA2 (8/30/2023)
- [Popmall] Introduced Outfit Feed - Share your outfits and like & boost others
- [Product Optimization] Introduced A/B Testing
- [Advertising] Add support for
analytics_protocol
ย (DataStore vs HTTP)
SDK Version 34 BETA1 (8/24/2023)
- [Catalog] Change Super Biz Catalog name to Popmall
- [Catalog] Item purchase block list - Prevent UGC rewards from being purchased in the catalog
- Set
BloxbizConfig.CatalogPurchaseBlockList
to a list of asset/bundle IDs that should be off-sale in your game - [Catalog] Allow zooming and full rotation in the avatar preview
- Avatar preview is now in idle pose
- [Catalog] Bug Fixes
- Catalog can now be opened immediately upon joining game
- Avatar no longer zoomed out on initial open
SDK Version 33 Release (8/21/2023)
- [Popfeed] User search
- [Popfeed] My decals
- [Analytics] Custom Events v1
SDK Version 33 BETA2 Release (8/16/2023)
- [Analytics] DataStore Analytics v1
SDK Version 33 BETA1 Release (8/14/2023)
- [Popfeed] User search
- [Popfeed] My decals
- [Analytics] Custom Events v1
SDK Version 32 Release (8/10/2023)
- [Popfeed] Selective and efficient auto localization
- [Catalog] Monetization reports related fix
- [Product Optimization] Gender/tier fetching critical fix
SDK Version 32 BETA1 Release (7/26/2023)
- [Popfeed] Selective and efficient auto localization
- [Catalog] Monetization reports related fix
- [Product Optimization] bug fix that prevented product optimization from working
SDK Version 31 Release (7/24/2023)
- [Popfeed] Added support for multiple images on a post
- [Popfeed] Fixed feed showing same posts multiple times
SDK Version 31 BETA1 Release (7/20/2023)
- [Popfeed] Added support for multiple images on a post
- [Popfeed] Fixed feed showing same posts multiple times
SDK Version 30 Release (7/18/2023)
- [Popfeed] Added Explore tab
- [Popfeed] Added Profile Shop Tab
- [Catalog] Numerous bug fixes
- Turned off auto localize to avoid using up game's auto localization limit
- Characters no longer appear larger when closing the catalog
- Outfits are properly loaded when updating the SDK version
- Items at the bottom of categories no longer get cut off
- In-category search behaves properly when switching categories
- Searching with 1 letter no longer causes an error
- Resetting outfit works more reliably
- Avatar preview no longer occasionally zooms out infinitely
- Animation bundles no longer break outfits
- Custom characters no longer break catalog preview
- Player's character loads properly on game load if PersistentWear is set to true
- Player's character stays synced with the catalog preview when making changes outside of the catalog if Persistent Wear is set to true
- Various UI tweaks
SDK Version 30 BETA3 Release (7/12/2023)
- [Catalog] Fixed avatar syncing
- [Catalog] Fixed avatar preview camera
SDK Version 30 BETA2 Release (7/7/2023)
- [Catalog] Scrolling frame fixes
- Removed duplicate Fusion modules
SDK Version 30 BETA1 Release (7/6/2023)
- [Popfeed] Added Explore tab
- [Popfeed] Added Shop tab on player profile
- [Popfeed] Bug fixes and polish
- [Catalog] Revert outfits datastore
- [Catalog] Bug fixes and polish
SDK Version 29 Released (6/27/23)
- [Catalog] Fixed faulty reporting
- [Catalog] Refactored to use Fusion
- [Catalog] Variety of UI improvements and new icons
- [Catalog] Variety of bug fixes
SDK Version 29 BETA2 Release (6/16/23)
- [Catalog] Fixed faulty reporting
- [Catalog] Fixed
PublicAPI
breakage - This is a BETA release, report all issues in #superbiz-beta
SDK Version 29 BETA1 Release (06/13/23)
- [Catalog] Refactored to use Fusion
- [Catalog] Variety of UI improvements and new icons
- [Catalog] Variety of bug fixes
- This is a BETA release, report all issues in #superbiz-beta
SDK Version 28 Released (05/25/23)
- [Catalog] Fix catalog analytics bug
- [Catalog] Fix outfit icons not appearing
- [Catalog] Fix unable to scroll in inventory
SDK Version 27 Released (05/23/23)
- [Popfeed] Popfeed v1 Release (Requires updating plugin to latest version and requires game approval)
- [Catalog] Added limited item labels
- [Catalog] Added search within categories
- [Catalog] Minor bug fixes
SDK Version 26 Released (02/01/23)
- [Catalog] Added loading state
- [Catalog] Fix last category being cut off
- Fix for bug causing frequent โUnknownโ country codes in player engagement reports
- Added warning if ad parts are not 2:1 size
- Updated TopBarPlus to latest version
SDK Version 25 Released (11/28/22)
- [Catalog] Catalog UI improved for mobile
- [Catalog] Added catalog analytics
- [Catalog] Added catalog player inventory + ability to update avatar
- [Catalog] Added PublicAPI.toggleCatalog
- Added Video Ad Debug mode
- Bug fix for GIFs with low frame count
- Bug fix for NPC ad dialogue sometimes cutting off
- Bug fix for ad formats enabled status being incorrect if streamingEnabled
SDK Version 24 Released (11/01/22)
- Added Portal Ads (Requires updating plugin to latest version)
- Fix race condition with 3d ads dynamic loading
- Added warnings for duplicate initialization of 3d ads and portal ads
- Added warnings for config usage with StreamingEnabled
SDK Version 23 Released (09/23/22)
- Fix Catalog not opening if opened immediately on slow internet race condition
- Fix debug character race condition
SDK Version 22 Released (09/19/22)
- [Catalog] Added Catalog search
- [Catalog] Added ability to turn on/off asset type limitations for trying on clothing
- [Catalog] Added ability to save outfits
- [Catalog] Added ability to change avatar scaling and skin tone
- [Catalog] Added ability to reset avatar
- [Catalog] Added ability to undo and redo changes to your avatar
- [Catalog] Various Catalog bug fixes
- Added BloxbizConfig event collection for future real time status
SDK Version 21 Released (09/15/22)
- Fixed high resolution static ads being cut after playing GIF or video ads
- Fixed video audio control not working when in first person
- Fixed impression detection stopping if character dies while looking at a billboard
SDK Version 20 Released (08/31/22)
- Video Ads release (Optional: Update plugin for best workflow)
- Batch remaining event data when server shuts down
SDK Version 19 Released (07/28/22)
- Super Biz Catalog
- Added new PublicAPI for runtime interaction
- Fix for infrequent corrupted engagement data
SDK Version 18 Released (07/11/22)
- Added ability to update ads without publishing game through use of DataStores - requires updating plugin to latest version
SDK Version 17 Released (06/28/22)
- Fixed issue where ads werenโt delivering in certain cases
- Added ability to collect game join events
- Added ability to collect game teleport events
SDK Version 16 Released (06/23/22)
- Added support for GIFs via spritesheets
- Fixed 3D ads dynamic loading at server start race condition
- Fixed rare frequency capping datastore save error race condition
SDK Version 15 Released (06/08/22)
- Changed print debug statements flag default to false
- Changed API endpoint domain
SDK Version 14 Released (06/02/22)
- Print statements moved behind debug flag
- Added backwards compatibility for older Bloxbiz Plugin
SDK Version 13 Released (06/01/22)
- Ad serving moved to SDK side to be compliant with Roblox new ToS
- Added any orientation functionality for 3D ads
SDK Version 12 Released (04/07/22)
- Major 3D ads performance optimizations
- Minor 2D ads performance optimizations
- Fixed memory leak when both 2D and 3D ads were both enabled
SDK Version 11 Released (03/30/22)
- Fix bug where โPaid Adโ disclaimer flickers with GIFs
- Fix soft lock race condition when character dies during NPC interaction
SDK Version 10 Released (03/29/22)
- New 3D ads: static models and interactive characters
- Fixed ad initialization bugs for analytics only users
SDK Version 9 Released (01/09/22)
- Added support for Sales Revenue reports
SDK Version 8 Released (10/20/21)
- Added support for localized ad disclaimers based on player's language
SDK Version 7 Released (9/23/21)
- Fix Gif flickering in certain games/scenarios
- Fix race condition that could cause 2 gifs to play at the same time
SDK Version 6 Released (9/10/21)
- Fix GIF flickering bug (happened in rare occasions)
SDK Version 5 Released (8/2/21)
- Updated Ad Disclaimer - "Bloxbiz Ad" โ> "Paid Ad"
- PolicyService API Check - In accordance with Roblox ToS, we check the Policy Service API before showing ads with external link references
- GIF Ads Beta - Features to enable GIF Ads are included in this version of the SDK. GIF Ads are disabled by default and are opt-in. More information to come soon.
SDK Version 4 Released (6/28/21)
- SDK will now be updated via the Bloxbiz Plugin (https://www.roblox.com/library/6963317097/BloxbizPlugin). Make sure to install the plugin to get access to the latest version of the SDK.
- [BREAKING CHANGE] The folder itself has been renamed from "BloxbizAds-Dev" to "BloxbizSDK", if you're dynamically loading parts, you may need to update this reference
- [Bug Fix] Fixed an issue causing impression tracking to fail while the camera is in first-person
- [Minor Change] Version numbers have changed from decimal to int to simplify upgrading and resolve issues with decimal rounding.