You need to enable JavaScript to run this app.
导航

分群相关

最近更新时间2023.12.19 17:24:11

首次发布时间2023.10.08 10:43:10

1. 获取人群包列表

基本信息

生效版本1.15
功能描述根据各种参数筛选获取人群包列表
接口模块SegmentationApi
接口名称LegacyGetSegmentList
请求类型GET
权限校验有模块权限校验

请求参数

  • 路径
名称数据类型是否必选描述
tenantCodeString租户Code
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名
  • Query参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-02-10
currentint当前页,默认1
pageSizeint分页大小,默认20
keywordString创建者和分群名称模糊检索关键字。
isSelfSeebool筛选是否只看我自己创建的
isOnlySourceReadybool筛选是否数据就绪的
idTypeString筛选目标实体code

domainType

String

Private,私域,默认

备注:domainType和segTypes参数呈包含关系,前者包含后者才有效哦

segTypes

sourcePlatform

String

String

筛选分群类型,逗号分隔,支持多选枚举值:
私域类型

  • Conditional,规则分群

  • Uploaded, 上传分群

  • ABI,ABI分群

  • Lookalike,Lookalike分群(旧版)

  • SubjectTrans,主体转换分群

  • FeatureRecommendation,标签推荐导出分群

  • InsightExport,旧版洞察导出分群

  • InsightExportV2,新版洞察导出分群

  • Finder,Finder分群

  • PrivateLookalike,私域lookalike分群

  • Model, 私域模型分群

来源平台,注意全大写,创建时可以执行

isAbaseAvailablebool筛选在线服务可用的分群(开启在线服务且导入完成)
isAbaseEnabledbool筛选开启了在线服务的分群

viewer

String

查看人(仅伊利使用)
返回的分群列表是基于这个viewer权限的,不填写的话,是取用接口调用人权限下的分群

segIdsstring分群ID列表,逗号分隔,多选。1.21版本开始支持

请求样例

curl --location --request GET 'http://10.248.134.123:30527/profile_platform/api/v2/openapi/seg/tenants/3/segmentations' \
--header 'X-BDPP-Id: BDPPf9f19e18b6dce6c2536fd7073023ddf6' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBJZCI6IkJEUFBmOWYxOWUxOGI2ZGNlNmMyNTM2ZmQ3MDczMDIzZGRmNiIsImV4cGlyZXMiOjE2NjcyMDgxMDI4ODl9.m6ql06y03U7wpIDDla-CMD_RHNWTss9Tx5T5tXRJgQc'

响应参数

名称数据类型描述
idint分群包id
nameString名称
descString描述
idTypeStringID类型code
idTypeNameStringID类型
subjectIdint所属主体
countint最新分群任务运行后分群数量
createdByString创建人
pathString分群离线文件地址
exportAtString分群最新文件导出时间,必有,若分群任务未就绪,默认为创建时间

exportStrategy

String

更新方式,Once一次性,Trigger按需(可看作是一次性),Daily按天,必有

segStatusString计算状态,Normal成功、Exporting导入中、Invalid失败,必有
sourceResultReadyString分群是否就绪,segStatus==Normal,必有
createdAtString分群创建时间
onlineSegStatusBoolean在线服务是否可用(开启配置,且导入完成)

groupInf

Json

分组信息
groupId 分组id
groupName 分组名

childSegmentsJson子包信息,结构同Response
sourcePlatformString来源平台:CDP,ABI,Finder,GMP。1.21版本开始支持
sourceModuleString来源模块。1.21版本开始支持
updatedByString编辑人。1.21版本开始支持
updateTimeString编辑时间。1.21版本开始支持
detailJson分群详情。1.21版本开始支持

响应样例

  • 正确
{
    "code": 0,
    "msg": "成功",
    "data": {
        "total": 1,
        "pageSize": 20,
        "page": 1,
        "items": [
            {
                "id": 1000069, //分群ID,必有
                "name": "autotest_guize09192105-子母包8-B", //分群名称,必有
                "desc": "分群描述", //分群描述
                "idType": "baseid", //目标实体code,必有
                "idTypeName": "基准", //目标实体中文名,必有
                "subjectId": 1, //目标实体所属主体id,必有
                "count": 3127, //分群数量,非必有,分群任务未就绪时,为null
                "createdBy": "admin", //创建人,必有
                "path": "/user/dp/cdp/segment_v2/target/2023-10-10/1000069/2932/9c62c1e5-de69-4b88-8964-99cf98db6cb4.gz", //分群最新离线文件地址,私有化为HDFS,非必有,分群任务未就绪时,为null,实时分群不包含今日实时数据
                "exportAt": "2023-10-10 00:01:11", //若分群任务未就绪,默认为本次分群数据刷新时间
                "exportStrategy": "Daily", //分群更新方式,Once一次性,Trigger按需(可看作是一次性),Daily按天,必有
                "segType": "Conditional", //分群类型,枚举值同查询参数,必有
                "segStatus": "Normal", //计算状态,Normal成功、Exporting导入中、Invalid失败,必有
                "sourceResultReady": true, //分群是否就绪,segStatus==Normal,必有
                "createdAt": "2023-09-19 21:35:58", //分群创建时间
                "onlineSegStatus": false, //在线服务是否可用(开启配置,且导入完成)
                "childSegments": [
                    {
                        "id": 1000116, //分群ID,必有
                        "name": "autotest_guize09192105-子母包8-B_1", //分群名称,必有
                        "idType": "baseid", //目标实体code,必有
                        "idTypeName": "基准", //目标实体中文名,必有
                        "subjectId": 1, //目标实体所属主体id,必有
                        "count": 1, //分群数量,非必有,分群任务未就绪时,为null
                        "createdBy": "admin", //创建人,必有
                        "path": "/user/dp/cdp/segment_v2/target/2023-10-10/1000116/2975/5221dbcf-8253-42cf-962a-638d8ac25524.txt", //分群最新离线文件地址,私有化为HDFS,非必有,分群任务未就绪时,为null,实时分群不包含今日实时数据
                        "exportAt": "2023-10-10 00:03:38", //若分群任务未就绪,默认为本次分群数据刷新时间
                        "exportStrategy": "Daily", //分群更新方式,Once一次性,Trigger按需(可看作是一次性),Daily按天,必有
                        "segType": "ChildSeg", //分群类型,枚举值同查询参数,必有
                        "segStatus": "Normal", //计算状态,Normal成功、Exporting导入中、Invalid失败,必有
                        "sourceResultReady": true, //分群是否就绪,segStatus==Normal,必有
                        "createdAt": "2023-09-19 21:40:31", //分群创建时间
                        "onlineSegStatus": false, //在线服务是否可用(开启配置,且导入完成)
                        "childSegments": null,
                        "groupInf": [], //分组信息
                        "sourcePlatform": "CDP", // 来源平台:CDP,ABI,Finder,GMP
                        "sourceModule": null, // 来源模块
                        "updatedBy": "admin", // 编辑人
                        "updateTime": "2023-09-19 21:40:32", // 编辑时间
                        "detail": { // 分群详情
                            "type": "ChildSeg",
                            "parentId": 1000069,
                            "index": 0,
                            "splitMethod": {
                                "type": "CustomSplit",
                                "type": "CustomSplit",
                                "nums": [
                                    1,
                                    1
                                ]
                            },
                            "parentSegName": "autotest_guize09192105-子母包8-B"
                        }
                    },
                    {
                        "id": 1000117,
                        "name": "autotest_guize09192105-子母包8-B_2",
                        "idType": "baseid",
                        "idTypeName": "基准",
                        "subjectId": 1,
                        "count": 1,
                        "createdBy": "admin",
                        "path": "/user/dp/cdp/segment_v2/target/2023-10-10/1000117/2974/d535bcc4-8d84-4a04-9fab-5c1dcb9fb749.txt",
                        "exportAt": "2023-10-10 00:03:35",
                        "exportStrategy": "Daily",
                        "segType": "ChildSeg",
                        "segStatus": "Normal",
                        "sourceResultReady": true,
                        "createdAt": "2023-09-19 21:40:31",
                        "onlineSegStatus": false,
                        "childSegments": null,
                        "groupInf": [],
                        "sourcePlatform": "CDP",
                        "sourceModule": null,
                        "updatedBy": "admin",
                        "updateTime": "2023-09-19 21:40:32",
                        "detail": {
                            "type": "ChildSeg",
                            "parentId": 1000069,
                            "index": 1,
                            "splitMethod": {
                                "type": "CustomSplit",
                                "type": "CustomSplit",
                                "nums": [
                                    1,
                                    1
                                ]
                            },
                            "parentSegName": "autotest_guize09192105-子母包8-B"
                        }
                    }
                ], //子包信息,若没有子包,childSegments为null。结构同外层母包
                "groupInf": [
                    {
                        "groupId":1, //分组id
                        "groupName":"分组名" //分组名
                    }
                ], //分组信息
                "sourcePlatform": "CDP", // 来源平台:CDP,ABI,Finder,GMP
                "sourceModule": null, // 来源模块
                "updatedBy": "admin", // 编辑人
                "updateTime": "2023-09-19 21:40:36", // 编辑时间
                "detail": { // 分群详情
                    "type": "Conditional",
                    "filter": {
                        "operator": "And",
                        "filters": [
                            {
                                "operator": "And",
                                "filters": [
                                    {
                                        "dataSourceId": 26,
                                        "field": "edu",
                                        "columnId": 288,
                                        "operator": "in",
                                        "value": [
                                            "本科"
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                }
            }
        ]
    }
}
2. 查询单个人群包详细信息

基本信息

生效版本1.15
功能描述查询单个人群包详细信息
接口模块SegmentationApi
接口名称LegacyGetSegment
请求类型GET
权限校验有模块和资源权限校验

请求参数

  • Query参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-02-10
tenantIdString租户Code (请不要填写租户ID,获取方式详见附录)
segIdInt分群id
  • Header
名称数据类型是否必选描述

Authorization

String

见《开发前必读》3.3中提到的签名

响应参数

名称数据类型描述
idint分群包id
nameString名称
idTypeStringID类型code
idTypeNameStringID类型
detailJson仅当分群为规则分群时才有
typeString分群类型
filterJson圈选条件dsl
resultJson分群最新结果,必有
countint分群数量,非必有,任务未就绪,为null
pathString分群离线文件地址,非必有,任务未就绪,为null,实时分群不包含今日实时数据
targetPathString同path
exportAtString分群最新文件导出时间,必有,若分群任务未就绪,默认为创建时间
segStatusString分群状态,必有 (Normal : 分群数据运行成功 ;Invalid: 分群运行失败 ;Exporting: 分群导入中。)
segTypeString分群类型,必有
abaseEnabledBoolean分群是否开启了在线服务配置,非必有,购买了在线服务的客户才有这个字段

响应样例

  • 正确
{
  "data": {
    "id": 1729,//分群id,必有
    "name": "232333",//分群名称,必有
    "createdBy": "admin",//创建人,必有
    "idType": "phoneid",//目标实体code,必有
    "idTypeName": "手机号",//目标实体名称,必有
    "result": {//分群最新结果,必有
      "count": 10016,//分群数量,非必有,任务未就绪,为null
      "path": "/user/dp/user_profile/segmentations_new_path/tenant_1001/normal/1729/2021-05-13/2925/1620873933634_target.gz",//分群离线文件地址,非必有,任务未就绪,为null
      "targetPath": "/user/dp/user_profile/segmentations_new_path/tenant_1001/normal/1729/2021-05-13/2925/1620873933634_target.gz",//同path
      "exportAt": "2021-05-13 10:45:23",//分群最新文件导出时间,必有,若问群任务未就绪,默认为创建时间
      "segStatus": "Normal"//分群状态,必有
    },
    "segType": "Conditional",//分群类型,必有
    "abaseEnabled": true//分群是否开启了在线服务配置,非必有,购买了在线服务的客户才有这个字段
  },
  "code": 0
}
3. 下载人群包

基本信息

生效版本1.15
功能描述根据租户code和人群包id下载对应人群包数据
接口模块SegmentationApi
接口名称DownloadSegFile
请求类型GET
权限校验

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-02-10
tenantIdString租户Code (请不要填写租户ID,获取方式详见附录)
segIdInt分群id

formatType

String

文件格式,GZ, TXT, CSV 可选,默认为GZ

needEncryptbool是否需要AES加密,默认否(AES密钥在idmapping页面管理)
  • Header
名称数据类型是否必选描述

Authorization

String

见《开发前必读》3.3中提到的签名

响应参数

名称数据类型描述
codeInt状态码:0 为成功。错误码见附录3
msgString状态信息
dataFile人群包文件

响应样例

  • 成功

    {
        "msg": "string",
        "data": "File",
        "code": 0
    }
    
  • 失败

    { 
      "msg": "error info"
      "data": null,
      "code": -1
    }
    

下载权限检查:

  • 模块权限检查:需要有分群模块的下载权限,报错:NO_SEG_MODULE_AUTH,1010250000034

  • 下载的分群资源权限检查:需要有分群的可读权限,报错:SEG_PARAMETER_SEG_AUTH_ILLEGAL,1010250000014

  • 授权操作说明:

4. 上传人群包(仅支持私有化版本,暂不支持SaaS版本)

私有化版本上传人群包需要两个步骤:

  1. 上传人群包到hdfs

  2. 通过hdfs创建

相关接口:

4.1 上传hdfs

基本信息

生效版本1.15
功能描述上传对应的人群包文件到hdfs
接口模块SegmentationApi
接口名称UploadSegFile
请求类型POST

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-02-10
tenantIdString租户Code (请不要填写租户ID,获取方式详见附录)
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名
  • Body

对应的文件
响应参数

名称数据类型描述
uploadTaskIdint上传文件id,用于上传分群创建,必有
linesint文件中的行数,必有
previewResultArray前50条的预览结果,必有

响应样例

  • 成功

    {
        "data":{
            "uploadTaskId":1,//上传文件id,用于上传分群创建,必有
            "lines":1000000,//文件中的行数,必有
            "previewResult":["123","456"]//前50条的预览结果,必有
        },
        "code": 0
    }
    
  • 失败

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

4.2 人群包导入

基本信息

生效版本1.15
功能描述从hdfs导入成人群包
接口模块SegmentationApi
接口名称LegacyCreateUploadSegment
请求类型POST

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-02-10
tenantCodeString租户Code (请不要填写租户ID,获取方式详见附录)
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名
  • Body
名称数据类型是否必选描述
nameString分群名称
descriptionString分群描述
idTypeString目标实体code

detail

Object

{
    "uploadTaskId": 1//必填,文件上传id,由上传分群文件接口获取
}
abaseEnabledBoolean是否开启在线服务,默认否
sourcePlatformString来源平台

请求样例

{
    "name": "分群名称",
    "desc": "描述",
    "idType": "baseid",
    "detail": {
        "uploadTaskId": 1
    },
    "abaseEnabled": null,
    "sourcePlatform": null
}

响应参数

名称数据类型描述
idint分群包id
nameString名称
idTypeStringID类型code
idTypeNameStringID类型
detailJson仅当分群为规则分群时才有
typeString分群类型
filterJson圈选条件dsl
resultJson分群最新结果,必有
countint分群数量,非必有,任务未就绪,为null
pathString分群离线文件地址,非必有,任务未就绪,为null,实时分群不包含今日实时数据
targetPathString同path
exportAtString分群最新文件导出时间,必有,若分群任务未就绪,默认为创建时间
segStatusString分群状态,必有 (Normal : 分群数据运行成功 ;Invalid: 分群运行失败 ;Exporting: 分群导入中。)
segTypeString分群类型,必有
abaseEnabledBoolean分群是否开启了在线服务配置,非必有,购买了在线服务的客户才有这个字段

响应样例

  • 成功
{
  "data": {
    "id": 1729,//分群id,必有
    "name": "232333",//分群名称,必有
    "createdBy": "admin",//创建人,必有
    "idType": "phoneid",//目标实体code,必有
    "idTypeName": "手机号",//目标实体名称,必有
    "result": {//分群最新结果,必有
      "count": 10016,//分群数量,非必有,任务未就绪,为null
      "path": "/user/dp/user_profile/segmentations_new_path/tenant_1001/normal/1729/2021-05-13/2925/1620873933634_target.gz",//分群离线文件地址,非必有,任务未就绪,为null
      "targetPath": "/user/dp/user_profile/segmentations_new_path/tenant_1001/normal/1729/2021-05-13/2925/1620873933634_target.gz",//同path
      "exportAt": "2021-05-13 10:45:23",//分群最新文件导出时间,必有,若问群任务未就绪,默认为创建时间
      "segStatus": "Normal"//分群状态,必有
    },
    "segType": "Conditional",//分群类型,必有
    "abaseEnabled": true//分群是否开启了在线服务配置,非必有,购买了在线服务的客户才有这个字段
  },
  "code": 0
}
  • 失败
{ 
  "data": "ERROR",
  "code": -1
}
5. 单个人群在线服务开启/关闭

基本信息

生效版本1.18
功能描述开启/关闭某个人群的在线导入任务
接口模块SegmentationApi
接口名称segmentOnlineServiceEnable
请求类型PATCH

请求参数

  • Header
名称数据类型是否必选描述
X-TenantStringApp id
AuthorizationString见《开发前必读》3.3中提到的签名
  • Param
名称数据类型是否必选描述
tenantIdInt租户id
segIdInt人群包id
  • Body
名称数据类型是否必选描述
onlineServiceEnabledBool是否开启在线导入任务

Body样例:

{
    "onlineServiceEnabled": true
}

返回示例:

{
  "code": 0,
  "msg": "string",
  "data": "string"
}
6. 人工分群包相关(仅支持私有化版本,暂不支持SaaS版本)

注意:这个API有前置条件,需要打开人工分群开关才可使用。

私有化版本创建上传人群包需要两个步骤

  1. 上传人群包到hdfs

  2. 通过hdfs创建人群

6.1 上传文件至hdfs(&临时表)

基本信息

生效版本1.20
功能描述上传对应的人群包文件到hdfs
接口模块SegmentationApi
接口名称uploadSegFileToCh
请求类型POST

接口限制

  • 单个上传文件大小为1G,超出后接口报错

  • 上传为同步接口,上传完成后返回

  • 上传支持格式 CSV & TXT

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-08-08
tenantIdString租户Code (请不要填写租户ID,获取方式详见附录)
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名
  • Body

    对应的文件

文件格式
cvs, txt

  1. template_ID.csv
69885290838 
48288698133 
68352714147
  1. template_ID.txt
69885290838
48288698133
68352714147
  1. template_unionID.csv
69885290838,123
69885290838,123
69885290838,123
  1. template_unionID.txt
69885290838         123 
69885290838         123 
69885290838         123

响应参数

名称数据类型描述
uploadTaskIdint上传文件id,用于上传分群创建,必有
linesint文件中的行数,必有
previewResultArray前50条的预览结果,必有

响应样例

  • 成功
{
    "data":{
        "uploadTaskId":1,//上传文件id,用于上传分群创建,必有
        "lines":1000000,//文件中的行数,必有
        "previewResult":["123","456"]//前50条的预览结果,必有
    },
    "code": 0,
    "msg": "成功"
}
  • 失败
{ 
  "data": "ERROR",
  "code": 1010250099999, // 错误码
  "msg": "UNKNOWN_ERROR" // 错误信息
}

6.2 创建人群包导入

基本信息

生效版本1.20
功能描述从hdfs导入成人群包
接口模块SegmentationApi
接口名称legacyCreateManualSegment
请求类型POST

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-08-08
tenantCodeString租户Code (请不要填写租户ID,获取方式详见附录)
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名
  • Body
名称数据类型是否必选描述
nameString分群名称,长度128
descriptionString分群描述,长度255
sourceIdTypeString源实体code
targetIdTypeString目标实体code

detail

Object

{
    "uploadTaskId": 1,//文件上传id,由上传分群文件接口获取
    "updateMode": "ADD"//更新模式:ADD-追加,REMOVE-剔除,OVERWRITE-覆盖
}
sourcePlatformString来源平台

请求样例

{
    "name": "分群名称",
    "desc": "描述",
    "sourceIdType": "baseid",
    "targetIdType": "baseid",
    "detail": {
        "uploadTaskId": 1,
        "updateMode": "ADD"
    },
    "sourcePlatform": null
}

响应参数

名称数据类型描述
idint分群包id
nameString名称
idTypeStringID类型code
idTypeNameStringID类型
segTypeString分群类型 ManualRealtime
createdByString创建人
abaseEnabledBoolean分群是否开启了在线服务配置

groupInf

Json

分组信息
groupId int 分组id
groupName String 分组名

result

Json

分群结果
count int 分群数量
path String 分群离线文件地址
targetPath String 分群离线文件地址,同path
exportAt String 分群最新文件导出时间
segStatus String 分群最新文件导出状态,Exporting

响应样例

  • 成功
{
    "code": 0,
    "msg": "成功",
    "data": {
        "id": 1000152,
        "name": "分群名称",
        "createdBy": "admin",
        "idType": "baseid",
        "idTypeName": "基准",
        "result": {
            "count": null,
            "path": null,
            "targetPath": null,
            "exportAt": null,
            "segStatus": "Exporting"
        },
        "segType": "ManualRealtime",
        "abaseEnabled": false,
        "detail": null,
        "groupInf": []
    }
}
  • 失败
{ 
  "data": "ERROR",
  "code": 1010250099999, // 错误码
  "msg": "UNKNOWN_ERROR" // 错误信息
}

6.3 修改人工分群

基本信息

生效版本1.20
功能描述修改人工分群
接口模块SegmentationApi
接口名称legacyModifyManualSegment
请求类型PATCH

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-08-08
tenantCodeString租户Code (请不要填写租户ID,获取方式详见附录)
segIdInteger分群ID
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名
  • Body
名称数据类型是否必选描述
nameString分群名称,长度128
descriptionString分群描述,长度255
sourceIdTypeString源实体code
targetIdTypeString目标实体code

detail

Object

{
    "uploadTaskId": 1,//可选,文件上传id,由上传分群文件接口获取
    "segmentId": 1000140,//可选,导入分群id。uploadTaskId和segmentId都为空时,表示只修改基本信息。
    "updateMode": "ADD"//更新模式:ADD-追加,REMOVE-剔除,OVERWRITE-覆盖
}
sourcePlatformString来源平台

请求样例

{
    "name": "分群名称",
    "desc": "描述",
    "sourceIdType": "web_id",
    "targetIdType": "baseid",
    "detail": {
        "uploadTaskId": 1,
        "updateMode": "ADD"
    },
    "sourcePlatform": null
}

响应样例

  • 成功
{
    "code": 0,
    "msg": "SUCCESS",
    "data": "success"
}
  • 失败
{ 
  "data": "ERROR",
  "code": 1010250099999, // 错误码
  "msg": "UNKNOWN_ERROR" // 错误信息
}
7. 简化创建离线规则分群接口

基本信息

生效版本1.20
功能描述简化创建离线规则分群接口,包含:id 类型,规则dsl,更新频率,名称
接口模块SegmentationApi
请求名称createConditionalSegment
请求类型POST

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-08-08
tenantCodeString租户Code (请不要填写租户ID,获取方式详见附录)
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名
  • Body
名称数据类型是否必选描述
nameString分群名称,长度128
descString分群描述,长度255
targetIdTypeIdInteger导出实体id

filter

Object

规则dsl,请参阅DSL编写规则CDP圈选DSL编写规范

{
    "filters":
    [
        {
            "filters":
            [
                {
                    "tagId": 356,
                    "operator": "in",
                    "value":
                    [
                        "兴趣"
                    ]
                }
            ],
            "operator": "And"
        }
    ],
    "operator": "And"
}
scheduleTypeStringOnce, Daily
scheduleTimeString不填默认为00:00
sourcePlatformString来源平台: 365

请求样例

{
    "name": "测试创建简化分群名称1",
    "targetIdTypeId": 8,
    "filter":
    {
        "filters":
        [
            {
                "filters":
                [
                    {
                        "tagId": 356,
                        "operator": "in",
                        "value":
                        [
                            "兴趣"
                        ]
                    }
                ],
                "operator": "And"
            }
        ],
        "operator": "And"
    },
    "scheduleType": "Daily",
    "scheduleTime": "00:00",
    "sourcePlatform": "365"
}

响应样例

  • 成功
{
    "code": 0,
    "msg": "成功",
    "data":
    {
        "id": 1000177,
        "name": "测试创建简化分群名称1",
        "createdBy": "admin",
        "idType": "web_id",
        "idTypeName": "web_id",
        "result":
        {
            "count": null,
            "path": null,
            "targetPath": null,
            "exportAt": null,
            "segStatus": "Exporting"
        },
        "segType": "Conditional",
        "abaseEnabled": null,
        "detail":
        {
            "type": "Conditional",
            "filter":
            {
                "filters":
                [
                    {
                        "filters":
                        [
                            {
                                "tagId": 1,
                                "operator": "in",
                                "value":
                                [
                                    "全量"
                                ]
                            }
                        ],
                        "operator": "And"
                    }
                ],
                "operator": "And"
            }
        },
        "groupInf":
        []
    }
}
  • 失败
{ 
  "data": "ERROR",
  "code": -1
}
8. 简化编辑离线规则分群接口

基本信息

生效版本1.20
功能描述编辑离线规则分群接口,包含:id 类型,规则dsl,更新频率,名称
接口模块SegmentationApi
请求名称modifyConditionalSegment
请求类型PATCH

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-08-08
tenantCodeString租户Code (请不要填写租户ID,获取方式详见附录)
segIdInteger分群ID
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名
  • Body
名称数据类型是否必选描述
nameString分群名称,长度128
descString分群描述,长度255
targetIdTypeIdInteger导出实体id

filter

Object

规则dsl

{
    "filters":
    [
        {
            "filters":
            [
                {
                    "tagId": 356,
                    "operator": "in",
                    "value":
                    [
                        "兴趣"
                    ]
                }
            ],
            "operator": "And"
        }
    ],
    "operator": "And"
}
scheduleTypeStringOnce, Daily
scheduleTimeString不填默认为00:00
sourcePlatformString来源平台: 365

请求样例

{
    "name": "测试创建简化分群名称2",
    "targetIdTypeId": 8,
    "filter":
    {
        "filters":
        [
            {
                "filters":
                [
                    {
                        "tagId": 356,
                        "operator": "in",
                        "value":
                        [
                            "兴趣"
                        ]
                    }
                ],
                "operator": "And"
            }
        ],
        "operator": "And"
    },
    "scheduleType": "Daily",
    "scheduleTime": "00:00",
    "sourcePlatform": "365"
}

响应样例

  • 成功
{
    "code": 0,
    "msg": "SUCCESS",
    "data": "success"
}
9. 删除单个人群包

基本信息

生效版本1.20
功能描述根据各种参数筛选获取人群包列表
接口模块SegmentationApi
请求路径legacyDeleteSegment
请求类型DELETE
权限校验有模块和资源权限校验

请求参数

  • Query 参数
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-08-08
tenantCodeString租户Code (请不要填写租户ID,获取方式详见附录)
segIdInteger分群ID
  • Header
名称数据类型是否必选描述
AuthorizationString见《开发前必读》3.3中提到的签名

响应样例
成功

{
  "code": 0,
  "msg": "string",
  "data": "success"
}
10. 更新单个人群包

基本信息

生效版本1.19
功能描述根据租户code和人群包id更新对应人群包的数据
接口模块SegmentationApi
接口名称RefreshSeg
请求类型PUT
权限校验有模块权限校验

请求参数

  • Query
名称数据类型是否必选描述
ApiActionString对应“基本信息”中的“接口名称”
ApiVersionString版本号: 2023-06-20
tenantCodeString租户Code (请不要填写租户ID,获取方式详见附录)
segIdInt分群id
  • Header
名称数据类型是否必选描述
X-BDPP-IdStringApp id
AuthorizationString见《开发前必读》3.3中提到的签名

请求样例

curl --location --request GET 'http://10.248.134.123:30527/profile_platform/api/v2/openapi/seg/tenants/3/segment/1000313/refresh' \
--header 'X-BDPP-Id: BDPPf9f19e18b6dce6c2536fd7073023ddf6' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBJZCI6IkJEUFBmOWYxOWUxOGI2ZGNlNmMyNTM2ZmQ3MDczMDIzZGRmNiIsImV4cGlyZXMiOjE2NjcyMDgxMDI4ODl9.m6ql06y03U7wpIDDla-CMD_RHNWTss9Tx5T5tXRJgQc'

响应样例

{ 
  "data": "Success",
  "code": 0
}