> For the complete documentation index, see [llms.txt](https://growingio.gitbook.io/v3/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://growingio.gitbook.io/v3/developer-manual/sdkintegrated/overview.md).

# SDK 简介

## SDK支持范围

SDK 包括客户端SDK和服务端SDK。目前客户端SDK支持Android和iOS原生，Web JS，小程序，微信小游戏，内嵌页，以及众多第三方混合开发框架。服务端SDK支持Java 和 PHP。SDK支持移动端第三方框架列表如下：

* React Native
* Flutter
* Cordova
* Weex
* API Cloud
* AppCan

小程序支持微信小程序、阿里(支付宝)小程序、百度小程序、字节(抖音头条)小程序、QQ小程序、快手小程序、快应用。

微信小程序支持的开发框架如下：

* 原生 、 原生+第三方插件
* Taro 2.x 、Taro3(React)、Taro 3.x(vue2)、Taro 3.x(vue3)
* uni-app(vue2)、uni-app(vue3)
* WePY 1.x、WePY 2.x 以及第三方插件
* Chameleon
* Remax

阿里(支付宝)小程序支持的开发框架如下：

* 原生
* Taro 2.x 、Taro3(React)、Taro 3.x(vue2)、Taro 3.x(vue3)
* uni-app(vue2)、uni-app(vue3)
* Chameleon
* Remax

百度小程序支持的开发框架如下：

* 原生
* Taro 2.x 、Taro3(React)、Taro 3.x(vue2)、Taro 3.x(vue3)
* uni-app(vue2)、uni-app(vue3)
* Chameleon

字节(抖音头条)小程序支持的开发框架如下：

* 原生
* Taro 2.x 、Taro3(React)、Taro 3.x(vue2)、Taro 3.x(vue3)
* uni-app(vue2)、uni-app(vue3)
* Remax

QQ小程序支持的开发框架如下：

* 原生
* Taro 2.x 、Taro3(React)、Taro 3.x(vue2)、Taro 3.x(vue3)

**各SDK支持的事件类型如下**：

<table><thead><tr><th width="150">SDK</th><th width="150">访问</th><th width="150">页面浏览</th><th width="150">元素点击</th><th width="150">输入框改变内容</th><th width="150">表单提交</th><th width="150">自定义埋点</th><th width="150">页面级变量</th><th width="150">转化变量</th><th width="150">访问用户变量</th><th width="150">登录用户变量</th><th width="150">激活</th><th>应用关闭</th></tr></thead><tbody><tr><td>Android无埋点</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td></tr><tr><td>Android埋点</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td></tr><tr><td>iOS无埋点</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td></tr><tr><td>iOS埋点</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td></tr><tr><td>Web JS</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>小程序</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>✅</td></tr><tr><td>微信小游戏</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>Hybrid JS</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>小程序和公众号H5内嵌页</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>React Native 无埋点</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>React Native 埋点</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>Flutter</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>Cordova</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>Weex</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>API Cloud</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>AppCan</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>✅</td><td>✅</td><td>✅</td><td>-</td><td>-</td></tr><tr><td>Java</td><td>-</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>-</td><td>-</td></tr><tr><td>PHP</td><td>-</td><td>-</td><td>-</td><td>-</td><td>-</td><td>✅</td><td>-</td><td>-</td><td>-</td><td>-</td><td>-</td><td>-</td></tr></tbody></table>

{% hint style="info" %}
关于事件类型说明请查看[**事件模型**](https://docs.growingio.com/v3/introduction/datamodel/eventmodel/)

SDK未支持的服务端开发语言，GrowingIO 提供有 [OPEN API](https://docs.growingio.com/v3/developer-manual/api-reference/)
{% endhint %}

## SDK 工作方式

### JS SDK

GrowingIO Web JS SDK 是运行于网页的一段 Javascript 代码，基于无埋点技术采集网站数据，同时 GrowingIO Web JS SDK 也提供丰富的接口以支持埋点。采集到的数据将被传输并存储在 GrowingIO 的云端服务器上。GrowingIO 通过使用这些数据来分析客户网站的用户的使用情况，生成网站使用报告，提供跟用户行为数据分析相关的服务。

GrowingIO Web JS SDK 会在网站用户加载网页后自动启动，并收集用户的行为数据，建议将 GrowingIO 提供的跟踪代码放在`<head> </head>`之间。JS SDK 采用异步方式加载，不会影响网站自身的加载数据。

目前 SDK 主要采集三类数据:

* **访问数据**:网站访客在何时何地访问了哪个网页，收集信息包括域名、页面路径、浏览器、操作系统、屏幕分辨率、访问来源、用户唯一标识 ID、访问唯一标识 ID、访问时间、页面标题等。如果客户集成时设置了自定义维度，也会一并收集。
* **行为数据**:用户在网站上的交互行为，比如点击链接、提交表单、修改选择，都会被自动采集。采集内容包括交互行为类型、交互元素的页面信息、交互元素的标记 ID、交互元素的超链接、交互元素的位置信息等。GrowingIO 不采集任何用户在文本框中输入的密码等个人隐私信息。
* **元素浏览数据**:当用户访问网站时，用户浏览的内容即页面出现的元素，会被自动采集，包括内容所在的页面信息、元素的标记 ID、文本内容、超链接、位置信息。

### 移动端 SDK

移动端SDK需要在应用打包时，被加载在您的应用当中。GrowingIO的「移动端SDK」会随着客户应用的启动而自动开始进行用户行为数据。当用户关闭应用时，SDK会随着客户应用的关闭而关闭，不会在后台做任何额外动作。

**时间延迟**

经过我们反复的测量，移动端SDK的数据发送仅仅会带来10ms以内的时间延迟，用户感知不到任何的差异。GrowingIO真正的做到了用户无感知的数据采集，不会对应用的用户体验带来任何降低。

**稳定性**

我们非常注重SDK的稳定性，每个版本的SDK我们都会进行大量的稳定性测试，以确保您的应用一如既往的稳定。从目前客户集成SDK的结果来看，应用的崩溃率没有因为集成而提高。

**移动端SDK采集的数据类型**

与「JS SDK」一样，移动端SDK主要采集三类数据：访问数据，内容数据，行为数据。并且，不采集应用文本框里的数据，也就不会主动记录普通用户填写的账户/电话/银行卡等隐私信息，在采集环节保证安全。

**移动端框架版本兼容**

| 框架           | SDK类别  | App适配的系统版本                       | 框架版本             |
| ------------ | ------ | -------------------------------- | ---------------- |
| 原生Android    | 无埋点、埋点 | <p>Android 4.2+</p><p>iOS 8+</p> | -                |
| 原生iOS        | 无埋点、埋点 | iOS 8+                           | -                |
| React Native | 无埋点、埋点 | <p>Android 4.2+</p><p>iOS 8+</p> | 0.46-0.56、0.59.9 |
| Flutter      | 埋点     | <p>Android 4.2+</p><p>iOS 8+</p> | -                |
| Cordova      | 埋点     | <p>Android 4.2+</p><p>iOS 8+</p> | 5.0.0            |
| Weex         | 埋点     | <p>Android 4.2+</p><p>iOS 8+</p> | 0.16.0           |
| API Cloud    | 埋点     | <p>Android 4.2+</p><p>iOS 8+</p> | -                |
| APP Can      | 埋点     | <p>Android 4.2+</p><p>iOS 8+</p> | -                |