Set up measurement for Xbox games

This guide walks you through the process of setting up a Xbox gaming app in Adjust, establishing a secure Server-to-Server (S2S) API connection, and effectively managing links for successful attribution measurement. Your users can download your game using the Microsoft store.

Here is what you need to do to set up measurement for Xbox games:

  1. Set up a new app in AppView.
  2. Set up the Adjust's S2S API to start recording sessions.
  3. Set up links in Campaign Lab.

Set up your app

To add and set up an Xbox app, follow these steps:

  1. Under AppView, select All apps.
  2. Select New app.
  3. Under Enter your app details, enter the app name, choose your reporting currency, and check if your game needs to comply with:
    • COPPA compliance. Applies for companies in the US only. To learn more about COPPA see our article on COPPA compliance.
    • Google DMA. Applies for apps that have their user base outside of the European Economic Area (EEA) only. To learn more about DMA see our article on Google DMA.
  4. Select Add app.
  5. Select Add platform to connect a platform to your game.
    1. Select Console > Xbox.
    2. Enter the App ID or select I don't have an App ID yet to enter it later. A simple way to get the App ID is by looking at the game’s store URL. For example: https://www.xbox.com/games/{APP_ID}.
    3. (Optional) Turn on Redirect all clicks to a custom URL and enter a Custom URL, if you want your users to go to a custom website instead of Microsoft's store. We recommend this if your app does not have an App ID.
    4. Select Save.
  1. On the Events tab, add an in-app event name to measure user activity in your game.
  2. On the Attribution settings tab, set attribution settings (for device matching, probabilistic modeling, and temporary attribution) and reattribution settings.
    • Make sure that probabilistic modeling is enabled for both clicks and impressions. It is highly recommended to set the attribution window for probabilistic modeling to 24 hours, but you can choose to set it for up to 90 days. The 90-day attribution window is available only for PC and Console platforms.
  3. On the Data management tab, set up server callbacks or cloud storage uploads to receive raw, user-level data, or use the Testing console to see test device data.
  4. On the Protection tab, set up S2S security as you'll need the token in the S2S API setup.

Set up the Adjust S2S API

<Draft or missing fragment>

ParameterData typeInDescription
s2s*StringQueryMust always be sent as 1.
Server-to-server parameter: allows Adjust servers to recognize server-side activity.
app_token*StringQueryUnique authentication token for your app
os_name*StringQueryUse xbox
`ip_address*StringQueryDevice IP address
created_at*TimestampQueryTimestamp of local device, creation of the package including timezone.
external_device_id*StringQueryUnique platform ID. Use xuid

Request example

cURL
curl -X 'POST' -d 's2s=1&app_token=a1234b2x3a4o&ip_address=0.0.0.0&created_at=2018-03-23T09:46:47.288Z-0400&sent_at=2018-03-23T09:46:47.288Z-0400&external_device_id=099aa0bc' -H 'Authorization: Bearer ADD_YOUR_AUTH_TOKEN_HERE' -H 'User-Agent: Adjust Streaming Job (akka-http)' 'https://s2s.adjust.com/session'

If you want to learn how to record events using the S2S API, visit Server-to-server (S2S) events.

Set up links

After you have set up and tested the S2S API integration between your app’s server and Adjust, you need to connect Adjust to the ad network you are running your campaign with.

Using links means that you can record attribution when users engage with your ad on other devices, for example watching an ad on their mobile phone or on a CTV, and later installing the game on PC. Here are two example of networks for web campaigns:

In Campaign Lab, follow the setup steps below.

  1. Under Campaign Lab, select Partners.
  2. Select New partner.
  3. In the Partner selection screen, choose the ad network that you want to set up.
  4. In the App selection screen, choose the app for which you want to create the link.
  5. (Optional) In the Data sharing screen, configure the integration between your network and Adjust, and choose data sharing options.
  6. In the Link structure screen, review the default link structure parameters provided by the network and update the values, if needed.
  7. (Optional) In the User destinations screen, configure a deep link, or add a redirect and fallback to your link.
    • If you want to redirect users to a particular game store, make sure to include the URL as an additional redirect parameter.
  8. (Optional) In the Attribution settings screen, set custom attribution settings for new and existing users. These attribution settings are available for clicks and impressions. If you skip this step, attribution settings that you chose during app setup will apply.
    • Make sure that probabilistic modeling is enabled for both clicks and impressions. It is highly recommended to set the attribution window for probabilistic modeling to 24 hours, but you can choose to set it for up to 90 days. The 90-day attribution window is available only for PC and Console platforms.
  9. In the Setup review screen, review your choices, and make any changes as necessary.
  10. Select Create link to generate the click URL, impression URL, QR code, and link token, and enable data sharing, if set up.