consentmanager Android SDK API
API
Konstruktör
Konstruktör för att skapa ett CmpManager-objekt
parametrar
| Namn | Typ |
Beskrivning |
| sammanhang | Sammanhang |
Appens sammanhang |
| config | CMPConfig |
Konfigurationsobjektet för consent manager |
| closeListener | Vid StängÅteruppringning |
Återuppringningen som ska anropas när samtyckeslagret stängs |
| openListener | OnOpenCallback |
Återuppringningen som ska anropas när samtyckeslagret öppnas |
| cmpNotOpenedCallback | OnCPMNotOpenedCallback |
Återuppringningen som ska anropas när samtyckeslagret inte kunde öppnas |
| vid Felåteruppringning | Vid feluppringning |
Återuppringningen som ska anropas vid ett fel |
openCustomLayer
Öppnar det anpassade samtyckeslagret
parametrar
| Namn | Typ |
Beskrivning |
| aktivitet | FragmentActivity |
Aktivitetsinstansen där samtyckesskiktet ska visas |
| containerViewId | @IdRes Int |
ID:t för behållarens användargränssnitt där samtyckeslagret ska visas |
Returer
En funktion utan returvärde
Exempelvis
val activity = requireActivity()
val containerViewId = R.id.container
openCustomLayer(activity, containerViewId)
checkAndOpenConsentLayer
Kontrollera och öppnar samtyckeslagret så småningom.
parametrar
| Namn | Typ |
Beskrivning |
| sammanhang | Sammanhang |
Appens kontextobjekt. |
Exempelvis
val cmpManager = CmpManager()
cmpManager.checkAndOpenConsentLayer(context)
openCmpLayer
Returnerar om syftet (id) har rättigheter att sätta cookies
parametrar
| Namn | Typ |
Beskrivning |
| sammanhang | Sammanhang |
Appens sammanhang |
| id | Sträng |
Syftets id Observera: Ändamåls-id är detsamma som visas i syfteslistan och kan ha ett prefix som C |
| kontrollera Samtycke | Boolean |
|
Returer
| Typ | Beskrivning |
| Boolean | En boolean som indikerar om leverantören har samtycke till att sätta cookies. |
Exempelvis
val vendorID = "1234"
val checkConsent = true
val result = hasVendorConsent(context, vendorID, checkConsent)
if (result) {
// Vendor has the rights to set cookies
} else {
// Vendor does not have the rights to set cookies
}
har säljarens samtycke
Returnerar om leverantören (id) har rättigheter att sätta cookies
parametrar
| Namn | Typ |
Beskrivning |
| id | Sträng: |
Försäljarens ID Observera: Leverantörs-id är detsamma som visas i ändamålslistan och kan ha ett prefix som C |
Returer
| Typ | Beskrivning |
| Boolean | Om syftet har samtycke att sätta cookies |
Exempelvis
val vendorId = "S123"
consentTool.hasVendor(vendorId)
harSyfte
Returnerar om syftet (id) har rättigheter att sätta cookies
parametrar
| Namn | Typ |
Beskrivning |
| id | Sträng: |
Syftets id Observera: Ändamåls-id är detsamma som visas i syfteslistan och kan ha ett prefix som C |
Returer
| Typ | Beskrivning |
| Boolean | Om syftet har samtycke att sätta cookies |
Exempelvis
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getVendorString
Returnerar om syftet (id) har rättigheter att sätta cookies
parametrar
| Namn | Typ |
Beskrivning |
| id | Sträng: |
Syftets id Observera: Ändamåls-id är detsamma som visas i syfteslistan och kan ha ett prefix som C |
Returer
| Typ | Beskrivning |
| Boolean | Om syftet har samtycke att sätta cookies |
Exempelvis
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposeString
Returnerar syftena String, som sattes av consentmanager
parametrar
inga parametrar
Returer
| Typ | Beskrivning |
| Sträng |
Den sträng av syften som sattes igenom consentmanager
|
Exempelvis
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposes
Returnerar syftena String, som sattes av consentmanager i ett Listobjekt
parametrar
| Namn | Typ |
Beskrivning |
| id | Sträng: |
Syftets id Observera: Ändamåls-id är detsamma som visas i syfteslistan och kan ha ett prefix som C |
Returer
| Typ | Beskrivning |
| Boolean | Om syftet har samtycke att sätta cookies |
Exempelvis
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
Gammal översikt (tbd)
|
API |
parametrar | Returer |
Beskrivning
|
|
openCmpConsentToolView( Kontext sammanhang ) |
sammanhang: Appens sammanhang | ogiltig | Visar en modal vy med samtyckeswebbvyn. Om efterlevnaden accepteras eller avvisas kommer en stängningsfunktion att anropas. Du kan åsidosätta denna stängningsfunktion med din egen. Implementera därför OnCloseCallback och lägg till detta som en parameter. @apiNote användargränssnitt -> exempel: Öppna lager med knappåtgärd |
|
openCmpConsentToolView( Kontext sammanhang, På Stäng Återuppringning ) |
sammanhang: Appens sammanhang
ring tillbaka: OnCloseCallback som ska anropas när webbvyn stängs av åtgärd
|
ogiltig | Visar en modal vy med samtyckeswebbvyn. Om efterlevnaden accepteras eller avvisas kommer en stängningsfunktion att anropas. Du kan åsidosätta denna stängningsfunktion med din egen. Implementera därför OnCloseCallback och ge den till denna funktion. Denna metod kommer inte att skicka en begäran till consentTool Server igen. Den kommer att använda det sista tillståndet. Om du bara vill öppna samtyckesverktygsvyn igen, om servern ger en svarsstatus == 1 använd checkAndProceedConsentUpdate-metoden @apiNote användargränssnitt -> exempel: Öppna Layer by button action |
|
setCloseCmpConsentToolViewListener( På Stäng Återuppringning ) |
ring tillbaka: OnCloseCallback som ska anropas när webbvyn stängs av åtgärd | ogiltig | Ställer in en lyssnare. Om efterlevnaden accepteras eller avvisas kommer denna funktion att anropas. Du kan åsidosätta denna stängningsfunktion med din egen. Implementera därför OnCloseCallback och lägg till denna som parameter. |
|
setCustomCmpConsentToolViewAction( CustomOpenActionCallback customAction ) |
customAction: CustomAction som ska anropas, förutom att visa samtyckesverktyget | ogiltig | Ställer in en anpassad åtgärd till ett serversvar. |
|
setErrorDialogCmpConsentToolViewListener( OnErrorDialogCallback återuppringning ) |
ring tillbaka: OnOpenCallback, som bör anropas, när vyn kommer att öppnas. | ogiltig | Ställer in en lyssnare. Om överensstämmelsevyn öppnas kommer denna funktion att anropas. Du kan åsidosätta denna öppna funktion med din egen. Implementera därför OnOpenCallback och lägg till denna som parameter. |
|
setNetworkErrorExceptionListener( OnNetworkExceptionCallback callback ) |
ring tillbaka: OnErrorNetworkCallback som måste anropas. | ogiltig | Ställer in en lyssnare som anropas om ett nätverksfel uppstår. |
|
setOnCPMNotOpenedCallback( OnCPMNotOpenedCallback callback ) |
ring tillbaka: Åtgärden cmpNotOpenedCallback som kommer att anropas | ogiltig | Ställer in en åtgärd när samtyckeslagret inte kommer att öppnas |
|
setOpenCmpConsentToolViewListener( Kontext sammanhang, Knapp gdprButton ) |
sammanhang: Sedan Context of App gdprButton: Knappen, openCmpConsentToolViewListener bör läggas till |
ogiltig | Ställer in en lyssnare på den givna knappen. Om knappen klickas, kommer en modal vy att visas med samtyckeswebbvyn. Om efterlevnaden accepteras eller avvisas kommer en stängningsfunktion att anropas. Du kan åsidosätta denna stängningsfunktion med din egen. Implementera därför OnCloseCallback och lägg till denna som en annan parameter. Om parametern inte är inställd, men setCloseCmpConsentToolViewListener användes för att lägga till en lyssnare till stängningshändelsen, kommer denna att användas. |
|
setOpenCmpConsentToolViewListener( Kontext sammanhang, Knapp gdprButton, På Stäng Återuppringning ) |
sammanhang: Appens sammanhang gdprButton: Knappen, openCmpConsentToolViewListener bör läggas till
ring tillbaka: OnCloseCallback som ska anropas när webbvyn stängs av åtgärd |
ogiltig | Ställer in en lyssnare på den givna knappen. Om knappen klickas, kommer en modal vy att visas med samtyckeswebbvyn. Om efterlevnaden accepteras eller avvisas kommer en stängningsfunktion att anropas. Du kan åsidosätta denna stängningsfunktion med din egen. Implementera därför OnCloseCallback och lägg till denna som den sista parametern. |
|
setOpenCmpConsentToolViewListener( På Stäng Återuppringning ) |
ring tillbaka: OnCloseCallback som ska anropas när webbvyn stängs av åtgärd |
ogiltig | Ställer in en lyssnare. Om överensstämmelsevyn öppnas kommer denna funktion att anropas. Du kan åsidosätta denna öppna funktion med din egen. Implementera därför OnOpenCallback och lägg till denna som parameter. |
|
setOpenPlaceHolderViewListener( Kontext sammanhang, Knappknapp, Strängförsäljare ) |
sammanhang: Appens sammanhang Knappen: En åtgärdsknapp för att skapa platshållarvyn leverantör: Leverantören som är tilldelad platshållaren |
ogiltig | Öppnar platshållarvyn vid knappklick för den tilldelade leverantören |
|
|
|||
|
kallas denna dag( Kontextkontext) |
sammanhang: Appens sammanhang |
boolean: om servern redan kontaktades denna dag | Returnerar om servern redan har kontaktats denna dag. |
|
clearAllValues(Kontextkontext) |
sammanhang: Appens sammanhang |
ogiltig | Återställer samtyckesdata |
|
skapaPlatshållare( Kontext sammanhang, CMPPPlaceholderParams cmpPlaceholderParams, CmpPlaceholderEventListener cmpPlaceholderEventListener) |
sammanhang: Appens sammanhang cmpPlaceholderParams: tilldela nödvändiga platshållarparametrar cmpPlaceholderEventListener: EventListener Interface för anpassade processfunktioner |
CmpPlaceholder: UIView av platshållaren | Skapar en platshållarvy för dynamisk innehållsblockering |
|
exportCMPData(kontextkontext) |
sammanhang: Appkontexten |
Sträng: Samtyckessträngen | En exportfunktion som kan anropas för att exportera den fullständiga samtyckessträngen som genereras av en ConsentWebView och sparas i delade inställningarna för denna enhet. |
|
getCalledLast(Kontextkontext) |
sammanhang: Appkontexten |
Datum: Datum när servern senast anropades | Ger information om det senaste datumet då servern kontaktades |
|
getConfig() |
|
CMPConfig: CMPConfig-objekt |
Returnerar CMPConfig som är inställd för närvarande |
|
getGoogleACString() |
sammanhang: Appkontexten |
Sträng: USA Sekretesssträng av leverantörer som sattes igenom consentmanager |
Returnerar den amerikanska integritetssträngen som ställts in av consentmanager |
|
getInstance() |
|
CMPConsentTool: Det initierade singelögonblicket av consentmanager |
Returnerar CMPConsentTool. Om du inte har initierat CMPConsentTool innan kommer undantaget CMPConsentToolInitialisation att kastas. |
|
getInstanceUnsafe() |
|
CMPConsentTool: det initierade singelögonblicket av consent Manager, eller null. |
Returnerar CMPConsentTool, eller null om det inte initierades. Den här metoden är osäker eftersom den kan leda till undantag för nollpekare, men om du är säker på att ConsentTool initierades tidigare kan du använda den här metoden utan att behöva fånga felet. Vi rekommenderar att du sparar det returnerade objektet från createInstant-metoden för att använda metoderna i consentManager. |
|
getLastConsentString( Kontextkontext) |
sammanhang: Appkontexten |
Sträng: Den senaste inställda samtyckessträngen |
Returnerar det senast givna samtycket, presenterat i base64 av consentManager |
|
getPurposes(Kontextkontext) |
sammanhang: Appkontexten |
Sträng: Den sträng av syften som sattes igenom consentmanager |
Returnerar syftena String, som sattes av consentmanager |
|
getUSPrivacyString(Kontextkontext) |
sammanhang: Appkontexten |
Sträng: USA:s sekretesssträng av leverantörer som sattes igenom consentmanager |
Returnerar den amerikanska integritetssträngen som ställts in av consentmanager |
|
getVendorsString(Kontextkontext) |
sammanhang: Appkontexten |
Sträng: Strängen av leverantörer som sattes igenom consentmanager |
Returnerar leverantörssträngen som sattes av consentmanager |
|
hasPurposeConsent(Kontextkontext, Sträng-id, booleskt ärIABPurpose) |
sammanhang: appkontexten id: ID för syftet ärIABPurpose: Om syftet är satt av IAB-standard (V1/V2) |
boolean: Om syftet har samtycke att sätta cookies |
Returnerar, om syftet (id) har rättigheter att sätta cookies. Uppmärksamhet: Ändamåls-id är detsamma som visas i syfteslistan och kan ha ett prefix som C |
|
har säljarens samtycke( Kontext sammanhang, Sträng-id, boolesk isIABVendor) |
sammanhang: Appkontexten id: Försäljarens ID ärIAB-försäljare: om leverantören är inställd av IAB-standard (V1/V2) |
boolean: Om säljaren har samtycke att sätta cookies. |
Returnerar, om leverantören (id) har rättigheterna att sätta cookies
Uppmärksamhet: Leverantörs-id är detsamma som visas i leverantörslistan och kan ha ett prefix som C, S |
|
importCMPData( Kontext sammanhang, Sträng cmpData ) |
sammanhang: Appkontexten cmpData: Strängen som kommer att ställas in. ConsentString ska skickas som kodad base64 |
boolean: Om importen lyckades eller om fel uppstår i strängen |
En importmetod som kan anropas för att importera den fullständiga samtyckessträngen som genereras av en ConsentWebView till delade inställningarna för denna enhet. |
|
needsAcceptance(Kontextkontext) |
sammanhang: Appkontexten |
boolean: om användaren behöver ge ett samtycke |
Returnerar om användaren behöver ge ett samtycke, för att han inte gjorde det tidigare, eller för att samtycke Servern returnerade, att ett nytt samtycke krävs |
|
needsServerUpdate(Kontextkontext) |
sammanhang: Appkontexten |
boolean: Om consentmanager behöver uppdateras |
Om CMPS-inställningarna behöver uppdateras från servern, eftersom de inte var det den här dagen. |
|
|
|
|
|
