オプション¶
オプションは、DeaSdk を作成するときに DeaSdkOptions 値として一度だけ渡します。インスタンスの作成時に
読み取られ、その後は変更できません。別のオプションを使うには、インスタンスを dispose() して新しく作成します。
import DeaBase
import DeaSDK
let dea = DeaSdk(
options: DeaSdkOptions(
appId: "YOUR_APP_ID",
requireConsent: true,
consent: Consent(store: DefaultsConsentStore()),
appKey: "YOUR_APP_KEY",
modelUpdates: true,
events: CaptureEvent.pointerKinds,
motionRate: 50
)
)
dea.start()
appId 以外のすべてのオプションにはデフォルトがあるので、変更するものだけを指定してください。Swift は
イニシャライザが宣言する順序で引数を受け取ります: appId、requireConsent、consent、appKey、
registryAppId、onLog、modelDirectory、modelUpdates、modelTimeout、events、idleMotionMs、
motionRate、touchMarginMs。
import DeaBase は、Consent、同意ストア、CaptureEvent を自分で指定するときだけ必要です。
テレメトリ(SDK のログと取得した入力)は、ステージングとテストのパッケージでアプリに届きます。 テレメトリを参照してください。
コアオプション¶
appId¶
| 型 | デフォルト | 必須 |
|---|---|---|
String |
— | はい |
DEA がこの iOS アプリ向けに発行した appId。アカウントとキーを
参照してください。SDK が要求を送るアドレスは組み込みで、どのオプションでも変更できません。
requireConsent¶
| 型 | デフォルト | 必須 |
|---|---|---|
Bool |
true |
いいえ |
true のとき、ユーザーが同意するまで何も記録されません。
ユーザー同意を参照してください。
false にするのは、SDK の外ですでに同意が得られている場合だけにしてください。たとえば、アプリが
オンボーディング中に同意を求め、ユーザーが同意した後にだけ DeaSdk を作成する場合です。
consent¶
| 型 | デフォルト | 必須 |
|---|---|---|
Consent? |
nil — 回答は UserDefaults.standard に保存 |
いいえ |
ユーザーの同意の回答を保持する場所。アプリがすでに別の場所で同意を保持しており、SDK にそこを読み書き
させたい場合を除き、nil のままにしてください。独自の ConsentStore の上に構築した Consent を渡します。
import DeaBase
import DeaSDK
final class MyConsentStore: ConsentStore {
func read() -> ConsentDecision {
switch MyPrivacySettings.shared.behaviourMeasurement {
case .some(true): return .granted
case .some(false): return .denied
case .none: return .unknown
}
}
func write(_ decision: ConsentDecision) {
switch decision {
case .granted: MyPrivacySettings.shared.behaviourMeasurement = true
case .denied: MyPrivacySettings.shared.behaviourMeasurement = false
case .unknown: MyPrivacySettings.shared.behaviourMeasurement = nil
}
}
}
let dea = DeaSdk(
options: DeaSdkOptions(
appId: "YOUR_APP_ID",
consent: Consent(store: MyConsentStore()),
appKey: "YOUR_APP_KEY"
)
)
ストアは Consent の作成時に一度だけ読み取られます。MyPrivacySettings は自分の設定ストレージに
置き換えてください。
| ストア | 回答の保持先 |
|---|---|
DefaultsConsentStore() |
UserDefaults.standard に、起動をまたいで保持(デフォルト) |
MemoryConsentStore() |
この実行中のみ。起動ごとにユーザーに再度求める |
onLog¶
| 型 | デフォルト | 必須 |
|---|---|---|
((LogEntry) -> Void)? |
nil |
いいえ |
SDK のビルドが持つ各ログエントリで呼び出されます。iOS SDK の本番ビルドはログを持たないため、
そこでは onLog は呼び出されません。
取得オプション¶
events¶
| 型 | デフォルト | 必須 |
|---|---|---|
[CaptureEvent] |
CaptureEvent.pointerKinds |
いいえ |
取得する入力の種類。取得する種類を減らすと処理は減りますが、スコアの根拠となる証拠も減ります。
| 値 | 取得するもの |
|---|---|
.pointerDown |
指またはスタイラスが画面に触れる |
.pointerMove |
タッチが移動する、およびポインターがホバーする |
.pointerUp |
タッチが終わる |
.pointerCancel |
システムがタッチをキャンセルする |
.wheel |
トラックパッドとマウスのスクロール |
.keyDown |
アプリが captureKey で報告するキーの押下 |
.keyUp |
アプリが captureKey で報告するキーの解放 |
CaptureEvent.pointerKinds は最初の 5 つです。キーの種類はデフォルトのリストに含まれず、自動的に
取得されることもありません。.keyDown は、アプリがタイピングを報告する場合だけ追加してください。
タイピングを報告するを参照してください。これがないと
captureKey は何もしません。
import DeaBase
import DeaSDK
let dea = DeaSdk(
options: DeaSdkOptions(
appId: "YOUR_APP_ID",
appKey: "YOUR_APP_KEY",
events: CaptureEvent.pointerKinds + [.keyDown]
)
)
スクロール、ホバー、マウスやトラックパッドのポインターは取得されますが、iOS ではスコアには加わりません。 スコアは、タッチとスタイラスの接触、端末の動き、アプリが報告するキー押下から構築されます。
motionRate¶
| 型 | デフォルト | 必須 |
|---|---|---|
Int(Hz) |
50 |
いいえ |
要求するモーションセンサーのレート。25 未満の値は 25 に引き上げられます。
sessionInfo.device.sensorRate は、最初のモーション読み取り値が届いた後にこのレートを報告し、それまでは
0 です。シミュレーターやモーションセンサーのない端末では、実行中ずっと 0 です。
idleMotionMs¶
| 型 | デフォルト | 必須 |
|---|---|---|
Int(ms) |
3000 |
いいえ |
誰も画面に触れていないとき、モーションデータは次のタッチまで低いレート(idleMotionMs ごとに 1 件)で
保持されます。0 にするとすべての読み取り値を保持します。
touchMarginMs¶
| 型 | デフォルト | 必須 |
|---|---|---|
Int(ms) |
200 |
いいえ |
各タッチの前後この時間だけ、アイドル中でもモーションデータをフルレートで保持します。
画面を記録の対象外にするには、pause() を使います。
アテステーションオプション¶
App Attest ケイパビリティをアプリに追加すると、App Attest が自動的に使われます。 アテステーションを参照してください。
appKey¶
| 型 | デフォルト | 必須 |
|---|---|---|
String? |
nil |
はい(アテステーションを使う場合) |
DEA が appId とともに発行した appKey。SDK は端末キーを登録するときに、これを X-App-Key ヘッダーで
送ります。前後の空白は取り除かれ、空文字列はキーなしとみなされます。
これがないと、attest() と renewAttestation() は DEA に接続せずに .unsupported を返し、結果の
detail は appKey が渡されていないことを示します。分類の読み取りには必要ありません。
DeaSdk.appKey で、SDK が送るキーを読み戻せます。
registryAppId¶
| 型 | デフォルト | 必須 |
|---|---|---|
String? |
nil |
いいえ |
非推奨。 0.20.8 以降は無視されます。証明は
appIdを含みません。DEA は証明に署名した端末キーから アプリを取得し、それがappKeyのアプリであることを確認します。既存のアプリがコンパイルできるよう、 このオプションは残してあります。次に更新するときに削除してください。
モデルオプション¶
SDK は組み込みのモデルでスコアリングします。modelUpdates が有効なときは、DEA のモデルサーバーに、
より新しいモデルが公開されていないかも問い合わせます。問い合わせは DeaSdk の作成ごとと、最後に回答を得た
確認から 1 日が経過している場合にアプリがフォアグラウンドに戻ったときに行われます。実行中のものより新しい
場合にだけモデルをダウンロードし、スコアリングエンジンは使用前にファイルを検証します。新しいモデルは
セッションの途中でもすぐに使われ、次回の起動のために端末に保持されます。確認はバックグラウンドで実行
されます。これを待つものはなく、throw することもありません。
DeaSdk.modelInfo は、どのモデルがスコアリングしているかを示します。
API リファレンスを参照してください。
modelUpdates¶
| 型 | デフォルト | 必須 |
|---|---|---|
Bool |
true |
いいえ |
確認を止めるには false にします。ダウンロード済みのモデルは DeaSdk の作成時に削除され、SDK は
組み込みモデルでスコアリングします。
modelDirectory¶
| 型 | デフォルト | 必須 |
|---|---|---|
URL? |
nil — アプリの Application Support ディレクトリ |
いいえ |
ダウンロードしたモデルの保持先。SDK はその中に dea/models を作成します。このフォルダを作成できない
場合、SDK は更新を確認せず、組み込みモデルでスコアリングします。
modelTimeout¶
| 型 | デフォルト | 必須 |
|---|---|---|
TimeInterval |
30 秒 |
いいえ |
1 回のモデル要求を打ち切るまでの時間。
予約済み¶
DeaSdkOptions には、DEA 自身のツールとテストのために予約されたパラメータがさらに 5 つあります。
デフォルトのままにしてください。
| パラメータ | 動作 |
|---|---|
integrations |
本番パッケージでは無視される。ただし収集トランスポーターのストリーム配信は、すべてのパッケージで接続される。データ収集を参照。ステージングとテストのパッケージでは独自のインテグレーションも接続される。テレメトリを参照 |
modelUrlOverride |
本番パッケージでは無視される |
openCore |
スコアリングエンジンを置き換える |
keystore |
端末キーや App Attest を拒否させ、それらの失敗をテストする |
urlProtocolClasses |
SDK が行うすべての要求の前に URLProtocol クラスを置く |