[Enhet] 2. API-dokumentation
Utfasad SDK/uppgradera till v3: Den här dokumentationen beskriver version 2.x av vår SDK. 2.x SDK är utfasad och kommer att tas bort av EOY 2025. Uppgradera till SDK version 3.x. Se hjälpavsnittet om SDK v3 här.
AddEventListeners
Ställer in Android-specifika återuppringningar för CMP-händelser.
Exempelvis
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);CheckConsentIsRequired
Kontrollerar om användarens samtycke krävs och, i så fall, öppnar användargränssnittet för samtyckeslagret. Denna metod förbrukar en sidvisning.
parametrar
| Inga. |
Retur
TRUE om användarens samtycke krävs
FALSE annat.
Exempelvis
var isRequired = await _cmpManager.CheckConsentIsRequired();CmpUIConfig Översikt
| Fastighet/metod | Beskrivning | Typ/parametrar |
|---|---|---|
screenConfig |
Egenskap för att hålla den valda skärmkonfigurationen. | Skärmkonfigurationslista |
androidUiType (Endast Android)
|
UI-typ för Android-enheter. | AndroidUiType enum |
androidFragmentContainerId (Endast Android)
|
Container ID för Android Fragment. | int |
isFocusable (Endast Android)
|
Om gränssnittet ska vara fokuserbart. | bool |
isOutsideTouchable (Endast Android)
|
Om yttre beröring ska upptäckas. | bool |
SetAndroidFragmentContainerId (Endast Android)
|
Ställer in behållar-ID för Android-fragmentet. | id (int) |
SetAndroidUiType (Endast Android)
|
Ställer in UI-typen för Android. | typ (AndroidUiType) |
CmpBridgeSetConsentManagerModalPresentationStyle (Endast iOS)
|
Ställer in den modala presentationsstilen via externt samtal. | modalPresentationStyle (int) |
ConfigureModalPresentationStyle (Endast iOS)
|
Konfigurerar den modala presentationsstilen för iOS. | stil (CmpIOSModalPresentationStyle) |
CmpConfig Översikt
| Fastighet/metod | Beskrivning | Typ/parametrar |
|---|---|---|
| Konstruktör | Initierar CMP-konfigurationen med nödvändiga parametrar. | id, domän, appnamn, språk, uiConfig (valfritt) |
| UIConfig | Egenskap för gränssnittskonfigurationen. | CmpUIConfig |
| IdfaOrGaid | Identifierare för annonsörer eller Google Advertising ID. | sträng |
| Timeout | Timeout för CMP-operationer. | int |
| JumpToSettingsPage | Om du ska hoppa till inställningssidan automatiskt. | bool |
| DesignId | Valfritt design-ID för anpassning av CMP-gränssnittet. | int? |
| Felsök | Aktiverar felsökningsläge. | bool |
| Id | Den unika identifieraren för CMP-instansen. | sträng (skrivskyddad) |
| Domän | Domänen som är kopplad till CMP-instansen. | sträng (skrivskyddad) |
| App-namn | Namnet på programmet som använder CMP. | sträng (skrivskyddad) |
| Språk | Språket för CMP UI och operationer. | sträng (skrivskyddad) |
ExportCmpString
Exporterar den aktuella CMP-strängen som representerar användarens samtyckespreferenser. Denna metod nås på ett statiskt sätt. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
Sträng: De exporterade CMP-inställningarna som en sträng.
Exempelvis
string cmpSettings = ExportCmpString();GetAllPurposes
Returnerar ID:n för alla ändamål. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
Lista: En lista över ändamåls-ID.
Exempelvis
List<string> purposes = GetAllPurposes();GetAllVendors
Returnerar alla leverantörers ID för en given CMP. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
Lista: En lista över leverantörs-ID.
Exempelvis
List<string> allVendors = GetAllVendors();GetDisabledPurposes
Returnerar ID:n för alla inaktiverade ändamål för en given CMP. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
Lista: En lista över inaktiverade ID:n.
Exempelvis
List<string> disabledPurposes = GetDisabledPurposes();
GetDisabledVendors
Returnerar alla inaktiverade leverantörers ID för en given CMP. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
Lista: En lista över inaktiverade leverantörs-ID:n.
Exempelvis
List<string> disabledVendors = GetDisabledVendors();GetEnabledPurposes
Returnerar alla aktiverade ändamåls ID:n för en given CMP. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
Lista: En lista över aktiverade ändamåls-ID:n.
Exempelvis
List<string> enabledPurposes = GetEnabledPurposes();GetEnabledVendors
Returnerar alla aktiverade leverantörers ID:n för en given CMP. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
Lista: En lista över aktiverade leverantörs-ID:n.
Exempelvis
List<string> enabledVendors = GetEnabledVendors();GetGoogleAcString
Hämtar Googles extra samtyckes-ID ('addtlConsent')-sträng som ställts in av consent manager.
För ytterligare information, kolla Teknisk specifikation för Google Ytterligare samtycke.
Denna metod förbrukar inga sidvisningar.
parametrar
| Ingen |
Retur
sträng: Googles annonsörssamtyckessträng.
Exempelvis
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Hämtar US Privacy String. Denna amerikanska integritetssträng är en cookie som lagrar information om avslöjande som gjorts och val som webbplatsbesökaren valt angående deras konsumenträttigheter. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
sträng: USA:s sekretesssträng.
Exempelvis
string usPrivacyString = GetUsPrivacyString();Har Samtycke
Kontrollerar om användaren redan gett sitt samtycke. Samtyckeslagret kan ha möjlighet att bara stänga lagret. I så fall lämnade användaren inget samtycke. Denna metod förbrukar inga sidvisningar.
parametrar
| Inga. |
Retur
TRUE om användaren har gett sitt samtycke
FALSE annat
Exempelvis
var hasConsent = _cmpManager.HasConsent();Har Syfte
Kontrollerar om ändamåls-ID är aktiverat baserat på användarens samtycke. Denna metod förbrukar inga sidvisningar.
parametrar
- id: ID för syftet att kontrollera.
Retur
TRUE om syftet är valt
FALSE annat.
Exempelvis
bool result = _cmpManager.HasPurpose(purposeId);Har säljare
Kontrollerar om leverantörs-ID är aktiverat baserat på användarens samtycke. Denna metod förbrukar inga sidvisningar.
parametrar
| Namn | Typ | Beskrivning |
id |
sträng | ID för säljaren att kontrollera. Du hittar leverantörs-ID:n i ditt konto under Meny > CMPs > Leverantörer. |
Retur
TRUE om leverantören är vald
FALSE annat.
Exempelvis
bool result = HasVendor("vendorId");ImportCmpString
Importerar en CMP-sträng som representerar användarens samtyckespreferenser. Strängen måste informeras AS-IS när den hämtas via exportCmpString()-metoden. Denna metod förbrukar en sidvisning.
parametrar
sträng: CMP-strängen
Retur
CmpImportResult: Resultat om importen lyckades.
Exempelvis
result = await _cmpManager.ImportCmpString(cmpString);initialisera
Initialiseringsfunktionen initierar samtyckesskiktet och kontrollerar automatiskt om användaren behöver ett samtycke eller inte. Denna funktion kommer så småningom att öppna samtyckeslagret och kommer att interagera med Apple Tracking Transparency API för att be användaren om samtycke. Denna metod förbrukar en sidvisning.
parametrar
| Namn | Typ | Beskrivning |
domain |
Sträng | Domänen för Consent Management Platform. |
codeId |
Sträng | Koden ID för applikationen. |
appName |
Sträng | Namnet på applikationen. |
language |
Sträng | Språkkoden (t.ex. "EN", "DE") för lokalisering. |
Exempelvis
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
}Lansering (utfasad)
Startar CmpManager och visar samtyckeslagret om det behövs.
Exempelvis
_cmpManager.Launch();OpenConsentLayer
Öppnar CMP-samtyckesskiktets webbvy med kraft. Denna metod förbrukar en sidvisning.
parametrar
| Inga. |
Retur
| Inga. |
Exempelvis
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Kontrollerar om användarens samtycke krävs och, i så fall, öppnar samtyckesskiktets webbvy. Denna metod förbrukar en sidvisning.
parametrar
| Inga. |
Retur
| Inga. |
Exempelvis
_cmpManager.OpenConsentLayerOnCheck();
