スマートバナーSDKの動作を制御するには、以下のパラメーターを設定します。
必要なパラメータ
アプリトークンを設定する
スマートバナーSDKを初期化するには、AdjustSmartBanner.init
メソッドを呼び出します。
このメソッドを呼び出すと、SDKはデバイスのプラットフォームを検出します。デバイスがモバイルプラットフォームの場合、SDKは利用可能なスマートバナーを読み込みます。初期化後、利用可能なバナーがすぐに表示されます。
プロジェクトの対象がシングルプラットフォームアプリの場合は、各プラットフォームトークンをappToken
オブジェクトのキーとしてパスします。
オプションパラメーター
ログレベルを設定する
SDKが実行するログの冗長性を設定します。
Log level | 説明 |
---|---|
verbose | SDKアクションに関する詳細なメッセージを出力します。 |
info | 基本情報メッセージ、警告およびエラーを出力します。 |
warning | 警告とエラーメッセージのみを出力します。 |
error | エラーメッセージのみを出力します。 |
none | 何も出力しません。 |
バナーロケールを設定する
language
パラメーターを設定して、バナーを表示する際に使用するロケール(言語)を管理します。
ディープリンクを設定する
ディープリンクを設定して、ユーザーがスマートバナーを操作した際にアプリ内で遷移される場所を指定します。
スマートバナーを使用したディープリンクを制御するには、以下のパラメーターを使用します。
context
(オブジェクト):ディープリンクパスのプレースホルダー({}
)に入力するデータを含むオブジェクト。androidDeepLinkPath
(文字列):Androidデバイスでユーザーがリダイレクトされるアプリ内の場所。iosDeepLinkPath
(文字列):iOSデバイスでユーザーがリダイレクトされるアプリ内の場所。context
(オブジェクト):androidDeepLinkPath
およびiosDeepLinkPath
パスで内挿される値を含むオブジェクト。
例
この例では、バナーはcontext
オブジェクトからitem_id
を内挿することによって、iOSユーザーをproducts/product=cool_jeans_123
のディープリンクパスにリダイレクトします。
この例では、バナーはcontext
オブジェクトからitem_id
を内挿することによって、Androidユーザーをproducts/product=cool_jeans_123
のディープリンクパスにリダイレクトします。
この例では、バナーはcontext
オブジェクトからitem_id
を内挿することによって、iOSユーザーとAndroidユーザーの両方をproducts/product=cool_jeans_123
のディープリンクパスにリダイレクトします。
context
オブジェクトを使用して、プラットフォームごとに異なるコンテキスト変数を定義できます。この例では:
- Androidユーザーは
promo/new_user
に誘導されます。 - iOSユーザーは
main/registrationFinished
に誘導されます。 unused_variable
は無視されます。
バナーの親要素を設定する
親要素を指定することで、スマートバナーを配置する場所を設定できます。デフォルトでは、バナーはdocument.body
に付与されています。既存のHTMLElement
を指定することで、これを上書きできます。
この例では、スマートバナーはID root-for-banner
の要素に付与されています。
バナーの作成時に関数を実行する
onCreated
パラメーターを使用して、スマートバナーが作成されるとすぐに実行される関数を設定します。
この例では、バナーが作成されるとコンソールにログが出力されます。
バナーが非表示になったときに関数を実行する
onDismissed
パラメーターを使用して、スマートバナーが閉じられたときに実行される関数を設定します。
この例では、バナーが閉じられたときにログがコンソールに出力されます。