Bulletin: Unity Ads cost API integration update

For:
Marketers
Last update:

What's new

 AppsFlyer has an API integration with Unity that allows us to get cost data. The API is being updated soon. Therefore, you need to update your integration to continue getting Unity cost data.

Update date

August 6, 2024
What you need to know
  • Unity is introducing a new cost API integration.
  • The old cost API integration is able to get cost data until its sunset date of October 1, 2024.
What you need to do

You must update your credentials for the new Unity cost API integration to continue getting cost data after October 1, 2024.

The credentials required are:

  • Organization Core ID
  • Service Account Secret Key
  • Service Account Key ID

Follow our instructions in the following sections to update the Unity cost integration in AppsFlyer. The integration has 2 steps:

  1. Get the new Unity credentials.
  2. Update the Unity cost API integration by entering the credentials in AppsFlyer.

Unity cost API integration procedures

Integrating the Unity cost API requires 2 steps:

  1. Get the new Unity credentials.
  2. Update the Unity cost API integration by entering the credentials in AppsFlyer.

The steps are described in the following sections.

Get Unity credentials

The required credentials for the Unity cost API integration are:

  • Organization Core ID
  • Service Account Secret Key
  • Service Account Key ID

Note: It is recommended to create a new Unity service account to get the secret key and key ID. We provide instructions on how to do so below.

To set up a Unity service account and get the required credentials for the Unity cost API integration:

  1. Log in to your Unity Cloud account.
  2. From the left-side menu, go to Grow (Unity Ads User Acquisition) > Settings.
  3. Find, copy, and save the Organization Core ID.
    Example Organization Core ID: 5773102414648
  4. From the left-side menu, go to Grow (Unity Ads User Acquisition) > {} API Management and in the Stats API v2.0 section, click Service Account.
  5. Click + New to create a new service account.
  6. In the Keys section, click + Add key to create a key for the service account.
  7. Copy and save the Key ID and Secret key. Note: This is the only time you can access the secret key, so make sure you save it now!
    • Example service account secret key: b0de73b1-b3ad-4175-bf9b-4913a0ff83ec
    • Example service account secret key key ID: a0X_cqHiXH4ABPS1Qr9TCy6EJdvG8ql5
  8. In the Organization roles section, click + Manage organization roles.
  9.  Under Edit roles in organization, set Growth to Advertise Stats API MMP Viewer.

Update Unity cost API integration in AppsFlyer

To update the Unity cost API in AppsFlyer:

  1. In AppsFlyer, from the side menu, select Collaborate > Active Integrations, and select Unity.
  2. Click Manage integration.
  3. Open the integrated partner Cost tab.
  4. Turn on the Get Cost Data toggle. The requirements to connect to the partner display.
  5. Enter your Unity credentials.
  6. Click Save Cost.
  7. Click Test Connection.
    • The API is active. AppsFlyer collects data from the partner 6 times a day, on average once every four hours.

Learn more about connecting cost integrations