[ReactNative] 1. consentmanager SDK-integration
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.
I det här dokumentet hittar du allmän information om hur du integrerar vår SDK i ditt projekt. För ytterligare information, se vår API-referens dokumentation. För vår demo-app som visar användningsfallen och en implementering som kan fungera som utgångspunkt, vänligen kontrollera vår repo.
1. Installation
Smakämnen consentmanager SDK för iOS-appar implementerar och tillhandahåller funktionalitet för att informera användaren om dataskydd och fråga och samla in samtycke från användaren. Det gör det möjligt för app-utvecklare att enkelt integrera consentmanager tjänst i deras app.
Steg - Beskrivning på hög nivå
-
Integration och konfiguration:
- Integrera SDK:n i din app.
- Konfigurera SDK-inställningarna efter dina behov.
-
Skapa en instans:
- Vid appstart skapar du en instans av
CMPConsentToolklass. Denna instans kommer att hantera samtyckesprocessen.
- Vid appstart skapar du en instans av
-
SDK-initiering:
- När instansen är klar hämtar SDK automatiskt nödvändig information från consentmanager servrar för att förbereda för dess drift.
-
Visar samtyckesskärmen:
- SDK:n visar automatiskt samtyckesskärmen om det behövs när
CMPConsentToolinstans skapas.
- SDK:n visar automatiskt samtyckesskärmen om det behövs när
-
Behandling av personuppgifter:
- När samtycken har samlats in lagras informationen och är tillgänglig för frågor genom olika egenskaper och metoder som exponeras av vår SDK. Du kommer att ha information om avvisade eller accepterade samtycken, leverantörer, syften etc.
Genom att följa dessa steg säkerställer du att din app är kompatibel med samtyckeskraven och att användarens samtycke hanteras och lagras korrekt.
Consent Manager Leverantörs SDK-sekvensdiagram
För att illustrera stegen ovan, låt oss kolla i diagrammet nedan tre möjliga SDK-sekvensflöden.
1. När du skapar en instans med hjälp av initialisera funktion finns det två möjliga utfall. Den första är när consentmanger API informerar SDK om att CMP inte kommer att öppnas, vilket utlöser OnCmpNotOpenedCallback. Det andra resultatet är när samtyckesskiktet öppnas, så att användaren kan interagera med det, och detta utlöser OnOpenCallback. När användaren ger sitt samtycke och samtycket behandlats, PåCmpCloseCallback kallas.
Observera att Vid feluppringning representeras av de röda streckade pillinjerna för att ge exempel på när fel kan uppstå under processen.
2. Skapa en instans och anropa openAndCheckConsent funktioner kommer att leda till en liknande process. Skillnaden är att genom att frikoppla skapandet av instansen och kontrollen för consentmanger API får du möjligheten att lägga till affärslogik och interagera med bibliotekens API.
3. Skapa en instans och anropa openLayer funktionen öppnar lagret utan att markera consentmanager, om det är nödvändigt. Om det redan finns ett samtycke kommer alternativen och inställningarna att visas för användaren. Processflödet kommer att se ut så här:
För ytterligare information om vår SDK-versionsöversikt och ändringslogg, se denna länk.
Installation via NPM
npm install cmp-sdkLänkning (React Native 0.59 och lägre)
Om du använder React Native 0.59 eller lägre måste du länka de inbyggda modulerna manuellt:
react-native link cmp-sdkImportera Consentmanager från cmp-sdk paket i din kod:
import { Consentmanager } from 'cmp-sdk';2. Initiera SDK
Du kan initiera CMP SDK med antingen den direkta konfigurationen eller ett konfigurationsobjekt:
Direkt initiering:
Consentmanager.createInstance('Code-ID from consentmanager, e.g. bfa712361a....',
'Server-Domain from consentmanager, e.g. delivery.consentmanager.net',
'App Name, e.g. MyReactApp',
'Language, e.g. FR');Initiering med Config Object:
Consentmanager.createInstanceByConfig(yourConfigObject);3. Använda SDK
Så här hanterar du samtyckesskiktet:
Öppna samtyckeslager:
Consentmanager.openConsentlayer();Händelsehändelse
Lägg till händelseavlyssnare för att hantera olika samtyckesrelaterade händelser:
const removeListeners = Consentmanager.addEventListeners({
onOpen: () => console.log('Consent layer opened'),
onClose: () => console.log('Consent layer closed'),
// Add other event handlers as needed
});
Kom ihåg att ta bort händelseavlyssnarna när de inte längre behövs:
removeListeners();Samtycksfrågor
Du kan söka efter leverantörs- och ändamålsmedgivanden:
Kontrollera leverantörens samtycke:
Consentmanager.hasVendor('vendorID').then((hasConsent) => {
console.log('Has vendor consent: ', hasConsent);
});Kontrollera syftessamtycke:
Consentmanager.hasPurpose('purposeID').then((hasConsent) => {
console.log('Has purpose consent: ', hasConsent);
});Återställ samtycke
Consentmanager.reset();Exporterar samtyckessträng
Consentmanager.exportCmpString().then((cmpString) => {
console.log('CMP String: ', cmpString);
});Ytterligare metoder
CMP SDK tillhandahåller olika metoder för att hämta eller hantera samtyckesdata, till exempel:
getAllVendors()getAllPurposes()getEnabledVendors()getEnabledPurposes()getDisabledVendors()getDisabledPurposes()getUSPrivacyString()getGoogleACString()
Se SDK-dokumentationen för detaljerad information om dessa metoder.
