npm 包 insight-share-api 使用教程-JavaScript中文网-JavaScript教程资源分享门户

什么是 insight-share-api

insight-share-api 是一个 npm 包,它是一个 JavaScript 库，用于在 Web 应用程序中集成 Insight 的分享功能。

主要功能包括:

在 Web 应用程序中推送分享内容
统计分享信息,并反馈至 Insight 分享统计系统

使用前准备

使用前需要您先在 Insight 官方网站：https://www.insight.com/ 注册一个账号。

注册后进入 Insight 后台界面，创建一个项目，获取到该项目的 app_id。

安装

你可以通过 npm 进行安装：

npm install insight-share-api --save

或通过 CDN 引入:

<script src="//unpkg.com/insight-share-api@1.0.0/dist/insight-share-api.min.js"></script>

使用教程

引入

通过 npm 引入：

import insightShareAPI from 'insight-share-api'

初始化

在使用 insight-share-api 前需要先初始化。

insightShareAPI.init({
  appId: '你的应用 ID ',
  url: 'https://insight-demo.com/api/share'
})

appId: 在 Insight 后台创建项目后获取的 app_id
url: Insight 分享统计系统的接口地址

如果您使用 CDN 引入，请添加：

<script>
  insightShareAPI.init({
    appId: '你的应用 ID ',
    url: 'https://insight-demo.com/api/share'
  })
</script>

推送分享内容（普通分享）

insightShareAPI.share('title', 'description', 'image', 'link')

参数说明:

title：分享标题，必填字段
description：分享描述，可以为空字符串或省略
image：分享图片，可以为空字符串或省略
link：分享链接，必填字段

推送分享内容（自定义分享）

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

参数说明：

platforms：自定义分享需要分享的平台，可选值：facebook，twitter，wechat，qq，weibo
title：自定义分享标题，必填字段
description：自定义分享描述，可以为空字符串或省略
image：自定义分享图片，可以为空字符串或省略
link：自定义分享链接，必填字段

获取分享统计信息

insightShareAPI.getShareStatics().then(result => {
  console.log(result)
})

返回值：

totalShareCount：累计分享次数
dailyShareCount：今日分享次数
weeklyShareCount：本周分享次数
monthlyShareCount：本月分享次数
totalSearchCount：累计搜索次数

示例代码

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

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

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

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

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

总结

insight-share-api 可以让你更方便地统计你的应用分享信息，并且通过 Insight 接口与 Insight 数据统计系统进行同步，更好地了解用户行为，优化产品。欢迎前端工程师使用。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600573b081e8991b448e9add