GDPR 機能 | APIリファレンス | Tealium開発者ドキュメントプレビュー

以下の utag.gdpr 関数を利用できます。

Function	説明
`getCategories()`	タグのグルーピングのために利用可能なコンプライアンスカテゴリのリストによって `Array` を返します
`getCategoryLanguage()`	アクティブな言語でのカテゴリ名と説明によって `Object` を返します
`getConsentState()`	完全に同意するか、同意を拒否するか、同意しないか、または部分的に同意するか、のいずれかとしてのユーザーが行った同意を返します
`getCookieValues()`	同意 Cookie を表す `Object` を返します
`getLanguage()`	同意マネージャーのコンテンツを表示するための言語による `String` を返します
`getSelectedCategories()`	カスタマーにより選択されたカテゴリによって `Array` を返します
`setAllCategories()`	すべてのカテゴリを、同意または拒否のいずれかの、同一の同意状態に構成し、(オプションとして) Collect API を呼び出して、同意をトラッキングします
`setConsentValue()`	同意 Cookie 値を有効または無効に構成します
`setCookie()`	Cookie オブジェクトに直接送信する内部関数
`setCookieValue()`	同意 Cookie の個別値を構成します
`setPreferencesFromList()`	同意状態を、カテゴリのリスト用に `allowed` に構成します
`setPreferencesValues()`	カテゴリのオブジェクトからの Cookie 値と、その同意状態を構成します
`showConsentPreferences()`	構成マネージャーのポップアップを表示します
`showExplicitConsent()`	明示的同意のポップアップを表示します
`updateConsentCookie()`	非表示のウェブビューを使用してアプリからモバイル同意を更新します

`utag.gdpr.getCategories()`

タグのグルーピングのために利用可能なコンプライアンスカテゴリのリストによって Array を返します。パラメータが提供されない場合は、すべてのカテゴリが返されます。パラメータとしての true または 1 を、Tealium Consent Preference Manager (同意構成マネージャー) インターフェイスでの、リターン有効 (アクティブ) カテゴリーのみに返します。

utag.gdpr.getCategories(onlyEnabledCats)

パラメータ	型	説明
`onlyEnabledCats`	`Boolean`	(オプション) `true` または `1` に構成して、有効な (アクティブな) カテゴリを返します

次の例では、すべてのカテゴリを返します。

utag.gdpr.getCategories()
// Returns: ["analytics", "affiliates", "display_ads", "search", "email", "personalization", "social", "big_data", "misc", "cookiematch", "cdp", "mobile", "engagement", "monitoring", "crm"]

次の例では、有効なカテゴリを返します。

utag.gdpr.getCategories(true)
// Returns: ["analytics", "affiliates", "personalization"]

`utag.gdpr.getCategoryLanguage()`

Consent Preferences Manager のインターフェイス「Category Parameters」からアクティブな言語でのカテゴリ名と説明によって Object を返します。カテゴリの言語は、 getLanguage() 関数によって返される言語です。

utag.gdpr.getCategoryLanguage(category)

パラメータ	型	説明
`category`	`String`	カテゴリ名

例:

utag.gdpr.getCategoryLanguage("analytics")
// if language is English, returns:
//{name: "Cookies that help us improve our website", notes: "These cookies help us understand how people use our website."}
// if language is Polish, returns:
//{name: "Pliki cookie dotyczące wydajności", notes: "Te pliki cookie gromadzą informacje o tym, jak odw…dynie w celu ulepszania działania naszej witryny."}

`utag.gdpr.getConsentState()`

完全に同意するか、同意を拒否するか、同意しないか、または部分的に同意するか、のいずれかとしてのユーザーが行った同意を返します。完全に同意したとき、同意を拒否したとき、または、同意しなかったときには、次の同意状態値が返されます。

Consent State	説明
`-1`	同意が拒否されました (Cookie 上では、[consent:false])
`0`	同意がされていません (Cookie がありません)
`1`	完全な同意がなされました (Cookie 上では、[consent:true])

部分的な同意の場合は、関数は、オブジェクトの配列 (それぞれがカテゴリを表すもの) を返します。各オブジェクトでは、 "ct" キーが同意状態 (1/0) を表し、 "name" キーカテゴリ単位 (denomination) です。

utag.gdpr.getConsentState()

例：

utag.gdpr.getConsentState()
// 0
// no consent was given, cookie is not present

utag.gdpr.getConsentState()
// 1
// cookie value is true

utag.gdpr.getConsentState()
//partial consent
/* Returns: [{"ct":"1","name":"analytics"},
{"ct":"0","name":"affiliates"},
{"ct":"0","name":"display_ads"},
{"ct":"0","name":"search"},
{"ct":"0","name":"email"},
{"ct":"0","name":"personalization"},
{"ct":"0","name":"social"},
{"ct":"0","name":"big_data"},
{"ct":"0","name":"misc"},
"Ct":"0","name":"cookiematch"},
{"ct":"0","name":"cdp"},
{"ct":"0","name":"mobile"},
{"ct":"0","name":"engagement"},
{"ct":"0","name":"monitoring"},
{"ct":"0","name":"crm"}]"
*/

`utag.gdpr.getCookieValues()`

キーと値のペアとして同意 Cookie を表す Object を返します。この関数は、デフォルトの Cookie 名前空間 (CONSENTMGR) 、または window.utag_cfg_ovrd.cmcookiensで提供される値を使用します。リバース関数 (Cookie への書き込み) は utag.gdpr.setCookie()です。

この関数を直接使用せずに、 utag.gdpr.getConsentState()などの関数を使用することが推奨されます。後者は、 getCookieValues() 関数を呼び出して Cookie を読みます。

utag.gdpr.getCookieValues()

次の例では、部分的な同意を付与します。

utag.gdpr.getCookieValues()
/* Returns: {"c1":"1",
"C2":"0",
"C3":"0",
"c4":"0",
"C5":"0",
"C6":"0",
"C7":"0",
"c8":"0",
"C9":"0",
"C10":"0",
"C11":"0","c12":"0","c13":"0","c14":"0","c15":"0",
"ts":"1586965568213",
"consent":"true"}*/

次の例では、完全な同意を付与します。

utag.gdpr.getCategories(true)
// Returns: {"consent":"true","ts":"1587026030058"}

`utag.gdpr.getLanguage()`

同意マネージャーのコンテンツを表示するための言語による String を返します。言語の優先順位は、データレイヤーに構成されたもの、ブラウザからの言語、または、デフォルト言語です。

utag.gdpr.getLanguage()

例:

utag.gdpr.getLanguage()
// Returns: "en-gb"

`utag.gdpr.getSelectedCategories()`

カスタマーにより選択されたカテゴリによって Array を返します。

utag.gdpr.getSelectedCategories()

例:

utag.gdpr.getSelectedCategories()
// Returns: ["analytics", "personalization"]

`utag.gdpr.setAllCategories()`

すべてのカテゴリを、同意または拒否のいずれかの、同一の同意状態に構成し、(オプションとして) Collect API を呼び出して、同意をトラッキングします。

utag.gdpr.setAllCategories(state, noCollect)

パラメータ	型	説明
`state`	`Boolean`	`true` に構成して、すべてのカテゴリへの同意を許可し、 `false` に構成して、同意を拒絶します
`noCollect`	`Boolean`	(オプション) `true` に構成して、同意をトラッキングするための Collect API へのコールをトリガーしないようにします

次の例は、すべての同意カテゴリへの同意を許可し、Collect API へのコールを行わないものです。

utag.gdpr.setAllCategories(true,true)

次の例は、すべての同意カテゴリへの同意を拒否し、同意をトラッキングするために Collect API を呼び出します。

utag.gdpr.setAllCategories(false)

`utag.gdpr.setConsentValue()`

同意 Cookie 値を有効または無効に構成します。この関数は、また、同意のタイムスタンプを更新し、Collect API へのトラッキングコールを生成し、キューに登録されたタグをリプレイします utag.gdpr.queue。

これによっても、個別のカテゴリの定数値は変更されません。定数値は、関連の API コール (setPreferencesFromList() または setPreferencesValues()) を用いて無効化する必要があります。

utag.gdpr.setConsentValue(_response)

パラメータ	型	説明
`_response`	`Boolean`	同意を有効にするには、 `true` に構成し、同意を無効にするには `false` に構成します

以下の例では、値 "consent:true" を有する Cookie を構成し、タイムスタンプを更新します。

utag.gdpr.setConsentValue(true)

以下の例では、値 "consent:false" を有する Cookie を構成し、タイムスタンプを更新します。

utag.gdpr.setConsentValue(0)

`utag.gdpr.setCookie()`

Cookie オブジェクトに直接送信する内部関数。これは、同意状態、タイムスタンプ、および部分的同意に関するさまざまなカテゴリを表すためのオブジェクトを使用します。これは、正しい Cookie 名および有効期限を自動的に使用します。

この関数を直接呼び出すことは推奨されません。

utag.gdpr.setCookie(onlyEnabledCats)

パラメータ	型	説明
`cookieData`	`Object`	同意 Cookie に保存されるデータを表すキー値のリスト

例:

var object = {"c6":"1","c1":"0","c2":"0","ts":1587133550264,"consent":"false","c3":"0","c4":"0","c5":"0","c7":"0","c8":"0","c9":"0","c10":"0","c11":"0","c12":"0","c13":"0","c14":"0","c15":"0"}"
utag.gdpr.setCookie(object)
// Sets the cookie to: c6:1%7Cc1:0%7Cc2:0%7Cts:1587133526482%7Cconsent:false%7Cc3:0%7Cc4:0%7Cc5:0%7Cc7:0%7Cc8:0%7Cc9:0%7Cc10:0%7Cc11:0%7Cc12:0%7Cc13:0%7Cc14:0%7Cc15:0

`utag.gdpr.setCookieValue()`

同意 Cookie の個別値を構成します。

この関数は、他の比較的高いレベルの関数 (setConsentValue()など) によって用いられます。このメソッドは、慎重に使用します。使用は、比較的高いレベルの関数では当初のニーズが満たせない場合に限ります。

utag.gdpr.setCookieValue(key, value);

パラメータ	型	説明
`key`	`String`	`consent`、 `ts` 、または、 `c` 値表現によって指定されるカテゴリのいずれか (Analytics 用の c1 または Affiliates 用の c2) のうちの、いずれかに構成された Cookie で用いられるキー
`value`	`String`	Cookie キーを構成するための値

次の例では、同意 Cookie を "consent:false"に構成します。

utag.gdpr.setCookieValue("consent", false);

次の例では、同意 Cookie を "c1:0"に構成します。

utag.gdpr.setCookieValue("c1", 0);

`utag.gdpr.setPreferencesFromList()`

同意状態を、パラメータで渡されたカテゴリのリスト用に allowed に構成します。リストの一部でないカテゴリの同意状態が declined に構成されます。これは、部分的同意用に用いられます。この関数は、 setPreferencesValues() 関数に依存しており、 getSelectedCategories()のリバース機能を提供します。

utag.gdpr.setPreferencesFromList(list)

パラメータ	型	説明
`List`	`Array`	有効なカテゴリの配列

例:

utag.gdpr.setPreferencesFromList(["analytics"])
// Only allows the "analytics" category in the consent cookie

utag.gdpr.getCategories(true)
//["analytics", "affiliates", "personalization"]

`utag.gdpr.setPreferencesValues()`

カテゴリのオブジェクトからの Cookie 構成値と、その同意状態を構成します。この関数は、主に、 setPreferencesFromList() 関数によって呼び出されます。この関数は、キュー utag.gdpr.queueに登録されているタグをリプレイします。

utag.gdpr.setPreferencesValues(state, noCollect)

パラメータ	型	説明
`state`	`Object`	形式 `category:consentState`でのキーと値のペア
`noCollect`	`Boolean`	(オプション) `true` に構成して、同意をトラッキングするための Collect API へのコールをトリガーしないようにします

次の例では、Cookie 値を構成します。

Var cats = {"analytics":"1","affiliates":"0","personalization":"0"}
utag.gdpr.setPreferencesValues(cats)
// Sets cookie to c6:1%7Cc1:0%7Cc2:0%7Cts:1587135590035%7Cconsent:true

`utag.gdpr.showConsentPreferences()`

同意構成のポップアップを表示します。この関数は、ページのカスタマイズで定義される、CSS、HTML および Javascript を注入します。これは、明示的同意 javascript リスナーによって、または、ユーザーがその構成を変更するページのいずれかのポイントから、呼び出されます。

utag.gdpr.showConsentPreferences(_lang)

パラメータ	型	説明
`_lang`	`String`	オプション。ISO 形式 (`en` または `en-gb` など) としての言語

以下の例は、デフォルト言語での、またはデータレイヤーで構成した言語での同意を表示しています。

utag.gdpr.showConsentPreferences()

次の例では、フランス語での同意を表示しています。

utag.gdpr.showConsentPreferences("fr-fr")

`utag.gdpr.showExplicitConsent()`

明示的同意のポップアップを表示します。この関数は、ページのカスタマイズで定義される、CSS、HTML および Javascript を注入します。明示的同意が構成されたときは、DOM READY イベント時に Tealium ユニバーサルタグ utag.js によってネイティブに呼び出されます。

utag.gdpr.showExplicitConsent(_lang)

パラメータ	型	説明
`_lang`	`String`	(オプション) ISO 形式 (`en` または `en-gb`など) での言語

以下の例は、デフォルト言語での、またはデータレイヤーで構成した言語での明示的同意を表示しています。

utag.gdpr.showExplicitConsent()

次の例では、フランス語での明示的同意を表示しています。

utag.gdpr.showExplicitConsent("fr-fr")