Documentation

Unity Ads Monetization

iOS API reference - Swift

iOS API reference - Objective-C

Unity Ads Monetization

Set up a custom consent solution

Implement a custom developer consent solution, whether you’re using a third-party mediator or mediating with Unity Ads exclusively.
Read time 1 minuteLast updated a day ago
The Unity Ads Privacy API provides three methods for communicating user privacy preferences:

Purpose

API method

Opt-in consent
setUserConsent()
Opt-out signal
setUserOptOut()
Child-directed or non-behavioral users
setNonBehavioral()
Important
As of SDK version 4.18.0, the UnityAds Privacy API enforces one authoritative signal per privacy framework, either the opt-in consent signal for opt-in privacy frameworks or the opt-out signal for opt-out privacy frameworks. Please consult Supported privacy frameworks to see which method is appropriate for which privacy framework. Signals from the non‑applicable API are not applied and the framework’s default behavior remains in effect.It’s your responsibility to ensure you have reviewed and fulfilled the prerequisites and using the latest version of the Unity Ads SDK when enabling developer consent.
For more information about the Unity Ads opt-in consent API, refer to the Unity Ads Privacy API reference for developers using Java, Kotlin, Objective-C, and Swift.
Tip
Call these methods after initializing the SDK to ensure the correct privacy behavior takes effect from the start of the session.
Use the following examples to communicate whether the user has granted or declined consent for targeted advertising. Use the following examples to communicate whether the user has granted or declined consent for targeted advertising. 
// If the user agrees to personalized adsUnityAds.setUserConsent(true)// If the user doesn't agree to personalized adsUnityAds.setUserConsent(false)

Opt-out signal API

Use the following examples to indicate whether the user has opted out of data collection under applicable privacy laws. 
// If the user opts in to personalized adsUnityAds.setUserOptOut(false)// If the user opts out to personalized adsUnityAds.setUserOptOut(true)

Age-restricted user specification API

Use the following examples to specify whether the app or user should be treated as child-directed or non-behavioral. 
// If the user opts out to personalized adsUnityAds.setNonBehavioral(true)// If the user opts in to personalized adsUnityAds.setNonBehavioral(false)