跳到主要内容

埋点管理 API

最近更新 2026/10/03

调用方法请参见Open API文档中的调用方法描述。

一、埋点方案​

建议先阅读TE使用手册了解埋点相关功能：埋点方案 和 数据验收

1. 查询埋点方案​

接口URL

/open/track-query?token=xxx&projectId=30

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId30Integer是项目ID

成功响应示例

{
    "data": {
        "commonEventProps": [{
            "name": "#device_id",
            "displayName": "设备id",
            "type": "string",
            "desc": ""
        }],
        "createTime": "2021-10-12 11:47:31",
        "eventProps": [
            {
                "createTime": "2021-10-12 11:47:30",
                "creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "desc": "",
                "displayName": "原因",
                "lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "lastUpdateTime": "2021-10-12 11:47:30",
                "name": "reason",
                "type": "string"
            }
        ],
        "events": [
            {
                "createTime": "2021-10-12 11:47:30",
                "creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "displayName": "",
                "eventDesc": "参加活动3",
                "eventName": "activity_attend",
                "eventTag": "111,aaa",
                "lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "lastUpdateTime": "2021-10-12 13:01:10",
                "props": [
                    "#city"
                ]
            }
        ],
        "projectId": 377,
        "userProps": [
            {
                "createTime": "2021-10-12 11:47:30",
                "creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "desc": "",
                "displayName": "余额",
                "lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "lastUpdateTime": "2021-10-12 11:47:30",
                "name": "accountbalance",
                "type": "number",
                "updateTypeName": ""
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
data-Object返回数据
data.commonEventProps-List公共事件属性信息
data.commonEventProps.name#device_idString属性名称
data.commonEventProps.displayName设备idString属性显示名
data.commonEventProps.typestringString类型
data.commonEventProps.descString描述
data.eventProps-List事件属性列表
data.eventProps.createTime2021-10-12 11:47:30Date创建时间
data.eventProps.creatorTG-38045d57-403c-424c-a6a6-b12f6a8943bdString创建人
data.eventProps.desc-String描述
data.eventProps.displayName原因String展示名称
data.eventProps.lastUpdateAuthTG-38045d57-403c-424c-a6a6-b12f6a8943bdString最后更新人
data.eventProps.lastUpdateTime2021-10-12 11:47:30Date最后更新时间
data.eventProps.namereasonString名称
data.eventProps.typestringString类型
data.events-List事件列表
data.events.createTime2021-10-12 11:47:30Date创建时间
data.events.creatorTG-38045d57-403c-424c-a6a6-b12f6a8943bdString创建人
data.events.displayName-String展示名称
data.events.eventDesc参加活动3String描述
data.events.eventNameactivity_attendString名称
data.events.eventTag111,aaaString标签
data.events.lastUpdateAuthTG-38045d57-403c-424c-a6a6-b12f6a8943bdString最后更新人
data.events.lastUpdateTime2021-10-12 13:01:10Date最后更新时间
data.events.props["#city"]List事件属性列表
data.projectId377Integer项目ID
data.userProps-String用户属性列表
data.userProps.createTime2021-10-12 11:47:30Date创建时间
data.userProps.creatorTG-38045d57-403c-424c-a6a6-b12f6a8943bdString创建人
data.userProps.desc-String描述
data.userProps.displayName余额String展示名称
data.userProps.lastUpdateAuthTG-38045d57-403c-424c-a6a6-b12f6a8943bdString最后更新人
data.userProps.lastUpdateTime2021-10-12 11:47:30Date最后更新时间
data.userProps.nameaccountbalanceString名称
data.userProps.typenumberString类型
data.userProps.updateTypeName-String
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名示例值参数类型参数描述
return_code-3004Integer返回码
return_message无效项目String返回信息

2. 导出埋点方案​

注意

下载excel版埋点方案，若该项目下没有埋点方案则报错

接口URL

/open/track-export?token=xxx&projectId=2

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId2Integer是项目ID

成功响应示例

导出文件格式为xlsx文件，包含“接入必知”，“#用户ID体系”，“#事件数据”，“#公共事件属性”，“#用户数据”，“数据类型设计原则”，“公共事件属性设置方式”，“多端接入注意点”，“多用户id体系的埋点建议”等sheet页数据，如下图：

错误响应示例

{
    "return_code": -1023,
    "return_message": "目标对象已不存在"
}
参数名示例值参数类型参数描述
return_code-1023Integer返回码
return_message目标对象已不存在String返回信息

3. 元数据导出埋点方案​

接口URL

/open/meta-export-track?token=xxx&projectId=2

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId2Integer是项目ID

成功响应示例

导出文件格式为xlsx文件，包含“接入必知”，“#用户ID体系”，“#事件数据”，“#公共事件属性”，“#用户数据”，“数据类型设计原则”，“公共事件属性设置方式”，“多端接入注意点”，“多用户id体系的埋点建议”等sheet页数据，如下图：

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名示例值参数类型参数描述
return_code-3004Integer返回码
return_message无效项目String返回信息

4. 埋点校验​

接口URL

/open/track-check?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数

{
    "projectId": 0, 
    "checkScope": {
       "startTime": "2021-01-01 10:00",
       "endTime": "2021-02-01 10:00",
       "checkDataTypes": ["event_data", "user_data"],
       "checkEvents": ["event1", "event2"],
       "eventFilter": {
       },
       "userFilter": {
         "tableType":"user",
         "columnName": "#os",
         "comparator": "equal",
         "ftv": [
           "ios"
         ]
       }
    },
    "resultScope": {
        "eventResults": ["unreported_event", "unplanned_event"],
        "userResults": ["unreported_user_prop", "unplanned_user_prop"]
    }
}
参数名示例值参数类型是否必填参数描述
checkScope-Object是校验范围
checkScope.checkDataTypesevent_dataList否校验数据类型，event_data事件数据，user_data用户数据，缺省值为两者都校验
checkScope.checkEventsstringList否事件校验范围，null则代表校验全事件
checkScope.endTimestringDate否校验时间段结束时间，缺省值为当前服务器时间
checkScope.eventFilter-List否事件筛选条件，只能筛选元数据事件属性(不能使用虚拟属性，用户标签)
checkScope.eventFilter.filterTypeSIMPLEString否

筛选器，

  • COMPOUND：复合类型
  • SIMPLE：简单类型
checkScope.eventFilter.filts-List否筛选值列表
checkScope.eventFilter.filts.filterTypeSIMPLEString否

筛选器，

  • COMPOUND：复合类型
  • SIMPLE：简单类型
checkScope.eventFilter.relationandString否筛选逻辑关系
checkScope.hasEmptyCheckfalseBoolean否是否将空字符串认定为空值
checkScope.propNullValueThreshold0Integer否属性空值率阈值
checkScope.startTimestringDate否校验时间段开始时间，缺省值为埋点方案上传时间
checkScope.userFilter-List否用户筛选条件，只能筛选元数据用户属性(不能使用虚拟属性，用户标签)

checkScope.userFilter.filterType

SIMPLEString否

筛选器，

  • COMPOUND：复合类型
  • SIMPLE：简单类型
checkScope.userFilter.filts-List否筛选值列表

checkScope.userFilter.filts.filterType

SIMPLEString否

筛选器，

  • COMPOUND：复合类型
  • SIMPLE：简单类型
checkScope.userFilter.relationandString否筛选逻辑关系
projectId0Integer是项目ID
resultScope-Object否选择结果范围（null则默认为全部选择）

resultScope.eventResults

["unreported_event"]

List

否

事件结果范围，可选值有

  • unreported_event：在埋点方案中，实际无上报的事件
  • unplanned_event：不在埋点方案中，实际有上报的事件
  • unplanned_event_prop：事件在埋点方案中，但事件属性不在埋点方案中的事件属性(预置属性不做校验）
  • missing_event_prop：在埋点方案中，但实际上报数据中缺失该属性
  • type_error_event_prop：事件属性类型与实际上报的属性类型不一致

resultScope.userResults

["missing_user_prop"]List否

用户结果范围，可选值有

  • unreported_user_prop：在埋点方案中，实际无上报的用户属性
  • unplanned_user_prop：不在埋点方案中，实际有上报的用户属性
  • type_error_user_prop：用户属性类型与实际上报的属性类型不一致

成功响应示例

{
    "data": "d611d456-e74d-47e3-b078-370b79a134af",
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
datad611d456-e74d-47e3-b078-370b79a134afObject校验结果查询key
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": -1008,
    "return_message": "projectId 不能为null"
}
参数名示例值参数类型参数描述
return_code-1008Integer返回码
return_messageprojectId 不能为nullString返回信息

5. 埋点校验结果查询​

接口URL

/open/track-check-result-query?token=xxx&key=d611d456-e74d-47e3-b078-370b79a134af

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
keyd611d456-e74d-47e3-b078-370b79a134afString是校验结果key

成功响应示例

{
    "return_code": 0,
    "return_message": "success",
    "data": {
        "projectId": 100,
        "checkTime": "2021-04-23 14:00:00",
        "checkScope": {},
        "checkResultType": "result_fail",
        "eventResults": [
            {
                "name": "event1",
                "resultType": "success",
                "details": [
                    {
                        "sample": [
                            ""
                        ]
                    }
                ],
                "propNullRates": [
                    {
                        "propName": "property1",
                        "displayName": "displayName1",
                        "hasRequired": true,
                        "propNullRate": 60
                    }
                ]
            },
            {
                "name": "event2",
                "displayName": "事件2",
                "resultType": "fail",
                "details": [
                    {
                        "propName": "property1",
                        "errorType": "type_error_prop",
                        "reportType": "string",
                        "planType": "number",
                        "sample": [
                            ""
                        ]
                    },
                    {
                        "propName": "property2",
                        "errorType": "unreported"
                    }
                ],
                "propNullRates": [
                    {
                        "propName": "property1",
                        "displayName": "displayName1",
                        "hasRequired": true,
                        "propNullRate": 60
                    }
                ]
            }
        ],
        "userResult": {
            "userSamples": [
                {}
            ],
            "userPropDetails": [
                {
                    "name": "property1",
                    "displayName": "用户属性1",
                    "resultType": "success",
                    "propNullRate": 10
                }
            ]
        }
    }
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息
data-Object校验结果查询key
data.projectId100Integer项目ID
data.checkTime2021-04-23 14:00:00Date校验时间
data.checkScope{}Object校验条件范围，接口/track-check请求体内容
data.checkResultTyperesult_failString

checkResultType：校验结果类型，有4种取值

  • result_success：校验成功（上报数据与埋点方案完全一致），可通过eventResults和userResult字段查看数据详情
  • result_fail：校验失败（上报数据与埋点方案有偏差），可通过eventResults和userResult字段查看数据详情
  • checking：校验中，请耐心等待，稍后查询
  • check_fail：计算失败，可通过checkError字段查看失败原因
data.eventResults-List事件数据校验结果
data.eventResults.nameevent1String事件名称
data.eventResults.resultTypesuccessString

事件校验结果类型，有4种类型，

  • success：检验成功
  • fail：校验失败
  • unreported：未上报
  • unplanned：计划外埋点
data.eventResults.details-List明细数据集合
data.eventResults.details.sample{}Object抽样示例，事件校验结果类型为未上报时没有抽样示例
data.eventResults.propNullRates-List属性空值率
data.eventResults.propNullRates.propNameproperty1String事件属性名
data.eventResults.propNullRates.displayNamedisplayName1String事件属性显示名
data.eventResults.propNullRates.hasRequiredtrueBoolean是否必需项
data.eventResults.propNullRates.propNullRate60Integer空值率
data.userResult-Object用户数据校验结果
data.userResult.userSamples{}List用户抽样示例10条
data.userResult.userPropDetails-List用户属性详情
data.userResult.userPropDetails.nameproperty1String用户属性名称
data.userResult.userPropDetails.displayName用户属性1String用户属性显示名
data.userResult.userPropDetails.resultTypesuccessString

用户属性校验结果类型，有4种类型

  • success：检验成功
  • fail：校验失败
  • unreported：未上报
  • unplanned_user_prop：计划外用户属性
data.userResult.userPropDetails.propNullRate10Integer属性空值率

错误响应示例

{
    "return_code": -1008,
    "return_message": "key not exist"
}
参数名示例值参数类型参数描述
return_code-1008Integer返回码
return_messagekey not existString返回信息

6. 保存埋点项excel​

注意

file参数上传excel模版

接口URL

/open/track-excel-save?token=xxx&projectId=0

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId0Integer是项目ID

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": 0,
    "return_message": "success",
    "data": ""
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息
dataObject返回数据

7. 新增埋点项​

注意

如果埋点方案中有请求的事件名或属性名，则报错返回

举例：新增已有事件的事件属性（新增register_name事件属性，同时绑定在已有事件register中）

接口URL

/open/track-insert?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数

{
    "projectId": 100,
    "events": [
        {
            "eventName": "register",
            "displayName": "注册事件",
            "hasAutoCollect": false,
            "dataOrigin": "ios",
            "eventDesc": "注册事件是指用户注册游戏触发的事件",
            "eventTag": "",
            "props": [
                "register_name"
            ]
        }
    ],
    "eventProps": [
        {
            "name": "register_name",
            "displayName": "注册名",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ],
    "userProps": [
        {
            "name": "user_name",
            "displayName": "用户名称",
            "type": "string",
            "updateType": "user_set",
            "desc": "",
            "propTag": ""
        }
    ],
    "commonEventProps": [
        {
            "name": "#device_id",
            "displayName": "设备id",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ]
}
参数名示例值参数类型是否必填参数描述
projectId100Integer是项目ID
events-List否事件信息
events.eventNameregisterString是事件名
events.displayName注册事件String是事件显示名
events.hasAutoCollectfalseBoolean否是否自动采集，默认值为否
events.dataOriginiosString否数据来源，数据来源为原始数据中的#lib字段值， 若无#lib，来源为其他
events.eventDesc注册事件是指用户注册游戏触发的事件String否事件说明
events.eventTagString否事件标签
events.propsregister_nameList否事件属性列表，事件属性名集合
eventProps-List否事件属性信息
eventProps.nameregister_nameString是事件属性名，必填项
eventProps.displayName注册名String是事件属性显示名
eventProps.typestringString是事件属性类型，有string, number, datetime, bool, array 五种类型
eventProps.hasRequiredtrueBoolean否默认值为true
eventProps.descString否事件属性说明
userProps-List否用户属性信息
userProps.nameuser_nameString是用户属性名
userProps.displayName用户名称String是用户属性显示名
userProps.typestringString是用户属性类型，有string, number, datetime, bool, array 五种类型
userProps.updateTypeuser_setString否用户属性更新方式，有user_setOnce, user_set, user_add三种类型
userProps.descString否用户属性说明
userProps.propTagString否用户属性标签
commonEventProps-List否公共事件属性信息
commonEventProps.name#device_idString是事件属性名
commonEventProps.displayName设备idString是事件属性显示名
commonEventProps.typestringString是事件属性类型，有string, number, datetime, bool, array五种类型
commonEventProps.hasRequiredtrueBoolean否默认值为true
commonEventProps.descString否事件属性说明

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名示例值参数类型参数描述
return_code-3004Integer返回码
return_message无效项目String返回信息

8. 保存埋点项​

注意

与新增接口的区别是此接口支持更新已存在的埋点属性

接口URL

/open/track-save?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数

{
    "projectId": 100,
    "events": [
        {
            "eventName": "register",
            "displayName": "注册事件",
            "hasAutoCollect": false,
            "dataOrigin": "ios",
            "eventDesc": "注册事件是指用户注册游戏触发的事件",
            "eventTag": "",
            "props": [
                "register_name"
            ]
        }
    ],
    "eventProps": [
        {
            "name": "register_name",
            "displayName": "注册名",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ],
    "userProps": [
        {
            "name": "user_name",
            "displayName": "用户名称",
            "type": "string",
            "updateType": "user_set",
            "desc": "",
            "propTag": ""
        }
    ],
    "commonEventProps": [
        {
            "name": "#device_id",
            "displayName": "设备id",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ]
}
参数名示例值参数类型是否必填参数描述
projectId100Integer是项目ID
events-List否事件信息
events.eventNameregisterString是事件名
events.displayName注册事件String是事件显示名
events.hasAutoCollectfalseBoolean否是否自动采集，默认值为否
events.dataOriginiosString否数据来源，数据来源为原始数据中的#lib字段值， 若无#lib，来源为其他
events.eventDesc注册事件是指用户注册游戏触发的事件String否事件说明
events.eventTagString否事件标签
events.propsregister_nameList否事件属性列表，事件属性名集合
eventProps-List否事件属性信息
eventProps.nameregister_nameString是事件属性名，必填项
eventProps.displayName注册名String是事件属性显示名
eventProps.typestringString是事件属性类型，有string, number, datetime, bool, array 五种类型
eventProps.hasRequiredtrueBoolean否默认值为true
eventProps.descString否事件属性说明
userProps-List否用户属性信息
userProps.nameuser_nameString是用户属性名
userProps.displayName用户名称String是用户属性显示名
userProps.typestringString是用户属性类型，有string, number, datetime, bool, array 五种类型
userProps.updateTypeuser_setString否用户属性更新方式，有user_setOnce, user_set, user_add三种类型
userProps.descString否用户属性说明
userProps.propTagString否用户属性标签
commonEventProps-List否公共事件属性信息
commonEventProps.name#device_idString是事件属性名
commonEventProps.displayName设备idString是事件属性显示名
commonEventProps.typestringString是事件属性类型，有string, number, datetime, bool, array五种类型
commonEventProps.hasRequiredtrueBoolean否默认值为true
commonEventProps.descString否事件属性说明

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名示例值参数类型参数描述
return_code-3004Integer返回码
return_message无效项目String返回信息

9. 编辑埋点项​

注意

需要填写其他不更新字段的准确值，即会整体进行数据更新

接口URL

/open/track-update?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数

{
    "projectId": 2,
    "targetName": "buy_shopitem",
    "event": {
        "eventName": "buy_shopitem",
        "displayName": "testName",
        "eventTag": "testTag",
        "eventDesc": "12",
        "props": [
            "#app_version"
        ]
    },
    "deleteProps": [
        {    
            "displayName": "运营商",
            "hasReported": true,
            "name": "#carrier",
            "type": "string"
        }
    ],
    "eventProps": [
        {
            "displayName": "app版本",
            "hasReported": true,
            "name": "#app_version",
            "type": "string"
        }
    ],
    "userProps": [
        {
            "displayName": "金币数量卡",
            "desc": "",
            "name": "coin_num",
            "type": "string",
            "updateType": "user_set",
            "propTag": "testPropTag"
        }
    ]
}
参数名示例值参数类型是否必填参数描述
projectId2Integer是项目ID
targetNamebuy_shopitemString是目标名
events-List-事件信息
events.eventNamebuy_shopitemString是事件名
events.displayNametestNameString是事件显示名
events.hasAutoCollectfalseBoolean否是否自动采集，默认值为否
events.dataOriginiosString否数据来源，数据来源为原始数据中的#lib字段值， 若无#lib，来源为其他
events.eventDesc12String否事件说明
events.eventTagtestTagString否事件标签
events.props["#app_version"]List否事件属性列表，事件属性名集合
eventProps-List-事件属性信息
eventProps.name#app_versionString是事件属性名，必填项
eventProps.displayNameapp版本String是事件属性显示名
eventProps.typestringString是事件属性类型，有string, number, datetime, bool, array 五种类型
eventProps.hasReportedtrueBoolean否默认值为true
eventProps.descString否事件属性说明
userProps-List-用户属性信息
userProps.namecoin_numString是用户属性名
userProps.displayName金币数量卡String是用户属性显示名
userProps.typestringString是用户属性类型，有string, number, datetime, bool, array 五种类型
userProps.updateTypeuser_setString否用户属性更新方式，有user_setOnce, user_set, user_add三种类型
userProps.descString否用户属性说明
userProps.propTagtestPropTagString否用户属性标签
commonEventProps-List-公共事件属性信息
commonEventProps.name#device_idString是事件属性名
commonEventProps.displayName设备idString是事件属性显示名
commonEventProps.typestringString是事件属性类型，有string, number, datetime, bool, array五种类型
commonEventProps.hasReportedtrueBoolean否默认值为true
commonEventProps.descString否事件属性说明
deleteProps-List否完全删除事件属性
deleteProps.name#carrierString是事件属性名
deleteProps.displayName运营商String是事件属性显示名
deleteProps.typestringString是事件属性类型，有string, number, datetime, bool, array五种类型
deleteProps.hasReportedtrueBoolean否默认值为true
deleteProps.descString否事件属性说明

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名示例值参数类型参数描述
return_code-3004Integer返回码
return_message无效项目String返回信息

10. 上传埋点方案​

注意

若该项目已存在方案则删除新建

接口URL

/open/track-upload?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数

{
    "projectId": 0, 
    "events": [
        {
            "eventName": "register", 
            "displayName": "注册事件", 
            "hasAutoCollect": false, 
            "dataOrigin": "ios", 
            "eventDesc": "注册事件是指用户注册游戏触发的事件", 
            "eventTag": "通用",
            "props": ["register_name"]
        }
    ], 
    "eventProps": [
         {
             "name": "register_name", 
             "displayName": "注册名", 
             "type": "string",
             "hasRequired": true,
             "desc": ""
         }
    ],
    "userProps": [
        {
            "name": "user_name", 
            "displayName": "用户名称", 
            "type": "string",
            "updateType": "user_set",
            "desc": "",
            "propTag": ""
        }
    ], 
    "commonEventProps": [
        {
            "name": "#device_id", 
            "displayName": "设备id", 
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ]
}
参数名示例值参数类型是否必填参数描述
projectId100Integer是项目Id
events-List否事件信息
events.eventNameregisterString是事件名
events.displayName注册事件String是事件显示名
events.hasAutoCollectfalseBoolean否是否自动采集，默认值为否
events.dataOriginiosString否数据来源，数据来源为原始数据中的#lib字段值， 若无#lib，来源为其他
events.eventDesc注册事件是指用户注册游戏触发的事件String否事件说明
events.eventTag通用String否事件标签
events.propsregister_nameString否事件属性列表，事件属性名集合
eventProps-List否事件属性信息
eventProps.nameregister_nameString是事件属性名，必填项
eventProps.displayName注册名String是事件属性显示名
eventProps.typestringString是事件属性类型，有string, number, datetime, bool, array 五种类型
eventProps.hasRequiredtrueBoolean否是否必传，默认值为true
eventProps.descString否事件属性说明
userProps-List否用户属性信息
userProps.nameuser_nameString是用户属性名
userProps.displayName用户名称String是用户属性显示名
userProps.typestringString是用户属性类型，有string, number, datetime, bool, array 五种类型
userProps.updateTypeuser_setString否用户属性更新方式，有user_setOnce, user_set, user_add三种类型
userProps.descString否用户属性说明
userProps.propTagString否用户属性标签
commonEventProps-List否公共事件属性信息
commonEventProps.name#device_idString是事件属性名
commonEventProps.displayName设备idString是事件属性显示名
commonEventProps.typestringString是事件属性类型，有string, number, datetime, bool, array五种类型
commonEventProps.hasRequiredtrueBoolean否是否必传，默认值为true
commonEventProps.descString否事件属性说明

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}

11. 删除埋点方案​

接口URL

/open/track-delete?token=xxx&projectId=100

请求方式

GET

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥
projectId100Integer是项目ID

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名示例值参数类型参数描述
return_code-3004Integer返回码
return_message无效项目String返回信息

12. 删除埋点项​

注意
  1. 删除事件时，会删除整个事件和该事件与事件属性绑定关系
  2. 删除事件属性时，会删除与所有事件绑定关系

接口URL

/open/track-delete-item?token=xxx

请求方式

POST

Content-Type

application/json

请求Query参数

参数名示例值参数类型是否必填参数描述
tokenxxxString是查询密钥

请求Body参数

{
    "projectId": 0,
    "events": [
        "login_in"
    ],
    "eventPropNames": [
        "register_name"
    ],
    "userPropNames": [
        "user_name"
    ],
    "commonEventPropNames": [
        "#device_id"
    ]
}
参数名示例值参数类型是否必填参数描述
projectId100Integer是项目ID
events["login_in"]List否事件名列表
eventPropNames["register_name"]List否事件属性名列表
userPropNames["user_name"]List否用户属性名列表
commonEventPropNames["#device_id"]List否公共事件属性名列表

成功响应示例

{
    "return_code": 0,
    "return_message": "success"
}
参数名示例值参数类型参数描述
return_code0Integer返回码
return_messagesuccessString返回信息

错误响应示例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
参数名示例值参数类型参数描述
return_code-3004Integer返回码
return_message无效项目String返回信息
这篇文档对你有帮助吗？
本页内容