Integrate API keys
API keys enable Unity to verify purchases and ensure campaign accuracy. You can integrate your API licensing keys with either of the Unity Ads dashboards:
- Monetization dashboard: Integrate in your project Settings under Acquire Optimization.
- User Acquisition dashboard: Integrate during campaign creation.
Integrate API Keys in the Monetization dashboard
To enter the API key in the Monetization dashboard, go to the Settings page, and do the following, depending on your app platform:
App platform | Integration procedure | Notes |
---|---|---|
iOS | Select the edit pencil icon next to Apple App Store to enter your Private API key. | For more information about Apple’s Private API keys, refer to Creating API keys to authorize API requests in the Apple Developer documentation. |
Android | Select the edit pencil icon next to Google Play Store to enter your License key. | For more information about Google’s License keys, refer to Find and troubleshoot your license key in the Android Developer documentation. |
You can also integrate your licensing keys using the Unity Monetize Manage API. Refer to the Set Google Acquire Optimization API Keys documentation in the Unity Services Web API Docs for more information.
Integrate API Keys in the User Acquisition dashboard
You can integrate your API Keys in the User Acquisition dashboard in the following places:
Integration location | Details | Notes |
---|---|---|
Apps page | Select the ellipses (...) next to any app on the Apps page and select Edit API key to enter your key. | |
Campaign creation | When you create a new campaign, the dashboard prompts you to enter your API key before naming your campaign. | The User Acquisition dashboard only prompts you to enter an API key for Android IAP (In-app Purchase) and Hybrid ROAS (Return on Ad spend) campaigns. |
Campaigns page | In the go-live list on the Campaigns page of the dashboard, you can select Add API key to enter your key. | The checklist displays for all campaigns that haven’t yet gone live. Only IAP and Hybrid ROAS campaigns include the step to add an API key. |