ConsentInformation

Kotlin |Java

public interface ConsentInformation

---

Dienstmethoden zum Einholen der Einwilligung von Nutzern.

Zusammenfassung

Verschachtelte Typen
@Retention(value = SOURCE) @IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED]) public annotation ConsentInformation.ConsentStatus Werte für den Einwilligungsstatus
public interface ConsentInformation.OnConsentInfoUpdateFailureListener Schnittstellendefinition für einen Rückruf, der aufgerufen wird, wenn die Einwilligungsinformationen nicht aktualisiert werden konnten.
public interface ConsentInformation.OnConsentInfoUpdateSuccessListener Schnittstellendefinition für einen Callback, der aufgerufen wird, wenn die Einwilligungsinformationen erfolgreich aktualisiert wurden.
public enum ConsentInformation.PrivacyOptionsRequirementStatus Status der Anforderungen an die Datenschutzoptionen

Öffentliche Methoden
abstract boolean	canRequestAds() Gibt an, ob das SDK eine Einwilligung gemäß den konfigurierten Mitteilungen der App eingeholt hat.
abstract int	@ConsentInformation.ConsentStatus getConsentStatus() Ruft den aktuellen Einwilligungsstatus ab.
abstract ConsentInformation.PrivacyOptionsRequirementStatus	getPrivacyOptionsRequirementStatus() Ruft den Status ab, der angibt, ob eine Schaltfläche für Datenschutzoptionen erforderlich ist.
abstract boolean	isConsentFormAvailable() Gibt true zurück, wenn eine ConsentForm verfügbar ist, andernfalls false.
abstract void	requestConsentInfoUpdate(     Activity activity,     ConsentRequestParameters consentRequestParameters,     ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,     ConsentInformation.OnConsentInfoUpdateFailureListener failureListener ) Es wird eine Aktualisierung der Einwilligungsinformationen angefordert.
abstract void	reset() Setzt ConsentInformation auf den Status „Initialisiert“ zurück.

Öffentliche Methoden

canRequestAds

abstract boolean canRequestAds()

Gibt an, ob das SDK eine Einwilligung gemäß den konfigurierten Mitteilungen der App eingeholt hat.

Diese Methode gibt false zurück, bis requestConsentInfoUpdate aufgerufen wird.

Wenn requestConsentInfoUpdate aufgerufen wird, gibt diese Methode true zurück, wenn getConsentStatus NOT_REQUIRED oder OBTAINED zurückgibt.

Ausgabe
boolean	„wahr“, wenn das SDK eine Einwilligung gemäß den konfigurierten Mitteilungen der App eingeholt hat.

getConsentStatus

@ConsentInformation.ConsentStatus
abstract int getConsentStatus()

Ruft den aktuellen Einwilligungsstatus ab.

Ausgabe
int	UNKNOWN, bis requestConsentInfoUpdate aufgerufen wird, und standardmäßig der Wert der vorherigen Sitzung, bis requestConsentInfoUpdate erfolgreich abgeschlossen und OnConsentInfoUpdateSuccessListener aufgerufen wird.

getPrivacyOptionsRequirementStatus

abstract ConsentInformation.PrivacyOptionsRequirementStatus getPrivacyOptionsRequirementStatus()

Ruft den Status ab, der angibt, ob eine Schaltfläche für Datenschutzoptionen erforderlich ist.

Ausgabe
ConsentInformation.PrivacyOptionsRequirementStatus	UNKNOWN, bis requestConsentInfoUpdate aufgerufen wird. Standardmäßig ist der Wert der vorherigen Sitzung, bis requestConsentInfoUpdate erfolgreich abgeschlossen und aufgerufen wird.

isConsentFormAvailable

abstract boolean isConsentFormAvailable()

Gibt true zurück, wenn eine ConsentForm verfügbar ist, andernfalls false.

requestConsentInfoUpdate

abstract void requestConsentInfoUpdate(
    Activity activity,
    ConsentRequestParameters consentRequestParameters,
    ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,
    ConsentInformation.OnConsentInfoUpdateFailureListener failureListener
)

Es wird eine Aktualisierung der Einwilligungsinformationen angefordert.

Diese API muss in jeder App-Sitzung aufgerufen werden, bevor getConsentStatus aufgerufen wird.

Nach dem Aufruf dieser API wird der Rückgabewert der getConsentStatus API synchron aktualisiert, um den Einwilligungsstatus aus der vorherigen App-Sitzung zu speichern, sofern vorhanden.

getConsentStatus wird möglicherweise nach dem Aufruf von noch einmal auf den aktuellen Status aktualisiert.

Parameter
Activity activity	Die Aktivität, mit der Bildschirmausschnitte erfasst werden.
ConsentRequestParameters consentRequestParameters	Die Anfrageparameter.
ConsentInformation.OnConsentInfoUpdateSuccessListener successListener	Der Listener für den Erfolg der Einwilligungsanfrage.
ConsentInformation.OnConsentInfoUpdateFailureListener failureListener	Der Listener für fehlgeschlagene Einwilligungsanfragen.

Zurücksetzen

abstract void reset()

Setzt ConsentInformation auf den Status „Initialisiert“ zurück. Diese Option sollte nur zur Fehlerbehebung verwendet werden.