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