npm 包 insight-share-api 使用教程

什么是 insight-share-api

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

主要功能包括:

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

使用前准备

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

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

安装

你可以通过 npm 进行安装：

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

或通过 CDN 引入:

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

使用教程

引入

通过 npm 引入：

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

初始化

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

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

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

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

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

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

参数说明:

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

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

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

参数说明：

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

获取分享统计信息

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

返回值：

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

示例代码

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

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

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

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

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

总结

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

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600573b081e8991b448e9add

阅读全文

猜你喜欢

  • npm 包 node-red-contrib-pi-hole 使用教程

    什么是 node-red-contrib-pi-hole node-red-contrib-pi-hole 是一个 Node-RED 的扩展组件，用于连接 Pi-hole（一种用于网络广告拦截的开源软...

    3 年前
  • npm 包 react-rayr-cli 使用教程

    React Rayr CLI 是一个方便快捷的 React 脚手架工具，可以大大简化 React 项目的搭建流程。本文将介绍如何使用 npm 包 react-rayr-cli 来快速创建 React ...

    3 年前
  • npm 包 sharecore-message 使用教程

    前言 随着移动互联网的快速发展，前端技术也呈现愈发重要的趋势。而 npm 包则是前端开发过程中不可或缺的一部分，为了提高前端开发效率，npm 包 sharecore-message 应运而生。

    3 年前
  • npm 包 ember-css-modules-reporter 使用教程

    在前端开发领域中，样式模块化已经是必备的技能。而 ember-css-modules 是一个可帮助你快速编写模块化 CSS 的插件。但是，使用这个插件的过程中，我们可能会遇到一些问题，比如：如何检查和...

    3 年前
  • NPM 包 electron-react-tools 使用教程

    简介 Electron-react-tools 是一个基于 Electron.js 和 React.js 技术的npm包，用于开发跨平台桌面应用程序。它提供了一套灵活、强大易用的工具，帮助开发人员更好...

    3 年前
  • npm 包 homebridge-openhab2 使用教程

    介绍 homebridge-openhab2 是一个 npm 包，用于将开放家居自动化协议(OpenHAB)与苹果的 HomeKit 桥接起来。通过 homebridge-openhab2，您的 Op...

    3 年前
  • npm 包 webpack-dependencies-loader 使用教程

    前言 在前端开发中，常常使用 webpack 来打包、构建项目。有时候我们需要对某些文件进行特殊的处理，例如在打包时排除某些文件，或者在打包时添加一些额外的依赖等。

    3 年前
  • npm 包 occurrence 使用教程

    前言 随着前端技术的发展，我们在日常的开发工作中使用的各种工具也在不断地变化和更新，而 npm 作为现代化的前端工具之一，其包管理能力也得到了广泛的应用。在实际的开发中，我们可能需要用到一些优秀的 n...

    3 年前
  • React-XState 使用教程

    作为一位前端开发者，您肯定经常使用 NPM 包来处理您的项目。其中有一款叫做 react-xstate 的包，它提供了一个强大且易于维护的方式来管理您的 React 组件状态。

    3 年前
  • npm 包 alooma-c3 使用教程

    #npm 包 alooma-c3 使用教程 在前端开发中，我们常常需要使用一些第三方库来实现我们想要的功能。其中，npm 是一个非常流行的包管理工具。在本文中，我将介绍一个针对数据可视化库 C3.js...

    3 年前
  • npm 包 element-ui-tuoke 使用教程

    前端开发中，我们经常会使用 UI 框架来快速地制作网页。其中，element-ui 是一个非常流行的 UI 框架，它提供了多种常用的组件和功能。而 element-ui-tuoke 这个 npm 包是...

    3 年前
  • npm 包 eslint-config-58fe 使用教程

    前言 在前端开发中，代码质量是非常重要的。为了保证代码的质量，我们需要借助静态类型检查工具、代码格式规范工具等等来辅助我们进行代码开发维护。其中 ESLint 是其中一种常用的代码检查工具，它能帮助我...

    3 年前
  • npm 包 vue-multiple-scrollbar 使用教程

    随着前端技术的不断发展，越来越多的开发者开始使用 Vue 来构建自己的 Web 应用。在 Vue 的生态圈中，有很多优秀的第三方插件和库，这些插件和库可以帮助我们更加轻松地完成各种复杂的任务。

    3 年前
  • npm 包 new-freshbooks 使用教程

    前言 在 Web 前端开发过程中，常常需要使用各种依赖包进行开发。其中，包管理工具 npm 非常常用。npm 可以使我们方便地安装、升级、卸载各种依赖包。在 npm 包之中，new-freshbook...

    3 年前
  • npm包golos-addons使用教程

    前言 在前端开发中，我们经常需要调用第三方库或框架来实现复杂的功能。而npm作为前端工程化中的一个重要工具，提供了海量的第三方包供开发者使用，极大地提高了前端开发的效率和便利性。

    3 年前
  • npm 包 @kentomoriwaki/react-router-redux4 的使用教程

    什么是 @kentomoriwaki/react-router-redux4？ @kentomoriwaki/react-router-redux4 是一个前端技术栈中用来处理路由和状态管理的 npm...

    3 年前
  • npm 包 octava-jquery-form 使用教程

    Octava-jquery-form 是一个应用于前端开发的 npm 包，其主要功能是操作表单，包括表单验证、序列化、取消等。本文将详细介绍该 npm 包的使用，包括安装、使用方法、参数配置以及示例。

    3 年前
  • npm 包 vue-computed-array 使用教程

    简介 vue-computed-array 是一个基于 Vue.js 的计算属性库，用于构建大型的、高效的计算属性数组。它提供了一种简单、易用的方法来创建复杂的计算属性，同时保持代码的可读性和可维护性...

    3 年前
  • npm 包 phosphor-layouts 使用教程

    什么是 phosphor-layouts？ phosphor-layouts 是一个基于 CSS Grid Layout 和 Flexbox 的布局引擎，它提供了一种灵活的方式来创建响应式布局。

    3 年前
  • npm 包 gulp-rev-collector-param 使用教程

    1. 简介 gulp-rev-collector-param 是一款非常实用的前端 npm 包，它可以帮助我们自动生成 hash 文件名，以及自动替换引用的文件路径。

    3 年前

相关推荐

    暂无文章