コンテンツにスキップ

API リファレンス

import * as Dea from '@dea/react-native';
// or named imports: import {init, getClassification, deaTarget} from '@dea/react-native';

SDK はモジュールレベルの関数の集合であり、保持するインスタンスはありません。SDK と通信するすべての関数は promise を返します。セッションを読み取る、または変更する呼び出しは、呼び出した順にメインスレッドで実行されます。 attest() と renewAttestation() はバックグラウンドスレッドで実行されます。init、deaTarget、getTargetTally、 onAttestationEvent を除くすべての関数は、init が実行されるまで、および dispose() の後は reject されます (エラーコード E_DEA)。getClassification() には独自のエラーコード threshold_missing がもうひとつあります。

init には、appId とともに DEA が発行した appKey を渡してください。 アカウントとキーとアテステーションを参照して ください。

ライフサイクル

init

function init(config: DeaConfig): Promise<Started>

SDK と取得を開始します。再度呼び出すと、実行中のセッションで resolve され、最初の呼び出しのオプションが保持 されます。スコアリングの問題では reject されず、ready: false と coreFault で resolve されます。Android と iOS 以外のプラットフォームでは、メッセージが is not supported で終わる Error で reject されます。 オプションを参照してください。

戻り値: Started

dispose

function dispose(): Promise<void>

取得を停止し、SDK を解放します。その後の init は新しいセッションを開始します。

ヒューマンスコアリング

getClassification

function getClassification(): Promise<Classification>

スコアを読み取る唯一の手段です。スコア、その背後にある証拠、読み込まれたモデルのしきい値を 1 回のスナップショット で取得し、human、bot、undetermined、insufficient のいずれかに分類します。ユーザーの直近のタッチも含みます。 しきい値は読み込まれたモデルのみに由来します。ヒューマンスコアリングを参照 してください。

読み込まれたモデルに bot しきい値がない場合、コード threshold_missing で reject されます。エラーの userInfo.modelVersion がそのモデルを示し、定数 THRESHOLD_MISSING がこのコードを保持します。

deaTarget

function deaTarget(
  name: string,
  bucket?: 'button' | 'link' | 'input' | 'canvas' | 'scroller',
): DeaTargetProps

同期関数です。SDK がビューに名前を付け、コントロールの種類を判別できるように、ビューにスプレッドする props を 返します。ビューに名前を付けるを参照してください。

パラメーター 型 説明
name string コントロールの名前。端末上でハッシュ化される。内容や個人情報は決して使わない
bucket string コントロールの種類。省略するとビューに名前だけ付ける

getTargetTally

function getTargetTally(): Promise<Record<number, number>>

init に countTargets: true が渡された場合の、init 以降の TargetBucket コードごとのプレス数。それ以外は空 です。本番環境の appId では常に空で、ネイティブ SDK は本番アカウントではカウンターを拒否します。init の 前は reject せず、空のオブジェクトで resolve されます。

setConsent

function setConsent(granted: boolean): Promise<void>

ユーザーの回答を記録し、端末に保存します。直ちに有効になります。 ユーザー同意を参照してください。

getConsent

function getConsent(): Promise<ConsentState>

ユーザーが回答するまでは 'unknown'、その後は 'granted' または 'denied' です。

取得

pause

function pause(): Promise<void>

記録を停止します。セッションは保持されます。機密性の高い画面を 参照してください。

resume

function resume(): Promise<void>

pause() の後に記録を再開します。同意は上書きしません。

captureEvent

function captureEvent(name: string, data?: Record<string, unknown>): Promise<boolean>
パラメーター 型 説明
name string 1〜64 文字。超えるとイベントは破棄される
data Record<string, unknown> 省略可。JSON として最大 1024 バイト。超えるとイベントは破棄される

イベントが記録された場合は true で resolve されます。カスタムイベント を参照してください。

セッション

reset

function reset(): Promise<void>

現在のセッションを終了し、新しいセッションを開始します。セッションを 参照してください。

getSessionInfo

function getSessionInfo(): Promise<Record<string, unknown>>

現在のセッション ID、端末、SDK バージョン。形状は SessionInfo を参照してください。

アテステーション

アテステーションには init に渡した appKey が必要で、Android では playIntegrityProject も必要です。 アテステーションを参照してください。

attest

function attest(): Promise<Attestation>

端末キーを DEA に登録し、結果で resolve します。最初の呼び出しで自動更新が有効になります。本番環境の appId で appKey がない場合は、DEA に接続せずに、verdict: 'unsupported'、supported: false、no appKey で始まる detail で直ちに resolve され、自動更新は開始されません。

renewAttestation

function renewAttestation(): Promise<Attestation>

現在の結果がまだ有効であっても今すぐ再登録し、自動更新を再計画します。拒否された場合は、すでに保持している登録 が維持されます。appKey がない場合は attest() と同じ応答になります。

getLastAttestation

function getLastAttestation(): Promise<Attestation | null>

再度アテステーションせずに、最後の登録結果を返します。最初の attest() の前は null です。

getNextAttestationRefresh

function getNextAttestationRefresh(): Promise<number | null>

次の自動更新がスケジュールされている時刻(エポック秒)。計画されていない場合は null です。

onAttestationEvent

function onAttestationEvent(listener: (event: AttestationEvent) => void): EventSubscription

自動更新が下すすべての判断で listener を呼び出します。同期関数です。停止するには、返される subscription の remove() を呼び出します。最初の更新をスケジュールする最初の attest() の前に購読してください。

広告

React Native では利用できません。 広告を参照してください。

型

DeaConfig

フィールド 型 説明
appId string 必須。このアプリのために DEA が発行した appId
requireConsent boolean? デフォルト true
consent boolean? アプリがすでに持っている回答
motionRate number? Android のみ。1 秒あたりのモーションサンプル数
appKey string? appId とともに DEA が発行した appKey。アテステーションに必須
playIntegrityProject number? Android のみ。Play Integrity のために DEA が発行した Google Cloud プロジェクト番号。Android でのアテステーションに必須
countTargets boolean? getTargetTally() のために bucket ごとのプレス数を集計する。本番環境の appId では効果なし
debug boolean? Android のみ。Logcat にログを出力する

オプションを参照してください。

Started

フィールド 型 説明
ready boolean false は SDK が取得はするがスコアリングできないことを意味する
coreFault string \| null スコアリングを開始できなかった理由
modelRunning string \| null SDK が読み込んだ保存済みモデルのラベル、または null。Android はここでは OTA でダウンロードしたモデルを報告しない。スコアリングしているモデルは常に getClassification().modelVersion が示す
sdkVersion string SDK バージョン

Classification

フィールド 型 説明
result ClassificationResult 結果
value number \| null 0〜1 のヒューマンスコア。result が 'insufficient' のときに限り null
actions number value の基になったスコアリングされたアクションの数。「あと N アクション」の表示に使う
botThreshold number \| null モデルの bot しきい値。モデルが読み込まれる前は null
humanThreshold number \| null モデルの human しきい値。モデルが設定していない場合は null で、そのときは botThreshold 以上のすべての value が 'human'
modelVersion number \| null しきい値の由来となるモデル。組み込みモデルは 0。モデルが読み込まれる前は null

ClassificationResult

次の順序で判定されます。

値 条件
'insufficient' スコアリングまたはモデルが読み込まれていない、またはアクションがモデルの要求数(組み込みモデルでは 8)に達していない。value は null で、証明は署名できない
'human' value が humanThreshold 以上
'bot' value が botThreshold 未満
'human' humanThreshold が null で、value が botThreshold 以上
'undetermined' value が botThreshold 以上かつ humanThreshold 未満

このリリースへの移行: Classification.sufficient は削除され、ClassificationResult に 4 つ目の値が 追加されました。

以前 このリリース
c.sufficient === false c.result === 'insufficient'
不十分なときの c.value: 数値 null
ClassificationResult は 3 値 4 値: すべての switch で 'insufficient' を処理する
humanThreshold なしで value が botThreshold 以上: 'undetermined' 'human'

ConsentState

'unknown'、'granted'、'denied'。

DeaTargetProps

フィールド 型 説明
nativeID string 名前。Android で読み取られる
testID string 名前。iOS で読み取られる
accessibilityRole 'button' \| 'link' \| 'search' \| 'image' \| 'scrollbar'(省略可) コントロールの種類。bucket を省略した場合はなし

TargetBucket

getTargetTally() のキーとなるコード: unknown 0、button 1、link 2、input 3、scroller 4、canvas 5、 background 6。

SessionInfo

getSessionInfo() は次の形状のオブジェクトで resolve されます。

フィールド 型 説明
session string 現在のセッション ID(UUID)
sdk.version string SDK バージョン
sdk.core string スコアリングエンジンのビルド
device.runtime number Android では 3、iOS では 4
device.os number 1 Android、2 iOS
device.surface {width, height} 論理ピクセルでの画面サイズ
device.pixelRatio number 論理ピクセルあたりの物理ピクセル数
device.rotation number 画面の回転: 0、90、180、270
device.maxTouchPoints number 画面が対応する同時タッチ数
device.sensorRate number モーションサンプルが届き始めた後の、要求したモーションレート(Hz)。最初のサンプルが届くまで、またサンプルを届けない端末では 0

Attestation

フィールド 型 説明
supported boolean キーを生成できたか
verdict 'passed' \| 'failed' \| 'unsupported' 結果
platformAttested boolean Play Integrity または App Attest が端末を保証したか
expiresAt number \| null 有効期限(エポック秒)
kid string \| null キーの識別子
tier string \| null DEA が割り当てた信頼ティア
backing string \| null キーが保管されている場所
detail string \| null アテステーションが失敗した理由

AttestationEvent

type その他のフィールド 意味
'scheduled' afterSeconds、nextRefresh 更新がスケジュールされた
'fired' verdict、nextRefresh 更新が実行された
'idle' nextRefresh 更新するものがない

nextRefresh はエポック秒、または null です。