オプション¶
オプションは init に一度だけ渡します。SDK の起動時に読み取られます。後の init 呼び出しに別のオプションを
渡しても効果はありません。実行中のインスタンスが返されるためです。
import { init, CaptureEvent, Profile } from '@dea/sdk';
const dea = init({
appId: 'YOUR_APP_ID',
appKey: 'YOUR_APP_KEY',
profile: Profile.Desktop,
events: [CaptureEvent.PointerDown, CaptureEvent.PointerUp, CaptureEvent.Wheel],
motionRate: 0,
targets: false,
requireConsent: true,
modelUpdates: true,
onLog: (entry) => myPanel.add(entry),
logLevel: 'info',
});
myPanel はアプリ側のコードを表します。
テレメトリ(SDK のログと取得した入力)は、ステージングとテストのパッケージでアプリに届きます。 テレメトリを参照してください。
コアオプション¶
appId¶
| 型 | デフォルト | 必須 |
|---|---|---|
string |
'unknown-app' |
はい |
appKey と一緒に発行された DEA のアプリケーション ID です。
アカウントとキーを参照してください。SDK がどの種類のアカウント
として動作するかは、この ID ではなく、インストールしたパッケージが決めます。
SDK が動作するアカウントを
参照してください。必ず渡してください。デフォルト値は、DEA に登録されていないプレースホルダーです。
appKey¶
| 型 | デフォルト | 必須 |
|---|---|---|
string |
なし | はい(アテステーションと広告に必要) |
DEA が appId と一緒に発行したアプリキーです。SDK は DEA のサービスへの要求(attest() と広告の証明)の
X-App-Key ヘッダーで送信します。モデルのダウンロードにはキーは付きません。アプリを識別するもので、秘密では
ありません。
これがない場合、本番の appId では attest() が要求を送らずに 'failed' を返し、すべての広告の証明は
署名前に拒否されるため、ads.session_opened() は null に解決されます。スコアリングと
getClassification() はどちらの場合も動作します。dea.appKey で使用中のキーを読み取れます。キーがない
場合は null です。
ログオプション¶
SDK が何をログに出力するかは、オプションではなくインストールするパッケージで決まります。本番パッケージは
ログを一切持ちません。ステージングパッケージ(ログを有効にした同じ SDK で、統合中に使うもの。
セットアップの確認を参照)は INFO 以上を出力します。各エントリは 1 つの
状態変化(SDK が起動した、端末キーが登録された、証明が受理された)で、すべてのプラットフォームで同じ形式です。
| パッケージ | 出力されるレベル |
|---|---|
| 本番 | なし |
| ステージング | INFO、WARN、ERROR |
すべてのエントリはブラウザーのコンソールに 1 行で書き出されます。
dea 2026-10-16T01:39:29.731Z INFO sdk.ready ok session.id=ee0962fd-… core=web-desktop profile=web-desktop | SDK ready: core web-desktop, profile web-desktop
onLog¶
| 型 | デフォルト | 必須 |
|---|---|---|
(entry: LogEntry) => void |
なし | いいえ |
すべてのエントリについて、OpenTelemetry のフィールド名(timestamp、severityText、severityNumber、
eventName、body、attributes、resource)を持つ JSON で呼び出されます。ログパネルや、独自のロガーへの
転送に使います。SDK 自身がエントリをどこかに送信することはありません。本番パッケージでは呼び出されません。
import { init } from '@dea/sdk';
init({
appId: 'YOUR_APP_ID',
appKey: 'YOUR_APP_KEY',
onLog: (entry) => myLogger.log(entry.severityText, entry.eventName, entry.attributes),
});
パッケージがエクスポートする formatLine(entry) は、エントリを上記のコンソール行として整形します。
logLevel¶
| 型 | デフォルト | 必須 |
|---|---|---|
'debug' \| 'info' \| 'warn' \| 'error' \| 'off' |
'debug' |
いいえ |
エントリを出力する最低レベルを引き上げます。パッケージ自身のレベルを抑えることはできますが、追加することは
できません。ステージングパッケージで logLevel: 'warn' とすると INFO が省かれ、本番パッケージでログを
有効にする手段はありません。
取得オプション¶
profile¶
| 型 | デフォルト | 必須 |
|---|---|---|
Profile |
自動判定 | いいえ |
ページをデスクトップブラウザーとして扱うか、モバイルブラウザーとして扱うかを指定します。プロファイルは、
どの入力を取得するか、モーションセンサーを要求するか、どのスコアリングエンジンでセッションをスコアリング
するかを決めます。自動判定では、ブラウザーが粗いポインター((pointer: coarse))と 1 つ以上のタッチ
ポイントを報告する場合に Profile.Mobile、それ以外では Profile.Desktop が選ばれます。
| プロファイル | 取得対象 | モーションセンサー |
|---|---|---|
Profile.Desktop('web-desktop') |
ポインター、ホイール、物理キーボード(keydown、keyup) |
なし |
Profile.Mobile('web-mobile') |
ポインター、ホイール、画面上のキーボード(beforeinput) |
あり |
ページが常に一種類の端末だけに配信される場合は、profile を渡す代わりに対応するエントリーポイントを
インポートします。自動判定が省かれます。
注: iPhone と iPad では、ブラウザーはユーザーが許可した後にのみモーションデータを提供します。
Profile.Mobileの場合、SDK はユーザーが最初にページをタップしたときにブラウザーへその許可を求め、 ブラウザーが独自のプロンプトを表示します。一切求めないようにするには、motionRate: 0を渡します。
events¶
| 型 | デフォルト | 必須 |
|---|---|---|
CaptureEvent[] |
プロファイルにより設定 | いいえ |
取得する入力イベントです。プロファイルのリストを上書きします。取得する種類を減らすとページの負荷は 下がりますが、分類の根拠となる証拠も減ります。
| 値 | ブラウザーイベント |
|---|---|
CaptureEvent.PointerDown |
pointerdown |
CaptureEvent.PointerMove |
pointermove |
CaptureEvent.PointerUp |
pointerup |
CaptureEvent.PointerCancel |
pointercancel |
CaptureEvent.Wheel |
wheel |
CaptureEvent.KeyDown |
keydown |
CaptureEvent.KeyUp |
keyup |
CaptureEvent.BeforeInput |
beforeinput(文字入力のみ。貼り付け、ドロップ、自動修正は含まない) |
BeforeInput を KeyDown や KeyUp と一緒に指定しないでください。物理キーボードでの入力は両方を発火
させるため、各キー入力が二重に記録されます。SDK がキーイベントから記録するのは、キーの種類(文字、数字、
スペースなど)、押されている修飾キー、タイミングのみで、文字そのものは記録しません。
<input type="password"> 内のキー入力からは何も記録しません。
motionRate¶
| 型 | デフォルト | 必須 |
|---|---|---|
number(Hz) |
モバイルで 50、デスクトップで 0 |
いいえ |
0 はモーション取得をオフにします。SDK は devicemotion を監視せず、許可も求めません。それ以外の値は
オンにします。ブラウザーは devicemotion を独自に決めたレートで提供し、このオプションではそれを変更
できません。値はセッションのセンサーレートとして記録され、最初の読み取りが届いた時点で
getSessionInfo().device.sensor_rate に報告されます(それまでは 0)。25 未満の値は 25 に
引き上げられます。
targets¶
| 型 | デフォルト | 必須 |
|---|---|---|
boolean |
false |
いいえ |
各プレスがどの種類の要素(ボタン、リンク、入力欄、スクロール領域、キャンバス)に着地したかを記録します。 記録されるのはカテゴリのみで、要素のテキストや属性は記録されません。カテゴリの解決にはプレスごとに一度 ブラウザーへレイアウト情報を問い合わせるため、オプトインです。
同意オプション¶
requireConsent¶
| 型 | デフォルト | 必須 |
|---|---|---|
boolean |
false |
いいえ |
同意ゲートをオンにします。ページが setConsent(true) を呼ぶまで、何も記録もスコアリングもされず、
スコアリングモデルもダウンロードされません。ユーザー同意を
参照してください。
consentStore¶
| 型 | デフォルト | 必須 |
|---|---|---|
ConsentStore |
ブラウザーの localStorage、キー deapnetwork.consent |
いいえ |
ユーザーの回答を訪問をまたいで保持する場所です。'unknown'、'granted'、'denied' のいずれかを返す
read() と、write(decision) を持つオブジェクトです。回答を同意管理プラットフォームの記録と並べて
保持するには、独自の実装を渡します。memoryConsentStore() は現在のページの間だけ保持します。
モデルオプション¶
modelUpdates¶
| 型 | デフォルト | 必須 |
|---|---|---|
boolean |
true |
いいえ |
SDK がスコアリングモデルを最新に保つかどうかです。オンの場合、すべての init は SDK の準備が整った後、
何も遅延させずに、このプロファイル向けに DEA が新しいモデルを公開していないかを
https://sdk.dep-protocol.com に問い合わせます。新しいモデルはダウンロードされ、SDK 内で検証され
(DEA による署名があり、実行中のものより新しい必要があります)、次回の訪問のためにブラウザーの IndexedDB
に保持されます。requireConsent: true の場合、この確認はユーザーが同意するまで待ちます。オフの場合、
SDK は保持しているモデルを削除し、要求を送らず、パッケージに組み込まれたモデルでスコアリングします。
dea.model() は使用中のモデルを { version, source } で報告します。source は 'embedded'、'cache'、
'network' のいずれかです。
読み込みオプション¶
coreUrl¶
| 型 | デフォルト | 必須 |
|---|---|---|
string \| URL |
パッケージに埋め込まれたエンジン | いいえ |
SDK の WebAssembly スコアリングエンジンを読み込む場所です。デフォルトではパッケージの JavaScript に
data: URL として埋め込まれています。コピーやホスティングが必要な .wasm ファイルはなく、このオプションは
不要です。Content Security Policy で connect-src に data: を許可できない場合にのみ設定し、代わりに
設定した URL を許可します(Content Security Policy を参照)。
URL のファイルは、セッションが動作するプロファイル向けにビルドされた、パッケージと同じリリースのエンジン
でなければなりません。SDK は、別のプロファイル向けにビルドされたファイルや、このリリースが読めない
ファイルを拒否し、dea.error に報告します。1 つの URL は 1 つのプロファイルにのみ対応するため、設定する
際はプロファイルを固定してください。
注: DEA のリリースは、モバイルプロファイルのエンジンのみを単独のファイルとして公開しています:
https://sdk.dep-protocol.com/0.26.0/core/wasm32-unknown-unknown/dea_core.wasm。@dea/sdk/mobileまたはprofile: Profile.Mobileと一緒に、DEA が任意のオリジンへ配信するこの URL のまま、または自身のホストにコピーして使います。デスクトッププロファイルのエンジンは単独のファイル として公開されていないため、デスクトップセッションでcoreUrlに指定できるファイルはありません。
本番パッケージが無視するオプション¶
DeaConfig は integrations、core、attest、ads、model も宣言しています。本番パッケージは
これらを無視します。ステージングとテストのパッケージでは、integrations で独自のインテグレーション
(取得した入力を受け取ります。テレメトリを参照)と DEA の収集
トランスポーター(データ収集を参照)を組み込めます。それ以外は
DEA 自身のテスト用です。設定しないでください。