Étape 3: Intégration avancée

Comment utiliser l'objet AppConsent ?

Spécifier un endpoint spécifique à utiliser à l'init

let appConsent = ACNotice(withAppKey: "YOUR_APP_KEY", dedicatedEndpointURL: "YOUR_BACKEND_ENDPOINT")

Rediriger l'utilisateur vers l'écran de settings

Cet écran permet d'afficher les paramètres du consentement de l'utilisateur. Cet écran permet à l'utilisateur de vérifier son consentement et d'avoir plus de granularité sur la saisie du consentement pour chaque élément individuel.

appConsent.presentSettings(viewController: self)

Vérifier le consentement de l'utilisateur

appConsent.consentGiven()

Retourne true si le consentement est donné, sinon false.

ATTENTION

Veuillez noter qu'il s'agit uniquement de savoir si l'utilisateur a confirmé un choix et non s'il a accepté ou refusé son consentement.

Implémenter les delegates afin d'être informé lorsque le consentement utilisateur est réalisé

Quand l'utilisateur complète le processus de consentement, ce delegate vous informe si celui-ci s'est déroulé avec succès ou si une erreur est arrivée. Vous avez aussi des delegates vous informant de certains événements UI (telle que lorsque la CMP s'affiche à l'utilisateur, si par exemple vous souhaitez mettre en pause certains processus pendant ce temps)

INFORMATION

Dans cet exemple ci-dessous nous reprenons avec le code provenant de l'étape 2: Intégration Standard

Attribuer le delegate à votre objet ACNotice

  self.appConsent.delegate = self

Implémenter le Delegate à votre ViewController ou l'objet qui contient votre appConsent

extension ExampleViewController: AppConsentDelegate {
    
    func appConsentDidFinish() {
       // Below you can place your own business logic, for example grab the general consent status
        print("🔥 AppConsentUnified Delegate: did finish")
        
        let consentStatus = appConsent.consentStatus()
        print("🔥 AppConsentUnified Delegate: consent status => \(consentStatus.description)")
    }
    
    func appConsentDidFail(_ error: Error?) {
        print("🔥 AppConsentUnified Delegate: did fail, \(error?.localizedDescription ?? "No error details")")
    }
    
    func appConsentDidAppear() {
        print("🔥 AppConsentUnified Delegate: did appear")
    }
    
    func appConsentDidDisappear() {
        print("🔥 AppConsentUnified Delegate: did disappear")
    }
}

Exemple avec intégration complète:

import AppConsentUnified

class ExampleViewController: UIViewController {

   // Notice Object
    private(set) var notice: ACNotice!
    
    override func viewDidLoad() {
        super.viewDidLoad()
       
        self.appConsent = ACNotice(withAppKey: "YOUR_APP_KEY")
        
        // Delegate is used to get some callbacks when CMP finishes its execution
        self.appConsent.delegate = self
        
        // Present CMP when you need it (it can after some internal logic on your end not necessarely here as the example shows)
        self.notice.presentNotice(viewController: self)
    }
}

fileprivate extension ExampleViewController: AppConsentDelegate {
    
    func appConsentDidFinish() {
       // Below you can place your own business logic, for example grab the general consent status
        print("🔥 AppConsentUnified Delegate: did finish")
        
        let consentStatus = notice.consentStatus()
        print("🔥 AppConsentUnified Delegate: consent status => \(consentStatus.description)")
    }
    
    func appConsentDidFail(_ error: Error?) {
        print("🔥 AppConsentUnified Delegate: did fail, \(error?.localizedDescription ?? "No error details")")
    }
    
    func appConsentDidAppear() {
        print("🔥 AppConsentUnified Delegate: did appear")
    }
    
    func appConsentDidDisappear() {
        print("🔥 AppConsentUnified Delegate: did disappear")
    }
}

INFORMATION Dans cet exemple ci-dessous nous reprenons avec le code provenant de l'étape 2: Intégration Standard

Implémenter le delegate dans votre fichier interface (.h)

#import <UIKit/UIKit.h>
#import <AppConsentUnified/ACNotice.h>
#import <AppConsentUnified/AppConsentUnified-Swift.h>

NS_ASSUME_NONNULL_BEGIN
@interface ExampleObjcViewController : UIViewController <AppConsentDelegate>
@end
NS_ASSUME_NONNULL_END

Assigner le delegate à self

[self.appConsent setDelegate:self];

Ensuite implémenter les méthodes du delegate dans votre fichier d'implémentation (.m)

- (void)appConsentDidFail:(NSError * _Nullable)error {
   NSLog(@"🔥 AppConsentUnified Delegate: did fail %@", error.localizedDescription);
}

- (void)appConsentDidFinish {
    NSLog(@"🔥 AppConsentUnified Delegate: did finish");
    
    // Here you can place your own business logic, for example grab the general consent status
    ACConsentStatus consentStatus = [self.appConsent consentStatus];
    
    switch (consentStatus) {
        case ACConsentStatusAllowed:
            NSLog(@"🔥 AppConsentUnified Delegate: consent status Allowed");
            break;
        case ACConsentStatusDenied:
            NSLog(@"🔥 AppConsentUnified Delegate: consent status Denied");
        case ACConsentStatusMixed:
            NSLog(@"🔥 AppConsentUnified Delegate: consent status Mixed. Need to verify per purposes");
        default:
            break;
    }
}

-(void)appConsentDidAppear {
    NSLog(@"🔥 AppConsentUnified Delegate: did appear");
}

- (void)appConsentDidDisappear {
    NSLog(@"🔥 AppConsentUnified Delegate: did disappear");
}

Exemple complet:

ExampleObjcViewController.h

#import <UIKit/UIKit.h>
#import <AppConsentUnified/ACNotice.h>
#import <AppConsentUnified/AppConsentUnified-Swift.h>

NS_ASSUME_NONNULL_BEGIN

@interface ExampleObjcViewController : UIViewController <AppConsentDelegate>
@end

NS_ASSUME_NONNULL_END

ExampleObjcViewController.m

#import "ExampleObjcViewController.h"

@interface ExampleObjcViewController ()
@property(nonatomic, strong) ACNotice *appConsent;
@end

@implementation ExampleObjcViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // initialise notice
    self.appConsent = [[ACNotice alloc] initWithAppKey:@"YOUR_APP_KEY"];
     // Set Delegate
     [self.appConsent setDelegate:self];
    // Present Notice
    [self.appConsent presentNoticeWithViewController:self];
}

- (void)appConsentDidFail:(NSError * _Nullable)error {
   NSLog(@"🔥 AppConsentUnified Delegate: did fail %@", error.localizedDescription);
}

- (void)appConsentDidFinish {
    NSLog(@"🔥 AppConsentUnified Delegate: did finish");
    
    // Here you can place your own business logic, 
    // An example here: get the general consent status
    ACConsentStatus consentStatus = [self.appConsent consentStatus];
    
    switch (consentStatus) {
        case ACConsentStatusAllowed:
            NSLog(@"🔥 AppConsentUnified Delegate: consent status Allowed");
            break;
        case ACConsentStatusDenied:
            NSLog(@"🔥 AppConsentUnified Delegate: consent status Denied");
        case ACConsentStatusMixed:
            NSLog(@"🔥 AppConsentUnified Delegate: consent status Mixed. Need to verify per purposes");
        default:
            break;
    }
}

-(void)appConsentDidAppear {
    NSLog(@"🔥 AppConsentUnified Delegate: did appear");
}

- (void)appConsentDidDisappear {
    NSLog(@"🔥 AppConsentUnified Delegate: did disappear");
}
@end

INFORMATION Dans cet exemple ci-dessous nous reprenons avec le code provenant de l'étape 2: Intégration Standard

Implémenter l'AppConsentDelegate dans votre ViewModel


// AppConsent Delegate
fileprivate extension AppConsentViewModel: AppConsentDelegate {    
    func appConsentDidFinish() {
        print("🔥 AppConsentUnified Delegate: did finish")
        noticeCompleted = true
    }
    func appConsentDidFail(_ error: Error?) {
        print("🔥 AppConsentUnified Delegate: did fail, \(error?.localizedDescription ?? "No error details")")
        noticeError = error
    }
    
    func appConsentDidAppear() {
        print("🔥 AppConsentUnified Delegate: did appear")
    }
    
    func appConsentDidDisappear() {
        print("🔥 AppConsentUnified Delegate: did disappear")
    }
}

Ajouter deux propriétés pour réagir aux différents callbacks du delegate

final class AppConsentViewModel: ObservableObject {
    
    private(set) var appConsent: ACNotice
    @Published var noticeCompleted = false
    @Published var noticeError: Error?
    
    init(ac: ACNotice) {
        self.appConsent = ac
    }
    
    func presentNotice() {
        if let rootVC = UIApplication.shared.keyWindow?.rootViewController {
            // Set delegate
            appConsent.delegate = self
            // Present Notice
            appConsent.presentNotice(viewController: rootVC)
        } else {
            noticeError = NSError(domain: "your_bundle_id", 
            code: 999, // Choose your internal code if needed
            userInfo: [
            NSLocalizedFailureReasonErrorKey: 
            "Unable to present notice, keyWindow is nil"
            ])
        }
    }
}

Implémentation complète du View Model

final class AppConsentViewModel: ObservableObject {
    private(set) var appConsent: ACNotice
    
    @Published var noticeCompleted = false
    @Published var noticeError: Error?
    
    init(notice: ACNotice) {
        self.appConsent = notice
    }
        
    func presentNotice() {
        if let rootVC = UIApplication.shared.keyWindow?.rootViewController {
            appConsent.delegate = self
            appConsent.presentNotice(viewController: rootVC)
        } else {
            noticeError = NSError(domain: "your_bundle_id", code: 999, userInfo: [NSLocalizedFailureReasonErrorKey: "Unable to present notice, keyWindow is nil"])
        }
    }
}

// AppConsent Delegate
extension AppConsentViewModel: AppConsentDelegate {
    
    func appConsentDidFinish() {
        print("🔥 AppConsentUnified Delegate: did finish")
        noticeCompleted = true
    }
    
    func appConsentDidFail(_ error: Error?) {
        print("🔥 AppConsentUnified Delegate: did fail, \(error?.localizedDescription ?? "No error details")")
        noticeError = error
    }
    
    func appConsentDidAppear() {
        print("🔥 AppConsentUnified Delegate: did appear")
    }
    
    func appConsentDidDisappear() {
        print("🔥 AppConsentUnified Delegate: did disappear")
    }
}

Intégration du ViewModel dans la vue Swift UI

import SwiftUI
import AppConsentUnified

struct ContentView: View {
    @StateObject private var appConsentViewModel: AppConsentViewModel
    
    init(appConsentViewModel: AppConsentViewModel) {
        self._appConsentViewModel = StateObject(wrappedValue: appConsentViewModel)
    }
    var body: some View {
        VStack {
            // YOUR VIEW ELEMENTS
            Text("My View")
        }.onAppear {
            let appConsent = ACNotice(withAppKey: "YOUR_APP_KEY")
            // present notice
            appConsentViewModel.presentNotice()
        }.onReceive(appConsentViewModel.$noticeCompleted) { success in
            // Here you can place your own business logic, for example grab the general consent status
            let consentStatus = appConsentViewModel.appConsent.consentStatus()
            print("🔥 AppConsentUnified Delegate: did finish consent status => \(consentStatus.description)")
        }.onReceive(appConsentViewModel.$noticeError) { error in
            // Here you can place your own business logic for error handling
        }
    }
}

Check for update

Cette méthode vous permet de vérifier sur nos serveurs si la notice doit être affichée de nouveau.

INFORMATION

La méthode renverra true si vous avez modifié la Source et/ou la Notice depuis votre dashboard et, si et seulement si, vous avez configuré votre Notice pour qu'elle se mette à jour pour tous vos utilisateurs

Notre dernier SDK fourni la possibilité d'utiliser le callback traditionnel ou async/await pour la plupart des méthodes. Check for update - Callback

  appConsent.checkForUpdate { [weak self] needUpdate in
             if needUpdate {
                // Your Notice has been updated, you must represent the CMP to your users
                // You can call presentNotice as per the below example
                 guard let self else { return }
                 appConsent.presentNotice(viewController: self)
            }
        }

    __weak typeof(self) weakSelf = self;
    
       [self.notice checkForUpdate:^(BOOL needUpdate) {
        if (needUpdate) {
            __strong typeof(self) strongSelf = weakSelf;
            if (!strongSelf) return;
            // Your Notice has been updated, you must represent the CMP to your users
           // You can call presentNotice as per the below example
            [self.notice presentNoticeWithViewController:strongSelf];
        }
    }];

Check for update - async / await

await appConsent.checkForUpdate()

GCM Status

INFORMATION

Cette méthode indique l'état actuel de GCMv2 (Google Consent Mode V2).

Avant d'appeler cette méthode, il est préférable de s'assurer que l'utilisateur a déjà donné son consentement et qu'il est à jour, et que le CMP n'a pas besoin d'être affiché.

Dans le cas contraire :

soit la valeur sauvegardée de l'ancien consentement sera retournée
soit les valeurs par défaut de votre configuration Firebase Analytics figurant dans votre Info.plist seront retournées.

Définir l'état de consentement par défaut à partir de la documentation de Google

ℹ️ Comme certaines annotations ne sont pas compatible avec Objective-C, nous avons deux méthodes différentes en fonction du language utilisé.

appConsent.gcmStatus()

Exemple:

let gcmStatus: GCMStatus = appConsent.gcmStatus()

Retourne GCMStatus

Modèle de données représentant l'état de GCMv2 (Google Consent Mode v2)

Cela vous permettra de définir le consentement à partir de votre instance Firebase Analytics.

Ouvrer le fichier Info.plist de votre application
Renseignez les champs suivants :
- GOOGLE_ANALYTICS_DEFAULT_ALLOW_ANALYTICS_STORAGE
- GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_STORAGE
- GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_USER_DATA
- GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_PERSONALIZATION_SIGNALS
Enregistrez les modifications. Ensuite, implémentez le mécanisme permettant de mettre à jour les valeurs du consentement.

Par exemple, pour définir le consentement pour tous les paramètres par défaut:

<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_ANALYTICS_STORAGE</key> <true/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_STORAGE</key> <true/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_USER_DATA</key> <true/>
<key>GOOGLE_ANALYTICS_DEFAULT_ALLOW_AD_PERSONALIZATION_SIGNALS</key> <true/>

PrécédentÉtape 2: Intégration standard SuivantAller plus loin

Mis à jour il y a 4 mois

hashtagComment utiliser l'objet AppConsent ?

hashtagSpécifier un endpoint spécifique à utiliser à l'init

hashtagRediriger l'utilisateur vers l'écran de settings

hashtagVérifier le consentement de l'utilisateur

hashtagImplémenter les delegates afin d'être informé lorsque le consentement utilisateur est réalisé

hashtagCheck for update

hashtagGCM Status

Comment utiliser l'objet AppConsent ?

Spécifier un endpoint spécifique à utiliser à l'init

Rediriger l'utilisateur vers l'écran de settings

Vérifier le consentement de l'utilisateur

Implémenter les delegates afin d'être informé lorsque le consentement utilisateur est réalisé

Check for update

GCM Status