ConsentInformation

Kotlin |Java

public interface ConsentInformation

---

วิธีการยูทิลิตีสําหรับรวบรวมความยินยอมจากผู้ใช้

สรุป

ประเภทที่ซ้อนกัน
@Retention(value = SOURCE) @IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED]) public annotation ConsentInformation.ConsentStatus ค่าสถานะความยินยอม
public interface ConsentInformation.OnConsentInfoUpdateFailureListener คําจํากัดความอินเทอร์เฟซสําหรับการเรียกกลับที่จะเรียกใช้เมื่ออัปเดตข้อมูลความยินยอมไม่สําเร็จ
public interface ConsentInformation.OnConsentInfoUpdateSuccessListener คําจํากัดความอินเทอร์เฟซสําหรับการเรียกกลับที่จะเรียกใช้เมื่ออัปเดตข้อมูลความยินยอมสําเร็จ
public enum ConsentInformation.PrivacyOptionsRequirementStatus สถานะข้อกำหนดของตัวเลือกความเป็นส่วนตัว

เมธอดสาธารณะ
abstract boolean	canRequestAds() ระบุว่า SDK ได้รวบรวมความยินยอมที่สอดคล้องกับข้อความที่กําหนดค่าของแอปหรือไม่
abstract int	@ConsentInformation.ConsentStatus getConsentStatus() รับสถานะความยินยอมปัจจุบัน
abstract ConsentInformation.PrivacyOptionsRequirementStatus	getPrivacyOptionsRequirementStatus() รับสถานะที่ระบุว่าต้องใช้ปุ่มตัวเลือกความเป็นส่วนตัวหรือไม่
abstract boolean	isConsentFormAvailable() แสดงผล true หากมี ConsentForm และแสดงผล false ในกรณีอื่นๆ
abstract void	requestConsentInfoUpdate(     Activity activity,     ConsentRequestParameters consentRequestParameters,     ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,     ConsentInformation.OnConsentInfoUpdateFailureListener failureListener ) ขอการอัปเดตข้อมูลความยินยอม
abstract void	reset() รีเซ็ต ConsentInformation เป็นสถานะ "เริ่มต้น"

เมธอดสาธารณะ

canRequestAds

abstract boolean canRequestAds()

ระบุว่า SDK ได้รวบรวมความยินยอมที่สอดคล้องกับข้อความที่กําหนดค่าของแอปหรือไม่

เมธอดนี้จะแสดงผล false จนกว่าจะมีการเรียกใช้ requestConsentInfoUpdate

เมื่อเรียก requestConsentInfoUpdate แล้ว เมธอดนี้จะแสดงผล true เมื่อ getConsentStatus แสดงผล NOT_REQUIRED หรือ OBTAINED

การคืนสินค้า
boolean	จริงหาก SDK ได้รวบรวมความยินยอมที่สอดคล้องกับข้อความที่กําหนดค่าของแอป

getConsentStatus

@ConsentInformation.ConsentStatus
abstract int getConsentStatus()

รับสถานะความยินยอมปัจจุบัน

การคืนสินค้า
int	UNKNOWN จนกว่าจะมีการเรียก requestConsentInfoUpdate และค่าเริ่มต้นจะเป็นค่าของเซสชันก่อนหน้าจนกว่า requestConsentInfoUpdate จะเสร็จสมบูรณ์และมีการเรียก OnConsentInfoUpdateSuccessListener

getPrivacyOptionsRequirementStatus

abstract ConsentInformation.PrivacyOptionsRequirementStatus getPrivacyOptionsRequirementStatus()

รับสถานะที่ระบุว่าต้องใช้ปุ่มตัวเลือกความเป็นส่วนตัวหรือไม่

การคืนสินค้า
ConsentInformation.PrivacyOptionsRequirementStatus	UNKNOWN จนกว่าจะมีการเรียก requestConsentInfoUpdate และค่าเริ่มต้นจะเป็นค่าของเซสชันก่อนหน้าจนกว่า requestConsentInfoUpdate จะเสร็จสมบูรณ์และมีการเรียก

isConsentFormAvailable

abstract boolean isConsentFormAvailable()

แสดงผล true หากมี ConsentForm และแสดงผล false ในกรณีอื่นๆ

requestConsentInfoUpdate

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

ขอการอัปเดตข้อมูลความยินยอม

ต้องเรียก API นี้ในเซสชันแอปแต่ละเซสชันก่อนเรียก getConsentStatus

หลังจากเรียกใช้ API นี้แล้ว ค่าที่ getConsentStatus API แสดงผลจะอัปเดตแบบซิงค์เพื่อเก็บสถานะความยินยอมจากเซสชันแอปก่อนหน้า (หากมี)

getConsentStatus อาจอัปเดตอีกครั้งเป็นสถานะล่าสุดหลังจากเรียกใช้

พารามิเตอร์
Activity activity	กิจกรรมที่ใช้รวบรวมภาพหน้าจอ
ConsentRequestParameters consentRequestParameters	พารามิเตอร์คำขอ
ConsentInformation.OnConsentInfoUpdateSuccessListener successListener	รายการฟังผลลัพธ์ของคําขอความยินยอม
ConsentInformation.OnConsentInfoUpdateFailureListener failureListener	โปรแกรมรับฟังการขอความยินยอมที่ไม่สําเร็จ

รีเซ็ต

abstract void reset()

รีเซ็ต ConsentInformation เป็นสถานะ "เริ่มต้น" ซึ่งควรใช้สำหรับการแก้ไขข้อบกพร่องเท่านั้น