ConsentInformation

Kotlin |Java

interface ConsentInformation

---

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

สรุป

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

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

ฟังก์ชันสาธารณะ

canRequestAds

fun canRequestAds(): Boolean

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

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

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

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

getConsentStatus

@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int

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

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

getPrivacyOptionsRequirementStatus

fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!

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

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

isConsentFormAvailable

fun isConsentFormAvailable(): Boolean

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

requestConsentInfoUpdate

fun requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
): Unit

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

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

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

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

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

รีเซ็ต

fun reset(): Unit

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