Migrate to the New Unity Dashboard using the Ads Unified Platform public API
Migrate your Manage API (legacy) integration to the Ads Unified Platform public API to move your production account to the New Unity Dashboard without losing programmatic capability.
읽는 시간 7분최근 업데이트: 6일 전
The Ads Unified Platform public API is the latest version of the Manage API (legacy). It gives you a supported path to migrate from the previous Unity Dashboard experience (to be deprecated) to the New Unity Dashboard without losing any programmatic capability you rely on.
Migration is customer-initiated. Unity doesn't move your organization to the New Unity Dashboard until you submit a support ticket requesting migration. Manage API (legacy) keeps working for your organization until then, and Unity doesn't deprecate the API platform-wide until every organization migrates.
If you use the Manage API (legacy) to manage your endpoints programmatically, update to the Ads Unified Platform public API before you move to the New Unity Dashboard. The following table details the endpoint updates for Monetization and User Acquisition customers:
User type | Dashboard | Managed endpoints |
|---|---|---|
| Publishers | Monetization |
|
| Advertisers | User Acquisition |
|
중요
After you submit your migration request and your organization migrates, Manage API (legacy) stops working for your organization immediately. If you rely on automations or continual optimizations built on Manage API (legacy), such as bid or placement adjustments, update to the Ads Unified Platform public API before you request your migration. Otherwise, those automations stop running when your organization moves to the New Unity Dashboard, which might affect your revenue.
To migrate to the New Unity Dashboard with the Unified Platform public API, complete the following workflows:
Workflow | Steps |
|---|---|
| Testing and validation |
|
Migration request and setup 중요 You must complete the test and validation workflow before you start migration |
|
Test and validate your migrated API integration
Before you migrate to the new dashboard experience, create a test organization, service account, and API key. Use this test environment to validate your API integration functions correctly with the New Dashboard experience.
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.
To use the User Acquisition endpoints, someone on your team must have the Manager role in the User Acquisition dashboard.
Test your migrated API integration
Create a test organization
To create a new organization to test your Ads Unified Platform public API integration in the legacy Unity Dashboard, do the following:
- From the top navigation of the dashboard, select your current organization, then select Switch organization > + New.
- Enter an organization name for your test organization.
- Select your organization type and enter your credentials.
- Click Create.
Create a test service account
Create a service account in the legacy Unity Dashboard to authenticate your API calls.
Preresuisites
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.
To create a service account in the legacy Unity Dashboard, do the following:
To create a test service account and add advertiser-specific roles to it, do the following:
- From the top navigation of the dashboard, select your account’s current organization >** Manage organization** to open the Organization Settings page.
- From the left navigation, go to Administration > Organization > Service Accounts.
- Select + New to create a test service account.
- Enter your test service account name and description, then click Create.
- From the test 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.
Generate an API key for your test organziation
After you create a service account, create an API key to authenticate your requests from the Unity Dashboard for your test service account.
To generate your API key, follow these steps:
- Go to the Keys section of your new service account.
- Select + Add key to create your API key. This key authenticates requests from your test organization.
중요
The 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.
Validate your Ads Unified Platform public API integration
After you create a service account and generate an API key, replicate your existing Manage API (legacy) workflows in the test organization to confirm that Ads Unified Platform public API supports your current workflows.
참고
The Ads Unified Platform public API only supports bidding placements. Waterfall placements are deprecated. If your current integration manages waterfall placements, you must transition them to bidding.
Alternatively, if Unity Ads is your only ad provider, migrate from Unity Ads to LevelPlay. If you use Unity Ads as part of a mediation stack, set up Unity Ads as a bidder instead.
Where possible, duplicate your current production setup and configurations (including apps, placements, and campaigns) inside your test organization. Mirroring your live environment makes it easier to confirm parity, which enables you to resolve any issues before you migrate.
If you use an LLM coding agent to assist with your migration, refer to the following coding agent guides:
LLM reference | Migration path |
|---|---|
| Publisher Public API LLM reference | From |
| Advertiser Public API LLM reference | From |
Refer to the following public API reference to ensure you map your use cases correctly:
- Publishers: Ads Unified Platform publisher public API
- Advertisers: Ads Unified Platform advertiser public API
Request and configure your API migration
After you validate your API integration, you can request your migration to the New Unity Dashboard.
Prerequisites
Before you migrate your production account, you must validate your Ads Unified Platform public API integration.
Request migration to the New Unity Dashboard
After you complete your test, migrate your production account to the New Unity Dashboard. Production account migration moves your existing configuration (for example, your apps, placements, campaigns, and other endpoints) and historical data to the New Unity Dashboard.
The Unity Ads Support team oversees and manages the migration of your production account to the New Unity Dashboard. When you’re ready to start migration, submit a ticket to start your migration request.
Prerequisites
Before you migrate your production account, you must validate your Ads Unified Platform public API integration.
Submit a migration request ticket
To submit a migration request ticket to the Unity Ads Support team, follow these steps in the New Unity Dashboard:
중요
Migration is irreversible. When migration is complete, Manage API (legacy) stops working immediately, and any automations or optimizations stop until your integration uses Ads Unified Platform public API. Ad delivery isn't affected.
- Go to the Unity Support portal.
- Select the Migrate to the New Dashboard Experience ticket type.
- Enter the required information, including your name, organization ID, and organization role (whether you're an Owner).
- Submit the ticket.
- Support will confirm your migration time and date. You must confirm receipt of this message, or your migration won't proceed.
Complete post-migration configurations
After the Unity Support team completes your migration, you must complete the following post-migration setup tasks:
- Create a production service account.
- Generate a production API key.
- Confirm that API calls work in the production workflows of your active organization.
참고
Reverting your setup to the old dashboard isn't supported. Complete all fixes and debugging using the new APIs.
Create a production service account
After migration, you must create new service accounts for your active organization (separate from the test service accounts you created in your test organization) for the Ads Unified Platform public API. Use the new service account in your production API calls so your validated API workflows reflect your live organization.
To create a service account for the New Unity Dashboard, follow these steps:
To create a service account from the User Acquisition Dashboard and add advertiser-specific roles to it, follow these 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.
Generate a production API key
With your new service account, generate an API key to authenticate your requests from the Unity Dashboard. To generate your key, follow these steps:
- From the new service account you created, go to the Keys section.
- Select + Add key to create your API key. Doing so replaces the test key and the test service account in your validated API workflows with the new API key and the new service account tied to your live organization.
중요
The 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.
Confirm API calls work in production
Verify your API calls return correct data and responses for your live apps, placements, campaigns, and other endpoints. Make any needed changes, such as swapping API keys, so your API calls align with your real, active organization, not your test organization.
If you notice any gaps or unexpected behavior in your API calls after migration, debug and fix them using the new Ads Unified Platform public API, not the legacy API.
참고
Reverting your setup to the old dashboard isn't supported. Complete all fixes and debugging using the new APIs.
Contact your account manager or Unity Support if you need help resolving issues or implementing the new APIs.