Information
du Paquet

ConsentManager SDK GDPR / CCPA pour iOS

The ConsentManager Le SDK pour les applications iOS implémente et fournit des fonctionnalités pour informer l'utilisateur sur la protection des données et demander et recueillir le consentement de l'utilisateur. Il permet aux développeurs d'applications d'intégrer facilement le ConsentManager service dans leur application.

Normes prises en charge

The ConsentManager Le SDK GDPR / CCPA pour Android prend en charge les normes industrielles suivantes:

  • IAB TCF v1
  • IAB TCF v2
  • IAB USPrivacy v1
  • ConsentManager fournisseurs / objectifs personnalisés
  • Mode de consentement supplémentaire Google (chaîne Google AC)

Comment ça marche

  1. Intégrez le SDK dans l'application et configurez les paramètres du SDK
  2. Une fois le SDK intégré dans une application, le SDK fournira des fonctions au développeur de l'application afin de récupérer les données de consentement
  3. Dès que l'application démarre, le SDK récupère automatiquement les informations du ConsentManager serveurs afin de préparer le SDK à son utilisation.
  4. Il est recommandé qu'au démarrage de l'application, l'application crée une instance de classe CMPConsentTool. Une fois le fichier créé, le SDK affichera automatiquement l'écran de consentement si nécessaire.
  5. Lorsque l'application souhaite traiter des données personnelles, elle doit «demander» au SDK si le consentement a été donné pour l'objectif et le fournisseur spécifiques.

Installation via Cocoapod

Ajouter une bibliothèque avec Cocoapod

Vous pouvez installer le consentmanager SDK en ajoutant consentmanager à votre Podfile comme expliqué dans l'exemple ci-dessous:

target 'YourProject' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!
  pod 'consentmanager'

  target 'YourProjectTests' do
    inherit! :search_paths
     # Pods for testing
  end
  
...
      
end

Une fois que cela est fait, vous devez exécuter pod install dans le répertoire de votre projet pour installer le consentmanager SDK. Après cela, veuillez ouvrir le *.xcworkspace et construire. 

Après avoir suivi toutes les étapes, votre dépendance doit être installée et vous pouvez continuer et l'utiliser dans votre projet.

Installation manuelle

Nous vous recommandons vivement d'installer et d'utiliser la bibliothèque avec Cocoapod. Sans cela, il sera plus difficile à maintenir pour l'utilisateur ainsi que pour le développeur. De cette façon, les mises à jour doivent être intégrées manuellement et il existe des problèmes de contrôle de version. Par conséquent, nous prévoyons d'arrêter le service actif pour cette bibliothèque. 

Télécharger le SDK

Veuillez télécharger la dernière version du SDK ici:

Cadre XCF : https://bitbucket.org/consentmanager/consentmanager-xcframework/src/master/

Le SDK est configuré pour iOS version 10 et supérieure.

Intégration

Afin d'intégrer le SDK dans votre projet existant, veuillez suivre ces étapes:

  1. Tirez les fichiers du dossier ConsentManager.framework dans le dossier principal de votre application:



  2. Cliquez sur votre projet et allez dans l'onglet Général: et développez la pièce sous Cadres, bibliothèques et contenu intégré:

     

  3. Si le module n'est pas encore intégré, cliquez sur + (Plus)> Ajouter autre> Ajouter des fichiers ...:

  4. Sélectionnez le ConsentManager.framework dossier de précise projet et cliquez sur Ouvert:

  5. Vous devriez maintenant voir le Framework comme "Intégrer et signer" dans la liste:

  6. Accédez à votre contrôleur de vue principal de votre application et importez le framework en utilisant:
    #import <ConsentManager/CmpConsentTool.h>

Lancer le SDK

Avec l'application-start (généralement votre fonction viewDidAppear) vous doivent créer une instance de classe CMPConsentTool. Cela récupérera automatiquement les données nécessaires de notre serveur et déterminera si l'écran de consentement doit être affiché ou non. Si tel est le cas, le SDK affichera automatiquement l'écran de consentement à ce stade, collectera les données et fournira les données à l'application. L'instance peut ensuite être utilisée afin d'obtenir les détails du consentement du SDK afin de l'utiliser dans l'application.

#import "ViewController.h"
#import <ConsentManager/CMPConsentTool.h>

@interface ViewController ()
@property (weak, nonatomic) IBOutlet UILabel *GDPRConsentStringLabel;
@end

@implementation ViewController
static CMPConsentTool *cmpConsentTool = nil;

- (void)viewDidLoad {
    [super viewDidLoad];
}

- (void)viewDidAppear:(BOOL)animated {
    cmpConsentTool = [[CMPConsentTool alloc] init:@"consentmanager.mgr.consensu.org" addId:@"123456" addAppName:@"my%20Test%20App" addLanguage:@"DE" addViewController:self];
}

- (IBAction)showGDPRConsentTool:(id)sender {
    [cmpConsentTool openCmpConsentToolView];
}
@end

Exemple pour Swift:

cmpConsentTool = CMPConsentTool.init("consentmanager.mgr.consensu.org", addId: "123456", addAppName: "my%20test%20app", addLanguage: "DE", add: self)

Veuillez noter qu'il est important d'initialiser le SDK dans la méthode didAppear. Sinon, la vue peut ne pas être prête à être utilisée et le SDK peut échouer.

Veuillez vous assurer d'utiliser les données de configuration correctes. Les données de configuration se trouvent dans votre ConsentManager compte à Menu> Obtenir le code.

Utilisation du SDK

Afin de vérifier si un fournisseur ou un objectif a son consentement, vous pouvez utiliser les deux méthodes:

if(consentTool!.hasPurposeConsent("52", purposeIsV1orV2: false))
{
    if(consentTool!.hasVendorConsent("s26", purposeIsV1orV2: false))
    {
        //do something with data
    }
}

Les deux méthodes hasPurposeConsent et hasVendorConsent nécessitent deux paramètres:

  • id - Chaîne du fournisseur ou de l'ID de fonction. Veuillez noter que les identifiants de fournisseur peuvent avoir différents formats ("123", "s123" et "c123"), veuillez vérifier avec Menu> Fournisseurs et Menu> Objectifs dans votre ConsentManager compte.
  • isIABVendor / isIABPurpose - Si le fournisseur ou l'objet est un fournisseur / objectif qui suit la norme IAB TCF, vous devrez définir un vrai, sinon un faux.

N'oubliez pas: tous les fournisseurs qui n'appartiennent pas à l'IAB ont des ID commençant par un "s" ou "c" (par exemple, "s123"); les fournisseurs qui appartiennent à l'IAB ont des ID ne commençant pas par un «s» ou «c».

Réouverture de l'écran de consentement

Afin de permettre à l'utilisateur de modifier les choix, vous pouvez simplement appeler openCmpConsentToolView():

consentTool.openCmpConsentToolView();

Swift:

cmpConsentTool!.openView()

Dans certains cas, une application native peut contenir des vues Web afin d'afficher certaines choses comme du contenu publicitaire ou publicitaire. Afin de transmettre les informations de consentement du SDK à la vue Web, veuillez utiliser la fonction:

consentData = CMPStorageConsentManager.exportCMPData(this);

Cela exportera les informations de consentement et toutes les autres données nécessaires au CMP. Vous pouvez ensuite transmettre ces informations au CMP qui se trouve dans votre vue Web en l'ajoutant à l'URL appelée dans la vue Web:

myWebView.loadURL("https://mywebsite.com/....#cmpimport=" + consentData);

Compiler / télécharger sur l'AppStore

Afin de compiler le SDK pour l'AppStore, vous pouvez utiliser le script suivant pour nettoyer le répertoire de travail:

APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"
FRAMEWORK_NAME="ConsentManager.framework"
# Check if Framework is present.
FRAMEWORK_LOCATION=$(find "$APP_PATH" -name "$FRAMEWORK_NAME" -type d)
if [ -z $FRAMEWORK_LOCATION ]; then
echo "Couldn't find ConsentManager.framework in $APP_PATH. Make sure 'Embed Frameworks' build phase is listed before the 'Strip Unused Architectures' build phase."
exit 1
fi
# This script strips unused architectures
find "$APP_PATH" -name "$FRAMEWORK_NAME" -type d | while read -r FRAMEWORK
do
FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"
EXTRACTED_ARCHS=()
for ARCH in $ARCHS
do
echo "Extracting $ARCH from $FRAMEWORK_EXECUTABLE_NAME"
lipo -extract "$ARCH" "$FRAMEWORK_EXECUTABLE_PATH" -o "$FRAMEWORK_EXECUTABLE_PATH-$ARCH"
EXTRACTED_ARCHS+=("$FRAMEWORK_EXECUTABLE_PATH-$ARCH")
done
echo "Merging extracted architectures: ${ARCHS}"
lipo -o "$FRAMEWORK_EXECUTABLE_PATH-merged" -create "${EXTRACTED_ARCHS[@]}"
rm "${EXTRACTED_ARCHS[@]}"
echo "Replacing original executable with thinned version"
rm "$FRAMEWORK_EXECUTABLE_PATH"
mv "$FRAMEWORK_EXECUTABLE_PATH-merged" "$FRAMEWORK_EXECUTABLE_PATH"
done

Préférences NSUserDefaults

Le SDK définira NSUserDefaults valeurs pour IAB TCF v1, IAB TCF v2, IAB USPrivacy et Google AC String.

Les clés suivantes sont définies:

IAB TCF v1  
IABConsent_CMPPresent Boolean: Défini sur true si un CMP implémentant cette spécification est présent dans l'application. Idéalement défini par l'éditeur dès que possible, mais peut également être défini par le CMP en variante.
IABConsent_SubjectToGDPR String 1 - (soumis au RGPD), 0 - (non soumis au RGPD), Nil - indéterminé (par défaut avant l'initialisation). S'aligne sur l'avis IAB OpenRTB GDPR. Décidé d'être String, pour avoir le statut non initialisé.
IABConsent_ConsentString String: Chaîne de consentement
IABConsent_ParsedPurposeConsents String (de «0» et «1») où le caractère en position N indique le statut de consentement à l'ID d'objet N tel que défini dans la liste globale des fournisseurs. Chaîne de consentement donnée pour permettre une vérification simple. Le premier caractère à partir de la gauche étant le but 1, ...
IABConsent_ParsedVendorConsents String (de «0» et «1») où le caractère en position N indique le statut de consentement à l'ID de fournisseur N tel que défini dans la liste globale des fournisseurs. Chaîne de consentement donnée pour permettre une vérification simple. Le premier caractère à gauche étant le vendeur 1, ... 
IAB TCF v2  
IABTCF_CmpSdkID Number: ID entier non signé du SDK CMP
IABTCF_CmpSdkVersion Number: Numéro de version entier non signé du SDK CMP
IABTCF_PolicyVersion Number: L'entier non signé représentant la version du TCF à laquelle ces consentements adhèrent.
IABTCF_gdprApplies Number:

1 Le RGPD s'applique dans le contexte actuel

0 - GDPR fait pas appliquer dans le contexte actuel

once - indéterminé (par défaut avant l'initialisation)

IABTCF_PublisherCC String: Code ISO 3166-1 alpha-2 à deux lettres - Défaut: AA (inconnu)
IABTCF_PurposeOneTreatment Number:

0 - pas de traitement spécial du but un

1 - but un non divulgué

Annuler la valeur par défaut - 0

Les fournisseurs peuvent utiliser cette valeur pour déterminer si le consentement à la première fin est requis.

IABTCF_UseNonStandardStacks Number:

1 - CMP a utilisé une pile non standard

0 - CMP n'a pas utilisé de pile non standard

IABTCF_TCString String: Chaîne TC entièrement codée
IABTCF_VendorConsents Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut de consentement pour l'ID du fournisseur n + 1; false et true respectivement. par exemple. '1' à l'index 0 est le consentement true pour l'ID du fournisseur 1
IABTCF_VendorLegitimateInterests Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut d'intérêt légitime pour l'ID du fournisseur n + 1; false et true respectivement. par exemple. '1' à l'index 0 l'intérêt légitime est-il établi true pour l'ID du fournisseur 1
IABTCF_PurposeConsents Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut de consentement pour l'identification d'objet n + 1; false et true respectivement. par exemple. '1' à l'index 0 est le consentement true à des fins d'identification 1
IABTCF_PurposeLegitimateInterests Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut d'intérêt légitime pour l'identification d'objet n + 1; false et true respectivement. par exemple. '1' à l'index 0 l'intérêt légitime est-il établi true à des fins d'identification 1
IABTCF_SpecialFeaturesOptIns Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut d'activation pour l'ID de fonction spéciale n + 1; false et true respectivement. par exemple. '1' à l'index 0 est opt-in true pour l'ID de fonction spéciale 1
IABTCF_PublisherRestrictions{ID} String ['0','1', or '2']: La valeur à la position n - où nl'indexation de commence à 0 - indique le type de restriction de l'éditeur (0-2) pour le fournisseur n + 1; (voir Types de restrictions de l'éditeur). par exemple. '2' à l'index 0 est restrictionType 2 pour l'ID du fournisseur 1. {ID} fait référence à l'ID d'objet.
IABTCF_PublisherConsent Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut de consentement à l'objectif pour l'ID d'objet n + 1 pour l'éditeur, car ils correspondent aux objectifs de la liste mondiale des fournisseurs; false et true respectivement. par exemple. '1' à l'index 0 est le consentement true à des fins d'identification 1
IABTCF_PublisherLegitimateInterests Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut d'intérêt légitime de la finalité pour l'identification de la finalité n + 1 pour l'éditeur, car ils correspondent aux objectifs de la liste mondiale des fournisseurs; false et true respectivement. par exemple. '1' à l'index 0 l'intérêt légitime est-il établi true à des fins d'identification 1
IABTCF_PublisherCustomPurposesConsents Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut de consentement à la finalité pour l'ID de finalité personnalisée de l'éditeur n + 1 pour l'éditeur; false et true respectivement. par exemple. '1' à l'index 0 est le consentement true pour un identifiant à usage personnalisé 1
IABTCF_PublisherCustomPurposesLegitimateInterests Binary String: Le '0' or '1' à la position n - où nl'indexation de commence à 0 - indique le statut d'intérêt légitime de la finalité pour l'identifiant de finalité personnalisé de l'éditeur n + 1 pour l'éditeur; false et true respectivement. par exemple. '1' à l'index 0 l'intérêt légitime est-il établi true pour un identifiant à usage personnalisé 1
IAB États-Unis  
IABUSPrivacy_String String: S'aligne sur l'avis IAB OpenRTB CCPA. La chaîne encode tous les choix et informations.
Chaîne Google AC  
IABTCF_AddtlConsent

String: Correspond aux spécifications techniques du mode de consentement supplémentaire de Google. 

Présentation de l'API

- (void) openCmpConsentToolView; Affiche une vue modale avec la vue Web de consentement, sans demander au serveur, si un nouveau consentement est nécessaire. Lorsque la Webview est ouverte, openListener sera appelé. Si la conformité est acceptée ou rejetée, une fonction de fermeture sera appelée. Vous pouvez régler ces fonctions vous-même et les passer soit par ou après l'initialisation. Si vous souhaitez ajouter un closeListener uniquement pour cet appel de cette méthode, vous pouvez surcharger cette fonction avec une fonction closeListener supplémentaire.
- (void) openCmpConsentToolView: (void (^) (void)) closeListener; Affiche une vue modale avec la vue Web de consentement, sans demander au serveur, si un nouveau consentement est nécessaire. Lorsque la Webview est ouverte, openListener sera appelé. Si la conformité est acceptée ou rejetée, une fonction de fermeture sera appelée. Vous pouvez régler ces fonctions par vous-même et les passer soit par ou après l'initalisation. Si vous souhaitez ajouter un closeListener uniquement pour cet appel de cette méthode, vous pouvez surcharger cette fonction avec une fonction closeListener supplémentaire. CloseListener est une fonction appelée sans paramètre et ne renvoie aucune valeur. Il sera appelé asynchrone.
- (NSString *) getVendorsString;  Si le consentScreen est fermé, une version étendue de ConsentString est renvoyée par la logique de consentmanager. La chaîne de fournisseur supplémentaire contient tous les fournisseurs qui ne sont pas mentionnés par la CMPString. Cette chaîne sera retournée. Chaque fournisseur est séparé par un «_» et aura un «_» devant lui. «_C23_» serait une chaîne VendorsString valide générée par ConsentManager. Une chaîne VendorsString vide sera nulle, «» ou «__».
- (NSString *) getPurposesString; Si le consentScreen est fermé, une version étendue de ConsentString est renvoyée par la logique de consentmanager. La chaîne Purpose supplémentaire contient tous les objectifs qui ne sont pas mentionnés par la chaîne CMPS. Cette chaîne sera retournée. Chaque objectif est séparé par un «_» et aura un «_» devant lui. «_P23_» serait une PurposeString valide générée par ConsentManager. Une PurposeString vide sera soit null, «» ou «__».
- (NSString *) getUSPrivacyString;  Renvoie la chaîne de confidentialité américaine, qui a été renvoyée par le consentement des utilisateurs dans CMP ConsentScreen.
- (BOOL) hasVendorConsent: (NSString *) vendorId vendorIsV1orV2: (BOOL) isIABVendor; Renvoie si un fournisseur donné a le droit de définir des cookies. Le paramètre vendorIsV1orV2 revendique, si le fournisseur est mentionné par l'IABString standard, ou s'il est contenu dans le vendorString généré par consentmanager.
- (BOOL) hasPurposeConsent: (NSString *) purposeId purposeIsV1orV2: (BOOL) isIABPurpose; Renvoie si un objectif donné est accepté. Le paramètre purposeIsV1orV2 revendique, si l'objectif est mentionné par l'IABString ordinaire, ou s'il est contenu dans l'objet purposeString généré par consentmanager.
- (BOOL) hasPurposeConsent: (int) purposeId forVendor: (int) vendorId;

Renvoie, si le consentement à une fin pour un fournisseur spécifique a été donné. Cette méthode ne donnera une réponse valide que si le consentement a été donné dans la version V2.

- (id) init: (NSString *) domaine addId: (NSString *) userId addAppName: (NSString *) appName addLanguage: (NSString *) langue addViewController: (UIViewController *) viewController;

- (id) init: (NSString *) domaine addId: (NSString *) userId addAppName: (NSString *) appName addLanguage: (NSString *) langue addViewController: (UIViewController *) viewController addOpenListener: (void (^) (void)) openListener;

- (id) init: (NSString *) domaine addId: (NSString *) userId addAppName: (NSString *) appName addLanguage: (NSString *) langue addViewController: (UIViewController *) viewController addCloseListener: (void (^) (void)) closeListener;

- (id) init: (NSString *) domaine addId: (NSString *) userId addAppName: (NSString *) appName addLanguage: (NSString *) langue addViewController: (UIViewController *) viewController addOpenListener: (void (^) (void)) openListener addCloseListener: (void (^) (void)) closeListener;

- (id) init: (NSString *) domaine addId: (NSString *) userId addAppName: (NSString *) appName addLanguage: (NSString *) langue addViewController: (UIViewController *) viewController autoupdate: (BOOL) autoupdate;

- (id) init: (NSString *) domaine addId: (NSString *) userId addAppName: (NSString *) appName addLanguage: (NSString *) langue addViewController: (UIViewController *) viewController autoupdate: (BOOL) autoupdate addOpenListener ( ^) (void)) openListener;

- (id) init: (NSString *) domaine addId: (NSString *) userId addAppName: (NSString *) appName addLanguage: (NSString *) langue addViewController: (UIViewController *) viewController autoupdate: (BOOL) autoupdate addCloseListener ( ^) (void)) closeListener;

- (id) init: (NSString *) domaine addId: (NSString *) userId addAppName: (NSString *) appName addLanguage: (NSString *) langue addViewController: (UIViewController *) viewController autoupdate: (BOOL) autoupdate addOpenListener ( ^) (void)) openListener addCloseListener: (void (^) (void)) closeListener;

- (id) init: (CMPConfig *) config withViewController: (UIViewController *) viewController;

- (id) init: (CMPConfig *) config withViewController: (UIViewController *) viewController addOpenListener: (void (^) (void)) openListener;

- (id) init: (CMPConfig *) config withViewController: (UIViewController *) viewController addCloseListener: (void (^) (void)) closeListener;

- (id) init: (CMPConfig *) config withViewController: (UIViewController *) viewController addOpenListener: (void (^) (void)) openListener addCloseListener: (void (^) (void)) closeListener;

- (id) init: (CMPConfig *) config withViewController: (UIViewController *) viewController autoupdate: (BOOL) autoupdate;

- (id) init: (CMPConfig *) config withViewController: (UIViewController *) viewController autoupdate: (BOOL) autoupdate addOpenListener: (void (^) (void)) openListener;

- (id) init: (CMPConfig *) config withViewController: (UIViewController *) viewController autoupdate: (BOOL) autoupdate addCloseListener: (void (^) (void)) closeListener;

- (id) init: (CMPConfig *) config withViewController: (UIViewController *) viewController autoupdate: (BOOL) autoupdate addOpenListener: (void (^) (void)) openListener addCloseListener: (void (^) (void)) closeListener;

Crée une nouvelle instance de ce CMPConsentTool.

@ param domain = L'URL du domaine de consentmanager par exemple.: "www.consentmanager. Net »

@ param userId = L'ID de votre compte de consentmanagers webste par exemple,: 123

@ param appName = Le nom de votre application, par exemple: "Mon application de test"

@param language = La langue dans laquelle le consentement doit être affiché, par exemple: "de"

@param viewController = L'instance ViewController principale de l'application

@param autoupdate = Si défini, l'application vérifiera d'elle-même, si un nouveau consentement est nécessaire, si l'application sera ouverte depuis l'arrière-plan.

@param openListener = Cet écouteur donné en tant que fonction sera appelé asynchrone peu de temps avant l'ouverture de l'écran de consentement CMP.

@param closeListener = Cet écouteur sera appelé asynchrone, si un consentement a été donné par l'utilisateur et le CMPConsentScreen a été fermé. Cet écouteur n'est PAS appelé si l'utilisateur ferme l'application sans donner son consentement.

@param config = Le domaine des paramètres, userId, appName, langue dans un objet de type CMPConfig.

Vous pouvez surcharger la fonction d'initialisation, comme vous pouvez le voir dans les constructeurs suivants:

+ (NSString *) exportCMPData; Exporte la chaîne CMPData actuelle. Vous pouvez facilement importer cette chaîne sur n'importe quel autre appareil avec la fonction importCMPData.
+ (BOOL) importCMPData: (NSString *) cmpData; Importe la chaîne CMPData donnée. Vous pouvez facilement exporter cette chaîne sur n'importe quel autre appareil avec la fonction exportCMPData.
- (BOOL) appeléThisDay;  renvoie, si le serveur CMPConsent Manager a été demandé aujourd'hui ou consentmanager a déjà été demandé au serveur, si l'écran de consentement CMP doit être affiché à nouveau.
- (BOOL) needsAcceptance;  renvoie, que l'utilisateur doive donner son consentement, parce qu'il ne l'a pas fait dans le passé ou parce que le serveur de consentement a renvoyé, qu'un nouveau consentement est requis.
+ (nul) réinitialisé; réinitialise toutes les données définies par consentCMPTool dans les préférences partagées.

 

Retour en haut de la page