オプション¶
オプションは DeaConfig として DeaSdk.init に一度だけ渡します。SDK の起動時に読み取られます。
後から init を呼び出すと実行中のインスタンスが返り、そのオプションが維持されます。後の呼び出しのオプションは
警告なしに無視されます。
import ai.dea.base.CAPTURE_EVENTS
import ai.dea.sdk.DeaConfig
import ai.dea.sdk.DeaSdk
import android.app.Application
class MyApp : Application() {
override fun onCreate() {
super.onCreate()
DeaSdk.init(
this,
DeaConfig(
appId = "YOUR_APP_ID",
appKey = "YOUR_APP_KEY",
requireConsent = true,
consent = null,
events = CAPTURE_EVENTS,
motionRate = 50,
playIntegrityProject = 123456789012L,
modelUpdates = true,
modelDirectory = null,
modelTimeoutMs = 30_000,
debug = false,
),
)
}
}
DeaConfig にはこのガイドで扱わないフィールドがいくつかあります。それらはデフォルトのままにしてください。
テレメトリ(SDK のログと取得した入力)は、ステージングとテストのパッケージでアプリに届きます。 テレメトリを参照してください。
コアオプション¶
appId¶
| 型 | デフォルト | 必須 |
|---|---|---|
String |
"unknown-app" |
はい |
DEA がこの Android アプリ用に発行した appId。
アカウントとキーを参照してください。必ず渡してください。
デフォルト値はプレースホルダーです。
appKey¶
| 型 | デフォルト | 必須 |
|---|---|---|
String? |
null |
はい(アテステーションに必要) |
appId とともに DEA が発行したアプリキー。DEA に対してアプリを識別するもので、秘密情報ではありません。
SDK は端末キーを登録するときに X-App-Key ヘッダーで送信し、DEA はこのキーが属するアプリの下に登録を
記録します。
appKey がない場合、attest() と renewAttestation() は DEA に接続せずに UNSUPPORTED を返し、detail に
appKey が指定されていないことが示されます。前後の空白は取り除かれ、空の値は未指定として扱われます。
分類の読み取りには使いません。
registryAppId¶
| 型 | デフォルト | 必須 |
|---|---|---|
String? |
null |
いいえ |
非推奨。 0.20.8 以降は無視されます。証明は
appIdを含みません。DEA は証明に署名した端末キーから アプリを取得し、それがappKeyのアプリであることを確認します。既存のアプリがコンパイルできるよう、 このオプションは残してあります。次に更新するときに削除してください。
requireConsent¶
| 型 | デフォルト | 必須 |
|---|---|---|
Boolean |
true |
いいえ |
true の場合、ユーザーが同意するまで何も記録されません。
ユーザー同意を参照してください。
false に設定するのは、同意が SDK の外ですでに確立している場合だけにしてください。たとえば、アプリが
オンボーディング中に同意を求め、ユーザーが同意した後にのみ DeaSdk.init を呼び出す場合です。false では、
SDK は保存されている回答にかかわらず記録します。setConsent(false) でも記録は止まりません。
consent¶
| 型 | デフォルト | 必須 |
|---|---|---|
Consent? |
null(回答はアプリのプリファレンスに保存) |
いいえ |
同意の回答を保持する場所。null のままにすると回答は端末に保存され、ユーザーに尋ねるのは一度だけになります。
共有端末向けに、この起動の間だけ回答を保持するには Consent() を渡します。独自の同意記録がすでに「はい」を
示している場合は Consent.granted() を渡します。回答を自分の記録と並べて保持するには、ConsentStore を
実装した yourStore を Consent(store = yourStore) として渡します。
ユーザー同意を参照してください。
debug¶
| 型 | デフォルト | 必須 |
|---|---|---|
Boolean |
false |
いいえ |
取得したイベントごとに、イベントの種類とセッション id を示す行を Logcat(タグ System.out、接頭辞 [dea])に
出力します。本番ビルドでは決して有効にしないでください。
onLog¶
| 型 | デフォルト | 必須 |
|---|---|---|
((LogEntry) -> Unit)? |
null |
いいえ |
SDK のすべてのログエントリを、ai.dea.base.log の LogEntry として受け取ります。SDK は各エントリを
タグ dea で Logcat にも書きます。SDK は任意のスレッドから呼び出すことがあり、コールバックが投げた例外は
無視します。
ログを書くのはステージングとテストのパッケージだけです。ステージングは INFO、WARN、ERROR を、テストは
DEBUG も書きます。本番パッケージはエントリを書かないため、onLog を呼び出しません。Android にはレベルを
変えるオプションがありません。コールバックで entry.levelText を使って絞り込んでください。
テレメトリを参照してください。
import ai.dea.sdk.DeaConfig
import ai.dea.sdk.DeaSdk
import android.util.Log
DeaSdk.init(
this,
DeaConfig(
appId = "YOUR_APP_ID",
appKey = "YOUR_APP_KEY",
onLog = { entry -> Log.d("MyApp", entry.line) },
),
)
取得オプション¶
events¶
| 型 | デフォルト | 必須 |
|---|---|---|
List<CaptureEvent> |
CAPTURE_EVENTS: 下記の最初の 5 種類 |
いいえ |
取得する入力の種類。種類を減らすと処理は軽くなりますが、分類の根拠となる証拠も減ります。
| 値 | 取得する内容 |
|---|---|
CaptureEvent.POINTER |
指、スタイラス、マウス: down、move、up、cancel、hover |
CaptureEvent.SCROLL |
マウスホイールとトラックパッドのスクロール |
CaptureEvent.MOTION |
加速度センサーとジャイロスコープ |
CaptureEvent.LIFECYCLE |
アプリがバックグラウンドに移り、戻ってくること |
CaptureEvent.CUSTOM |
独自のカスタムイベント |
CaptureEvent.KEY_DOWN |
アプリが captureKey で報告するキーの押下。デフォルトには含まれません |
CaptureEvent.KEY_UP |
アプリが captureKey で報告するキーの解放。デフォルトには含まれません |
CaptureEvent.CUSTOM がないと、captureEvent は何も記録せず false を返します。CaptureEvent.KEY_DOWN が
ないと、captureKey は何も記録しません。
motionRate¶
| 型 | デフォルト | 必須 |
|---|---|---|
Int(Hz) |
50 |
いいえ |
要求する加速度センサーとジャイロスコープのレート。端末は異なるレートで配信することがあります。最初の
モーションデータが届くと、sessionInfo.device.sensorRate は要求したレートを返します。0 はモーションデータが
まだ届いていないことを意味します。
25 以上に保ってください。それ未満ではモーションデータが疎すぎて役に立ちません。SDK は低い値を
自動的に引き上げません。
targets¶
| 型 | デフォルト | 必須 |
|---|---|---|
TargetReader |
ViewTargetReader() |
いいえ |
DeaConfig のフィールドではなく、DeaSdk.init の引数です。タッチがどの種類のコントロール(ボタン、リンク、
テキストフィールド、スクロールするリスト)に着地したか、そしてそれがどのコントロールだったかを、レイアウトで
ビューに付けたリソースのエントリ名(buy_button)から判定します。テキスト、ラベル、コンテンツの説明は
一切読みません。
ほとんどのアプリはデフォルトのままで構いません。デフォルトが誤って読み取るビュー(たとえば実際にはリンクである
クリック可能な TextView)を修正するには、そのビューで宣言します。
import ai.dea.base.TargetBucket
import ai.dea.base.deaTarget
headline.deaTarget("story_headline", TargetBucket.LINK)
独自の TargetReader を渡すのは、ビューの名前をデフォルトが見ない場所に保持している場合だけにしてください。
タッチの down ごとに、ウィンドウのルートビューとタッチの画面座標(ピクセル)を引数として呼び出されます。
import ai.dea.base.TargetReader
import ai.dea.base.ViewTargetReader
import ai.dea.sdk.DeaConfig
import ai.dea.sdk.DeaSdk
val viewReader = ViewTargetReader()
val myReader = TargetReader { root, x, y ->
// Look your own names up here, and fall back to the default reader.
viewReader.targetAt(root, x, y)
}
DeaSdk.init(this, DeaConfig(appId = "YOUR_APP_ID", appKey = "YOUR_APP_KEY"), targets = myReader)
個人情報を含む名前は決して使わないでください。
アテステーションオプション¶
playIntegrityProject¶
| 型 | デフォルト | 必須 |
|---|---|---|
Long? |
null |
はい(アテステーションに必要) |
DEA が appId と appKey とともにアプリ用に発行した Google Cloud プロジェクト番号。L 接尾辞を付けて
書いてください。12 桁の数値は Int に収まりません。
アテステーションを参照してください。
DeaSdk.init(
this,
DeaConfig(appId = "YOUR_APP_ID", appKey = "YOUR_APP_KEY", playIntegrityProject = 123456789012L),
)
モデルオプション¶
SDK はパッケージに組み込まれたモデルでスコアリングします。デフォルトでは、DEA が公開する新しいモデルも
ダウンロードし、最新のものを端末に保持します。確認は起動ごとに行われ、アプリがフォアグラウンドに戻ったときにも、
前回の確認から 1 日が経過していれば再び行われます。確認はバックグラウンドで実行され、init や
getClassification() を遅らせることはありません。SDK は DEA のモデルホストからのみ、HTTPS でモデルを
ダウンロードし、使用中のものより新しいバージョンだけを読み込みます。新しいモデルは読み込みが完了するとすぐに、
実行中のセッション内でスコアリングを始めます。要求の詳細は
プライバシーとネットワークを参照してください。
modelUpdates¶
| 型 | デフォルト | 必須 |
|---|---|---|
Boolean |
true |
いいえ |
false に設定すると、モデルの要求を一切行いません。SDK は以前にダウンロードしたモデルを削除し、組み込みモデルで
スコアリングします。
modelDirectory¶
| 型 | デフォルト | 必須 |
|---|---|---|
java.io.File? |
null(アプリの noBackupFilesDir) |
いいえ |
ダウンロードしたモデルを保持する場所。SDK はその中に dea/models/ota を作成します。デフォルトは Android の
バックアップから除外されており、それが望ましい動作です。ダウンロードしたモデルはいつでも再取得できます。
modelTimeoutMs¶
| 型 | デフォルト | 必須 |
|---|---|---|
Int(ms) |
30000 |
いいえ |
1 回のモデル要求にかけられる時間。これを超えると SDK は要求を打ち切り、手元のモデルを使い続けます。