Get started with the Ads Unified Platform public API
Set up an organization, service account, and API key to start managing your apps, placements, or campaigns programmatically with the Ads Unified Platform public API.
Read time 2 minutesLast updated 7 days ago
The Ads Unified Platform public API is the latest version of the Manage API (legacy) for the Unity Monetization and Unity User Acquisition dashboards.
While you can manage your apps, placements, and campaigns directly in the Unity dashboards, the Ads Unified Platform public API enables you to manage your endpoints programmatically instead. The following table details the endpoints you can manage with the API:
Dashboard | Managed endpoints | Benefits |
|---|---|---|
| Monetization |
| Create and update placements in bulk instead of one at a time. These endpoints are useful if you regularly launch new apps, add placements, or adjust test devices across different ad formats. |
| User Acquisition |
| Automate changes instead of making them one at a time in the dashboard. These endpoints are useful if you manage a large number of campaigns or need to make frequent updates. |
To get started with the Ads Unified Platform public API, complete the following setup tasks:
- Prerequisites
- Create an organization
- Create a service account
- Generate your API key
- Implement the Ads Unified Platform public API
Prerequisites
Before you get started with the Ads Unified Platform public API, ensure someone on your team has the Organization role for your dashboard in the Unity dashboards.
Advertisers
To use the User Acquisition endpoints, someone on your team must have the Manager role in the User Acquisition dashboard.
Publishers
To use the Monetization endpoints, someone on your team must have the Owner role in the Monetization dashboard.
Create an organization
Create an organization to manage your endpoints in the Ads Unified Platform public API.
Refer to Create an organization to set one up, and other Organizations articles to manage or update your organization after you create it.
Create a service account
Create a service account from the Unity Dashboard to authenticate your API calls.
Advertisers
To create a service account from the User Acquisition dashboard and add advertiser-specific roles to it, complete the following steps:
- Go to the User Acquisition dashboard > Settings > Organization > Manage organization > Service accounts > + New.
- Select + manage organization roles.
- Enter a service account name and service account description.
- From the new service account page you created, go to the Organization roles section > + Manage organization roles.
- From the organization roles dialog, go to the Grow dropdown, then select all the Advertise API roles in the list to add to your service account.
Publishers
To create a service account from the Monetization dashboard and add publisher-specific roles to it, complete the following steps:
- Go to the Monetization dashboard > Settings > Organization > Manage organization > Service accounts > + New.
- Select + manage organization roles.
- Enter a service account name and service account description.
- From the new service account page you created, go to the Organization roles section > + Manage organization roles.
- From the organization roles dialog, go to the Monetization dropdown, then select the following Publisher API roles to add to your service account:
- Ads Publisher Automation
- Ads Publisher Test Devices Automation
Generate your API key
To create an API key to authenticate your requests from the Unity Dashboard, do the following from your new service account:
- Go to the Keys section of your service account.
- Select + Add key to create your API key.
ImportantThe dashboard displays secret keys only once, so store the Key ID and Secret securely together for your reference later. If you lose the key values, you must create a new key.
- Select Done.
Implement the Ads Unified Platform public API
Refer to the following API reference to build your integration.
- Publishers: Ads Unified Platform Publisher Public API
- Advertisers: Ads Unified Platform Advertiser Public API