@adjustcom/smart-banner-sdk

中文文档

1.3.3发布于 2026/10/23MITTypeScriptCommonJS零依赖构建来源已验证近 30 天下载 1.4万

调整智能屏蔽 SDK

文档目录13 节

内容提要
目录
安装
初始化
强制性参数
可选段落
隐藏并显示
本地化
深链接
纯字符串深链接路径
深链接路径模板
深链接路径和上下文设置器
许可证

内容提要

这是用于网站或网络应用的"调整智能封面"SDK的指南. 您可以读取更多关于调整 TM 的调整.com。。。 .

安装

建议安装SDK的方法为npm:

npm install @adjustcom/smart-banner-sdk --save

然后导入到您的代码中:

import AdjustSmartBanner from '@adjustcom/smart-banner-sdk'

Sdk也通过CDN提供,然后通过环球访问 AdjustSmartBanner。。。 .

改为: 通过 CDN 装入智能封条 SDK 将以下片段粘入 <head> 标签 :

<script type="application/javascript">
!function(n,t,e,o,a,s,r,i,c){var u=a+"_q";n[a]=n[a]||{},n[u]=n[u]||[];for(var d=0;d<s.length;d++)r(n[a],n[u],s[d]);i=t.createElement(e),c=t.getElementsByTagName(e)[0],i.async=!0,i.src="https://cdn.adjust.com/adjust-smart-banner-latest.min.js",i.onload=function(){n[a]=n[a].default;for(var t=0;t<n[u].length;t++)n[a][n[u][t][0]]?n[a][n[u][t][0]].apply(n[a],n[u][t][1]):console.error("No such function found in "+a+": "+n[u][t][0]);n[u]=[]},c.parentNode.insertBefore(i,c)}(window,document,"script",0,"AdjustSmartBanner",["init","show","hide","setLanguage","setIosDeepLinkPath","setAndroidDeepLinkPath","setContext"],(function(n,t,e){n[e]=function(){t.push([e,arguments])}}));
</script>

在通过CDN装入sdk时,我们建议使用精密版本. 您可以瞄准特定版本, 如 https://cdn.adjust.com/adjust-smart-banner-1.2.4.min.js,或者可以瞄准最新版本 https://cdn.adjust.com/adjust-smart-banner-latest.min.js 如果您需要自动更新而不需要更改目标文件。 sdk文件是被缓存的,因此可以尽可能快地提供,缓存每半小时刷新一次. 如果您需要更新, 请立即确定针对特定版本 .

初始化

为了初始化智能旗下SDK,你应该叫 AdjustSmartBanner.init 方法 :

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

当你称这种方法为Smart Banner SDK检测设备平台时,如果它是移动平台,那么SDK加载可用的智能旗. 如果当前页面的横幅存在,则在初始化完成后立即显示.

以下是当前可用参数的完整列表 init 方法 :

强制性参数

应用 `string | object`

根据您在您的空间里拥有的应用程序, 您会提供一个或多个应用标志 .

对于多平台的应用程序, 将它的应用程序代号传递给 Evolution SDK :

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

对于单个平台的应用程序,每个平台都会通过应用标志:

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

可选段落

日志级别 `string`

默认情况下,此参数设定为 error。可能的数值是: none, (中文(简体) ), error, (中文(简体) ), warning, (中文(简体) ), info, (中文(简体) ), verbose我们强烈建议您使用 verbose 测试时,以查看精确的日志,并确保整合工作进行得当. 以下是每个日志级别的更多细节:

verbose - 如果发生某些行动,将打印详细信息
info - 只打印基本信息信息、警告和错误
warning - 只打印警告和错误信息
error - 将只打印错误消息
none - 什么都不会印

语言 `string`

您可以指示 sdk 显示旗帜时应该使用什么本地化。详情见本地化。。。 .

示例

AdjustSmartBanner.init({
  // other initialisation parameters including mandatory ones
  language: "fr"
})

深链接路径参数

这些参数允许您在点击横幅时指定您的用户在您的应用程序中降落的位置。详情见深链接。。。 .

android DeepLinkPath 软件 `string`

覆盖Android深链接路径,这使得您在点击横幅时可以在移动应用程序中更改用户目的地.

示例

AdjustSmartBanner.init({
  // other initialisation parameters including mandatory ones
  androidDeepLinkPath: "android/path/to/screen"
})

请找到更多实例进一步模板和上下文解释见深链接章节.

欧斯丁克派斯 `string`

覆盖了 iOS 深链接路径,这使得您在点击横幅时可以在移动应用程序中更改用户目的地.

示例

AdjustSmartBanner.init({
  // other initialisation parameters including mandatory ones
  iosDeepLinkPath: "ios/path-to-screen"
})

请找到更多实例进一步模板和上下文解释见深链接章节.

上下文 `object`

设置深链接路径模板的上下文。上下文是一个SDK搜索值以插入深链接路径模板的对象. 详情见深链接。。。 .

实例:

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

AdjustSmartBanner.init({
  // other initialisation parameters including mandatory ones
  androidDeepLinkPath: "products/{item_id}",
  context: {
    item_id: "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"
  }
})

您可以为iOS和Android使用不同的路径并设置不同的上下文变量:

示例

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"
  }
})

旗下家长 `HTMLElement`

默认横幅附着在 document.body。要改变这一行为,您可以指定横幅的父程序。它应该是现有的 HTMLElement。。。 .

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

AdjustSmartBanner.init({
    // other initialisation parameters including mandatory ones
    bannerParent: element
})

已创建 `function`

显示横幅后的函数 .

AdjustSmartBanner.init({
    // other initialisation parameters including mandatory ones
    onCreated: () => console.log('Smart banner shown')
})

解职 `function`

点击了标语的删除按钮时要调用的函数 .

AdjustSmartBanner.init({
   // other initialisation parameters including mandatory ones
    onDismissed: () => console.log('Smart banner dismissed')
})

隐藏并显示

可以在初始化后隐藏智能旗并在需要时再次显示.

隐藏

隐藏了智能旗. 注意: 此函数不会从 DOM 中去除横幅 .

AdjustSmartBanner.hide();

显示

展示出聪明的旗帜.

重要:如果您的网页应用程序是单一的页面应用程序(SPA),在导航发生后和当前页面URL更改后,您应该使用这种方法. 这迫使 SDK 读取页面更新的 URL, SDK 可以找到当前页面的合适横幅, 或者当它构建一个跟踪器链接时使用更新的 GET 参数动态深通。。。 .

AdjustSmartBanner.show();

本地化

为了更好的用户体验,你可以将你的智能横幅本地化. Smart Banner SDK读取了浏览器中使用的语言,如果有这样的横幅本地化,横幅将会被以适当的语言显示. 但默认选择可能不是最好的选择, 很可能你更清楚用户喜欢哪种语言。在此情况下, 您可以指示 sdk 使用何种语言 .

设置首选语言有两种方法

传为: a 参数改为 AdjustSmartBanner.init
调用 setLanguage 设置如下:

AdjustSmartBanner.setLanguage("fr");

设置器接受双字母语言代码,即:. en, (中文(简体) ), de等 (中文(简体) ).

深链接

Deeplink是一个链接,可以引导用户访问您移动应用程序中的某个事件或页面,提供无缝用户体验. 智能横幅 sdk 支持 纯字符串深链接路径 财务报告和审定财务报表 深链接路径模板。。。 .

设置深链接路径或深链接路径模板有两种方法:

通过深链接路径参数改为 AdjustSmartBanner.init 方法
调用 setAndroidDeepLinkPath 财务报告和审定财务报表 setIosDeepLinkPath 设置

纯字符串深链接路径

普通字符串深链接路径只是您移动应用程序中用作用户目的地的字符串.

示例

// Plain string deeplink path

const deeplinkPath = "products/jeans/?product=cool_jeans_123"

深链接路径模板

深链接路径模板是一个字符串,其中包含卷曲括号中的占位符. Sdk 替换占位符为上下文值,即插入模板。插值的结果是平面字符串,在您的移动应用程序中被用作用户目的地.

示例

// Deeplink path template

const template = "products/{category}/?product={product_id}"

// Substrings {category} and {product_id} are the placeholders, which are replaced by values found in the context

重要: 深链接模板中的占位符由 sdk 使用提供上下文或者说获取参数当前网页 URL.

深链接路径模板的背景

上下文用于插入深链接路径模板。。。 .

从方案角度提供背景情况有两种方法:

作为上下文深链接上下文参数改为 AdjustSmartBanner.init
调用 setContext 设置

设置上下文的另一种方法是使用获取参数。。。 .

在深链接路径模板内插之前, sdk 读取当前 URL 地址的 GET 参数,并将其与程序上传的上下文结合. 如果存在GET参数和同名上下文属性, sdk 倾向于并存储上下文中出现的值.

然后sdk通过深链接路径模板来查看并用组合上下文的属性来取而代之的是卷曲括号中的位置符. 如果组合上下文中没有这样的属性,则插入了空字符串而不是占位符 .

使用 GET 参数作为上下文

要插入深链接路径模板, sdk 读取当前 URL 地址的 GET 参数,并将其与程序设置上下文结合.

示例

// Let's say the current URL is "https://my-shop.com/?product_id=111222&promo=spring_10"

AdjustSmartBanner.setIosDeepLinkPath("products/{product_id}/?promo={promo}");

// Then resulting deeplink path is "products/111222/?promo=spring_10"

你可以结合方法设置上下文:

// Let's say the current URL is "https://my-shop.com/?product_id=111222&promo=spring_10"

AdjustSmartBanner.setIosDeepLinkPath("products/{category}/{product_id}/?promo={promo}");

// But wait, there is no value for {category} in the GET parameters

AdjustSmartBanner.setContext({ category: "jeans" });

// Then resulting deeplink path is "products/jeans/111222/?promo=spring_10"

重要: 如果您的网页应用程序是单页应用程序( SPA) , 您应该呼叫 AdjustSmartBanner.show() 当 sdk 自己无法跟踪导航事件并检索更新的 URL 后页面地址更改时.

重要页:1 上下文程序上传输到 sdk 是填入占位符的先行选择, 而带有相同密钥的 GET 参数会被忽略为上下文 .

示例

// Let's say the current URL is "my-shop.com/?product_id=111222", so we have product_id parameter in the GET parameters

AdjustSmartBanner.setIosDeepLinkPath("products/{product_id}/");

// And then setContext function is called, which overrides a value of product_id
AdjustSmartBanner.setContext({ product_id: "999888" });

// Then resulting deeplink path is "products/999888/"

深链接路径和上下文设置器

设置自定义深链接路径或深链接路径模板及其上下文有几种功能.

设置和机器人 DepLinkPath

接受代表深链接路径或深链接路径模板的字符串.

示例

AdjustSmartBanner.setAndroidDeepLinkPath("products/jeans/?product=111222&promo=spring_10")

深链接路径模板可包含卷括号内的任何占位符.

示例

AdjustSmartBanner.setAndroidDeepLinkPath("products/jeans/?product={product_id}&promo={promo_id}")

Sdk 将用来自上下文在初始化过程中提供或设置函数,或从 URL 参数。。。 .

设置( S) 深线

接受代表深链接路径或深链接路径模板的字符串.

示例

AdjustSmartBanner.setIosDeepLinkPath("products/jeans/?product=111222&promo=spring_10")

深链接路径模板可包含卷括号内的任何占位符.

示例

AdjustSmartBanner.setIosDeepLinkPath("products/jeans/?product={product_id}&promo={promo_id}")

Sdk 将用来自上下文在初始化过程中提供或设置函数,或从 URL 参数。。。 .

设置

一个有数据可以将占位符填入深链接模板的对象. sdk 在通过上下文的密钥中搜索一个占位符,并用给定值替换占位符.

示例

AdjustSmartBanner.setAndroidDeepLinkPath("products/{category}/{product_id}/?promo={promo}");
AdjustSmartBanner.setContext({
  category: "jeans",
  product_id: "111222",
  promo: "spring_10"
});

// Resulting deeplink path is "products/jeans/111222/?promo=spring_10"

重要: 如果没有这样的密钥 context 找到 sdk 将尝试从当前 URL 地址的 GET 参数中获取值。如果无法找到要填入的值,则将占位符替换为空字符串.

示例

AdjustSmartBanner.setIosDeepLinkPath("products/{category}/{product_id}/?promo={promo}");
AdjustSmartBanner.setContext({ category: "jeans" });

// Resulting deeplink path is "products/jeans//?promo="

重要: 注意到 setContext 覆盖上次保存的上下文,而不是顺序调用,您应该将所有需要的参数合并在一个对象中,然后调用 setContext 带着它.

示例

// Wrong
AdjustSmartBanner.setIosDeepLinkPath("products/{category}/{product_id}");
AdjustSmartBanner.setContext({ category: "jeans" });
AdjustSmartBanner.setContext({ product_id: "111222" }); // Previous context is lost

// Resulting deeplink path is "products//111222", {category} is replaced with an empty string

// Correct
AdjustSmartBanner.setIosDeepLinkPath("products/{category}/{product_id}");
AdjustSmartBanner.setContext({
  category: "jeans",
  product_id: "111222"
});

// Resulting deeplink path is "products/jeans/111222"

许可证

调整型SDK根据麻省理工学院许可证获得许可.

特此免费准许任何人获得《公约》副本此软件和相关文档文件( “软件” ), 用于处理软件不受限制,包括不受限制使用、复制、修改、合并、出版、分发、分版许可和/或销售副本软件,并允许向软件提供软件的人因此,在下列条件下:

上述版权通知和这项许可通知应载入所有软件的复制件或大部分.

软件是提供的"AS IS", 没有任何的恐惧, EXPRESS OR ,包括但不限制于雇佣军的保障, 特别目的和非目的的证明。绝对不会 B. 任何索赔、索赔或其他索赔的索赔人或责任,在契约、契约或其他行为中,产生于, 财产、财产、财产、财产、财产或财产软件.

版本与发布记录

@adjustcom/smart-banner-sdk 共发布 25 个版本，首次发布于 2023/05/17；过去 12 个月发布了 5 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本	发布日期	距今
`1.3.3`latest	2026/10/23	15 天前
`1.3.2`	2026/10/12	26 天前
`1.3.1`	2026/07/30	3 个月前
`1.3.0`	2026/07/27	3 个月前
`1.2.8`	2025/12/02	11 个月前
`1.2.7`	2025/10/28	1 年前

关于 @adjustcom/smart-banner-sdk 的常见问题