[Unity] 2. Documentation de l'API
SDK obsolète / Mise à niveau vers la version 3 : Cette documentation décrit la version 2.x de notre SDK. Le SDK 2.x est obsolète et sera supprimé d'ici la fin de l'année 2025. Veuillez effectuer une mise à niveau vers la version 3.x du SDK. Voir la section Aide sur SDK v3 ici.
AddEventListeners
Définit des rappels spécifiques à Android pour les événements CMP.
Exemple
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);CheckConsentIsRequired
Vérifie si le consentement de l'utilisateur est requis et, si tel est le cas, ouvre l'interface utilisateur de la couche de consentement. Cette méthode consomme une page vue.
Paramètres
| Aucun. |
Retour
TRUE si le consentement de l'utilisateur est requis
FALSE autrement.
Exemple
var isRequired = await _cmpManager.CheckConsentIsRequired();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 |
isFocusable (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) |
SetAndroidUiType (Android uniquement)
|
Définit le type d’interface utilisateur pour Android. | tapez (AndroidUiType) |
CmpBridgeSetConsentManagerModalPresentationStyle (iOS seulement)
|
Définit le style de présentation modale via un appel externe. | modalPresentationStyle (int) |
ConfigureModalPresentationStyle (iOS seulement)
|
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) |
ExporterCmpString
Exporte la chaîne CMP actuelle représentant les préférences de consentement de l'utilisateur. Cette méthode est accessible de manière statique. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
Chaîne: Les paramètres CMP exportés sous forme de chaîne.
Exemple
string cmpSettings = ExportCmpString();ObtenirAllPurposes
Renvoie tous les identifiants des objectifs. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
Lister : une liste d'identifiants d'objectif.
Exemple
List<string> purposes = GetAllPurposes();ObtenirTousLesVendeurs
Renvoie tous les identifiants des fournisseurs pour un CMP donné. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
Lister: Une liste d’ID de fournisseur.
Exemple
List<string> allVendors = GetAllVendors();GetDisabledObjectifs
Renvoie tous les identifiants des objectifs désactivés pour un CMP donné. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
Lister : une liste des identifiants d'objectif désactivés.
Exemple
List<string> disabledPurposes = GetDisabledPurposes();
GetDisabledVendors
Renvoie tous les identifiants des fournisseurs désactivés pour une CMP donnée. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
Lister: Une liste des identifiants de fournisseurs désactivés.
Exemple
List<string> disabledVendors = GetDisabledVendors();GetEnabledPurposes
Renvoie tous les identifiants des objectifs activés pour un CMP donné. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
Lister : une liste des identifiants d'objectif activés.
Exemple
List<string> enabledPurposes = GetEnabledPurposes();GetEnabledVendors
Renvoie tous les identifiants des fournisseurs activés pour une CMP donnée. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
Lister: Une liste des ID de fournisseur activés.
Exemple
List<string> enabledVendors = GetEnabledVendors();ObtenirGoogleAcString
Récupère la chaîne d'ID de consentement supplémentaire de Google ('addtlConsent') qui a été définie par le consent manager.
Pour plus d'informations, consultez le Spécifications techniques du consentement supplémentaire de Google.
Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun |
Retour
un magnifique : la chaîne de consentement de l'annonceur Google.
Exemple
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Récupère la chaîne de confidentialité américaine. Cette chaîne de confidentialité américaine est un cookie qui stocke des informations sur les divulgations effectuées et les choix sélectionnés par le visiteur du site Web concernant ses droits de consommateur. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
un magnifique: La chaîne de confidentialité américaine.
Exemple
string usPrivacyString = GetUsPrivacyString();AConsent
Vérifie si l'utilisateur a déjà donné son consentement. La couche de consentement peut avoir l'option de simplement fermer la couche. Dans ce cas, l'utilisateur n'a pas donné son consentement. Cette méthode ne consomme aucune page vue.
Paramètres
| Aucun. |
Retour
TRUE si l'utilisateur a donné son consentement
FALSE autrement
Exemple
var hasConsent = _cmpManager.HasConsent();A un but
Vérifie si l'ID d'objectif est activé en fonction du consentement de l'utilisateur. Cette méthode ne consomme aucune page vue.
Paramètres
- id: L'ID du but à vérifier.
Retour
TRUE si le but est sélectionné
FALSE autrement.
Exemple
bool result = _cmpManager.HasPurpose(purposeId);AVendeur
Vérifie si l'ID du fournisseur est activé en fonction du consentement de l'utilisateur. Cette méthode ne consomme aucune page vue.
Paramètres
| 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. |
Retour
TRUE si le vendeur est sélectionné
FALSE autrement.
Exemple
bool result = HasVendor("vendorId");ImportCmpString
Importe une chaîne CMP représentant les préférences de consentement de l'utilisateur. La chaîne doit être informée TELLE QUELLE lorsqu'elle est récupérée via la méthode exportCmpString(). Cette méthode consomme une page vue.
Paramètres
un magnifique: La chaîne CMP
Retour
CmpImportResult:Résultat si l'importation a réussi.
Exemple
result = await _cmpManager.ImportCmpString(cmpString);Initialiser
La fonction Initialize initialise la couche de consentement et vérifie automatiquement si l'utilisateur a besoin d'un consentement ou non. Cette fonction ouvrira éventuellement la couche de consentement et interagira avec l'API Apple Tracking Transparency pour demander le consentement de l'utilisateur. Cette méthode consomme une page vue.
Paramètres
| Nom | Type | Description |
domain |
Chaîne | Le domaine de la plateforme de gestion du consentement. |
codeId |
Chaîne | L’ID de code de l’application. |
appName |
Chaîne | Nom de l'application. |
language |
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
}Lancement (obsolète)
Lance le CmpManager et affiche la couche de consentement si nécessaire.
Exemple
_cmpManager.Launch();OuvrirConsentLayer
Ouvre de force la vue Web de la couche de consentement CMP. Cette méthode consomme une page vue.
Paramètres
| Aucun. |
Retour
| Aucun. |
Exemple
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Vérifie si le consentement de l'utilisateur est requis et, si tel est le cas, ouvre la vue Web de la couche de consentement. Cette méthode consomme une page vue.
Paramètres
| Aucun. |
Retour
| Aucun. |
Exemple
_cmpManager.OpenConsentLayerOnCheck();
