[Unity] 2. Documentation de l'API
Initialiser
Initialise le Consent Manager avec le domaine fourni, l'ID de code, le nom de l'application et la langue.
Paramètres
| Prénom | Type | Description |
| domaine | Chaîne | Le domaine de la plateforme de gestion du consentement. |
| codeId | Chaîne | L’ID de code de l’application. |
| nom de l'application | Chaîne | Nom de l'application. |
| langue | Chaîne | Le code de langue (par exemple, « EN », « DE ») pour la localisation. |
Exemple
private void Awake()
{
_cmpManager = CmpManager.Instance;
}
private void Start()
{
_mainThread = Thread.CurrentThread;
Debug.Log("Consentmanager SampleScene started");
#if (UNITY_ANDROID || UNITY_IOS) && !UNITY_EDITOR
var config = new CmpConfig(CodeId, Domain, AppName, Language);
// Example of using a custom layout
// var customRect = new Rect(0,0, 300, 600);
// config.SetCustomLayout(customRect);
// alternative create the instance directly with the required parameters
// _cmpManager.Initialize(Domain, CodeId, AppName, Language);
_cmpManager.Initialize(config);
_cmpManager.Launch();
#endif
}
AddEventListeners
Définit des rappels spécifiques à Android pour les événements CMP.
Exemple
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);Lancement
Lance le CmpManager et affiche la couche de consentement si nécessaire
Exemple
_cmpManager.Launch();AConsent
Vérifie si l'utilisateur a donné son consentement.
Retour
vrai si l'utilisateur a donné son consentement, faux sinon.
Exemple
var hasConsent = _cmpManager.HasConsent();
OuvrirConsentLayer
Ouvre la couche de consentement pour gérer les paramètres de consentement de l'utilisateur.
Exemple
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Ouvre la couche de consentement si nécessaire en fonction des vérifications.
Exemple
_cmpManager.OpenConsentLayerOnCheck();AVendeur
Vérifie si un fournisseur avec l'ID spécifié a été sélectionné par l'utilisateur.
Paramètres
| Prénom | Type | Description |
id |
un magnifique | L'ID du fournisseur à vérifier. Vous pouvez trouver les identifiants des fournisseurs dans votre compte sous Menu > CMP > Fournisseurs. |
Type de retour
(booléen) true si le fournisseur est sélectionné, false autrement.
Exemple
bool result = HasVendor("vendorId");A un but
Vérifie si un objectif avec l'ID spécifié a été sélectionné par l'utilisateur.
Paramètres
- id: L'ID du but à vérifier.
Type de retour
bool: Vrai si l'objectif est sélectionné, faux sinon.
Exemple
bool result = _cmpManager.HasPurpose(purposeId);CheckConsentIsRequired
Vérifie si l'utilisateur doit donner son consentement
Type de retour
bool: Vrai si le consentement est requis
Exemple
var isRequired = await _cmpManager.CheckConsentIsRequired();ExporterCmpString
Exporte les paramètres de la Consent Management Platform (CMP) sous forme de chaîne.
Type de retour
un magnifique: Les paramètres CMP exportés sous forme de chaîne.
Exemple
string cmpSettings = ExportCmpString();ImportCmpString
Importez la chaîne Consent Management Platform (CMP).
Paramètres
un magnifique: La chaîne CMP
Type de retour
CmpImportResult: Résultat si l'import a réussi
Exemple
result = await _cmpManager.ImportCmpString(cmpString);ObtenirAllPurposes
Obtient une liste de tous les objectifs disponibles.
Type de retour
Lister : une liste d'identifiants d'objectif.
Exemple
List<string> purposes = GetAllPurposes();GetEnabledPurposes
Obtient une liste des objectifs activés.
Type de retour
Lister : une liste des identifiants d'objectif activés.
Exemple
List<string> enabledPurposes = GetEnabledPurposes();GetDisabledObjectifs
Obtient une liste des objectifs désactivés.
Type de retour
Lister : une liste des identifiants d'objectif désactivés.
Exemple
List<string> disabledPurposes = GetDisabledPurposes();ObtenirTousLesVendeurs
Obtient une liste de tous les fournisseurs disponibles.
Type de retour
Lister: Une liste d’ID de fournisseur.
Exemple
List<string> allVendors = GetAllVendors();GetEnabledVendors
Obtient une liste des fournisseurs activés.
Type de retour
Lister: Une liste des ID de fournisseur activés.
Exemple
List<string> enabledVendors = GetEnabledVendors();GetDisabledVendors
Obtient une liste des fournisseurs désactivés.
Type de retour
Lister: Une liste des identifiants de fournisseurs désactivés.
Exemple
List<string> disabledVendors = GetDisabledVendors();ObtenirGoogleAcString
Obtient la chaîne de consentement de l'annonceur Google.
Type de retour
un magnifique : la chaîne de consentement de l'annonceur Google.
Exemple
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Obtient la chaîne de confidentialité américaine.
Type de retour
un magnifique: La chaîne de confidentialité américaine.
Exemple
string usPrivacyString = GetUsPrivacyString();
Aperçu :
| Fonction | Description | Paramètres |
|---|---|---|
| Initialiser | Initialise le gestionnaire CMP avec le domaine, l'ID de code, le nom de l'application et la langue. | domaine, codeId, appName, langue |
| Initialiser | Initialise le gestionnaire CMP avec un objet de configuration. | configuration (CmpConfig) |
| AConsent | Vérifie si l'utilisateur a donné son consentement. | Aucune |
| AVendeur | Vérifie si un fournisseur avec l'ID spécifié est sélectionné par l'utilisateur. | identifiant (chaîne) |
| A un but | Vérifie si un objectif avec l'ID spécifié est sélectionné par l'utilisateur. | identifiant (chaîne) |
| OuvrirConsentLayer | Ouvre la couche de consentement pour gérer les paramètres de consentement des utilisateurs. | Aucune |
| OpenConsentLayerOnCheck | Ouvre la couche de consentement si nécessaire, sur la base d'une vérification auprès du backend. | Aucune |
| CheckConsentIsRequired | Vérifie si l’ouverture de la couche de consentement est nécessaire. | Aucune |
| Accepter tout | Accepte toutes les options de consentement. | Aucune |
| Rejeter tout | Rejette toutes les options de consentement. | Aucune |
| Lancement | Lance le gestionnaire CMP et affiche la couche de consentement si nécessaire. | Aucune |
| Réinitialiser | Réinitialise les paramètres CMP. | Aucune |
| ExporterCmpString | Exporte les paramètres CMP sous forme de chaîne. | Aucune |
| ImportCmpString | Importe les paramètres CMP à partir d'une chaîne donnée. | cmp (chaîne) |
| ObtenirGoogleAcString | Obtient la chaîne de consentement de l'annonceur Google. | Aucune |
| GetUsPrivacyString | Obtient la chaîne de confidentialité américaine. | Aucune |
| GetLastATTrackingRequestDate | Obtient la date de la dernière demande de transparence du suivi des applications. | Aucune |
| ObtenirGoogleConsentModeStatus | Obtient l'état actuel du mode consentement de Google. | Aucune |
| ObtenirAllPurposes | Obtient une liste de tous les objectifs disponibles. | Aucune |
| GetEnabledPurposes | Obtient une liste des objectifs activés. | Aucune |
| GetDisabledObjectifs | Obtient une liste des objectifs désactivés. | Aucune |
| ObtenirTousLesVendeurs | Obtient une liste de tous les fournisseurs disponibles. | Aucune |
| GetEnabledVendors | Obtient une liste des fournisseurs activés. | Aucune |
| GetDisabledVendors | Obtient une liste des fournisseurs désactivés. | Aucune |
| DéfinirUIConfig | Définit la configuration de l'interface utilisateur pour l'interface utilisateur CMP. | cmpUIConfig (CmpUIConfig) |
| DemandeATTrackingPermission | (iOS uniquement) Demande l’autorisation de transparence du suivi des applications. | Aucune |
Présentation de CmpUIConfig :
| Propriété/Méthode | Description | Type/Paramètres |
|---|---|---|
| screenConfig | Propriété pour contenir la configuration d'écran choisie. | Énumération ScreenConfig |
| AndroidUiType (Android uniquement) | Type d'interface utilisateur pour les appareils Android. | Énumération AndroidUiType |
| androidFragmentContainerId (Android uniquement) | ID de conteneur pour le fragment Android. | int |
| estFocusable (Android uniquement) | Si l'interface utilisateur doit être focalisable. | bool |
| isOutsideTouchable (Android uniquement) | Si le contact extérieur doit être détecté. | bool |
| SetAndroidFragmentContainerId (Android uniquement) | Définit l'ID du conteneur pour le fragment Android. | identifiant (int) |
| DéfinirAndroidUiType (Android uniquement) | Définit le type d’interface utilisateur pour Android. | tapez (AndroidUiType) |
| CmpBridgeSetConsentManagerStyle de présentation modale (iOS uniquement) | Définit le style de présentation modale via un appel externe. | modalPresentationStyle (int) |
| ConfigureModalPresentationStyle (iOS uniquement) | Configure le style de présentation modale pour iOS. | style (CmpIOSModalPresentationStyle) |
Présentation de CmpConfig :
| Propriété/Méthode | Description | Type/Paramètres |
|---|---|---|
| Constructeur | Initialise la configuration CMP avec les paramètres nécessaires. | identifiant, domaine, appName, langue, uiConfig (facultatif) |
| UIConfig | Propriété pour contenir la configuration de l'interface utilisateur. | CmpUIConfig |
| IdfaOrGaid | Identifiant des annonceurs ou identifiant publicitaire Google. | un magnifique |
| Temps mort | Délai d'expiration pour les opérations CMP. | int |
| Aller à la page Paramètres | S'il faut accéder automatiquement à la page des paramètres. | bool |
| ID de conception | ID de conception facultatif pour la personnalisation de l’interface utilisateur CMP. | int ? |
| Déboguer | Active le mode débogage. | bool |
| Id | L'identifiant unique de l'instance CMP. | chaîne (lecture seule) |
| Domaine | Domaine associé à l'instance CMP. | chaîne (lecture seule) |
| Nom de l'application | Le nom de l'application utilisant CMP. | chaîne (lecture seule) |
| Langue | Le langage pour l’interface utilisateur et les opérations CMP. | chaîne (lecture seule) |
