ConsentManager
TealiumがAndroid(Kotlin)向けに提供するConsentManagerクラスとメソッドのリファレンスガイド。
クラス: ConsentManager
以下は、KotlinのConsentManager
クラスの一般的に使用されるメソッドをまとめたものです。詳細はConsent Managementを参照してください。
メソッド | 説明 |
---|---|
isConsentLoggingEnabled |
同意の構成変更をログに記録するかどうかを取得/構成します |
policy |
現在適用されているポリシーを取得します(null可) |
reset() |
Consent StatusとCategoriesをデフォルト値にリセットします |
userConsentCategories |
現在同意されているConsentCategory のセットを取得/構成します |
userConsentStatus |
現在のユーザーConsentStatus を取得/構成します |
isConsentLoggingEnabled
ユーザーの同意構成の変更をログに記録するかどうかを取得または構成します。TealiumConfig.consentManagerLoggingEnabledオプションで初期化されます。
tealium.consentManager.isConsentLoggingEnabled // 例: false
policy
現在使用中のConsentPolicy
を返します。TealiumConfig.consentManagerPolicyオプションで初期化され、null
に構成することも可能です。
val policy = tealium.consentManager.policy // 例: ConsentPolicy.GDPR
reset()
提供されたuserConsentStatus
とuserConsentCategories
をそれぞれデフォルト値のConsentStatus.UNKNOWN
とnull
に戻します。
tealium.consentManager.reset()
userConsentCategories
アプリユーザーによって付与された現在のConsent Statusを構成または取得します。利用可能なオプションについて詳しくはこちらをご覧ください。
tealium.consentManager.userConsentCategories = setOf(ConsentCategory.CDP, ConsentCategory.EMAIL)
val categories = tealium.consentManager.userConsentCategories
// setOf(ConsentCategory.CDP, ConsentCategory.EMAIL)を返します
userConsentStatus
アプリユーザーによって付与された現在の同意ステータスを構成または取得します。利用可能なオプションは次のとおりです:UNKOWN
、CONSENTED
、NOT_CONSENTED
tealium.consentManager.userConsentPreferences = ConsentStatus.CONSENTED
val status = tealium.consentManager.userConsentStatus // ConsentStatus.CONSENTEDを返します
インターフェース: UserConsentPreferencesUpdatedListener
UserConsentPreferencesUpdatedListener
はリスナーインターフェースです。UserConsentPreferences
とConsentPolicy
の最新バージョンの更新を受け取るために登録します。
メソッド | 説明 |
---|---|
onUserConsentPreferencesUpdated() |
同意の構成変更をログに記録するかどうかを取得または構成します |
onUserConsentPreferencesUpdated()
同意の構成変更をログに記録するかどうかを取得または構成します。インターフェースを実装するクラスでメソッドを実装するか、Tealium
インスタンスを作成した後に匿名オブジェクトを渡します。
onUserConsentPreferencesUpdated(userConsentPreferences:policy:)
パラメータ | タイプ | 説明 |
---|---|---|
userConsentPreferences |
UserConsentPreferences |
ユーザーの同意構成 |
policy |
ConsentManagementPolicy |
同意管理ポリシー |
例:
val tealium = Tealium.create(...) {
events.subscribe(object : UserConsentPreferencesUpdatedListener {
override fun onUserConsentPreferencesUpdated(userConsentPreferences: UserConsentPreferences,
policy: ConsentManagementPolicy) {
Logger.dev(BuildConfig.TAG, "同意構成が更新されました")
}
)}
)
}
最終更新日 :: 2024年May月15日