adjust-icon

スマートバナーSDKの初期化オプション

スマートバナーSDKの動作を制御するには、以下のパラメーターを設定します。

必須パラメーター

アプリトークンを設定する

スマートバナーSDKを初期化するには、AdjustSmartBanner.initメソッドを呼び出します。

AdjustSmartBanner.init({
   appToken: "APP_TOKEN",
});

このメソッドを呼び出すと、SDKはデバイスのプラットフォームを検出します。デバイスがモバイルプラットフォームの場合、SDKは利用可能なスマートバナーを読み込みます。初期化後、利用可能なバナーがすぐに表示されます。

プロジェクトの対象がシングルプラットフォームアプリの場合は、各プラットフォームトークンをappTokenオブジェクトのキーとしてパスします。

AdjustSmartBanner.init({
   appToken: {
      ios: "IOS_APP_TOKEN",
      android: "ANDROID_APP_TOKEN",
   },
});

オプションパラメーター

ログレベルを設定する

SDKが実行するログの冗長性を設定します。

Log level説明
verboseSDKアクションに関する詳細なメッセージを出力します。
info基本情報メッセージ、警告およびエラーを出力します。
warning警告とエラーメッセージのみを出力します。
errorエラーメッセージのみを出力します。
none何も出力しません。
AdjustSmartBanner.init({
   logLevel: "verbose",
});

バナーロケールを設定する

languageパラメーターを設定して、バナーを表示する際に使用するロケール（言語）を管理します。

AdjustSmartBanner.init({
   language: "fr",
});

ディープリンクを設定して、ユーザーがスマートバナーを操作した際にアプリ内で遷移される場所を指定します。

スマートバナーを使用したディープリンクを制御するには、以下のパラメーターを使用します。

  • context （オブジェクト）：ディープリンクパスのプレースホルダー（{}）に入力するデータを含むオブジェクト。
  • androidDeepLinkPath （文字列）：Androidデバイスでユーザーがリダイレクトされるアプリ内の場所。
  • iosDeepLinkPath （文字列）：iOSデバイスでユーザーがリダイレクトされるアプリ内の場所。
  • context （オブジェクト）： androidDeepLinkPathおよびiosDeepLinkPathパスで内挿される値を含むオブジェクト。

例

この例では、バナーはcontextオブジェクトからitem_idを内挿することによって、iOSユーザーをproducts/product=cool_jeans_123のディープリンクパスにリダイレクトします。

AdjustSmartBanner.init({
   // other initialisation parameters including mandatory ones
   iosDeepLinkPath: "products/product={item_id}",
   context: {
      item_id: "cool_jeans_123",
   },
});

この例では、バナーはcontextオブジェクトからitem_idを内挿することによって、Androidユーザーをproducts/product=cool_jeans_123のディープリンクパスにリダイレクトします。

AdjustSmartBanner.init({
   // other initialisation parameters including mandatory ones
   androidDeepLinkPath: "products/{item_id}",
   context: {
      item_id: "cool_jeans_123",
   },
});

この例では、バナーはcontextオブジェクトからitem_idを内挿することによって、iOSユーザーとAndroidユーザーの両方をproducts/product=cool_jeans_123のディープリンクパスにリダイレクトします。

AdjustSmartBanner.init({
   // other initialisation parameters including mandatory ones
   androidDeepLinkPath: "products/{item_id}",
   iosDeepLinkPath: "products/product={item_id}",
   context: {
      item_id: "cool_jeans_123",
   },
});

contextオブジェクトを使用して、プラットフォームごとに異なるコンテキスト変数を定義できます。この例では：

  • Androidユーザーはpromo/new_userに誘導されます。
  • iOSユーザーはmain/registrationFinishedに誘導されます。
  • unused_variableは無視されます。
AdjustSmartBanner.init({
   // other initialisation parameters including mandatory ones
   androidDeepLinkPath: "promo/{android_promo}",
   iosDeepLinkPath: "main/{ios_promo}",
   context: {
      android_promo: "new_user",
      ios_promo: "registrationFinished",
      unused_variable: "this will be ignored",
   },
});

バナーの親要素を設定する

親要素を指定することで、スマートバナーを配置する場所を設定できます。デフォルトでは、バナーはdocument.bodyに付与されています。既存のHTMLElementを指定することで、これを上書きできます。

この例では、スマートバナーはID root-for-bannerの要素に付与されています。

const element = document.querySelector("#root-for-banner");


AdjustSmartBanner.init({
   bannerParent: element,
});

バナーの作成時に関数を実行する

onCreatedパラメーターを使用して、スマートバナーが作成されるとすぐに実行される関数を設定します。

この例では、バナーが作成されるとコンソールにログが出力されます。

AdjustSmartBanner.init({
   onCreated: () => console.log("Smart banner shown"),
});

バナーが非表示になったときに関数を実行する

onDismissedパラメーターを使用して、スマートバナーが閉じられたときに実行される関数を設定します。

この例では、バナーが閉じられたときにログがコンソールに出力されます。

AdjustSmartBanner.init({
   onDismissed: () => console.log("Smart banner dismissed"),
});