アカウントとキー¶
DEA SDK を使うアプリはすべて、プラットフォームごとに一度 DEA に登録されます。登録すると 2 つの値が発行され、 それらを一緒に SDK に渡します。
| 値 | 内容 | 秘密情報か |
|---|---|---|
appId |
SDK に対してアプリを識別します | いいえ |
appKey |
DEA サービスに対してアプリを識別します。SDK はすべてのアテステーション要求と証明要求の X-App-Key ヘッダーで送信します |
いいえ |
どちらの値も秘密情報ではありません。両方ともアプリやページの中に同梱され、誰でも読み取れます。つまり アプリを識別するものであり、それ自体では何も認可しません。要求を信頼できるものにするのは、DEA が登録した キーで端末が署名した証明です(アテステーションを参照)。
appId と appKey を取得する¶
アプリの登録は DEA が行います。セルフサービスのサインアップはありません。DEA の担当者に各アプリの登録を 依頼し、次の情報を伝えてください。
| プラットフォーム | アプリを識別する情報 |
|---|---|
| Android | 出荷するビルドのアプリケーション ID(パッケージ名) |
| iOS | 出荷するビルドのバンドル識別子 |
| Web | ページを配信するオリジン。例: https://www.example.com |
| Flutter、React Native | 上記の両方。Android アプリと iOS アプリはそれぞれ別のアプリとして登録され、それぞれにペアが発行されます |
登録したアプリごとに appId と appKey のペアを受け取ります。Android アプリの場合は Google Cloud
プロジェクト番号も受け取り、これを playIntegrityProject として渡します
(Android のアテステーションガイドを参照)。
ビルドに対応するアプリ用に発行されたペアを使ってください。DEA サービスは X-App-Key の先にあるアプリの
下に端末キーを登録し、別のアプリの下に登録された端末キーで署名された証明を拒否します。
SDK に渡す¶
| プラットフォーム | appId |
appKey |
appKey のない本番アプリ |
|---|---|---|---|
| Web | init({ appId }) |
init({ appKey }) |
アテステーションは失敗し、広告の証明は要求を送らずに端末上で拒否されます |
| Flutter | DeaOptions(appId:) |
DeaSdk.init(…, appKey:)。アプリが動作するプラットフォームのペア |
アテステーションは要求を送らずに unsupported を返します。証明は DEA の開発用キーの下で送信されます |
| Android | DeaConfig(appId = …) |
DeaConfig(appKey = …) |
アテステーションは UNSUPPORTED を返し、証明は要求を送らずに拒否されます |
| iOS | DeaSdkOptions(appId:) |
DeaSdkOptions(appKey:) |
アテステーションは .unsupported を返し、証明は署名されますが要求を送らずに送信されません |
| React Native | init({ appId }) |
init({ appKey })。アプリが動作するプラットフォームのペア |
アテステーションは要求を送らずに unsupported を返します |
取得と分類は、appKey の有無にかかわらず同じように動作します。attest() が最後の列のように答える場合は、
まず appKey を確認してください。端末が原因ではありません。
0.20.8 以降、証明と署名付き要求は appId を含みません。DEA は署名した端末キーからアプリを取得し、
それが X-App-Key のアプリであることを確認します。署名される appId を設定していた registryAppId
オプションは、すべてのプラットフォームで非推奨となり、無視されます。既存のアプリがコンパイルできるよう
残してあります。次に更新するときに削除してください。
SDK が動作するアカウント¶
SDK がどの種類のアカウントとして動作するかは、すべてのプラットフォームで、インストールしたパッケージが
決めます。appId は決めません。SDK は appId をヘッダーで送ることもなく、test_、sandbox_、stg_
などの先頭の文字列は何も変えません。
| パッケージ | SDK の動作モード | 意味 |
|---|---|---|
本番: リリース URL に /staging/ も /test/ も含まれない |
本番アカウント | 本番用モデルを読み、アテステーションと証明にはアプリの appKey が必要で、ログを一切書きません。取得した入力は端末の外に出ません。DEA はこのパッケージ向けの収集トランスポーターを公開していません |
ステージング: リリース URL に /staging/ を含む |
サンドボックスアカウント | DEA のステージング用モデルを読み、INFO 以上をログに書き、データを収集できます |
テスト: リリース URL に /test/ を含む |
テストアカウント | DEA のテスト用モデルを読み、DEBUG まですべてをログに書き、appKey が与えられない場合はアテステーションが開発用キーにフォールバックし、データを収集できます。DEA 自身のテスト用です。決して出荷しないでください |
どのパッケージでも、DEA がアプリに発行した appId を渡してください。Web、Android、React Native の
ブリッジでは appId にデフォルト値 'unknown-app' があり、これは DEA が登録していない ID です。必ず自分の
値を渡してください。ステージングとテストのパッケージは、appId が未設定、空、または unknown-app の
場合に sdk.app_id_missing をログに書きます。
アテステーションと証明¶
SDK が DEA と通信する時点で、appId と appKey が意味を持ちます。
- アテステーションは、端末の署名キーを DEA に登録します。登録は
X-App-Keyが示すアプリの下に 記録されます。 - 証明(「広告」ページでインプレッションやクリックに添付するものなど)は、ヘッダーに
appKeyを含み、 端末キーで署名されます。サービスは、appKeyが端末キーの登録先のアプリを示す場合にのみ受け付けます。
分類の読み取りにはどちらも必要ありません。スコアリングは端末上で動作し、要求を送りません。