[Reaguj natywnie] 1. consentmanager Integracja SDK
W tym dokumencie znajdziesz ogólne informacje na temat integracji naszego SDK z Twoim projektem. Więcej szczegółów znajdziesz w naszym Dokumentacja API dokumentacja. Aby zapoznać się z naszą aplikacją demonstracyjną prezentującą przypadki użycia i implementację, która mogłaby służyć jako punkt wyjścia, sprawdź nasze repozytorium.
1. Instalacja
Kurs consentmanager SDK dla aplikacji na iOS implementuje i zapewnia funkcjonalność informowania użytkownika o ochronie danych oraz pytania i zbierania zgody od użytkownika. Umożliwia programistom aplikacji łatwą integrację consentmanager usługi do swojej aplikacji.
Kroki — opis wysokiego poziomu
-
Integracja i konfiguracja:
- Zintegruj pakiet SDK ze swoją aplikacją.
- Skonfiguruj ustawienia SDK zgodnie ze swoimi potrzebami.
-
Tworzenie instancji:
- Podczas uruchamiania aplikacji utwórz instancję
CMPConsentTool
klasa. Ta instancja będzie obsługiwać proces wyrażania zgody.
- Podczas uruchamiania aplikacji utwórz instancję
-
Inicjalizacja SDK:
- Gdy instancja będzie gotowa, SDK automatycznie pobierze niezbędne informacje z pliku consentmanager serwerów w celu przygotowania ich do działania.
-
Wyświetlanie ekranu zgody:
- W razie potrzeby pakiet SDK automatycznie wyświetli ekran zgody
CMPConsentTool
instancja jest tworzona.
- W razie potrzeby pakiet SDK automatycznie wyświetli ekran zgody
-
Przetwarzanie danych osobowych:
- Po zebraniu zgód informacje są przechowywane i można je przeglądać za pomocą różnych właściwości i metod udostępnianych przez nasz pakiet SDK. Będziesz mieć informacje o odrzuconych lub zaakceptowanych zgodach, dostawcach, celach itp.
Wykonując te kroki, masz pewność, że Twoja aplikacja jest zgodna z wymogami dotyczącymi zgody oraz że zgody użytkowników są odpowiednio zarządzane i przechowywane.
Consent Manager Diagram sekwencji zestawu SDK dostawcy
Aby zilustrować powyższe kroki, sprawdźmy na poniższym diagramie trzy możliwe przepływy sekwencji SDK.
1. Podczas tworzenia instancji przy użyciu zainicjować funkcji, istnieją dwa możliwe wyniki. Pierwsza ma miejsce, gdy interfejs API zgody informuje zestaw SDK, że CMP nie zostanie otwarty, co powoduje wyzwolenie OnCmpNotOpenedWywołanie zwrotne. Drugim rezultatem jest otwarcie warstwy zgody, co pozwala użytkownikowi na interakcję z nią, a to wyzwala OnOpenCallback. Po wyrażeniu przez użytkownika zgody i przetworzeniu zgody, OnCmpCloseOddzwonienie nazywa się.
Należy pamiętać, że Przy oddzwonieniu po błędzie jest reprezentowany przez czerwone przerywane linie strzałek, aby podać przykłady błędów, które mogą wystąpić podczas procesu.
2. Tworzenie instancji i wywoływanie otwórz i sprawdź zgodę funkcje doprowadzą do podobnego procesu. Różnica polega na tym, że oddzielając tworzenie instancji od sprawdzania API zgody, zyskujesz możliwość dodawania logiki biznesowej i interakcji z API bibliotek.
3. Tworzenie instancji i wywoływanie Otwórz warstwę funkcja otworzy warstwę bez sprawdzania pliku consentmanager, jeśli to konieczne. Jeśli jest już wyrażona zgoda, opcje i ustawienia zostaną pokazane użytkownikowi. Przebieg procesu będzie wyglądał następująco:
Więcej informacji na temat naszego przeglądu wersji pakietu SDK i dziennika zmian można znaleźć w artykule pod tym linkiem.
Instalacja za pomocą NPM
npm install cmp-sdk
Łączenie (React Native 0.59 i starsze)
Jeśli używasz React Native 0.59 lub starszej wersji, musisz ręcznie połączyć moduły natywne:
react-native link cmp-sdk
Importuj Consentmanager
z cmp-sdk
pakiet w swoim kodzie:
import { Consentmanager } from 'cmp-sdk';
2. Inicjowanie pakietu SDK
Możesz zainicjować zestaw SDK CMP przy użyciu konfiguracji bezpośredniej lub obiektu konfiguracyjnego:
Inicjalizacja bezpośrednia:
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');
Inicjalizacja przy użyciu obiektu konfiguracyjnego:
Consentmanager.createInstanceByConfig(yourConfigObject);
3. Korzystanie z SDK
Aby zarządzać warstwą zgody:
Otwórz warstwę zgody:
Consentmanager.openConsentlayer();
Obsługa zdarzeń
Dodaj detektory zdarzeń, aby obsługiwać różne zdarzenia związane z zgodą:
const removeListeners = Consentmanager.addEventListeners({
onOpen: () => console.log('Consent layer opened'),
onClose: () => console.log('Consent layer closed'),
// Add other event handlers as needed
});
Pamiętaj, aby usunąć detektory zdarzeń, gdy nie są już potrzebne:
removeListeners();
Zapytania o zgodę
Możesz sprawdzić zgody dostawcy i celu:
Sprawdź zgodę sprzedawcy:
Consentmanager.hasVendor('vendorID').then((hasConsent) => {
console.log('Has vendor consent: ', hasConsent);
});
Sprawdź cel Zgoda:
Consentmanager.hasPurpose('purposeID').then((hasConsent) => {
console.log('Has purpose consent: ', hasConsent);
});
Resetowanie zgody
Consentmanager.reset();
Eksportowanie ciągu zgody
Consentmanager.exportCmpString().then((cmpString) => {
console.log('CMP String: ', cmpString);
});
Dodatkowe metody
Pakiet CMP SDK zapewnia różne metody pobierania danych dotyczących zgody i zarządzania nimi, takie jak:
getAllVendors()
getAllPurposes()
getEnabledVendors()
getEnabledPurposes()
getDisabledVendors()
getDisabledPurposes()
getUSPrivacyString()
getGoogleACString()
Szczegółowe informacje na temat tych metod można znaleźć w dokumentacji zestawu SDK.