Étape 2: Intégration standard

Comment utiliser AppConsentUnified

1. Récupérer votre App Key

La première étape est de créer votre source / notice et de récupérer YOUR_APP_KEY généré depuis : https://app.appconsent.io

2.Créez l'instance de AppConsentUnified & l'utiliser

La seconde étape est d'initialiser le SDK Notre SDK support les applications cibles suivantes:

iOS (iPhone, iPad et macOS avec mac Catalyst). Déploiement minimum iOS 13.0

AppConsentUnified est développé en swift et utilise UIKit et supporte l'intégration avec les environnements en objective-c.

AppConsentUnified est s'intègre aussi bien avec Swift UI mais requiert plus d'intégration. Un exemple figure ci-dessous

INFO AppConsentUnified SDK supports le framework App Tracking Transparency framework (> iOS 14+). Vous devez saisir la clé NSUserTrackingUsageDescription dans votre Info.plist de votre application. Dans le cas contraire votre application risquerait de provoquer un crash. Voir App Tracking Transparency pour plus d'information.

INFORMATION

Dans cet example ci-dessous, le code se concentre principalement sur les fonctions du SDK. Les éléments graphiques et autres sont omis pour plus de clarté.

import AppConsentUnified

class ExampleViewController: UIViewController {

    private(set) var appConsent: ACNotice!
    
    override func viewDidLoad() {
        super.viewDidLoad()
       
        self.appConsent = ACNotice(withAppKey: "YOUR_APP_KEY")
                
        // Présentez la CMP dès que vous en avez besoin en fonction de votre logique métier
        self.appConsent.presentNotice(viewController: self)
    }
}

INFORMATION Dans cet example ci-dessous, le code se concentre principalement sur les fonctions du SDK. Les éléments graphiques et autres sont omis pour plus de clarté.

En premier lieu veuillez importer le fichier header de notre SDK afin de pouvoir accéder au méthodes.

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

If you are mixing Swift + Objective-C you will need to important as well your "{App}-Swift.h" file. Si vous mélanger Swift et Objective-c, il est important aussi d'ajouter votre header avec votre module "{App}-Swift.h" Exemple:

#import "YourAppModule-Swift.h"

Une fois cela fait, l'implémentation standard se réalise de la manière suivante: Importer le header ACNotice.h dans votre interface

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

NS_ASSUME_NONNULL_BEGIN
@interface ExampleObjcViewController : UIViewController
@end
NS_ASSUME_NONNULL_END

Instancier une propriété ACNotice et utiliser là. Ici par simplicité, celle-ci est utilisé directement dans le viewDidLoad

#import "ExampleObjcViewController.h"

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

@implementation ExampleObjcViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // initialiser notice
    self.appConsent = [[ACNotice alloc] initWithAppKey:@"YOUR_APP_KEY"];
    // Presenter la Notice
    [self.appConsent presentNoticeWithViewController:self];
}
@end

INFORMATION Notre SDK est développé avec UIKit et donc requiert plusieurs ajustements et donc certains éléments de code ci-dessous sont des éléments permettant de réaliser une des manières d'intégration. Vous pouvez utiliser d'autre manière intégrer le SDK ( UIViewRepresentable, etc)

(Optionnel) Utilisons un ViewModel afin d'encapsuler toute la logique métier

final class AppConsentViewModel: ObservableObject {
    
    private(set) var appConsent: ACNotice

    init(ac: ACNotice) {
        self.appConsent = ac
    }
    
    func presentNotice() {
        if let rootVC = UIApplication.shared.keyWindow?.rootViewController {
            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"
            ])
        }
    }
}

(Optional) Si vous utiliser le Scene Delegate ou l'App Delegate , créer une petite extension afin de pouvoir récupérer la fenêtre principale qui servira pour présenter notre CMP.

extension UIApplication {
    var keyWindow: UIWindow? {
        if #available(iOS 15.0, *) {
            return connectedScenes
                .compactMap { $0 as? UIWindowScene }
                .first(where: { $0.activationState == .foregroundActive })?
                .windows
                .first(where: { $0.isKeyWindow })
        } else {
            // iOS 13–14 fallback
            return windows.first { $0.isKeyWindow }
        }
    }
}

L'implémentation de la vue se fait donc comme ceci

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")
            // presente la notice (vous pouvez 
            // bien entendu l'appeler au moment le plus opportun 
            // en fonction de votre logiaue métier
            appConsentViewModel.presentNotice()
        }
    }
}

PrécédentÉtape 1: Commencer SuivantÉtape 3: Intégration avancée

Mis à jour il y a 4 mois

hashtagComment utiliser AppConsentUnified

hashtag1. Récupérer votre App Key

hashtag2.Créez l'instance de AppConsentUnified & l'utiliser

Comment utiliser AppConsentUnified

1. Récupérer votre App Key

2.Créez l'instance de AppConsentUnified & l'utiliser