ConsentInformation
interface ConsentInformation
ユーザーの同意を取得するためのユーティリティ メソッド。
概要
ネストされた型 |
|---|
@Retention(value = SOURCE)同意ステータスの値。 |
|
同意情報の更新に失敗したときに呼び出されるコールバックのインターフェース定義。 |
|
同意情報が正常に更新されたときに呼び出されるコールバックのインターフェース定義。 |
|
プライバシー オプションの要件のステータス。 |
パブリック関数 |
|
|---|---|
Boolean |
SDK がアプリで設定されたメッセージに沿って同意を取得したかどうかを示します。 |
Int |
現在の同意ステータスを取得します。 |
ConsentInformation.PrivacyOptionsRequirementStatus! |
プライバシー オプション ボタンが必要かどうかを示すステータスを取得します。 |
Boolean |
|
Unit |
requestConsentInfoUpdate(同意情報の更新をリクエストします。 |
Unit |
reset()
|
パブリック関数
canRequestAds
fun canRequestAds(): Boolean
SDK が、アプリで設定されたメッセージに沿って同意を取得したかどうかを示します。
このメソッドは、requestConsentInfoUpdate が呼び出されるまで false を返します。
requestConsentInfoUpdate が呼び出されると、getConsentStatus が NOT_REQUIRED または OBTAINED を返すと、このメソッドは true を返します。
| 戻り値 | |
|---|---|
Boolean |
SDK がアプリで設定されたメッセージに沿って同意を取得した場合は true。 |
getConsentStatus
@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int
現在の同意ステータスを取得します。
| 戻り値 | |
|---|---|
Int |
|
getPrivacyOptionsRequirementStatus
fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!
プライバシー オプション ボタンが必要かどうかを示すステータスを取得します。
| 戻り値 | |
|---|---|
ConsentInformation.PrivacyOptionsRequirementStatus! |
|
isConsentFormAvailable
fun isConsentFormAvailable(): Boolean
ConsentForm が使用可能な場合は true、それ以外の場合は 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! |
同意リクエストの失敗リスナー。 |