npm 包 branch-sdk-imagitas 使用教程

阅读时长 5 分钟读完

简介

branch-sdk-imagitas 是一个基于 branch.io 平台的前端 JavaScript SDK 库,它提供了一个方便快捷的方式来创建有品牌效应的 App 链接,可以轻松地跟踪和衡量这些链接的点击和转化率。我们可以将它安装到我们的项目中,并简单的配置后就能使用它的功能。

在本文中,我们将重点介绍如何使用 branch-sdk-imagitas,让你能够轻松添加这个功能到你的前端开发项目中。

安装

首先我们要先安装 branch-sdk-imagitas,因为它是一个 npm 包,可以通过以下命令行进行安装:

基本用法

源码中的 Branch 模块被用来创建一个 Branch 链接,我们创建一个链接的大概过程如下:

  1. 导入 Branch 模块:
  1. 创建 Branch 对象并设置配置:

其中,keysecret 是由 branch.io 颁发的认证信息,这些信息用于身份验证。

  1. 在你的代码中使用 link 方法来创建一个 Branch 链接:
-- -------------------- ---- -------
----- -------- - -
  --------- --------------
  -------- -------------
  -------- -------------
  ------ -----------
  ----- -
    ------- ----------
  -
--

--------------------- ----- ---- -- -
  ------- -
    -------------------
  - ---- -
    -----------------
  -
---

以上代码将返回一个包含 Branch 链接的 JSON 对象,可以将该链接作为普通的 HTTP 链接来使用。

配置项

Branch 对象可以接受以下的配置项:

key

类型:String

Branch 颁发的认证信息键值。

secret

类型:String

Branch 颁发的认证信息密钥。

branch_callback_url

类型:String

设置一个回调 URL,这个 URL 可用于跟踪用户转化。

xhr_headers

类型:Object

为发出的每个 XHR 请求添加自定义标头。

timeout

类型:Number

设置链接过期前的时间(以秒为单位)。

retries

类型:Number

配置错误时重新尝试的次数。

delay

类型:Number

设置每次重新尝试的延迟(以秒为单位)。

tracking_disabled

类型:Boolean

设置为 true 时将禁用 Branch 链接的本地用户跟踪。

disable_entry_animation

类型:Boolean

设置为 true 时关闭点击 Branch 链接时的默认入场动画。

initialize

类型:Boolean

设置为 false 时将防止 Branch 自动初始化。

force_new_session

类型:Boolean

设置为 true 以生成一个新会话。

示例代码

我们将创建一个简单的页面,使用 Branch 模块来创建 Branch 链接。下面是示例代码:

-- -------------------- ---- -------
--------- -----
------
  ------
    ----- ----------------
    ------------- ---- ---------------
  -------
  ------
    ---------- ---- ------------
    -- ---------------------
    ------- ---------------------- --------------------------
  -------
-------
-- -------------------- ---- -------
------ - ------ - ---- ----------------------

----- ------ - --- --------
  ---- ------------------
  ------- --------------------
---

----- -------- - -
  --------- --------------
  -------- -------------
  -------- -------------
  ------ -----------
  ----- -
    ------- ----------
  -
--

--------------------- ----- ---- -- -
  ------- -
    -------------------
  - ---- -
    ----- ---------- - ---------------------------------------
    -------------------- - --- ----------------- --------------------------------
  -
---

这个示例构建了一个简单的页面,并在页面中创建了一个 Branch 链接。我们可以更改 linkData 对象中的值来满足我们的需求。通过修改这些值,我们可以创建不同的 Branch 链接,并为每个链接跟踪转化率。

总结

使用 Branch 模块可以轻松地创建有品牌效应的 App 链接,并跟踪和衡量这些链接的点击和转化率。branch-sdk-imagitas 提供了一个快速、方便的前端 JavaScript SDK 库,我们可以通过安装它并简单的进行配置,就可以实现这些功能。这使得前端开发人员可以轻松地为他们的应用添加这个功能,并了解这个插件能够为他们的应用带来的价值。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066c84ccdc64669dde4e7e

纠错
反馈