[Enhet] 2. API-dokumentation
initialisera
Initierar Consent Manager med den angivna domänen, kod-ID, appnamn och språk.
parametrar
| Namn | Typ | Beskrivning |
| domän | Sträng | Domänen för Consent Management Platform. |
| codeId | Sträng | Koden ID för applikationen. |
| app-namn | Sträng | Namnet på applikationen. |
| språk | 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
}
AddEventListeners
Ställer in Android-specifika återuppringningar för CMP-händelser.
Exempelvis
_cmpManager.AddEventListeners(OnOpen, OnClose, OnNotOpened, OnCmpButtonClicked, OnError);Starta
Startar CmpManager och visar samtyckeslagret om det behövs
Exempelvis
_cmpManager.Launch();Har Samtycke
Kontrollerar om användaren har gett sitt samtycke.
Retur
sant om användaren har gett sitt samtycke, falskt annars.
Exempelvis
var hasConsent = _cmpManager.HasConsent();
OpenConsentLayer
Öppnar samtyckesskiktet för att hantera användarens samtyckesinställningar.
Exempelvis
_cmpManager.OpenConsentLayer();
OpenConsentLayerOnCheck
Öppnar samtyckesskiktet vid behov baserat på kontroller.
Exempelvis
_cmpManager.OpenConsentLayerOnCheck();Har säljare
Kontrollerar om en leverantör med angivet ID har valts av användaren.
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. |
Returtyp
(bool) true om leverantören väljs, false annat.
Exempelvis
bool result = HasVendor("vendorId");Har Syfte
Kontrollerar om ett ändamål med angivet ID har valts av användaren.
parametrar
- id: ID för syftet att kontrollera.
Returtyp
bool: Sant om syftet är valt, falskt annars.
Exempelvis
bool result = _cmpManager.HasPurpose(purposeId);CheckConsentIsRequired
Kontrollerar om användaren behöver ge sitt samtycke
Returtyp
bool: Sant om samtycke krävs
Exempelvis
var isRequired = await _cmpManager.CheckConsentIsRequired();ExportCmpString
Exporterar inställningarna för Consent Management Platform (CMP) som en sträng.
Returtyp
sträng: De exporterade CMP-inställningarna som en sträng.
Exempelvis
string cmpSettings = ExportCmpString();ImportCmpString
Importera strängen Consent Management Platform (CMP).
parametrar
sträng: CMP-strängen
Returtyp
CmpImportResult: Resultat om importen lyckades
Exempelvis
result = await _cmpManager.ImportCmpString(cmpString);GetAllPurposes
Får en lista över alla tillgängliga ändamål.
Returtyp
Lista: En lista över ändamåls-ID.
Exempelvis
List<string> purposes = GetAllPurposes();GetEnabledPurposes
Får en lista över aktiverade syften.
Returtyp
Lista: En lista över aktiverade ändamåls-ID:n.
Exempelvis
List<string> enabledPurposes = GetEnabledPurposes();GetDisabledPurposes
Får en lista över funktionshindrade ändamål.
Returtyp
Lista: En lista över inaktiverade ID:n.
Exempelvis
List<string> disabledPurposes = GetDisabledPurposes();GetAllVendors
Får en lista över alla tillgängliga leverantörer.
Returtyp
Lista: En lista över leverantörs-ID.
Exempelvis
List<string> allVendors = GetAllVendors();GetEnabledVendors
Får en lista över aktiverade leverantörer.
Returtyp
Lista: En lista över aktiverade leverantörs-ID:n.
Exempelvis
List<string> enabledVendors = GetEnabledVendors();GetDisabledVendors
Får en lista över funktionshindrade leverantörer.
Returtyp
Lista: En lista över inaktiverade leverantörs-ID:n.
Exempelvis
List<string> disabledVendors = GetDisabledVendors();GetGoogleAcString
Hämtar Google Advertiser Consent-strängen.
Returtyp
sträng: Googles annonsörssamtyckessträng.
Exempelvis
string googleAcString = GetGoogleAcString();GetUsPrivacyString
Får den amerikanska integritetssträngen.
Returtyp
sträng: USA:s sekretesssträng.
Exempelvis
string usPrivacyString = GetUsPrivacyString();
Översikt:
| Funktion | Beskrivning | parametrar |
|---|---|---|
| initialisera | Initierar CMP Manager med domän, kod-ID, appnamn och språk. | domän, codeId, appName, language |
| initialisera | Initierar CMP Manager med ett konfigurationsobjekt. | config (CmpConfig) |
| Har Samtycke | Kontrollerar om användaren har gett sitt samtycke. | Ingen |
| Har säljare | Kontrollerar om en leverantör med angivet ID har valts av användaren. | id (sträng) |
| Har Syfte | Kontrollerar om ett ändamål med angivet ID är valt av användaren. | id (sträng) |
| OpenConsentLayer | Öppnar samtyckesskiktet för hantering av användarens samtyckesinställningar. | Ingen |
| OpenConsentLayerOnCheck | Öppnar samtyckesskiktet vid behov, baserat på en kontroll med backend. | Ingen |
| CheckConsentIsRequired | Kontrollerar om det är nödvändigt att öppna samtyckeslagret. | Ingen |
| Acceptera alla | Accepterar alla samtyckesalternativ. | Ingen |
| Avvisa alla | Avvisar alla samtyckesalternativ. | Ingen |
| Starta | Startar CMP Manager och visar samtyckesskiktet om det behövs. | Ingen |
| Återställa | Återställer CMP-inställningarna. | Ingen |
| ExportCmpString | Exporterar CMP-inställningar som en sträng. | Ingen |
| ImportCmpString | Importerar CMP-inställningar från en given sträng. | cmp (sträng) |
| GetGoogleAcString | Hämtar Google Advertiser Consent-strängen. | Ingen |
| GetUsPrivacyString | Får den amerikanska integritetssträngen. | Ingen |
| GetLastATtrackingRequestDate | Hämtar datumet för den senaste begäran om insyn i appspårning. | Ingen |
| GetGoogleConsentModeStatus | Hämtar aktuell status för Googles samtyckesläge. | Ingen |
| GetAllPurposes | Får en lista över alla tillgängliga ändamål. | Ingen |
| GetEnabledPurposes | Får en lista över aktiverade syften. | Ingen |
| GetDisabledPurposes | Får en lista över funktionshindrade ändamål. | Ingen |
| GetAllVendors | Får en lista över alla tillgängliga leverantörer. | Ingen |
| GetEnabledVendors | Får en lista över aktiverade leverantörer. | Ingen |
| GetDisabledVendors | Får en lista över funktionshindrade leverantörer. | Ingen |
| SetUIConfig | Ställer in gränssnittskonfigurationen för CMP-gränssnittet. | cmpUIConfig (CmpUIConfig) |
| RequestATtrackingPermission | (Endast iOS) Begär tillstånd för insyn i appspårning. | Ingen |
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 |
| är fokuserbar (Endast Android) | Om gränssnittet ska vara fokuserbart. | bool |
| ärOutsideTouchable (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) |
| CmpBridgeSetConsentManagerModal presentationsstil (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) |
