コンテンツにスキップ

ユーザー同意

ヒューマンスコアリングユースケースの一部です。

SDK はユーザーがページをどのように操作するかを記録します。ユーザーの所在地や自身のプライバシーポリシーに よっては、記録を始める前にユーザーの許可が必要になることがあります。Web SDK にはそのための同意ゲートが あります。デフォルトではオフなので、オンにしなければ取得は init の時点で始まります。

SDK は同意ダイアログを描画しません。ページが自身の言葉で質問し、その回答を SDK に渡します。

使いどころ

  • 行動データに同意を必要とする法域にユーザーがいる
  • 同意管理プラットフォーム(CMP)がすでに分析や不正防止について尋ねている

前提条件

使い方

import { init } from '@dea/sdk';

const dea = init({
  appId: 'YOUR_APP_ID',
  appKey: 'YOUR_APP_KEY',
  requireConsent: true,
});

requireConsent: true の場合、ユーザーが同意するまで:

  • 何も記録もスコアリングもされず、getClassification() は 'insufficient' を返します。
  • resume() は記録を開始しません。ゲートは pause() とは別のものです。
  • SDK はスコアリングモデルをダウンロードせず、ready() は 解決しません。質問する前に ready() を待たないでください。

回答を記録する

dea.setConsent(true);  // the user agreed: recording starts
dea.setConsent(false); // the user declined, or withdrew: recording stops

setConsent(false) は即座に記録を停止します。セッションとその中ですでにスコアリングされたものは保持され、 後の setConsent(true) はそれを継続します。破棄するには reset() も呼んでください。

回答はブラウザーの localStorage にキー deapnetwork.consent で保持され、次の init で復元されます。 回答を現在のページの間だけ保持するには(共有端末やキオスク端末)、{ remember: false } を渡します。 すでに保存されているものはそのまま残ります。

dea.setConsent(true, { remember: false });

誰も回答していないときだけ質問する

if (!dea.consent.isAnswered) {
  showConsentDialog(); // your own dialog, which calls dea.setConsent(…)
}

dea.consent.decision は 'unknown'、'granted'、'denied' のいずれかです。dea.consent.isGranted は 'granted' の場合のみ true です。

回答を独自のストアに保持する

回答を localStorage ではなく同意管理プラットフォームの記録と並べて保存するには、consentStore を渡します。

import { init, type ConsentDecision } from '@dea/sdk';

init({
  appId: 'YOUR_APP_ID',
  appKey: 'YOUR_APP_KEY',
  requireConsent: true,
  consentStore: {
    read: (): ConsentDecision => myConsentRecord.dea ?? 'unknown',
    write: (decision) => { myConsentRecord.dea = decision; },
  },
});

注: ゲートが保留するのは記録、スコアリング、モデルのダウンロードです。ページ側が行う呼び出しは 保留しません。ブラウザーのキーを DEA に登録する attest() を、ユーザーが同意する 前に呼ばないでください。

注: iPhone と iPad では、モバイルプロファイルはユーザーの最初のタップ時にブラウザーへモーション センサーの許可を求め、ブラウザーが独自のプロンプトを表示します。SDK はゲートが閉じている間も求めます。 同意前のそのプロンプトを避けるには、motionRate: 0 を渡すか、以下のようにユーザーが同意した後にのみ init を呼びます。

ページがすでにこの種のツールを読み込む前に同意を待っている場合は、ユーザーが同意した後にのみ init を 呼び、撤回したら dispose() を呼びます。

import { init, DeaSdk } from '@dea/sdk';

function onConsentGiven() {
  init({ appId: 'YOUR_APP_ID', appKey: 'YOUR_APP_KEY' });
}

function onConsentWithdrawn() {
  DeaSdk.current?.dispose(); // stops capture and drops anything not yet processed
}

例

import { init } from '@dea/sdk';

const dea = init({ appId: 'YOUR_APP_ID', appKey: 'YOUR_APP_KEY', requireConsent: true });

// Replace with your CMP's API.
cmp.onChange((consent) => {
  dea.setConsent(consent.fraudPrevention);
});

showConsentDialog、myConsentRecord、cmp はアプリ側のコードを表します。

API

メンバー 戻り値 説明
init({ requireConsent: true }) DeaSdk ゲートを閉じた状態で SDK を起動する
setConsent(granted, options?) void 回答を記録する。{ remember: false } はこのページの間だけ保持する
consent.decision 'unknown' \| 'granted' \| 'denied' 現在の回答
consent.isAnswered boolean ユーザーが回答するまで false
consent.isGranted boolean 回答が 'granted' のとき true
dispose() void 取得を停止し、SDK を解放する