Compliant with GDPR, CCPA, COPPA, LGPD, PECR, PDPA, PIPEDA, and more.
UniConsent CMP est un package pour la gestion du consentement GDPR IAB TCF 2.4 sur iOS. Vous trouverez une application de démonstration intégrée avec UniConsent CMP dans le répertoire « UniConsentDemo ».
Ajoutez UniConsent.xcframework à votre projet. Dans les paramètres de votre cible sous General > Frameworks, Libraries, and Embedded Content, définissez UniConsent.xcframework sur Embed & Sign.
Avant d'intégrer le SDK, personnalisez l'apparence de la bannière de consentement dans le tableau de bord UniConsent pour qu'elle corresponde à votre marque et optimise les taux de consentement.
Accédez à Projects → Select your Project → Settings → Step 5: UI & Style Settings pour configurer :
Pour un contrôle plus précis, ajoutez du CSS personnalisé dans le champ CSS Content sous l'étape 5. Ceci est recommandé pour que la bannière s'intègre nativement à votre application et obtienne le meilleur taux de consentement :
/* Example: Style the accept button to match your brand */
.unic-btn-accept {
background-color: #4CAF50;
border-radius: 8px;
font-weight: 600;
}
/* Example: Adjust banner font */
.unic-banner {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
}
/* Example: Make the reject button less prominent */
.unic-btn-reject {
background-color: transparent;
border: 1px solid #ccc;
color: #666;
}
Astuce : Une interface de consentement bien adaptée à votre marque et qui semble native à votre application obtient généralement de meilleurs taux de consentement. Les utilisateurs sont plus enclins à réagir positivement face à une bannière qui correspond à l'apparence et au style qu'ils attendent.
Pour utiliser UniConsent CMP dans votre application, suivez ces étapes :
Initialisez la CMP avec un App ID fourni par votre gestionnaire de compte :
import UniConsent
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Init CMP with appId
// initialize() loads the location, config and vendor list over the network: keep it off the main thread
DispatchQueue.global(qos: .userInitiated).async {
UniConsentCMP.shared.initialize(apiId: "YOUR_APP_ID_CHANGE_THIS")
}
return true
}
Affichez l'interface CMP :
// Display CMP as full-screen modal (default)
UniConsentCMP.shared.setUIStage(.GDPRFirstScreen)
UniConsentCMP.shared.launchCMP(rootVC: self)
// Display CMP as a modal bottom sheet
UniConsentCMP.shared.launchCMP(rootVC: self, displayMode: .modalSheet)
// Display CMP as a modal bottom sheet at 60% of the available height
UniConsentCMP.shared.launchCMP(rootVC: self, displayMode: .modalSheet, heightRatio: 0.6)
// Display CMP as a center dialog
UniConsentCMP.shared.launchCMP(rootVC: self, displayMode: .dialog)
// Display CMP as a center dialog at 80% width and 60% height
UniConsentCMP.shared.launchCMP(rootVC: self, displayMode: .dialog, widthRatio: 0.8, heightRatio: 0.6)
Modes d'affichage disponibles (CMPDisplayMode) :
.fullScreen — Présentation modale plein écran (par défaut).modalSheet — Panneau inférieur avec poignée de glissement (iOS 15+).dialog — Boîte de dialogue centrée avec arrière-plan assombriDisponible à partir de la version 26.8.0 du SDK.
Les deux ratios sont optionnels — chaque mode d'affichage fonctionne sans eux. Ne passez un ratio (une fraction de l'écran, limitée à l'intervalle 0.1...1.0) que pour remplacer la taille par défaut :
| Paramètre | S'applique à | Valeur par défaut si omis |
|---|---|---|
heightRatio | .modalSheet, .dialog | Panneau : 90 % de la hauteur disponible. Dialogue : 70 % de l'écran |
widthRatio | .dialog uniquement | 90 % de la largeur de l'écran, jusqu'à 500 pt |
Les ratios qui ne s'appliquent pas au mode d'affichage choisi sont ignorés (.fullScreen ignore les deux). Sur iOS 16+, le panneau utilise exactement le heightRatio ; iOS 15 se rabat sur le detent système medium (ratio ≤ 0,5) ou large (ratio > 0,5).
Écoutez les événements du cycle de vie du SDK avec CMPEventHandler. C'est la méthode recommandée pour savoir quand le SDK a terminé son initialisation, quand l'interface est affichée et quand elle est fermée.
Événements disponibles (CMPEventType) :
.sdkInit — Initialisation du SDK lancée.ready — Initialisation du SDK terminée (GEO, configuration et fournisseurs chargés).uiDisplay — L'interface de consentement est affichée.uiClose — L'interface de consentement est ferméeAbonnez-vous aux événements avant d'appeler initialize() pour recevoir tous les événements :
import UniConsent
@main
class AppDelegate: UIResponder, UIApplicationDelegate, CMPEventHandler {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
UniConsentCMP.shared.subscribe(self)
DispatchQueue.global(qos: .userInitiated).async {
UniConsentCMP.shared.initialize(apiId: "YOUR_APP_ID")
}
return true
}
func handle(event: CMPEvent) {
switch event.type {
case .ready:
// SDK is ready — check consent and launch CMP if needed
// events arrive on the thread that called initialize(): show UI on the main thread
DispatchQueue.main.async {
if let rootVC = UIApplication.shared.connectedScenes
.compactMap({ ($0 as? UIWindowScene)?.keyWindow?.rootViewController }).first {
UniConsentCMP.shared.launchCMPIfNeeded(rootVC: rootVC)
}
}
case .uiClose:
// User finished interacting with consent UI
print("TC String:", UniConsentCMP.shared.getTCString())
default:
break
}
}
}
Vous pouvez également vous abonner depuis un contrôleur de vue :
class ViewController: UIViewController, CMPEventHandler {
override func viewDidLoad() {
super.viewDidLoad()
UniConsentCMP.shared.subscribe(self)
}
func handle(event: CMPEvent) {
switch event.type {
case .uiDisplay:
print("CMP UI is now visible")
case .uiClose:
print("Consent given, vendor 1 allowed:", UniConsentCMP.shared.isAllowVendorById(vendorId: 1))
default:
break
}
}
}
Pour se désabonner :
UniConsentCMP.shared.unsubscribe(self)
Vous pouvez également écouter la fermeture du consentement avec CMPUIDelegate :
class ViewController: UIViewController, CMPUIDelegate {
func showCMP() {
UniConsentCMP.shared.view.delegate = self
UniConsentCMP.shared.setUIStage(.GDPRFirstScreen)
UniConsentCMP.shared.launchCMP(rootVC: self, displayMode: .modalSheet)
}
func onDismiss() {
// Called when the user closes the consent UI
print("TC String:", UniConsentCMP.shared.getTCString())
}
}
Vérification automatique de l'expiration du consentement lors de la mise à jour de la vendorList :
// Automatic check if consent is expired when vendorList updates
if UniConsentCMP.shared.shouldRequestConsent() {
UniConsentCMP.shared.launchCMP(rootVC: self)
}
Récupérer la tcString si nécessaire :
// Get tcString if required
UniConsentCMP.shared.getTCString()
Lire le statut du consentement :
// Check consent for a specific IAB purpose
UniConsentCMP.shared.isAllowPurposeById(purposeId: 1)
// Check consent for a specific IAB vendor
UniConsentCMP.shared.isAllowVendorById(vendorId: 1)
// Get all allowed purpose/vendor IDs
UniConsentCMP.shared.getAllowedPurposeIds()
UniConsentCMP.shared.getAllowedVendorIds()
// Check if GDPR applies
UniConsentCMP.shared.gdprApplies
// Check if any consent has been given
UniConsentCMP.shared.isConsentGiven()
Réinitialiser le statut du consentement si nécessaire :
// Reset consent status if required
UniConsentCMP.shared.clearConsentData()
Disponible à partir de la version 26.7.0 du SDK. Si vous créez votre propre interface de consentement de premier niveau au lieu d'afficher la webview du CMP, vous pouvez enregistrer le consentement directement :
// Grant consent for all purposes, special features and vendors
let saved = UniConsentCMP.shared.agreeAll()
// Reject all purposes, special features and vendors
let saved = UniConsentCMP.shared.rejectAll()
Ces deux API enregistrent les mêmes valeurs de consentement que le flux de l'interface CMP (clés IAB TCF, consentement additionnel et signaux de consent mode) et déclenchent le même événement .uiClose pour les abonnés.
Pour les utilisateurs des États-Unis et du Canada, les deux API enregistrent aussi le choix CCPA, US State Privacy et IAB TCF Canada qui les concerne, selon les mêmes règles que l'interface de la CMP, et écrivent les clés IAB GPP et US Privacy. Activez les modes API-Only dans les paramètres du projet du tableau de bord UniConsent pour que la bannière de la CMP ne s'affiche pas dans ces régions.
Elles enregistrent aussi le choix des catégories de cookies là où une bannière de catégories de cookies s'applique (toutes les catégories, ou seulement Strictement nécessaires), ainsi que les finalités et fournisseurs personnalisés du projet.
Pour savoir quel premier niveau afficher, appelez getPolicy() (à partir de la version 26.10.0 du SDK). Elle renvoie la politique qui s'applique à l'utilisateur, selon les mêmes règles que la CMP : gdpr (IAB TCF), tcfca (IAB TCF Canada), uss (US State Privacy), ccpa, categories (voir Catégories de cookies ci-dessous) ou none.
let cmp = UniConsentCMP.shared
if cmp.shouldRequestConsent() {
// l'utilisateur doit faire un choix : affichez votre premier niveau pour cette politique
let policy = cmp.getPolicy() // gdpr, tcfca ou categories
}
Remarque : Ces API récupèrent la liste des fournisseurs et la configuration du projet via le réseau de manière synchrone et renvoient
falsesi le consentement n'a pas pu être enregistré (par exemple hors ligne). Appelez-les aprèsinitialize()et en dehors du thread principal.Important : Votre premier niveau personnalisé doit toujours respecter les exigences de l'IAB TCF (divulguer les finalités et les fournisseurs, et proposer l'acceptation et le refus avec la même visibilité). Les utilisateurs doivent toujours pouvoir ouvrir l'interface CMP complète (
launchCMP()) pour effectuer des choix granulaires.
Si votre application ouvre une WKWebView qui charge une page web avec le tag CMP UniConsent, vous pouvez transmettre le statut de consentement natif afin que le tag CMP reconnaisse le consentement existant et n'affiche pas la bannière à nouveau.
Appelez syncConsent(to:) avant de charger la page web :
import WebKit
import UniConsent
let webView = WKWebView(frame: .zero, configuration: WKWebViewConfiguration())
// Inject native consent before page load
UniConsentCMP.shared.syncConsent(to: webView)
// Then load your web page
webView.load(URLRequest(url: URL(string: "https://example.com")!))
// Initialize with event handler
@interface AppDelegate () <CMPEventHandler>
@end
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[[UniConsentCMP shared] subscribe:self];
// initialize loads the location, config and vendor list over the network: keep it off the main thread
dispatch_async(dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0), ^{
[[UniConsentCMP shared] initializeWithApiId:@"YOUR_APP_ID"];
});
return YES;
}
- (void)handleWithEvent:(CMPEvent *)event {
switch (event.type) {
case CMPEventTypeReady:
NSLog(@"CMP ready");
break;
case CMPEventTypeUiClose:
NSLog(@"TC String: %@", [[UniConsentCMP shared] getTCString]);
break;
default:
break;
}
}
@end
// Display CMP (full screen by default)
[UniConsentCMP.shared launchCMPWithRootVC:self];
// Display CMP with a specific display mode
// Use CMPDisplayModeFullScreen, CMPDisplayModeModalSheet, or CMPDisplayModeDialog
[UniConsentCMP.shared launchCMPWithRootVC:self displayMode:CMPDisplayModeModalSheet];
Ouvrez la CMP sur un écran précis, par exemple depuis un lien « Paramètres de confidentialité » de votre app. L'écran demandé s'ouvre toujours. Pour les utilisateurs aux États-Unis, les écrans de paramètres ouvrent les paramètres CCPA ou US State Privacy qui s'appliquent à eux. Les utilisateurs au Canada voient la version IAB TCF Canada des écrans IAB TCF.
| Écran | Affiche |
|---|---|
.GDPRFirstScreen | Premier niveau (bannière) |
.GDPRSecondScreen | Paramètres (finalités) |
.GDPRVendorsScreen | Fournisseurs |
.CCPAFirstScreen | Premier niveau CCPA |
.CCPASecondScreen | Paramètres CCPA |
.USStateFirstScreen | Premier niveau US State Privacy |
.USStateSecondScreen | Paramètres US State Privacy |
.CategoriesFirstScreen | Premier niveau des catégories de cookies (bannière) |
.CategoriesSecondScreen | Paramètres des catégories de cookies |
let cmp = UniConsentCMP.shared
// ouvrir l'écran des paramètres
cmp.setUIStage(.GDPRSecondScreen)
cmp.launchCMP(rootVC: self)
// ouvrir la CMP seulement si un consentement est nécessaire (UE et IAB TCF Canada) ; indique si elle s'est ouverte
let opened = cmp.launchCMPIfNeeded(rootVC: self)
// journaux de débogage du SDK et de la page CMP ; utilisez .error (par défaut) dans les builds de production
cmp.setLogLevel(.debug)
// pour les tests uniquement : afficher la CMP comme pour un utilisateur d'une autre région, "EU", "CA" (Canada), "CAQC" (Québec), "US" suivi d'un code d'État comme "USCA" ou "USTX", "BR", "CN", "ZA", "VN" ou tout autre code pays, ou "N" (hors de ces régions). S'applique aussi à getPolicy() et à shouldRequestConsent() ; à retirer des builds de production
cmp.setTestRegion("CA")
// fermer la CMP si elle est ouverte
cmp.dismissCMP()
// l'utilisateur a fait un choix : IAB TCF, CCPA, US State Privacy ou IAB TCF Canada
let given = cmp.isConsentGiven()
// jours depuis la création du consentement IAB TCF, 0 s'il n'y en a pas
let days = cmp.getConsentAge()
// région de l'utilisateur et, pour les États-Unis et le Canada, le code de l'État ou de la province (vide si inconnu)
let geo = cmp.getGEO()
let state = cmp.getGEOState()
La CMP enregistre les clés IAB GPP et la clé US Privacy dans les UserDefaults de l'app, telles que les définissent les spécifications de l'IAB. Les SDK publicitaires de votre app les lisent à cet endroit ; aucune modification de code n'est nécessaire. Les clés GPP sont écrites lorsque GPP, US State Privacy ou IAB TCF Canada est activé dans les paramètres du projet du tableau de bord UniConsent. La clé US Privacy est écrite dès que le CCPA est activé.
| Clé | Valeur |
|---|---|
IABGPP_HDR_Version | Version GPP (1) |
IABGPP_HDR_Sections | ID des sections présentes dans la chaîne GPP, séparés par _ |
IABGPP_HDR_GppString | La chaîne GPP complète |
IABGPP_GppSID | ID des sections qui s'appliquent à l'utilisateur, séparés par _, ou -1 si aucune ne s'applique |
IABGPP_2_String | Chaîne IAB TCF EU, lorsque le RGPD s'applique |
IABGPP_5_String | Chaîne IAB TCF Canada, lorsque le TCF Canada s'applique |
IABGPP_6_String | Chaîne US Privacy, lorsque le CCPA s'applique |
IABGPP_7_String | Chaîne US National (usnat), lorsque US State Privacy ou le CCPA s'applique |
IABGPP_8_String à IABGPP_27_String | La section de l'État de l'utilisateur (8 Californie à 27 Rhode Island), lorsque US State Privacy s'applique, ou la Californie avec le CCPA, selon le paramètre GPP Sections |
IABUSPrivacy_String | Chaîne US Privacy dès que le CCPA est activé : le choix de l'utilisateur dans la région CCPA, sinon 1--- |
Les clés sont mises à jour à chaque chargement de la CMP et après chaque choix de consentement. Lorsque GPP est désactivé, les clés IABGPP_ sont supprimées. Pour les lire vous-même :
let gppString = UserDefaults.standard.string(forKey: "IABGPP_HDR_GppString") ?? ""
let gppSid = UserDefaults.standard.string(forKey: "IABGPP_GppSID") ?? ""
Les apps prennent en charge les mêmes options pour les États-Unis et le Canada que les sites web : CCPA, US State Privacy (avec la liste des États et les paramètres GPP Sections et MSPA) et IAB TCF Canada. shouldRequestConsent() renvoie true pour les utilisateurs du Canada concernés par l'IAB TCF Canada tant qu'ils n'ont pas fait de choix. La confidentialité aux États-Unis fonctionne par opposition (opt-out) : les utilisateurs américains ne sont pas sollicités d'eux-mêmes, ils voient la bannière ou les paramètres américains lorsque votre app ouvre la CMP, par exemple depuis un lien vers les paramètres de confidentialité. D'ici là, lorsque le CCPA ou US State Privacy est activé, le SDK écrit les clés US Privacy et GPP par défaut pour les utilisateurs américains sans rien afficher : sans opposition, ou avec opposition lorsque le suivi publicitaire est désactivé sur l'appareil. US State Privacy est désactivé au départ pour les nouveaux projets Mobile App ; activez-le dans le tableau de bord.
Lorsque l'utilisateur a désactivé le suivi publicitaire sur l'appareil, la CMP le traite comme un refus américain de la vente, du partage et de la publicité ciblée, comme le fait Global Privacy Control sur les sites web. Sous iOS, il s'agit du suivi non autorisé dans App Tracking Transparency ; sous Android, d'un identifiant publicitaire supprimé ou de la limitation du suivi publicitaire, lus via les services Google Play lorsque votre app les inclut. Un choix que l'utilisateur enregistre ensuite dans la bannière est prioritaire.
Le SDK renvoie aussi les chaînes enregistrées :
let gppString = UniConsentCMP.shared.getGPPString()
let gppSid = UniConsentCMP.shared.getGPPSID()
let usPrivacy = UniConsentCMP.shared.getUSPrivacyString()
Disponible à partir de la version 26.10.0 du SDK. Lorsqu'une région utilise des catégories de cookies au lieu de l'IAB TCF ou des politiques américaines, la CMP affiche une bannière avec quatre catégories : Strictement nécessaires, Performance, Fonctionnalité, et Ciblage ou publicité. Cela s'applique à :
Les catégories en opt-in démarrent avec seulement Strictement nécessaires activée, et shouldRequestConsent() renvoie true tant que l'utilisateur n'a pas fait de choix, puis à nouveau après un changement de version de configuration. Les catégories en opt-out démarrent avec toutes les catégories activées (Ciblage désactivé lorsque le suivi publicitaire est désactivé sur l'appareil aux États-Unis), et l'app ne sollicite pas l'utilisateur d'elle-même : il les modifie depuis votre lien vers les paramètres de confidentialité. L'opt-out s'applique à une règle opt-out pour les autres pays et, dans les apps, à un projet Consent Categories aux États-Unis.
Ouvrez les écrans des catégories avec .CategoriesFirstScreen (bannière) et .CategoriesSecondScreen (paramètres). setTestRegion() accepte aussi BR, CN, ZA, VN et d'autres codes pays, pour tester ces régions.
Disponible à partir de la version 26.10.0 du SDK. Les finalités personnalisées et les fournisseurs personnalisés que vous ajoutez dans les paramètres du projet du tableau de bord UniConsent s'affichent dans les écrans de la CMP : les finalités personnalisées dans le premier niveau et les paramètres IAB TCF et dans les paramètres des catégories de cookies, les fournisseurs personnalisés dans la liste des fournisseurs IAB TCF. Dans les paramètres CCPA et US State Privacy, seules les finalités personnalisées sensibles sont listées. Dans les paramètres des catégories de cookies, les fournisseurs personnalisés suivent la catégorie Ciblage ou publicité. Là où l'IAB TCF ne s'applique pas (catégories de cookies et États-Unis), les fournisseurs personnalisés sont listés en lecture seule dans la liste des fournisseurs du menu, et dans les paramètres des catégories de cookies sous Ciblage ou publicité.
Pour démarrer ou arrêter vos propres SDK selon eux, demandez au SDK si l'app peut utiliser maintenant une finalité personnalisée ou un fournisseur personnalisé. La réponse suit la politique de l'utilisateur, selon les mêmes règles que la CMP utilise pour les balises :
let cmp = UniConsentCMP.shared
if cmp.isCustomPurposeConsented(1) {
// démarrez le SDK couvert par votre finalité personnalisée 1
}
let vendorAllowed = cmp.isCustomVendorConsented(2)
let all = cmp.getCustomConsents() // ["purposes": ["1": true], "vendors": ["2": false]]
Appelez-les de nouveau après la fermeture de la CMP ou un changement du consentement. Les identifiants que le projet n'a pas, et tous les identifiants avant que le SDK soit prêt, renvoient false.
La CMP peut lister les SDK tiers de votre app (régies publicitaires, analytique, attribution et autres) avec leur société, leur utilisation et leur politique de confidentialité. Les utilisateurs les voient dans la liste des fournisseurs, en lecture seule dans toutes les régions : il n'y a pas d'interrupteurs, et votre app continue d'activer ou de désactiver chaque SDK selon les choix de l'utilisateur pour les finalités ou les catégories de cookies.
Pour définir la liste, activez Enable Third-party SDKs dans Step 4: Advanced Features de votre projet d'app, choisissez vos SDK dans l'onglet Third-party SDKs ou ajoutez les vôtres, puis enregistrez et publiez. Aucun code n'est nécessaire dans votre app.
Configurer les valeurs par défaut du statut de consentement (KV) :
<key>FIREBASE_ANALYTICS_COLLECTION_ENABLED</key> <false/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_ANALYTICS_STORAGE</key> <false/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_STORAGE</key> <false/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_USER_DATA</key> <false/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_PERSONALIZATION_SIGNALS</key> <false/>
Contrôler les analyses en fonction des indicateurs de consentement :
// SDK Version <= 25.6.1
public func onDismiss() {
if(UniConsentCMP.shared.isAllowPurposeById(purposeId: 1)) {
Analytics.setConsent([
.analyticsStorage: .granted,
.adStorage: .granted,
.adUserData: .granted,
.adPersonalization: .granted,
])
Analytics.setAnalyticsCollectionEnabled(true);
} else {
Analytics.setConsent([
.analyticsStorage: .denied,
.adStorage: .denied,
.adUserData: .denied,
.adPersonalization: .denied,
])
Analytics.setAnalyticsCollectionEnabled(false);
}
// other logics such as send analytics events
}
Plus d'informations sur Configurer le mode de consentement pour les applications
getGPPString(), getGPPSID() et getUSPrivacyString().USStateSecondScreen ; ajout de launchCMPIfNeeded(), setLogLevel() et getGEOState().CCPAFirstScreen et .USStateFirstScreen ; ajout de setTestRegion() pour tester la CMP comme un utilisateur d'une autre région, par exemple le Canada.CategoriesFirstScreen et .CategoriesSecondScreengetPolicy() ; agreeAll() et rejectAll() enregistrent aussi les catégories de cookies, les finalités personnalisées et les fournisseurs personnaliséssetTestRegion() accepte aussi BR, CN, ZA, VN et d'autres codes pays, et s'applique à getPolicy() et à shouldRequestConsent()isCustomPurposeConsented(), isCustomVendorConsented() et getCustomConsents() : les finalités et fournisseurs personnalisés que l'app peut utiliser maintenant selon la politique de l'utilisateur