# API 2.x ## API概览 ```javascript // 初始化参数 gio('init', projectId, options); gio('send') ​ // 修改系统变量API gio('config', options); ​ // 发送事件API gio('track', eventId); gio('track', eventId, eventLevelVariables); ​ // 发送页面级变量API gio('page.set', key, value); gio('page.set', pageLevelVariables); ​ // 发送转化变量API gio('evar.set', key, value); gio('evar.set', conversionVariables); ​ // 发送登录用户变量API gio('people.set', key, value); gio('people.set', customerVariables); ​ // 发送访问用户变量API gio('visitor.set', key, value); gio('visitor.set', visitorVariables); ​ // 设置登录用户ID gio('setUserId', userId); ​ // 清除登录用户ID gio('clearUserId'); ``` ## 接口定义 ### 1. 初始化（init） 初始化参数，用来设置项目ID和一些常用的配置项。 ```javascript //init API原型 gio('init', projectId, options); ``` | 参数名称 | 类型 | 是否必须 | 说明 | | --------- | ----------- | ---- | ------ | | projectId | string | 是 | 项目ID。 | | options | JSON Object | 否 | 系统变量配置 | **代码示例：** ```javascript //init API调用示例 //配置imp类型的数据关闭发送 gio('init', '1234567890', {'imp':false}); ``` ### 2. 设置登录用户ID（setUserId） 当用户登录之后调用 setUserId API ，设置登录用户 ID 。 {% hint style="success" %} 90% 以上的用户都会上传登录用户 ID，以便分析登录用户的数据情况。 {% endhint %} ```javascript //setUserId API原型 gio('setUserId', userId); ``` | 参数名称 | 类型 | 是否必须 | 说明 | | ------ | ------ | ---- | ---------- | | userId | string | 是 | 用户的登录用户ID。 | **代码示例：** ```javascript //setuserId API调用示例 gio('setUserId', '1234567890'); ``` ### 3. 清除登录用户ID（clearUserId） 当用户登出之后调用 clearUserId ，清除已经设置的登录用户 ID 。 **代码示例：** ```javascript //clearUserId API原型和调用示例 gio('clearUserId'); ``` ### 4. 设置登录用户级变量（people.set） 发送登录用户信息用于登录用户信息相关分析，在添加代码之前必须在打点管理界面上声明登录用户变量。 ```javascript // people.set API原型 gio('people.set', key, value); gio('people.set', customerVariables); ``` | 参数名称 | 类型 | 是否必须 | 说明 | | ----------------- | ----------- | ---- | ---------------- | | key | string | 否 | 登录用户变量的标识符。 | | value | string | 否 | 登录用户变量的值。 | | customerVariables | JSON Object | 否 | 包含登录用户变量的JSON对象。 | **代码示例：** ```javascript // people.set API调用示例一 gio('people.set', 'gender', 'male'); ``` ```javascript //people.set API调用示例二 gio('people.set', {'gender':'male', 'age':'25'}); ``` ### 5. 设置访问用户级变量（visitor.set） 发送访问用户信息用于访问用户信息相关分析，在添加代码之前必须在打点管理界面上声明访问用户变量。 ```javascript // visitor.set API原型 gio('visitor.set', key, value); gio('visitor.set', visitorVariables); ``` | 参数名称 | 类型 | 是否必须 | 说明 | | ---------------- | ----------- | ---- | ---------------- | | key | string | 否 | 访问用户变量的标识符。 | | value | string | 否 | 访问用户变量的值。 | | visitorVariables | JSON Object | 否 | 包含访问用户变量的JSON对象。 | **代码示例：** ```javascript // visitor.set API调用示例一 gio('visitor.set', 'gender', 'male'); ``` ```javascript // visitor.set API调用示例二 gio('visitor.set', {'gender':'male', 'age':'25'}); ``` ### 6. 设置页面级变量（page.set） 发送页面级别的维度信息，在添加代码之前必须在打点管理界面上声明页面级变量。 ```javascript // page.set API原型 gio('page.set', key, value); gio('page.set', pageLevelVariables); ``` | 参数名称 | 类型 | 是否必须 | 说明 | | ------------------ | ----------- | ---- | ------------------------ | | key | string | 否 | 页面级变量的标识符。 | | value | string | 否 | 页面级变量的值。 | | pageLevelVariables | JSON Object | 否 | 包含页面级变量的JSON对象，即页面级别的信息。 | **代码示例：** ```javascript // page.set API调用示例一 gio('page.set', {'pageName': 'Home Page', 'author': 'Zhang San'}); ``` ```javascript // page.set API调用示例二 gio('page.set', 'author', 'Zhang San'); ``` ### 7. 设置转化变量（evar.set） 发送一个转化信息用于高级归因分析，在添加代码之前必须在打点管理界面上声明转化变量。 ```javascript // evar.set API原型 gio('evar.set', key, value); gio('evar.set', conversionVariables); ``` | 参数名称 | 类型 | 是否必须 | 说明 | | ------------------- | ----------- | ---- | -------------- | | key | string | 否 | 转化变量的标识符。 | | value | strong | 否 | 转化变量的值。 | | conversionVariables | JSON Object | 否 | 包含转化变量的JSON对象。 | **代码示例：** ```javascript // evar.set API调用示例一 gio('evar.set', 'campaignId'，'1234567890'); ``` ```javascript // evar.set API调用示例二 gio('evar.set', {'campaignId': '1234567890', 'campaignOwner':'lisi'}); ``` ### 8. 设置自定义事件和事件级变量（track） 在添加所需要发送的事件代码之前，需要在打点管理用户界面配置事件以及事件级变量。 ```javascript // track API原型 gio('track', eventId, eventLevelVariables); ``` | 参数名称 | 类型 | 是否必须 | 说明 | | ------------------- | ----------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | eventId | string | 是 | 事件标识符 | | eventLevelVariables | JSON Object | 否 | 包含事件级变量的JSON对象，暨事件发生时所伴随的维度信息。限制：非空，长度限制小于等于100（eventLevelVariable.length()<=100）；eventLevelVariable内部不允许含有JSONObject或者JSONArray； key长度限制小于等于50，value长度限制小于等于200，值不能为空字符串，也就是“”。 | **代码示例：** ```javascript // track API调用示例一 gio('track', 'registerSuccess'); ``` ```javascript // track API调用示例二 gio('track', 'registerSuccess', {'gender':'male', 'age':21}); ``` ```javascript // track API调用示例三 gio('track', 'loanAmount', 800000, {'loanType':'houseMortgage','province':'Zhejiang'}); ``` ### 9. 手动发送页面浏览事件(sendPage) 在默认情况下，由于用户浏览网站的交互行为导致当前页面的 URL 产生变化时，GrowingIO 的 Web JS SDK 会发送一个 page 类型的请求。在一些特殊的情况下，例如用户在访问单页应用（Single Page Application）类型的网站时，用户的操作会导致业务上面理解的页面产生了变化，但是当前的 URL 可能并没有改变。 这时，可以调用GrowingIO提供的 sendPage 接口手动发送页面浏览事件。这个接口的调用将会发送出一条‘page’类型的数据，GIO 服务器在收到 page 类型的数据之后，页面浏览量这个预定义指标会加 1。 **代码示例：** ```javascript //sendPage API原型和调用示例 gio('sendPage'); // 在调用 window.gio('send') 之后调用 ``` ### 10. GDPR数据采集开关 * 全局配置, 可以放到send之后 * 关闭或开启全局数据采集 ```javascript // 停止采集数据 window.gio('config',{"dataCollect": true}); // 全局配置, 在调用 window.gio('send') 之前调用 // 采集数据 (默认) window.gio('config',{"dataCollect": false}); ``` ### 11. 获取访问用户ID（getVisitUserId） ```javascript gio('getVisitUserId'); // 在调用 window.gio('send') 之后调用 ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://growingio.gitbook.io/docs/developer-manual/sdkintegrated/web-js-sdk/web-sdk-api/websdk-apiv2.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.