Integrating with ByteBrew enables you to keep track of installs and receive post-install event postbacks for your ad campaigns. For the most up-to-date ByteBrew integration information, consult the ByteBrew Developer Hub.
To activate the integration between Unity and ByteBrew, complete the following tasks:
- Create a Service account in the Unity Ads User Acquisition dashboard.
- Create API keys in your dashboard service account settings.
- Complete the integration workflow in the ByteBrew dashboard.
Prerequisites
- Add at least one app to the Unity Ads User Acquisition dashboard.
- Initialize the ByteBrew SDK in your app. Refer to ByteBrew's Unity SDK integration guide for detailed initialization instructions.
Create a Service account
A service account enables you to programmatically use the Unity Advertising Statistics API with your ByteBrew integration. To create a Service account, do the following in the Unity Ads User Acquisition dashboard:
- From the left navigation menu, select API Management.
- In the Stats API v2.0 section, select Service account.
- From the upper right corner of the Service Accounts page, select + New to open the Create service account dialog and create a new service account.
- Enter the Service account name and Service account description. Refer to the following name and description examples:
- Service account name: ByteBrew attribution
- Service account description: ByteBrew attribution campaign metadata pull
- Select Create to save your settings and add the new service account to the list in the Service Accounts page.
Create API keys
To enable programmatic data-sharing from the Unity Stats API in your ByteBrew integration, you need to create two API keys in your Service account settings: a Key ID and a Secret Key.
To create these keys, do the following in the Organization > Service accounts settings of the Unity Cloud dashboard:
- Find and select the service account you previously created. You can use the search bar to locate the account.
- In the Keys section, select + Add key to generate your keys and open the New key has been created dialog.
- You need both the Key ID and Secret key from this dialog to complete your integration in the ByteBrew dashboard. Copy both keys.
- Select Done to close the dialog.
Complete the ByteBrew integration workflow
The following article discusses products or services (“Third-party Products”) not developed, owned, or operated by Unity. This information might be outdated or incomplete and is provided for your convenience. Your use of any Third-party Product is subject to its own terms. Unity makes no warranties regarding these products and isn't liable for any damages or losses arising from their use, including issues related to content, advertising, or materials from Third-party providers.
After creating a service account and API keys in the Unity Cloud dashboard, go to the ByteBrew dashboard and do the following to complete your integration setup:
- Select your app from the dashboard navigation menu.
- Go to Attribution > Network Settings and find UnityAds from the list of networks.
- Next to UnityAds, select Setup to open the Add Ad Network dialog.
- Complete the Network Settings fields. Refer to the following tabs for instructions on where to locate these values in the User Acquisition dashboard:
- Go to the API Management page.
- Copy the API Key in the Stats API v1.0 section.
- Go to the Apps page and select the app you're integrating from the list of apps.
- Copy the Game ID listed at the top of the Campaigns page for your app.
- Go to the Settings page.
- Copy the Organization ID from the Organization section of your settings.
- Go to the Settings page.
- Copy the Organization core ID from the Organization section of your settings.
- Select Next to progress to the Install Settings* tab of the dialog.
- To enable view-through attribution, select the Enable view through tracking checkbox and configure the view-through lookback window. ByteBrew generates Click-through attribution links by default.
- Configure your attribution lookback windows in the following Install Settings fields:
| Install setting | Required | Configuration | Notes |
|---|---|---|---|
| Click-Through Window | Yes | Use the Days selector to set the number of days an install can be attributed after a user clicks on your ad. | The maximum click-through lookback period is 30 days. The recommended best practice is to set the click-through setting to seven days or more for accurate attribution. |
| View-Through Window | No | Use the Days selector to set the number of days an install can be attributed after a user watches your ad. | The maximum view-through lookback period is seven days. The recommended best practice is to set the view-through setting to one day or more for accurate attribution. |
For more information about attribution lookback options, refer to the Attribution lookback settings section of the ByteBrew data-sharing reference.
- In the Send all install events from section, choose whether to pass engagement data from all of your app's installs (including unattributed) or just those attributed to Unity. Choose from the following options:
- Only this partner
- All Partners and Organics
- This Partner and Organics For more information about the install data source options, refer to the Attribution data sources section of the ByteBrew data-sharing reference.
- Select Next to progress to the Postback Settings tab of the dialog.
- To add a post-install event you want to pass to Unity, select + Add Postback Event and choose from the following options:
- Ad Watched Event
- User App Open Event
- In-App Purchase Event For more information about the postback event options, refer to the Post-install event data-sharing section of the ByteBrew data-sharing reference.
Don’t define a new user event in your app code. ByteBrew tracks new user events by default using the User App Open Event option. For more information, refer to the ByteBrew Developer Hub Attribution documentation.
- In the Postback Events Settings section, choose whether to pass post-install event data from all of your app's installs (including unattributed) or just those attributed to Unity. Choose from the following options:
- Send only from this partner
- Send from all Networks and Organics
- Send only from this Partner and Organics For more information about the post-install event data source options, refer to the Postback data sources section of the ByteBrew data-sharing reference.
- On the final tab of the network setup dialog, you can copy your attribution links. For instructions on how to integrate these URLs in the User Acquisition dashboard, refer to Integrate attribution links with Unity.
- Select Finish to complete the integration.