初始化选项
您可以设置下列参数来控制智能横幅 SDK 的行为。
必要参数
设置应用识别码
要初始化 Smart Banner SDK,请调用AdjustSmartBanner.init
方法。
AdjustSmartBanner.init({
appToken: "APP_TOKEN",
});
调用该方法时SDK 会检测设备平台。如果设备为移动平台,SDK 就会加载可用的智能横幅。可用横幅会在初始化后立即显示。
如果您的项目针对单一平台应用,请在appToken
对象中将每个平台识别码作为键进行发送。
AdjustSmartBanner.init({
appToken: {
ios: "IOS_APP_TOKEN",
android: "ANDROID_APP_TOKEN",
},
});
可选参数
设置日志级别
配置 SDK 日志的详细级别。
verbose
日志以便详细了解潜在问题。
logLevel | 描述 |
---|---|
`verbose` | 输出 SDK 操作的详细信息 |
`info` | 输出基本信息、警告和错误 |
`warning` | 只输出警告和错误信息 |
`error` | 只输出错误信息 |
`none` | 不输出任何内容 |
AdjustSmartBanner.init({
logLevel: "verbose",
});
设置横幅语种
设置language
参数来控制显示哪种语言的横幅。
AdjustSmartBanner.init({
language: "fr",
});
设置深度链接
您可以配置深度链接,指定与智能横幅互动的用户跳转到应用中的何处。
使用下列参数来控制智能横幅的深度链接:
context
(对象): 包含数据的对象,其中的数据可填充深度链接路径中的占位符 ({}
) 。androidDeepLinkPath
(字符串):用户在安卓设备上被重定向到的应用内位置。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
将安卓用户重定向至位于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 和安卓用户重定向至位于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
对象针对不同平台定义不同上下文变量。在此示例中:
- 安卓用户会被转到
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"),
});