ANDROID JAVA

ConsentManager

クラス：ConsentManager

以下は、一般的に使用されるConsentManagerクラスのメソッドをまとめたものです。

メソッド 説明
getPolicy() 現在のポリシーを返します
getUserConsentCategories() ユーザーの現在の同意カテゴリを返します
getUserConsentPreferences() UserConsentPreferencesオブジェクトを返します
getUserConsentStatus() ユーザーの現在の同意ステータスを返します
resetUserConsentPreferences() ユーザーの同意設定をリセットします
setPolicy() デフォルトのポリシーパラメータをオーバーライドします（デフォルト：gdpr）
setUserConsentCategories() ユーザーの同意ステータスと同意カテゴリを設定します
setUserConsentStatus() ユーザーの同意ステータスを設定します
setUserConsentStatusWithCategories() 1つのコールで同意ステータスとカテゴリを設定します

getPolicy()

現在のポリシーを返します。

final String currentPolicy = tealiumInstance.getConsentManager().getPolicy();
戻り値 戻り値の型
User’s current policy String

getUserConsentCategories()

ユーザーの現在の同意カテゴリを返します。

final String[] userCategories = tealiumInstance.getConsentManager().getUserConsentCategories();
戻り値 戻り値の型
User’s current consent categories String[]

getUserConsentPreferences()

ユーザーの同意設定を返します。

final UserConsentPreferences userPreferences = tealiumInstance.getConsentManager().getUserConsentPreferences();
戻り値 戻り値の型
User’s consent preferences UserConsentPreferences

getUserConsentStatus()

ユーザーの現在の同意ステータスを返します。

final String userStatus = tealiumInstance.getConsentManager().getUserConsentStatus();
戻り値 戻り値の型
User’s current consent status String

resetUserConsentPreferences()

保存されている同意設定をクリアし、ユーザー設定をデフォルトにリセットして、同意ステータスをカテゴリが何も設定されていないUNKNOWNに設定します。

tealiumInstance.getConsentManager().resetUserConsentPreferences();

setPolicy()

デフォルトのポリシーパラメータをオーバーライドします。デフォルトはgdprです。

tealiumInstance.getConsentManager().setPolicy(policy);
パラメータ 型 説明 例
policy String 設定するポリシー "custompolicy"

setUserConsentCategories()

ユーザーの同意ステータスと同意カテゴリを設定します。このメソッドはアプリの同意管理設定画面から呼び出します。このメソッドでは、任意の数のカテゴリが設定された場合に、ユーザーの同意ステータスが自動的にCONSENTEDに設定されます。

tealiumInstance.getConsentManager().setUserConsentCategories(categories);
パラメータ 型 説明 例
categories [String] 設定するカテゴリ String[]

以下の静的定数は、サポートされている同意カテゴリの包括的なリストです。

AFFILIATES
ANALYTICS
BIG_DATA
CDP
COOKIEMATCH
CRM
DISPLAY_ADS
EMAIL
ENGAGEMENT
MOBILE
MONITORING
PERSONALIZATION
SEARCH
SOCIAL
MISC

setUserConsentStatus()

ユーザーの同意ステータスを設定します。このメソッドは、ユーザーがトラッキングをオプトインまたはオプトアウトしたときに、アプリの同意管理設定画面から呼び出します。trueの場合は、すべてのカテゴリが自動的に有効になります。falseの場合は、すべてのカテゴリが自動的に無効になります。

このメソッドを使用してユーザーのステータスがCONSENTEDに設定されると、Consent Managerでは、ユーザーが自動的に使用可能なすべての同意カテゴリにサブスクライブされます（一部のカテゴリのみにすることはできません）。

tealiumInstance.getConsentManager().setUserConsentStatus(status);
パラメータ 型 説明 例
status String ユーザーの同意に設定するステータス [ConsentManager.ConsentStatus.CONSENTED, ConsentManager.ConsentStatus.NOT_CONSENTED]

これらの静的定数は、サポートされている同意ステータスの包括的なリストです。

CONSENTED
NOT_CONSENTED
UNKNOWN

UNKNOWN
UNKNOWNステータスは、Consent Managerのデフォルト設定です。このステータスの場合、Consent Managerはローカルでイベントをキューに追加します。これは、断定的なCONSENTED/NOT_CONSENTEDステータスが設定されるまで続きます。

tealiumInstance.getConsentManager().setUserConsentStatus(ConsentManager.ConsentStatus.UNKNOWN);

CONSENTED
CONSENTEDステータスは、ユーザーがトラッキングに同意している場合に設定されます。このステータスの場合、Consent Managerは、以前キューに追加されたトラックコールをキューから取り出し、以降のすべてのトラッキングコールを通常通りに続行できます。

tealiumInstance.getConsentManager().setUserConsentStatus(ConsentManager.ConsentStatus.CONSENTED);

NOT_CONSENTED
NOT_CONSENTEDステータスは、ユーザーがトラッキングを拒否している場合に設定されます。このステータスの場合、Consent Managerは、以前キューに追加されたトラックコールを削除し、以降のすべてのトラッキングコールがそれ以上SDKによって処理されないようにします。

tealiumInstance.getConsentManager().setUserConsentStatus(ConsentManager.ConsentStatus.NOT_CONSENTED);

setUserConsentStatusWithCategories()

1つのコールで同意ステータスとカテゴリを設定します。

tealiumInstance.getConsentManager().setUserConsentStatusWithCategories(status, categories);
パラメータ 型 説明 例
status String ユーザーの同意に設定するステータス [ConsentManager.ConsentStatus.CONSENTED, ConsentManager.ConsentStatus.NOT_CONSENTED]
categories [String] 設定するカテゴリ new String[]{ConsentManager.ConsentCategory.ANALYTICS, ConsentManager.ConsentCategory.BIG_DATA}

サポートされている定数のリストについては、setUserConsentStatus()とsetUserConsentCategories()を参照してください。

DataSources