微信小程序

对于微信小程序多样的开发方式，我们给出了主流开发方式的集成方法参考。如您使用了其他开发方式，请咨询我们。

如果您使用跨平台框架开发且有多端（特指小程序，快应用、App 和 Web 除外）同时需要集成 SDK 的需求时，只需在框架代码中集成一次即可。例：

使用 uni-app 同时开发微信小程序和阿里(支付宝)小程序，只需集成一次即可。

准备工作

1、在 GrowingIO 平台中新数据源并获取**accountId和dataSourceId**。

2、在您的小程序中获取**appId**。

3、在下列选项中选择对应的开发方式，并下载对应的 SDK 文件存放在项目中或使用 npm 的方式集成。

集成SDK

原生
uni-app
Taro
MPX
小程序插件

1、加载 SDK

下载SDK添加至项目目录中，下文中以utils/gio目录作为下载集成的示例目录(目录和 SDK 文件可自定义重命名)。

微信原生 SDK 下载：https://assets.giocdn.com/sdk/minip/4.1.0/gio-wechat.js
(如果您点击链接在浏览器中直接打开了文件并不是下载文件，请尝试右键点击链接，选择 链接存储为... 即可正常触发下载)

2、使用`init`方法进行初始化

参考示例代码在 app.js 小程序主文件中引用SDK并在 App 实例之前调用init方法进行初始化。

注意不要随意修改初始化代码位置，SDK 不支持在小程序的任意生命周期中进行初始化。

示例代码

// app.js
import gdp from './utils/gio/gio-wechat.js';

gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url',
    ...other settings
});

App({ ... });

原有 require 的引用方式依然可以使用。
const gdp = require('./utils/gio/gio-wechat.js').default;

1、加载 SDK

方式一：下载本地集成

下载SDK添加至项目目录中，下文中以utils/gio目录作为下载集成的示例目录(目录和 SDK 文件可自定义重命名)。

uniapp 框架 SDK 下载：https://assets.giocdn.com/sdk/minip/4.1.0/gio-uniapp.js
(如果您点击链接在浏览器中直接打开了文件并不是下载文件，请尝试右键点击链接，选择 链接存储为... 即可正常触发下载)

方式二：npm 集成

npm i gio-miniprogram-sdk --save

2、使用`init`方法进行初始化

参考示例代码在 main.js 小程序主文件中引用SDK并调用init方法进行初始化。

注意init方法所处位置（vue2 和 vue3 中分别与 app 实例的相对位置不同）

注意不要随意修改初始化代码位置，SDK 不支持在小程序的任意生命周期中进行初始化。

示例代码

uni-app(vue2)
uni-app(vue3)

// main.js
import Vue from 'vue';
import App from './App.vue';
// 下载集成方式
import gdp from './utils/gio/gio-uniapp.js';
// npm集成方式
import gdp from 'gio-miniprogram-sdk/uniapp';

App.mpType = 'app';

gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url'
    uniVue: Vue,
    ...other settings
});

// 注意vue2中app实例在初始化之后
const app = new Vue(App);
app.$mount();

// main.js
import App from './App.vue';
import { createApp } from 'vue';
// 下载集成方式
import gdp from './utils/gio/gio-uniapp.js';
// npm集成方式
import gdp from 'gio-miniprogram-sdk/uniapp';

export function createApp() {
  // 注意vue3中app实例在初始化之前
  const app = createApp(App);

  gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
      version: 'your miniProgram version',
      // OP私有部署客户请填写serverUrl，Saas客户请忽略
      serverUrl: 'your server url'
      uniVue: app,
      ...other settings
  });

  return { app };
}

原有 require 的引用方式依然可以使用。
const gdp = require('./utils/gio/gio-uniapp.js').default;

1、加载 SDK

方式一：下载本地集成

下载SDK添加至项目目录中，下文中以utils/gio目录作为下载集成的示例目录(目录和 SDK 文件可自定义重命名)。

Taro 框架 SDK 下载：https://assets.giocdn.com/sdk/minip/4.1.0/gio-taro.js
(如果您点击链接在浏览器中直接打开了文件并不是下载文件，请尝试右键点击链接，选择 链接存储为... 即可正常触发下载)

方式二：npm 集成

npm i gio-miniprogram-sdk --save

2、使用`init`方法进行初始化

参考示例代码在 app.js 小程序主文件中引用SDK并调用init方法进行初始化。

注意init方法所处位置（vue2 和 vue3 中分别与 app 实例的相对位置不同）。使用 vue 开发时taro和taroVue都要传。

注意不要随意修改初始化代码位置，SDK 不支持在小程序的任意生命周期中进行初始化。

示例代码

Taro2(React)
Taro3(React)
Taro3(vue2)
Taro3(vue3)

// app.jsx
import Taro, { Component } from '@tarojs/taro';
// 下载集成方式
import gdp from './utils/gio/gio-taro.js';
// npm集成方式
import gdp from 'gio-miniprogram-sdk/taro';

gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url'
    taro: Taro,
    ...other settings
});

class App extends Component { ... }
Taro.render(<App />, document.getElementById('app'));

// app.js
import React, { Component } from 'react';
// 下载集成方式
import gdp from './utils/gio/gio-taro.js';
// npm集成方式
import gdp from 'gio-miniprogram-sdk/taro';

const taroRuntime = require('@tarojs/runtime');
gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url'
    taro: taroRuntime,
    ...other settings
});

class App extends Component { ... }
export default App;

// app.js
import Vue from 'vue';
import Taro from '@tarojs/taro';
// 下载集成方式
import gdp from './utils/gio/gio-taro.js';
// npm集成方式
import gdp from 'gio-miniprogram-sdk/taro';

gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url'
    // 注意taro和taroVue都需要传
    taro: Taro,
    taroVue: Vue,
    ...other settings
});

// 注意vue2中App实例在初始化之后
const App = { ... };
export default App;

// app.js
import { createApp } from 'vue';
import Taro from '@tarojs/taro';
// 下载集成方式
import gdp from './utils/gio/gio-taro.js';
// npm集成方式
import gdp from 'gio-miniprogram-sdk/taro';

const taroRuntime = require('@tarojs/runtime');

// 注意vue3中App实例在初始化之前
const App = createApp({ ... });

gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url'
    // 注意taro和taroVue都需要传
    taro: taroRuntime,
    taroVue: App,
    ...other settings
});

export default App;

原有 require 的引用方式依然可以使用。
const gdp = require('./utils/gio/gio-taro.js').default;

1、加载 SDK

下载SDK添加至项目目录中，下文中以utils/gio目录作为下载集成的示例目录(目录和 SDK 文件可自定义重命名)。

2、使用`init`方法进行初始化

参考示例代码在 app.js 小程序主文件中引用SDK并在 App 实例之前调用init方法进行初始化。

注意不要随意修改初始化代码位置，SDK 不支持在小程序的任意生命周期中进行初始化。

3、全局替换方法

全局替换 MPX的createApp方法为GioApp、createPage方法为GioPage、createComponent方法为GioComponent。

示例代码

// app.js
import gdp, { GioApp } from './utils/gio/gio-wechat.js';
import mpx from '@mpxjs/core';

gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url',
    ...other settings
});

// 修改mpx的 createApp 方法为 GioApp ↓↓↓
GioApp({ ... });

// page.js
import gdp, { GioPage } from '../utils/wechat';

// 修改mpx的 createPage 方法为 GioPage ↓↓↓
GioPage({
  data: {...},
  onShow() {
    gdp('xxx', xxx);
    ...
  },
  ...
});

// component.js
import gdp, { GioComponent } from '../utils/wechat';

// 修改mpx的 createComponent 方法为 GioComponent ↓↓↓
GioComponent({
  data: {...},
  onShow() {
    gdp('xxx', xxx);
    ...
  },
  ...
});

原有 require 的引用方式依然可以使用。
const gdp = require('./utils/gio/gio-wechat.js').default;

1、加载 SDK

下载SDK添加至项目目录中，下文中以utils/gio目录作为下载集成的示例目录(目录和 SDK 文件可自定义重命名)。

2、使用`init`方法进行初始化

参考示例代码在 app.js 小程序主文件中引用SDK并在 App 实例之前调用init方法进行初始化。

注意不要随意修改初始化代码位置，SDK 不支持在小程序的任意生命周期中进行初始化。

示例代码

页面应用型插件
组件型插件

页面应用型插件可视为一个独立的小程序进行集成，但由于其运行限制的特殊性，需要调用GioPage来运行页面。

入口文件

// index.js
import gdp from './utils/gio/gio-wechat.js';

gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram plugin version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url'
    ...other settings
});

module.exports = { ... };

页面文件

// page/xxx.js
import gdp, { GioPage } from '../../utils/gio/gio-wechat.js';

GioPage({
  data: {},
  onShow() {
    gdp('xxx', xxx);
  }
});

组件型插件因其只有一个Component组件，直接集成即可。

示例代码

// myComponent.js
import gdp from './utils/gio/gio-wechat.js';

gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
    version: 'your miniProgram plugin version',
    // OP私有部署客户请填写serverUrl，Saas客户请忽略
    serverUrl: 'your server url'
    ...other settings
});

Component({ ... });

更多初始化配置项请在初始化配置菜单中查看

SDK功能插件扩展

集成 SDK 时，SDK 仅内置埋点功能，如您需要扩展其他功能时，需要集成并注册对应插件方可激活对应功能使用。

各个插件的介绍和集成方式请见插件。

加载插件后会在初始化之前打印日志。例：

数据校验

请在init初始化配置项中，将 debug 设置为 true 打开调试模式，然后在开发者工具中 Console 标签中即可实时查看 SDK 上报的 log 数据。如下图：

添加白名单

由于微信小程序对网络请求的限制参考文档，您需要将 https://your serverHost 在「小程序后台-开发-开发设置-服务器域名」中添加为 request 合法域名。小程序后台

caution

如果小程序通过第三方平台发布代码，在发布代码之前，需要调用接口在 requestdomain 中添加https://your serverHost，参考小程序官方第三方说明。

注意：请在正式生产环境发布前完成白名单的添加，未添加白名单可能会出现 SDK 无法上报数据的情况。

准备工作​

集成SDK​

1、加载 SDK​

2、使用init方法进行初始化​

示例代码​

1、加载 SDK​

方式一：下载本地集成​

方式二：npm 集成​

2、使用init方法进行初始化​

示例代码​

1、加载 SDK​

方式一：下载本地集成​

方式二：npm 集成​

2、使用init方法进行初始化​

示例代码​

1、加载 SDK​

2、使用init方法进行初始化​

3、全局替换方法​

示例代码​

1、加载 SDK​

2、使用init方法进行初始化​

示例代码​

入口文件​

页面文件​

示例代码​

SDK功能插件扩展​

数据校验​

添加白名单​

准备工作

集成SDK

1、加载 SDK

2、使用`init`方法进行初始化

示例代码

1、加载 SDK

方式一：下载本地集成

方式二：npm 集成

2、使用`init`方法进行初始化

示例代码

1、加载 SDK

方式一：下载本地集成

方式二：npm 集成

2、使用`init`方法进行初始化

示例代码

1、加载 SDK

2、使用`init`方法进行初始化

3、全局替换方法

示例代码

1、加载 SDK

2、使用`init`方法进行初始化

示例代码

入口文件

页面文件

示例代码

SDK功能插件扩展

数据校验

添加白名单