在线服务接口

在线服务接口：高QPS，低延迟，适合大的并发量且实时的场景，开启此接口需提前配置Redis资源，如未配置资源直接进行调用，则调用失败。在线服务配置入口:

2.1 获取用户属性/标签信息

2.1.1 属性在线服务配置

点击“属性在线服务配置”进入该页面。在当前页面支持按照主体及业务系统筛选标签，需注意，可选择的业务系统必须是已经配置在在在线服务接口中的业务系统。

支持在列表页删除属性或者更新属性，即当上游属性更新后，需要手动更新配置的属性。

支持新增属性。支持选择主体及该主体下该操作用户有权限的属性，标签支持多选。
*注意：新增属性的数量与用户资源限制相关。

通过查询用户的基准id获取其标签

2.1.2 标签在线服务配置

点击“标签在线服务配置”按钮进入配置页面。在当前页面支持按照主体及业务系统筛选标签，需注意，可选择的业务系统必须是已经配置在在在线服务接口中的业务系统。

支持在列表页删除标签。

点击“新增标签”按钮进入配置页面，支持选择主体及该主体下的标签，标签支持多选。

*注意：新增标签的数量与用户资源限制相关。

2.1.3 接口调用

基本信息

请求参数

• Query 参数

• Header

• body

profile_request 里面的字段信息

响应参数

NOTE:

1. 如果属性/标签的值为空，则返回的结果里面不包含此属性/标签的信息

响应样例

{
    "properties":{
        "1": "96", //1 代表的是属性id
        "2":"男"
        
    },
    "tags":{
        "23":"dwe",
        "45":"上海"
    }
    "code":0,
    "msg":"success"
}

• 失败

{ 
  "data": "ERROR",
  "code": -1032
}

错误码

2.2 判断用户所在的分群「是否在指定分群中」

2.2.1 分群在线服务配置

点击“分群在线服务配置”进入该页面。在当前页面支持按照主体及业务系统筛选标签，需注意，可选择的业务系统必须是已经配置在在在线服务接口中的业务系统。

列表页展示分群名称，分群ID，以及导入状态，支持手动删除及更新。

点击列表右上角“新增分群”，可选择分群进行导入。

*注意：此处可选择的分群为分群列表中的所有分群，已导入的分群不可再进行选择，且可增加的分群数量，不超过系统支持的分群数量总和。

2.2.2 接口调用

基本信息

请求参数

• Query 参数

• Header

响应参数

响应样例

{
    "data": [
        "1",
        "11"
    ]
    "code": 0
}

2.3 idmapping高qps接口

2.3.1 在线服务配置

在「OpenApi管理」功能模块中点击「在线服务接口」，在刷新后的页面右边点击「IDmapping在线服务配置」进入 「IDMapping在线服务配置」界面。

IDMapping - ID 在线服务

作用：将ID与OneID（又称基准ID BaseID）导入至高速查询引擎Tendis中，以保证高速查询能力和性能
操作：所有操作在 「IdMapping在线服务配置」页面内操作完成

1. 点击【新增导入ID】

2. 选择需要导入的ID对应的主体及ID类型，支持多个ID同时导入

*注：如已导入则无需重复导入

3. 保存后返回列表，可以将ID导入逻辑手工更新，常规会每天定时更新导入

IDMapping -主体转换关系

作用：将A主体和B主体的转换关系导入至高速查询引擎Tendis中，以保证高速查询能力和性能

支持A主体的OneID到B主体的OneID直接转换，也支持关系中A主体的非OneID的ID类型转换为B主体的非OneID的ID类型，具体可以转的ID可以参考关系的配置

操作：

1. 点击【新增导入主体转换关系】

2. 选择需要转换的主体，然后根据主体拉出两者已经配置的关系

*注：导入转换关系时，会将主体中涉及到的ID类型也导入至告诉查询引擎Tendis中

将添加好的「IdMapping在线服务配置」绑定到「App管理」中的「对应服务账号」。

2.3.2 接口调用

基本信息

请求参数

• Query 参数

• Header

• Body

idmapping映射说明

请求样例

curl -v -S --location --request \
POST 'https://XXXXXX/openapi/online/v1/mapping/online/sync' \
--header 'X-BDPP-Id: XXXXXXXX' \
--header 'Authorization:Bearer XXX' \
--header 'Content-Type: application/json'  \
--data ':{
      "id":"12345678909",
      "source_entity_name":"phoneid",
      "target_entity_name":"baseid"
      }'

响应参数

响应样例

• 成功

{
    "data": "123",
    "code": 0,
    "msg": "success"
}

• 失败

{
    "data": "",
    "code": -1203,
    "msg": "xxxx"
}

2.4 判断用户是否命中实时规则

2.4.1 功能

提供高qps的在线服务接口：判断某个用户是否被实时更新的数据组成的规则命中

Tip: 目前CDP提供的分群及其相关接口相关数据为离线更新，本接口是独立于分群功能、对单点实时场景在线查询的补充。

2.4.2 操作说明

Part 1 前置依赖

将需要用于规则引擎服务调用的所用标签、属性导入在线服务（tendis）

步骤	示意图
进入控制台、标签/属性在线服务配置页面
2. 将规则需要使用的标签导入在线服务

Part2 规则配置

在区别于分群的页面，单独配置实时变更数据用于在线服务判断的规则

2.4.3 接口调用

基本信息

请求参数

• Query 参数

• Header

• Body参数(json格式)

响应参数

响应样例

{
    "code": 0,
    "message": "success",
    "rule_ids":[1,2,3,4]
}

• 失败

{
    "code": -1203,
    "message": "xxxx",
    "rule_ids":[]
}

2.5 查询用户是否命中分群v2版本

与2.2相比，支持传入用户id的idType类型与分群类型不一致但必须是在相同主体下，前提是开启idmapping导入，支持的场景见如下

基本信息

请求参数

• Query 参数

• Header

• 请求Body参数(json格式)

seg_data结构体的定义

响应参数

2.6 查询用户的行为（数据源和事件）和明细

基本信息

请求参数

• Query 参数

• Header

• Body参数(json格式)

2.6.1 data_req 结构体定义

2.6.2 event 结构体定义

2.6.3 detail 结构体定义

请求参数示例

{
"tenant_code":"1",
"ignore_illegal":true, //是否忽略未导入到在线服务的数据
"data_req":{
"id":"1",
"id_type":"uid",
 "event":[{
  "datasource_id":1,
  "event_ids":[1,2,3],
  "start_time":"1683880304000",//时间戳，单位到毫秒
  "end_time":"1683880305000", //时间戳单位到毫秒
  "need_properties":false  //显示用户的属性值
 }],
 "detail":[{
  "datasource_id":1,
  "columnId":[12,434,54],
  "start_time":"1683880304000",//时间戳，单位到毫秒
  "end_time":"1683880305000"//时间戳,单位到毫秒
 }]
}

}

响应参数

2.6.4 data 结构体定义

2.6.5 eventResp 结构体定义

2.6.6 detailResp 结构体定义

2.7 获取所有在线可用的标签/属性/明细/行为事件 列表

对应查询如下前端页面展示的开启了在线导入且导入成功过的对应数据

基本信息

请求参数

• Query参数

• Header（按照网关要求，无特殊要求）

• Body（无）

响应参数：

返回示例：

{
    "data": {
        "items": [
            {
                "id": 2,
                "name": "autotest0131/autotest_guize01311730",
                "status": "succeed",
                "LatestSuccessDate": "2023-02-12" ,//最新可用的日期
                "dataSourceId":1
            }
        ],
        "page": 1,
        "pageSize": 20,
        "total": 1
    },
    "code": 0
}