京东小程序
对于京东小程序多样的开发方式,我们给出了主流开发方式的集成方法参考。如您使用了其他开发方式,请咨询我们。
如果您使用跨平台框架开发且有多端(特指小程序,快应用、App 和 Web 除外)同时需要集成 SDK 的需求时,只需在框架代码中集成一次即可。例:
使用 uni-app 同时开发京东小程序和阿里(支付宝)小程序,只需集成一次即可。
准备工作
1、在 GrowingIO 平台中新数据源并获取accountId
和dataSourceId
。
2、在您的小程序中获取appId
。
3、下载 SDK 文件存放在项目中,下文中以utils/gio
目录为例(目录和 SDK 文件可自定义重命名)。
集成
参考示例在 app.js 小程序主文件中添加初始化代码。添加位置参考示例代码,注意不要随意修改初始化代码位置。SDK 不支持在小程序中任意生命周期中进行初始化。
- Native 原生
- uni-app
- Taro
1、加载 SDK
京东原生 SDK 下载:https://assets.giocdn.com/sdk/minip/cdp/3.8.19/gio-jingdong.js
(如果您点击链接在浏览器中直接打开了文件并不是下载文件,请尝试右键点击链接,选择 链接存储为...
即可正常触发下载)
2、使用init
方法进行初始化
注意init
方法所处位置在 App 实例之前。
示例代码
// app.js
import gdp from './utils/gio/gio-jingdong.js';
gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
version: 'miniProgram version',
host: 'Your ServerHost',
...other settings
});
App({ ... });
原有 require 的引用方式依然可以使用。
const gdp = require('./utils/gio/gio-jingdong.js').default;
1、加载 SDK
方式一:下载本地集成
uniapp 框架 SDK 下载:https://assets.giocdn.com/sdk/minip/cdp/3.8.19/gio-uniapp.js
(如果您点击链接在浏览器中直接打开了文件并不是下载文件,请尝试右键点击链接,选择 链接存储为...
即可正常触发下载)
方式二:npm 集成
npm i gio-miniprogram-sdk-cdp --save
2、使用init
方法进行初始化
注意init
方法所处位置(vue2 和 vue3 中分别与 app 实例的相对位置不同)
示例代码
- 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-cdp/gio-uniapp';
App.mpType = 'app';
gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
version: 'miniProgram version',
host: 'Your ServerHost',
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-cdp/gio-uniapp';
export function createApp() {
// 注意vue3中app实例在初始化之前
const app = createApp(App);
gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
version: 'miniProgram version',
host: 'Your ServerHost',
uniVue: app,
...other settings
});
return { app };
}
原有 require 的引用方式依然可以使用。
const gdp = require('./utils/gio/gio-uniapp.js').default;
1、加载 SDK
方式一:下载本地集成
Taro 框架 SDK 下载:https://assets.giocdn.com/sdk/minip/cdp/3.8.19/gio-taro.js
(如果您点击链接在浏览器中直接打开了文件并不是下载文件,请尝试右键点击链接,选择 链接存储为...
即可正常触发下载)
方式二:npm 集成
npm i gio-miniprogram-sdk-cdp --save
2、使用init
方法进行初始化
注意init
方法所处位置(vue2 和 vue3 中分别与 app 实例的相对位置不同)。使用 vue 开发时taro
和taroVue
都要传。
示例代码
- Taro2
- 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-cdp/gio-taro';
gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
version: 'miniProgram version',
host: 'Your ServerHost',
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-cdp/gio-taro';
const taroRuntime = require('@tarojs/runtime');
gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
version: 'miniProgram version',
host: 'Your ServerHost',
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-cdp/gio-taro';
gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
version: 'miniProgram version',
host: 'Your ServerHost',
taro: Taro, // 注意taro和taroVue都需要传
taroVue: Vue, // 注意taro和taroVue都需要传
...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-cdp/gio-taro';
const taroRuntime = require('@tarojs/runtime');
// 注意vue3中App实例在初始化之前
const App = createApp({ ... });
gdp('init', 'your GrowingIO accountId', 'your dataSourceId', 'your AppId', {
version: 'miniProgram version',
host: 'Your ServerHost',
taro: taroRuntime, // 注意taro和taroVue都需要传
taroVue: App, // 注意taro和taroVue都需要传
...other settings
});
export default App;
原有 require 的引用方式依然可以使用。
const gdp = require('./utils/gio/gio-taro.js').default;
更多配置项请在集成配置菜单中查看
插件扩展
集成 SDK 时,SDK 仅内置埋点功能,如您需要扩展其他功能时,需要集成并注册对应插件方可激活对应功能使用。
各个插件的介绍和集成方式请见插件。
加载插件后会在初始化之前打印日志。例:
数据校验
请在init
初始化配置项中,将 debug
设置为 true
打开调试模式,然后在开发者工具中 Console 标签中即可实时查看 SDK 上报的 log 数据。如下图:
添加白名单
由于京东小程序对网络请求的限制参考文档,您需要将 https://your serverHost
在「小程序后台-开发管理-设置-开发设置-服务器域名」中添加为 request 合法域名。小程序后台