— 初期化オプション一覧

Specification

SDK の初期化時にオプションを指定することで、SDKの一部の挙動を変更することが可能です。
なお通常はデフォルトの設定で問題ありません。

オプションデフォルト値内容
Config#isDryRunfalse

イベントトラッキングを行うかどうか指定するためのオプションです。

true を指定することでイベントトラッキングが行われなくなります。

Config#isOptOutfalse

オプトアウトを行うかどうか指定するためのオプションです。

true を指定することで、オプトアウトが有効になります。

実装の方法については、オプトアウトに対応する をご覧ください。

Config#enabledTrackingAaidfalse

広告 ID (AAID) を送信するかどうかを指定するためのオプション。

true を指定することで送信が行われるようになります。

詳細は、Appendix: 広告ID(AAID)を送信する をご覧ください。

CrashReportingConfig#enabledTrackingtruev2.12.0以降のバージョンで使用可能です。

クラッシュイベントを送信するかどうかを指定するためのオプション。

true を指定することで送信が行われるようになります。

また、 inappmessaging モジュールと notifications モジュールにはそれぞれ追加の設定オプションがあります。
KarteApp.setup 関数で上記初期化オプションを設定する際に、モジュールごとの設定を行うことも可能です。

inappmessaging モジュールの設定オプション

オプションデフォルト値内容
InAppMessaging.Config.enabledWebViewCachetrue非推奨: v2.5.0より常にtrueとして扱われます。

接客表示に使用する WebView をキャッシュするかを指定するためのオプションです。

true を指定することでキャッシュされるようになります。

詳細は、アクション表示の仕組み - WebViewのキャッシュ をご覧ください。

notifications モジュールの設定オプション

オプションデフォルト値内容
NotificationsConfig#enabledFCMTokenResendtrue

SDK 初期化時に FCM トークンを自動送信するかどうかを指定するためのオプションです。

true を指定することで自動送信が有効になります。

※同じ設定のオプションNotifications.Config.enabledFCMTokenResendはv2.7.0より非推奨となりました。

Updated 6 months ago

— 初期化オプション一覧


Specification

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.