小程序 SDK

下载小程序SDK
微信小程序SDK下载地址：https://assets.giocdn.com/sdk/cdp/gio-minp.js​
支付宝小程序SDK下载地址：https://assets.giocdn.com/sdk/cdp/gio-alip.js​
头条小程序SDK下载地址：https://assets.giocdn.com/sdk/cdp/gio-bytedance-minp.js​
将gio-minp.js / gio-alip.js / gio-bytedance-minp.js 放在小程序目录下（比如：/src/utils目录）
// 微信小程序
var gio = require("./utils/gio-minp.js").default;
​
// 支付宝小程序
var gio = require("./utils/gio-alip.js").default;
​
// 头条小程序
var gio = require("./utils/gio-bytedance-minp.js").default;
添加数据追踪代码
请将以下的页面代码放置到小程序App.js首部，即可完成 小程序SDK 代码的安装。请注意使用具体的项目 ID替换代码中的 your projectId，使用具体的数据源 ID替换代码中的 your dataSourceId，使用具体的小程序Id代替代码中的your appId 。
// 原生小程序
var gio = require("./utils/gio-minp.js").default;
gio('init', 'your projrctId','your datasourceID','your appId', {})；
App({
onLaunch: function () {
},
globalData: {
gio: gio
}
})
使用Taro，Mpvue，Chameleon，Uniapp等多端框架开发的小程序，需要在项目的App.js 中添加集成如下代码。
// Taro框架
import Taro from '@tarojs/taro';
var gio = require("utils/gio-minp/index.js").default;
gio('init', 'your projrctId', 'your datasourceID', 'your appId', { version: '小程序版本', taro: Taro });
// Wepy,Mpvue和Uniapp框架
import Vue from 'vue';
var gio = require("utils/gio-minp/index.js").default;
gio('init','your projrctId', 'your datasourceID', 'your appId', { version: '小程序版本', vue: Vue });
// Chameleon 框架
import Cml from 'chameleon-runtime';
var gio = require("utils/gio-minp/index.js").default;
gio('init', 'your projrctId', 'your datasourceID', 'your appId', { version: '小程序版本', cml: Cml });
添加请求服务器域名
要正常采集微信小程序的数据并发送，需要在微信小程序里事先设置一个通讯域名，允许跟 GrowingIO API 服务器进行网络通信。具体步骤如下：
登陆微信小程序后台，进入配置。
打开开发设置，到服务器域名配置部分。
在request合法域名中添加：同init中的host地址。
数据校验
在初始化时打开 debug 为true，打开控制台，即可看到实时采集的数据。
gio('init', 'your projectId', 'your dataSourceId', 'your appId',{debug: true});
配置系统变量
host
GrowingIO 默认不配置 发数的api，需要在初始化时设置 host，否则会初始化失败。然后需要在微信后台配置合法域名，与传入的参数的host一致：
gio('init', 'your projectId','your dataSourceId', 'your appId', {host: 'api.growingio.com'});
Scheme
GrowingIO 默认发数时是https，如果您的请求协议为http，可以参考如下设置：
gio('init', 'your projectId','your dataSourceId', 'your appId' , {scheme: 'http'});
forceLogin
小程序可以指定强制登录，设置 forceLogin 为 true 后未调用 identify 方法前，不会发送数据，调用 identify 会设置 anonymousId 为给定值（一般是小程序 openId），然后会开发发送数据，包括identify之前触发的事件。
gio('init', 'your projectId','your dataSourceId', 'your appId' , {forceLogin: true});
​
gio('identify', openId)
getLocation
GrowingIO 默认不获取用户的地理位置信息，如果您的小程序在打开时就需要获取用户地理信息，需要在初始化时设置获取用户地理位置信息和位置格式。
autoGet：true | false
type：wgs84 | gcj02 //gcj02 为火星坐标系
gio('init', 'your projectId','your dataSourceId', 'your appId' , {getLocation: {
autoGet: true,
type: 'wgs84'
}
}
);
​
gtouchHost 
请求弹窗地址，一般与您环境的host一致
gio('init', 'your projectId','your dataSourceId', 'your appId', {host: 'api.growingio.com',gtouchHost:'popupwindow.test.com'});
常用API
简介
init 方法建议在集成sdk之后马上调用，其他方法必须在app的onshow周期及之后的生命周期调用才生效
// 初始化参数
gio('init', projectId, dataSourceId, appId options);
​
// 发送事件API
gio('track', eventId);
gio('track', eventId, eventLevelVariables);
​
// 上传物品模型
gdp('track', eventId, eventLevelVariables，item);
​
// 发送用户变量 API
gio('setUserAttributes', userAttributes);
​
// 设置登录用户 ID
gio('setUserId', userId); 
​
// 清除登录用户 ID
gio('clearUserId');
​
// 设置访问用户 ID
gio('identify', openId)
​
// 获取用户信息
gio('setPlatformProfile')
​
初始化参数API（Init）
初始化参数，用来设置项目ID和一些常用的配置项。
参数名称
类型
是否必填
说明
projectId
string
是
项目ID
dataSourceId
string
是
数据源ID
appId
string
是
微信应用ID
host
string
是
发送到服务端的主机名
scheme
string
否
api 请求协议 http/https
forceLogin
boolean
否
设置是否强制登录，默认值 false
getLocation
JSON Object
否
是否获取地理位置和坐标格式
options
JSON Object
否
系统变量配置
//init API原型
gio('init', projectId, dataSourceId, appId, options);
//init API调用示例
//配置发数api为 http://api.test.com
gio('init', 'your-project-id', 'your-data-source-id', 'wx112222', {
    scheme: 'http',
    host: 'api.test.com'
});
设置登录用户 ID（setUserId）
当用户登录之后调用 setUserId API ，设置登录用户 ID 。
参数名称
类型
是否必填
说明
userId
string
是
应用的登录用户ID
//setUserId API原型
gio('setUserId', userId);
​
//setuserId API调用示例
gio('setUserId', '88888');
清除登录用户 ID（clearUserId）
当用户登出之后调用 clearUserId ，清除已经设置的登录用户 ID 。
//clearUserId API原型和调用示例
gio('clearUserId');
设置用户变量 （setUserAttributes）
参数名称
类型
是否必填
说明
userAttributes
JSON Object
是
包含用户变量的JSON对象。
// setUserAttributes API调用原型
gio('setUserAttributes', userAttributes);
​
// setUserAttributes API调用示例
gio('setUserAttributes', {name: 'zc'})
设置平台用户信息
获取用户信息 (setPlatformProfile) 在取得用户授权后，可以获得用户的信息。需要在获取用户授权的回掉函数中调用。以微信小程序为例：
--wxml
<button open-type="getUserInfo" bindgetuserinfo="setPlatformProfile">获取用户信息</button>
--js
setPlatformProfile: (e) => {
    gio('setPlatformProfile', e.detail.userInfo);
 }
上传物品模型
参数名称
参数类型
是否必填
说明
eventId
string
是
事件标识符
eventLevelVariables
JSON Object
是，必填，如果没有可以填一个空对象 {}
事件级变量
item
JSON Object
是
物品模型参数
物品模型参数说明：
参数名称
参数类型
是否必填
说明
id
string
是
物品模型id
Key
string
是
物品模型唯一id标识
自定义事件API
参数名称
类型
是否必填
说明
eventId
string
是
事件标识符。
eventLevelVariables
JSON Object
否
事件变量。
// track API调用原型
gio('track', 'eventId');
gio('track', 'eventId', eventLevelVariables);
// track API调用示例
gio('track', 'order', {'price': 100.0 })
GDPR数据采集开关
注意这里和线上UBA WEB JS SDK有区别，UBA 中开关为 True 时停止采集。
GrowingIO 全面支持欧盟《一般数据保护条例》。
// 停止采集数据
gio('setConfig',{'dataCollect': false}); 全局配置, 可以放到send之后
// 采集数据 (默认)
gio('setConfig',{'dataCollect': true}); 
// 获取访问用户ID
​

以前

PHP SDK

下一个

H5内嵌页SDK(仅支持app内的H5)

最近更新 7 months ago

参数名称	类型	是否必填	说明
projectId	string	是	项目ID
dataSourceId	string	是	数据源ID
appId	string	是	微信应用ID
host	string	是	发送到服务端的主机名
scheme	string	否	api 请求协议 http/https
forceLogin	boolean	否	设置是否强制登录，默认值 false
getLocation	JSON Object	否	是否获取地理位置和坐标格式
options	JSON Object	否	系统变量配置

参数名称	参数类型	是否必填	说明
eventId	string	是	事件标识符
eventLevelVariables	JSON Object	是，必填，如果没有可以填一个空对象 {}	事件级变量
item	JSON Object	是	物品模型参数

小程序 SDK

下载小程序SDK

添加数据追踪代码

添加请求服务器域名

数据校验

配置系统变量

host

Scheme

forceLogin

getLocation

gtouchHost

常用API

简介

初始化参数API（Init）

设置登录用户 ID（setUserId）

清除登录用户 ID（clearUserId）

设置用户变量 （setUserAttributes）

设置平台用户信息

上传物品模型

自定义事件API

GDPR数据采集开关

设置用户变量（setUserAttributes）