[Eenheid] 2. API-documentatie
Voeg EventListeners toe
Stelt Android-specifieke callbacks in voor CMP-gebeurtenissen.
Voorbeeld
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);Vink ToestemmingIsVereist aan
Controleert of toestemming van de gebruiker vereist is en opent, indien dit het geval is, de gebruikersinterface van de toestemmingslaag. Deze methode verbruikt één paginaweergave.
parameters
| Geen. |
Retourneren
TRUE indien de toestemming van de gebruiker vereist is
FALSE anders.
Voorbeeld
var isRequired = await _cmpManager.CheckConsentIsRequired();CmpUIConfig-overzicht
| Eigenschap/methode | Beschrijving | Type/parameters |
|---|---|---|
screenConfig |
Eigenschap om de gekozen schermconfiguratie vast te houden. | ScreenConfig opsomming |
androidUiType (Alleen Android)
|
UI-type voor Android-apparaten. | AndroidUiType opsomming |
androidFragmentContainerId (Alleen Android)
|
Container-ID voor Android-fragment. | int |
isFocusable (Alleen Android)
|
Als de gebruikersinterface focusseerbaar moet zijn. | bool |
isOutsideTouchable (Alleen Android)
|
Als de aanraking van buitenaf moet worden gedetecteerd. | bool |
SetAndroidFragmentContainerId (Alleen Android)
|
Stelt de container-ID in voor het Android-fragment. | ID (int) |
SetAndroidUiType (Alleen Android)
|
Stelt het UI-type voor Android in. | type (AndroidUiType) |
CmpBridgeSetConsentManagerModalPresentationStyle (alleen iOS)
|
Stelt de modale presentatiestijl in via een extern gesprek. | modalPresentatiestijl (int) |
ConfigureModalPresentationStyle (alleen iOS)
|
Configureert de modale presentatiestijl voor iOS. | stijl (CmpIOSModalPresentationStyle) |
CmpConfig-overzicht
| Eigenschap/methode | Beschrijving | Type/parameters |
|---|---|---|
| Constructeur | Initialiseert de CMP-configuratie met de benodigde parameters. | id, domein, appName, taal, uiConfig (optioneel) |
| UIConfig | Eigenschap om de UI-configuratie vast te houden. | CmpUIConfig |
| IdfaOrGaid | Identificatie voor adverteerders of Google Advertising ID. | snaar |
| Timeout | Time-out voor CMP-bewerkingen. | int |
| Ga naarInstellingenPagina | Of er automatisch naar de instellingenpagina moet worden gesprongen. | bool |
| OntwerpId | Optionele ontwerp-ID voor aanpassing van de CMP UI. | int? |
| Debug | Schakelt de foutopsporingsmodus in. | bool |
| Id | De unieke ID voor het CMP-exemplaar. | tekenreeks (alleen-lezen) |
| Domein | Het domein dat is gekoppeld aan het CMP-exemplaar. | tekenreeks (alleen-lezen) |
| Applicatie naam | De naam van de toepassing die CMP gebruikt. | tekenreeks (alleen-lezen) |
| Taal | De taal voor de CMP-gebruikersinterface en -bewerkingen. | tekenreeks (alleen-lezen) |
ExportCmpString
Exporteert de huidige CMP-tekenreeks die de toestemmingsvoorkeuren van de gebruiker vertegenwoordigt. Deze methode wordt op een statische manier benaderd. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
Draad: De geëxporteerde CMP-instellingen als tekenreeks.
Voorbeeld
string cmpSettings = ExportCmpString();GetAllPurposes
Retourneert alle doeleinden-ID's. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
Lijst: een lijst met doel-ID's.
Voorbeeld
List<string> purposes = GetAllPurposes();GetAllVendors
Retourneert alle leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
Lijst: een lijst met leveranciers-ID's.
Voorbeeld
List<string> allVendors = GetAllVendors();GetDisabledPurposes
Retourneert alle ID's van uitgeschakelde doeleinden voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
Lijst: een lijst met uitgeschakelde doel-ID's.
Voorbeeld
List<string> disabledPurposes = GetDisabledPurposes();
GetDisabledVendors
Retourneert alle uitgeschakelde leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
Lijst: een lijst met uitgeschakelde leveranciers-ID's.
Voorbeeld
List<string> disabledVendors = GetDisabledVendors();GetEnabledPurposes
Retourneert alle ingeschakelde doeleinden-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
Lijst: een lijst met ingeschakelde doel-ID's.
Voorbeeld
List<string> enabledPurposes = GetEnabledPurposes();GetEnabledVendors
Retourneert alle ingeschakelde leveranciers-ID's voor een gegeven CMP. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
Lijst: een lijst met ingeschakelde leveranciers-ID's.
Voorbeeld
List<string> enabledVendors = GetEnabledVendors();GetGoogleAcString
Haalt de extra toestemmings-ID ('addtlConsent') van Google op die door de consent manager.
Voor meer informatie, kijk op de Technische specificatie voor aanvullende toestemming van Google.
Deze methode verbruikt geen paginaweergaven.
parameters
| Geen |
Retourneren
snaar: De tekenreeks voor toestemming van Google-adverteerder.
Voorbeeld
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Haalt de US Privacy String op. Deze US privacy string is een cookie die informatie opslaat over de openbaarmakingen en keuzes die de bezoeker van de website heeft gemaakt met betrekking tot zijn consumentenrechten. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
snaar: De Amerikaanse privacytekenreeks.
Voorbeeld
string usPrivacyString = GetUsPrivacyString();Heeft toestemming
Controleert of de gebruiker al toestemming heeft gegeven. De toestemmingslaag kan de optie hebben om de laag gewoon te sluiten. In dat geval heeft de gebruiker geen toestemming gegeven. Deze methode verbruikt geen paginaweergaven.
parameters
| Geen. |
Retourneren
TRUE als de gebruiker toestemming heeft gegeven
FALSE anders-
Voorbeeld
var hasConsent = _cmpManager.HasConsent();Heeft een doel
Controleert of de doel-ID is ingeschakeld op basis van de toestemming van de gebruiker. Deze methode verbruikt geen paginaweergaven.
parameters
- id: De ID van het doel dat moet worden gecontroleerd.
Retourneren
TRUE als het doel is geselecteerd
FALSE anders.
Voorbeeld
bool result = _cmpManager.HasPurpose(purposeId);HeeftVerkoper
Controleert of de leveranciers-ID is ingeschakeld op basis van de toestemming van de gebruiker. Deze methode verbruikt geen paginaweergaven.
parameters
| Naam | Type | Beschrijving |
id |
snaar | De ID van de leverancier die moet worden gecontroleerd. U vindt de leveranciers-ID's in uw account onder Menu > CMP's > Leveranciers. |
Retourneren
TRUE als de leverancier is geselecteerd
FALSE anders.
Voorbeeld
bool result = HasVendor("vendorId");ImportCmpString
Importeert een CMP-tekenreeks die de toestemmingsvoorkeuren van de gebruiker vertegenwoordigt. De string moet AS-IS worden geïnformeerd wanneer deze wordt opgehaald via de exportCmpString()-methodeDeze methode verbruikt één paginaweergave.
parameters
snaar: De CMP-tekenreeks
Retourneren
CmpImportResultaat: Resultaat als het importeren succesvol was.
Voorbeeld
result = await _cmpManager.ImportCmpString(cmpString);initialiseren
De functie Initialize initialiseert de toestemmingslaag en controleert automatisch of de gebruiker toestemming nodig heeft of niet. Deze functie opent uiteindelijk de toestemmingslaag en zal interacteren met de Apple Tracking Transparency API om de gebruiker om toestemming te vragen. Deze methode verbruikt één paginaweergave.
parameters
| Naam | Type | Beschrijving |
domain |
Draad | Het domein van het toestemmingsbeheerplatform. |
codeId |
Draad | De code-ID voor de toepassing. |
appName |
Draad | De naam van de applicatie. |
language |
Draad | De taalcode (bijvoorbeeld "EN", "DE") voor lokalisatie. |
Voorbeeld
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
}Lancering (verouderd)
Start de CmpManager en toont indien nodig de toestemmingslaag.
Voorbeeld
_cmpManager.Launch();OpenConsentLayer
Opent geforceerd de CMP-toestemmingslaag webview. Deze methode verbruikt één paginaweergave.
parameters
| Geen. |
Retourneren
| Geen. |
Voorbeeld
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Controleert of toestemming van de gebruiker vereist is en opent, indien dit het geval is, de toestemmingslaag webview. Deze methode verbruikt één paginaweergave.
parameters
| Geen. |
Retourneren
| Geen. |
Voorbeeld
_cmpManager.OpenConsentLayerOnCheck();
