Info
Content

[Eenheid] 2. API-documentatie

initialiseren


Initialiseert de Consent Manager met het opgegeven domein, code-ID, app-naam en taal.

parameters
Naam Type Omschrijving
domein Draad Het domein van het toestemmingsbeheerplatform.
codeId Draad De code-ID voor de toepassing.
applicatie naam Draad De naam van de applicatie.
taal 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
        }

 

Voeg EventListeners toe


Stelt Android-specifieke callbacks in voor CMP-gebeurtenissen.

Voorbeeld
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);

Lancering


 Start de CmpManager en toont indien nodig de toestemmingslaag

Voorbeeld
_cmpManager.Launch();

 

Heeft toestemming


Controleert of de gebruiker toestemming heeft gegeven.

Retourneren

true als de gebruiker toestemming heeft gegeven, anders false.

Voorbeeld
var hasConsent = _cmpManager.HasConsent();

 

OpenConsentLayer


Opent de toestemmingslaag om de toestemmingsinstellingen van de gebruiker te beheren.

Voorbeeld
_cmpManager.OpenConsentLayer();

 

OpenConsentLayerOnCheck


Opent indien nodig de toestemmingslaag op basis van controles.

Voorbeeld
_cmpManager.OpenConsentLayerOnCheck();

 

HeeftVerkoper


Controleert of een leverancier met het opgegeven ID door de gebruiker is geselecteerd.

parameters
  • id: De ID van de leverancier die moet worden gecontroleerd.
Retourtype

bool: True als de leverancier is geselecteerd, anders false.

Voorbeeld
bool result = HasVendor("vendorId");

Heeft een doel


Controleert of een doel met het opgegeven ID door de gebruiker is geselecteerd.

parameters
  • id: De ID van het doel dat moet worden gecontroleerd.
Retourtype

bool: Waar als het doel is geselecteerd, anders onwaar.

Voorbeeld
bool result = _cmpManager.HasPurpose(purposeId);

Vink ToestemmingIsVereist aan


Controleert of de gebruiker toestemming moet geven

Retourtype

bool: Waar als toestemming vereist is

Voorbeeld
var isRequired = await _cmpManager.CheckConsentIsRequired();

ExportCmpString


Retourtype

snaar: De geëxporteerde CMP-instellingen als tekenreeks.

Voorbeeld
string cmpSettings = ExportCmpString();

ImportCmpString


parameters

snaar: De CMP-tekenreeks

Retourtype

CmpImportResultaat: Resultaat als de import succesvol was

Voorbeeld
 result = await _cmpManager.ImportCmpString(cmpString);

GetAllPurposes


Krijgt een lijst met alle beschikbare doeleinden.

Retourtype

Lijst: een lijst met doel-ID's.

Voorbeeld
List<string> purposes = GetAllPurposes();

GetEnabledPurposes


Krijgt een lijst met ingeschakelde doeleinden.

Retourtype

Lijst: een lijst met ingeschakelde doel-ID's.

Voorbeeld
List<string> enabledPurposes = GetEnabledPurposes();

GetDisabledPurposes


Krijgt een lijst met uitgeschakelde doeleinden.

Retourtype

Lijst: een lijst met uitgeschakelde doel-ID's.

Voorbeeld
List<string> disabledPurposes = GetDisabledPurposes();

GetAllVendors


Krijgt een lijst met alle beschikbare leveranciers.

Retourtype

Lijst: een lijst met leveranciers-ID's.

Voorbeeld
List<string> allVendors = GetAllVendors();

GetEnabledVendors


Krijgt een lijst met ingeschakelde leveranciers.

Retourtype

Lijst: een lijst met ingeschakelde leveranciers-ID's.

Voorbeeld
List<string> enabledVendors = GetEnabledVendors();

GetDisabledVendors


Krijgt een lijst met uitgeschakelde leveranciers.

Retourtype

Lijst: een lijst met uitgeschakelde leveranciers-ID's.

Voorbeeld
List<string> disabledVendors = GetDisabledVendors();

GetGoogleAcString


Haalt de tekenreeks voor toestemming van Google-adverteerder op.

Retourtype

snaar: De tekenreeks voor toestemming van Google-adverteerder.

Voorbeeld
string googleAcString = GetGoogleAcString();

GetUsPrivacyString


Haalt de Amerikaanse privacytekenreeks op.

Retourtype

snaar: De Amerikaanse privacytekenreeks.

Voorbeeld
string usPrivacyString = GetUsPrivacyString();

 

Overzicht: 

 

Functie Omschrijving parameters
initialiseren Initialiseert de CMP Manager met domein, code-ID, app-naam en taal. domein, codeId, appName, taal
initialiseren Initialiseert de CMP Manager met een configuratieobject. configuratie (CmpConfig)
Heeft toestemming Controleert of de gebruiker toestemming heeft gegeven. Geen
HeeftVerkoper Controleert of een leverancier met het opgegeven ID door de gebruiker is geselecteerd. ID (tekenreeks)
Heeft een doel Controleert of een doel met het opgegeven ID door de gebruiker is geselecteerd. ID (tekenreeks)
OpenConsentLayer Opent de toestemmingslaag voor het beheren van de toestemmingsinstellingen van gebruikers. Geen
OpenConsentLayerOnCheck Opent indien nodig de toestemmingslaag op basis van een controle met de backend. Geen
Vink ToestemmingIsVereist aan Controleert of het openen van de toestemmingslaag noodzakelijk is. Geen
Accepteer alles Accepteert alle toestemmingsopties. Geen
Alles afwijzen Wijst alle toestemmingsopties af. Geen
Lancering Start de CMP Manager en toont indien nodig de toestemmingslaag. Geen
Reset Reset de CMP-instellingen. Geen
ExportCmpString Exporteert CMP-instellingen als een tekenreeks. Geen
ImportCmpString Importeert CMP-instellingen uit een bepaalde tekenreeks. cmp (tekenreeks)
GetGoogleAcString Haalt de tekenreeks voor toestemming van Google-adverteerder op. Geen
GetUsPrivacyString Haalt de Amerikaanse privacytekenreeks op. Geen
GetLastATTrackingRequestDate Haalt de datum op van het laatste App Tracking Transparency-verzoek. Geen
GetGoogleConsentModeStatus Krijgt de huidige status van de Google-toestemmingsmodus. Geen
GetAllPurposes Krijgt een lijst met alle beschikbare doeleinden. Geen
GetEnabledPurposes Krijgt een lijst met ingeschakelde doeleinden. Geen
GetDisabledPurposes Krijgt een lijst met uitgeschakelde doeleinden. Geen
GetAllVendors Krijgt een lijst met alle beschikbare leveranciers. Geen
GetEnabledVendors Krijgt een lijst met ingeschakelde leveranciers. Geen
GetDisabledVendors Krijgt een lijst met uitgeschakelde leveranciers. Geen
SetUIConfig Stelt de UI-configuratie in voor de CMP-gebruikersinterface. cmpUIConfig (CmpUIConfig)
VerzoekATTrackingToestemming (Alleen iOS) Verzoekt toestemming voor app-trackingtransparantie. Geen

CmpUIConfig-overzicht: 

 

Eigenschap/methode Omschrijving Type/parameters
schermConfig 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
is focusseerbaar (Alleen Android) Als de gebruikersinterface focusseerbaar moet zijn. bool
isBuitenAanraakbaar (Alleen Android) Als de aanraking van buitenaf moet worden gedetecteerd. bool
StelAndroidFragmentContainerId in (Alleen Android) Stelt de container-ID in voor het Android-fragment. ID (int)
Stel AndroidUiType in (Alleen Android) Stelt het UI-type voor Android in. type (AndroidUiType)
CmpBridgeSetConsentManagerModale presentatiestijl (alleen iOS) Stelt de modale presentatiestijl in via een extern gesprek. modalPresentatiestijl (int)
ConfigureerModalePresentatiestijl (alleen iOS) Configureert de modale presentatiestijl voor iOS. stijl (CmpIOSModalPresentationStyle)

 

CmpConfig-overzicht:

 

Eigenschap/methode Omschrijving 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)
Terug naar boven