オプション¶
オプションは init に一度だけ渡します。SDK の起動時に読み取られます。後から init を呼び出しても、実行中の
セッションが返され、最初の呼び出しのオプションが保持されます。
import * as Dea from '@dea/react-native';
await Dea.init({
appId: 'YOUR_APP_ID',
requireConsent: true,
consent: undefined,
motionRate: 50,
appKey: 'YOUR_APP_KEY',
playIntegrityProject: 123456789012,
countTargets: false,
debug: false,
});
テレメトリ(SDK のログと取得した入力)は、ステージングとテストのパッケージでアプリに届きます。 テレメトリを参照してください。
コアオプション¶
appId¶
| 型 | デフォルト | 必須 |
|---|---|---|
string |
— | はい |
このアプリのために DEA が発行した appId。
アカウントとキーを参照してください。
appKey¶
| 型 | デフォルト | 必須 |
|---|---|---|
string |
undefined |
はい(アテステーションに必要) |
このプラットフォームの appId とともに DEA が発行した appKey。iOS では iOS アプリのキー、Android では
Android アプリのキーです。キーがない場合、attest() は DEA に接続せずに
unsupported を返し、その detail は no appKey で始まります。取得と分類には不要です。
アカウントとキーを参照してください。
requireConsent¶
| 型 | デフォルト | 必須 |
|---|---|---|
boolean |
true |
いいえ |
true の場合、ユーザーが同意するまで何も記録されません。
ユーザー同意を参照してください。
false に設定するのは、同意が SDK の外側ですでに確立している場合に限ります。たとえば、アプリがオンボーディング中に
尋ね、ユーザーが同意した後にのみ init を呼び出す場合です。
consent¶
| 型 | デフォルト | 必須 |
|---|---|---|
boolean |
未設定 | いいえ |
init を呼び出す前にユーザーに尋ねていて、アプリがすでに持っている回答。true は同意、false は拒否を記録し、
最初のイベントが取得される前に適用されるため、直前に同意したユーザーを取り逃がしません。回答は setConsent で
記録したものと同様に端末に保存されます。以前の起動時に端末に保存された回答を保持するには、未設定のままに
してください。
init を再度呼び出した場合、Android は渡された consent を記録しますが、iOS は無視します。最初の init の後に
回答を記録するには setConsent を使用してください。
debug¶
| 型 | デフォルト | 必須 |
|---|---|---|
boolean |
false |
いいえ |
Android のみ。 SDK の診断情報と、取得したイベントごとに 1 行を標準出力に書き出し、Logcat に表示されます。 iOS では無視されます。本番ビルドでは決して有効にしないでください。
取得オプション¶
motionRate¶
| 型 | デフォルト | 必須 |
|---|---|---|
number(Hz) |
50 |
いいえ |
Android のみ。 加速度センサーとジャイロスコープに要求するレート。0 または未設定の場合はデフォルトを使用
します。モーションサンプルが届き始めると、getSessionInfo().device.sensorRate が要求したレートを報告します。
最初のサンプルが届くまで、またサンプルを届けない端末では 0 のままです。iOS は常に SDK のデフォルトレート
(50 Hz)を使用します。
countTargets¶
| 型 | デフォルト | 必須 |
|---|---|---|
boolean |
false |
いいえ |
各プレスがどの種類のコントロールに着地したかを集計し、getTargetTally() で読み取れるようにします。
警告:
countTargetsは本番環境のappIdでは効果がありません。ネイティブ SDK は本番アカウントでは カウンターを拒否するため、ここに何を渡してもgetTargetTally()は空のオブジェクトを返します。
アテステーションオプション¶
playIntegrityProject¶
| 型 | デフォルト | 必須 |
|---|---|---|
number |
undefined |
Android では、アテステーションに必要。iOS では無視 |
Android のみ。 Android アプリの appId と appKey とともに DEA が発行した Google Cloud プロジェクト番号。
アテステーションを参照してください。