Unity

Learn how to integrate ByteBrew's light-weight Unity SDK for Mobile and Web Games.

Unity SDK Integration

Follow the steps below to integrate the ByteBrew SDK or watch the tutorial video for a step by step walkthrough:

infoNote ByteBrew supports Android 5.1 and above & iOS version 9.0 and above. ByteBrew SDK is compatible with iOS 14 updates.

Step 1

Import ByteBrew SDK

Import ByteBrew Unity SDK to your project.

(Android Only) If you don't use Auto-Resolve on your External Dependency Manager, then after importing the SDK, go to Assets, find External Dependency Manager, select Android Resolver, and click Force Resolve.

Step 2

Create ByteBrew Object

Create the ByteBrew GameObject by following the steps below:

Go to Window

Select ByteBrew

Choose "Create ByteBrew GameObject". Make sure to place GameObject in your first scene.

notification_importantImportantPlace your game object on the first scene of your game. ByteBrew SDK does not support offline event caching.

Step 3

Enable Platforms

To enable platforms:

Go to Window

Select ByteBrew

Choose "Select ByteBrew settings"

Enable which platforms (iOS, Android and Web) you want to track on the Unity ByteBrew settings inspector panel.

Step 4

Go to your ByteBrew Dashboard

Go to your Game Settings page on the ByteBrew dashboard and locate your game keys listed on the dashboard. After finding your Game IDs and SDK Key, copy them.

Step 5

Input Game Keys and SDK Key into Unity

Now that you've located your Game IDs and SDK Key, input the platform specific Game IDs and SDK Key from your game on the ByteBrew dashboard into the Unity ByteBrew settings inspector panel.

infoNote When updating the ByteBrew SDK, make sure to re-input your Game Keys and SDK Key after updating.

Step 6

Initialize ByteBrew

After inputing your Game IDs and SDK Key, initialize ByteBrew using the code below at the beginning of your game to start capturing sessions and events:

                                
                                
                                
                                // Initialize ByteBrew
                                ByteBrew.InitializeByteBrew();

Step 7

iOS Only (Optional) - Call ByteBrew's App Tracking Transparency (ATT) wrapper

ByteBrew offers our own ATT Handler, so you do not have to call native code in your unity application.

infoNote If you are using ByteBrew attribution call this method before initializing the ByteBrew SDK.

If you use our ATT Handler, you must do the following in your info.plist:

Use the Xcode Property List Editor to add: Privacy - Tracking Usage Description.

In the value string field enter a sentence or statement for the reason behind you tracking request.

                                
                                
                                
                                // Call ByteBrew ATT Wrapper
                                ByteBrew.requestForAppTrackingTransparency((status) =>
                                {
                                    //Case 0: ATTrackingManagerAuthorizationStatusAuthorized
                                    //Case 1: ATTrackingManagerAuthorizationStatusDenied
                                    //Case 2: ATTrackingManagerAuthorizationStatusRestricted
                                    //Case 3: ATTrackingManagerAuthorizationStatusNotDetermined
                                    Debug.Log("ByteBrew Got a status of: " + status);
                                    ByteBrew.InitializeByteBrew();
                                });

Step 8

Exporting iOS Requirements

To export for iOS, ByteBrew requires the following three (3) iOS Frameworks:

Security.Framework

AdServices.Framework

AdSupport.Framework

Each of these listed frameworks should be implemented in your final xcode project as frameworks.

Custom Events Tracking

tag Watch Video play_circle

Custom Events in ByteBrew enable you to deep dive across all of our extensive analytics dashboards. Continue below to learn how to integrate custom events.

Custom Events on ByteBrew allow for an unlimited number of key_name=value; sub-parameters under the custom event. For example, you can have a custom event called “level” that has a subparameter under the event named “levelnumber” and the values of that Level Number subparameter could be “1, 2, 3, 4, 5, etc.”. Additionally you could add in other subparameters for attributes inside the levels of your game, such as "powerups", to show the different equipment used in levels with parameter values "fireball, revive, doublepoints, etc.". The world is your oyster with custom events, so build as complex of an event system as you need for your game. To illustrate our custom event structure visually, see the following diagram:

notification_importantImportant Do not replicate or copy/paste event structures from other analytics providers to ByteBrew, this will lead to malformed event reporting. Follow ByteBrew's event structure in the following documentation.

Custom Events

See samples below to see how to code Custom Events:

notification_importantImportant Do not use special characters, such as (1) spaces, (2) periods ".", or (3) colons ":" in your custom events or parameters. As an alternative to spaces in custom events, use "_". Ex. "key_name=value;".

Custom event names and parameters that include special characters will not be processed on the dashboard. These events are unrecognized by ByteBrew and antipattern to ByteBrew's event structure.

Basic Custom Event:

                                
                                
                                    //Basic Custom Event without any sub-parameters
                                    ByteBrew.NewCustomEvent("eventName");

Dictionary Custom Event Tracking Method:

To easily add additional custom sub-parameters to an event you can use the dictionary method below:

infoNoteNote: This method is only available on SDK 0.1.2 and higher

                                
                                    //Custom Event Dictionary Example with sub-parameters
                                    var eventParameters = new Dictionary<string, string>()
                                    {
                                        { "key_name", "value" },
                                        { "key_name1", "value1" },
                                        { "key_name2", "value2" },
                                        { "key_name3", "value3" },
                                        { "key_name4", "value4" },
                                        { "key_name5", "value5" }
                                    };
                                    ByteBrew.NewCustomEvent("eventName", eventParameters);

                                    //Example Event
                                    var mapCheckpointParameters = new Dictionary<string, string>()
                                    {
                                        { "earned", "KARMA" },
                                        { "amount", "250" },
                                        { "character", "Hunterwizard" },
                                        { "selectedPowerup", "ExtraArrow" },
                                        { "level", "32" },
                                        { "runDeathCount", "2" }
                                    };
                                    ByteBrew.NewCustomEvent("MapCheckPointHit", mapCheckpointParameters);

Custom Event Tracking Method:

                                
                                
                                    
                                    //Custom Event Format with sub-parameters
                                    ByteBrew.NewCustomEvent("eventName", "key_name1=value1;key_name2=value2;key_name3=value3;key_name4=value4;");

                                    //Example Event
                                    ByteBrew.NewCustomEvent("LevelStarted", "level=25;character=AlienSpaceMan;weapon=megablaster;powerup=extralife;");

Remote Configs & A/B Tests

tag Watch Video play_circle

Remote Configs allow you to make updates to your app remotely without having to update your game's app store. Adding remote configs to your games are a fantastic way to be agile and send updates or patches to players instantly. Remote Configs are also utilized for creating A/B Tests on the platform.

When planning to integrate Remote Configs, We recommend implementing remote configs throughout all parts of your game to allow you to tweak and tune as you analyze your game performance data. See how to implement remote configs in your game by watching the tutorial video or following the steps below:

infoNote If you are calling to get/update Remote Configs in the same scene as your ByteBrew initialization, it's recommended to use the IsByteBrewInitialized callback in the SDK to determine if the ByteBrew SDK has finished initialization before calling to get/update Remote Configs.

notification_importantImportant Do not spam config calls in your app code. Apps that spam remote configs calls with behavior such as: calling configs each game frame, or rapidly firing multiple calls per user will be auto flagged and potentially paused.

Loading the Remote Configs

To use Remote Configs, you must first call for the config to get updated. You can call the below code whenever you want to update the configs:

                                
                                
                                    
                                    
                                //Call the Action handler 
                                ByteBrew.RemoteConfigsUpdated(() =>
                                {
                                    //Do Whatever you want here once the config is updated
                                });

                                //Check if the remote configs are ready and set
                                ByteBrew.HasRemoteConfigsBeenSet();

Retrieve the Configs

Once the action handler has finished, you can call the remote config method below:

infoNote Additionally, you can grab A/B Test keys and values using this method. If the user is part of the control group it won't return anything but the default parameter value set.

                                
                                
                                    
                                    
                                //Call to get the key specific value and if the key doesn't exist it will return the default variable specified, like if the AB test user is in the control group
                                ByteBrew.GetRemoteConfigForKey("dailyWeapon", "goldRevolver");

Push Notifications

tag Watch Video play_circle smartphoneMobile Only

Using ByteBrew you can send cross-platform push notifications to your players around the globe. To get started with push notifications follow the steps below or watch the tutorial video series.

infoNote If you are using Push Notifications in ByteBrew, you must first call InitializeByteBrew before calling StartPushNotification.

notification_importantImportantIn addition to setting up Push Notifications in the SDK, there is additional setup required on the ByteBrew dashboard to get up and running. Visit the Push Notifications documentation page for all the steps to get step.

Step 1

Integrate Push Notifications

Integrating Push Notifications with ByteBrew is super simple and only requires one line of code after initializing the ByteBrew SDK. See the Push Notification integration code line below:

                                
                                
                                    
                                    
                                
                                ByteBrew.StartPushNotifications();

Step 2

Create Push Notification App on the ByteBrew Dashboard

Go to the Push Notification dashboard on ByteBrew and create a new Push Notification App. See our Push Notification Dashboard documentation for step by step walkthroughs about this.

infoNote In order to create a push app, you must first create an game or app on the ByteBrew dashboard.

Push Notification Android Manifest (Required Android Only)

notification_importantImportantIf your app targets Android API Level 33 and above, make sure your implement this manifest permission.

                                
                                    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>

Push Notification Xcode Export Additions (Required iOS Only)

For sending notifications to iOS devices, follow the additional required steps below on Xcode:

infoNote For the best step by step walkthrough on push notification integration, watch the video tutorial series on the ByteBrew Youtube Channel.

Step 1

Add UserNotifications.framework

Add UserNotifications.framework to the frameworks and libraries in Xcode.

Step 2

Add Capabilities

Press "+ Capability" and add the following capabilities listed in steps 3 and 4 below.

Step 3

Add "Background Modes" and under that section, checkmark "Remote Notifications

Step 4

Add "Push Notifications"

Track Purchases

tag Watch Video play_circle smartphoneMobile Only

In ByteBrew SDK you can track all your game or apps in-app purchases to analyze your monetization performance on the dashboard. There are two ways to track purchases on ByteBrew. The first way is to use basic in-app purchase events. The second way is to use our real-time server-side purchase validation to validate real purchases vs. fraudulent transactions. See below to learn how to implement either method or watch our tutorial video.

Track Validated Purchases

On ByteBrew, we offer a real-time server-side purchase validation to stop purchase fraud from client-side purchase receipt tampering that takes place in mobile games and apps. To utilize this validation you have two options: (1) a method with a callback to retrieve if a purchase was valid and (2) a method just to validate purchases without a callback. Follow below sections for code snippets for each function:

infoNote To help avoid any common mistakes made during integration of purchases follow the below:

fiber_manual_record

You do not not need to use track using both the basic tracking purchase method and purchases validation methods. The purchase validation method also tracks purchases. Using both methods will cause your purchases to double.

Purchase Validation with Callback

To track validated in-app purchases utilize the platform specific method. Using this method will create a purchase callback that will return a payload with the purchases details and verification status. See below for the Return Results and message definitions:

notification_importantImportantMake sure the receipts have correct JSON string formatting.

                                
                                
   

                                //JSON Format ex. string json = "{\"firstname\":\"john\", \"lastname\":\"doe\",\"age\":30}";

                                //Retrieve the iOS receipt from the purchase event that occurs. We will validate it server side so you can view valid purchases in you dashboard.
                                string iosReceipt = "...";
                                ByteBrew.ValidateiOSInAppPurchaseEvent("Apple App Store", "USD", 1.99f, "NoAds", "NoAds", iosReceipt,
                                    purchaseResultData => {
                                        Debug.Log("ByteBrew Purchase Processed: " + purchaseResultData.purchaseProcessed);   //bool telling if the purchase even went to the server to get checked
                                        Debug.Log("ByteBrew Purchase Is Valid: " + purchaseResultData.isValid);              //bool signaling if the purchase is real or fake
                                        Debug.Log("ByteBrew Purchase Message: " + purchaseResultData.message);               //Message from the server telling the explaination behind the decision
                                        Debug.Log("ByteBrew Purchase timestamp: " + purchaseResultData.timestamp);
                                    });

                                //Retrieve the Android receipt and Signature from the purchase event that occurs. We will validate it server side so you can view valid purchases in you dashboard.
                                string googleReceipt = "...";
                                string googleSignature = "...";
                                ByteBrew.ValidateGoogleInAppPurchaseEvent("Google Play Store", "USD", 1.99f, "NoAds", "NoAds", googleReceipt, googleSignature,
                                    purchaseResultData => {
                                        Debug.Log("ByteBrew Purchase Processed: " + purchaseResultData.purchaseProcessed);  //bool telling if the purchase even went to the server to get checked
                                        Debug.Log("ByteBrew Purchase Is Valid: " + purchaseResultData.isValid);             //bool signaling if the purchase is real or fake
                                        Debug.Log("ByteBrew Purchase Message: " + purchaseResultData.message);              //Message from the server telling the explaination behind the decision
                                        Debug.Log("ByteBrew Purchase timestamp: " + purchaseResultData.timestamp);
                                    });

Returned Results:

The following table are the possible returning results:

fiber_manual_record

purchaseProcessed: Boolean communicating if the purchase was processed by the server.

fiber_manual_record

isValid: Boolean telling if the purchase is Real or Fake.

Returned Results Message:

In addition to the Return Result you will also recieve a message. See below for possible output messages and their definition:

"Validation Successful, real purchase.": This means that the message as a real purchase.

"Validation Failed, fake purchase.": This means that the purchase is fake or fraudulent.

"Error validating receipt, check game configs.": This message means that there might be an issue with the implementation. Check to make sure that the purchaseProcessed boolean is True and go to your game settings on the ByteBrew dashboard to update your Apple App Shared Secret and Google Play License Key.

Purchase Validation without Callback

To track in-app purchases using our validation system without looking for the purchase callback, utilize the platform specific method code snippets below:

notification_importantImportantMake sure the receipts have correct JSON string formatting.

                                
                                
   
                                //JSON Format ex. string json = "{\"firstname\":\"john\", \"lastname\":\"doe\",\"age\":30}";

                                //Retrieve the iOS receipt from the purchase event that occurs. We will validate it server side so you can view valid purchases in you dashboard.
                                string iosReceipt = "...";
                                ByteBrew.TrackiOSInAppPurchaseEvent("Apple App Store", "USD", 5.99f, "currencyPack01", "Currencies", iosReceipt);

                                //Retrieve the Android receipt and Signature from the purchase event that occurs. We will validate it server side so you can view valid purchases in you dashboard.
                                string googleReceipt = "...";
                                string googleSignature = "...";
                                ByteBrew.TrackGoogleInAppPurchaseEvent("Google Play Store", "USD", 5.99f, "currencyPack01", "Currencies", googleReceipt, googleSignature);

Track Basic In-App Purchases

For cases where you are using your own in-app purchase validation, track in-app purchases in your game using the below method:

                                
                                
   
                                
                                ByteBrew.TrackInAppPurchaseEvent("Apple App Store", "USD", 5.99f, "currencyPack01", "Currencies");

Ad Tracking Event

tag smartphoneMobile Only

Using ByteBrew you can track your game's or app's ad events. Tracking Ad Events will enable you to see breakdowns of your ads in the monetization dashboard. See the code snippets below to learn how to track ad events:

infoNoteTracking Ad Events in the ByteBrew SDK is necessary for visualizing pLTV, make sure to utilize your monetization SDKs impression callback to get revenue.

                                
                                
                                // Record the Placement Type, Provider of the ad, ad unit name, and revenue of the impression
                                ByteBrew.TrackAdEvent(ByteBrewAdTypes.Interstitial, "Google AdMob", "Interstitial_Unit_Name", 0.00074145);
                                ByteBrew.TrackAdEvent(ByteBrewAdTypes.Reward, "Unity Ads", "Reward_Unit_Name", 0.005562);

                                //Add your ad units placement location in your game to breakdown your impression more.
                                ByteBrew.TrackAdEvent(ByteBrewAdTypes.Interstitial, "Google AdMob", "Interstitial_Unit_Name", "Interstitial_EndOfLevel", 0.0024145);

Data Attributes

tag smartphoneMobile Only

Data attributes are tags in the SDK that you can give a user to define them more specifically on the dashboard when filtering. For example, you can use data attributes to tag to users to build player segments to send targeted push notifications. If you are looking to update values on users at certain locations of your game, then use Custom Events with subparamters to track that type of update. See the following code snippets for examples on how to use Data Attributes:

infoNote Data Attributes should not be spammed or used to continuoisly update a set of values a single user. If our system detects or tracks that your game(s) are spamming this method, it will automatically turn off your Data Attribute tracking. See list for most common forms of spamming:

fiber_manual_record

Sending a high frequency of updates per second or per user.

fiber_manual_record

Using Data Attributes like Custom Events.

fiber_manual_record

Sending updates to Data Attributes in bulk by updating all attributes at once instead of one value that was changed.

fiber_manual_record

Sending unnecessary updates by updating data attributes with repeated values.

                                
                                
                                
                                ByteBrew.SetCustomUserDataAttribute("dundees", 3);
                                ByteBrew.SetCustomUserDataAttribute("loves_the_office", true);

Get User ID

tag

GetUserID method in the SDK enables you to grab the current User ID of the user in your game. This is a handy method for finding the ID for a user you want to send a specific push notification to.

                                
                                
                                
                                
                                // Get the string userID
                                ByteBrew.GetUserID();

Initialization Callback

tag

notification_importantImportantIt is not recommended to hold your game loading for this status of the ByteBrew initialization callback. This function is meant to run asynchronously in the background.

In the SDK, you can use an initialization callback to get a True/False boolean to determine if ByteBrew SDK has completed the initialization.

                                
                                
                                
                                ByteBrew.IsByteBrewInitialized();

Stop Tracking Current User

tag

In the ByteBrew SDK, you have the option to stop tracking any user in your game by calling the ByteBrew StopTracking method. This will immediately stop and disable any tracking for a user. As another alternative method to disabling tracking, you can build your own consent pop-up prompt screen in your game or app and delay the initialization of ByteBrew SDK until your user has consented/agreed to your prompt.

                                
                                
                                
                                
                                ByteBrew.StopTracking();

ProGuard Setup for ByteBrew SDK

tag smartphoneMobile Only

If you have ProGuard or Minify enabled in your game, add the following to your "proguard-user.txt" file.

                                
                                
                                
                                
                                
                                -keep class com.bytebrew.** {*; }

Updating ByteBrew SDK

tag Watch Video play_circle

Checkout how to update the ByteBrew SDK by watching our short 1 minute tutorial video or following the steps below:

infoNote Each time you update the ByteBrew SDK, you must follow these steps.

Remove the older ByteBrew SDK

Import the new ByteBrew SDK you're upgrading to.

Select ByteBrew Setting by clicking (1) Window, then (2) ByteBrew in the dropdown, then finally (3) select ByteBrew Settings

Re-input your SDK Keys for your game.

SDK FAQs

Why am I not seeing data after updating the ByteBrew SDK in my game?

Check to make sure that you've re-inputted your Game IDs and SDK Keys after updating the ByteBrew SDK.

What events does ByteBrew automatically track?

ByteBrew has standardized events that are automatically tracked such as: install events and session events. These events are used throughout the platform to automatically calculate out-of-the-box metrics like: session length, playtime, retention and more.

Does ByteBrew track offline users?

here are several reasons ByteBrew does not cache offline player data such as:
(1) App File Size: For games tracking many parts of their games, users playing offline will generate a significant file size of cached data that will inflate the app size on the device.
(2) Reduce App Crashes: If the storage of offline data becomes too large, the device will not be able to open the app on lower end devices and cause a potential app crash. ByteBrew is designed to make sure those issues do not exist for your game.
(3) Data Accuracy Tampering: Cached data from historical game session will get uploaded into the system the next time the user comes back online. This mean malicious users can tamper with your app's data, leading to potential issues with accurate reporting for you to operate from.

What could cause a 401 Error in my game code?

If you're receiving a 401 Error in your game code, re-confirm that you have correctly inputting all your game's information including: SDK Key, Game IDs, and Bundle ID.

What could cause a NoClassDefFoundError?

If you see a NoClassDefFoundError for a third party library (like Google Advertising ID), then use the External Dependency force resolve. However, if the class that is missing is a ByteBrew class, then check your ProGaurd settings.

Why am I not seeing Custom Events populate on the ByteBrew dashboard?

If you track custom events in the same scene you initialize the ByteBrew SDK, then there is a chance your custom events wont get tracked as the SDK might not be finished initializing. To solve this, use the Initialization callback in the SDK to determine when the SDK has finished initialization before tracking custom events.

Why am I not receiving Remote Configs?

If you call for remote configs within the same scene you initialize the ByteBrew SDK, then there is a chance your remote configs wont get loaded as the SDK might not be finished initializing. To solve this, use the Initialization callback in the SDK to determine when the SDK has finished initialization before calling remote configs.

What is the minimum OS versions required for ByteBrew SDK?

ByteBrew supports Android 5.1 and above & iOS version 9.0 and above.

Can I use two push notification providers at once?

No, you can only use one push notification service or provider to send notifications at one time. However, if you are only using ByteBrew for our other services, then you can use another platform's push notifications SDK while still using ByteBrew SDK without any issues.

Is there any callback needed for Push Notifications?

No, Push Notifications has it's own internal callback, so no other callback is necessary.

What is the minimum Android API version for ByteBrew?

API Level 22 (Android 5.1)

How long does it take for my Configs or my A/B Test to deliver to my players?

A/B Tests deliver configs using your Remote Configs integration. Remote Configs delivered in milliseconds to your players after the ByteBrew SDK is initialized.

Can I send event to ByteBrew using a server?

No, all events that can be sent to ByteBrew are only from our SDK.

Why do I get successful Purchase Validation without a callback?

As a first step, always check to confirm you're using the Purchase Validation Code that includes the Callback function. If you confirmed you are utilizing the purchase validation method with the callback, check for and remove any package, system, or code in your project that truncates or shortens your project's code base. These systems can remove code that ByteBrew requires to operate the validation process.

Should I convert revenue to USD?

Yes, whether tracking in-app purchases or using Custom Events that send revenue parameters, the revenue you send should be in USD.

Does ByteBrew Unity SDK support Web Games?

Yes! Use this integration page to see how to integrate ByteBrew with your Unity Web Game.

lightbulb Pro Tip Re-input your SDK Keys and Game IDs each time you update the ByteBrew SDK!