You need to enable JavaScript to run this app.
导航
根据各种参数筛选获取人群包列表 - LegacyGetSegmentList
最近更新时间:2024.12.06 13:07:29首次发布时间:2024.07.10 15:50:08

请求说明

  • 请求方式:GET
  • 接口名称:LegacyGetSegmentList
  • 请求地址:https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

LegacyGetSegmentList

固定值,对应“请求说明”中的“接口名称”

ApiVersion

String

2023-02-10

固定值,版本号:2023-02-10

tenantId

Int

1

项目ID,参考附录-主体ID获取方式

current

int

1

当前页,默认1

pageSize

int

20

分页大小,默认20

keyword

String

分群关键字

创建者和分群名称模糊检索关键字。

isSelfSee

Bool

false

筛选是否只看我自己创建的

isOnlySourceReady

Bool

false

筛选是否数据就绪的

idType

String

baseid

筛选目标实体code

segTypes

String

Conditional

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

  • Conditional,规则分群
  • Uploaded, 上传分群
  • ABI,ABI分群
  • Lookalike,Lookalike分群(旧版)
  • SubjectTrans,主体转换分群
  • FeatureRecommendation,标签推荐导出分群
  • InsightExport,旧版洞察导出分群
  • InsightExportV2,新版洞察导出分群
  • Finder,Finder分群
  • PrivateLookalike,私域lookalike分群
  • Model, 私域模型分群

其他类型

  • PublicConditional,其他规则分群
  • PublicModelResult,其他模型分群
  • PublicLookalike,其他lookalike分群
  • PrivateTransToPublic,私转公分群

sourcePlatform

String

open_platform

来源平台,注意全大写,创建时可以指定

isAbaseAvailable

Bool

false

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

isAbaseEnabled

Bool

false

筛选开启了在线服务的分群

domainType

String

  • Public

公私域类型:

  • Private,私域,默认
  • Public,其他

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

viewer

String

"admin"

返回的分群列表是基于这个viewer权限的,不填写的话,是取用接口调用人权限下的分群

segIds

String

"1,2"

分群ID列表,多个值使用英文逗号分隔。1.21版本开始支持

Body


返回参数

data字段内容

参数

类型

示例值

描述

total

int

1

总数

pageSize

int

20

每页大小

page

int

1

页码

items

Array

结果

  • items 数组元素字段内容

参数

类型

示例值

描述

id

Int

1000069

分群包id

name

String

autotest_guize09192105-子母包8-B

名称

desc

String

分群描述

描述

idType

String

baseid

ID类型code

idTypeName

String

基准

ID类型

subjectId

Int

1

所属主体ID,参考附录-主体ID获取方式

count

Int

3217

最新分群任务运行后分群数量

createdBy

String

admin

创建人

path

String

/user/dp/cdp/segment_v2/target/2023-10-10/1000069/2932/9c62c1e5-de69-4b88-8964-99cf98db6cb4.gz

分群离线文件地址

exportAt

String

2023-10-10 00:01:11

分群最新文件导出时间,必有,若分群任务未就绪,默认为创建时间

exportStrategy

String

Daily

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

segStatus

String

Normal

计算状态,Normal成功、Exporting导入中、Invalid失败,必有

sourceResultReady

Boolean

true

分群是否就绪,segStatus==Normal,必有

cantPublicType

String

废弃

hasPublicBefore

Boolean

true

废弃

createdAt

String

2023-09-19 21:35:58

分群创建时间,格式 yyyy-MM-dd HH:mm:ss

childSegments

Array

null

子包信息,结构同Response data字段

version

Int

1

分群在clickhouse中的最新版本号

onlineSegStatus

Boolean

false

在线服务是否可用(开启配置,且导入完成)

pdate

String

2023-02-10

日期,格式 yyyy-MM-dd

请求示例

{
    "tenantId": 1
}

返回示例

{
    "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": [
                                            "本科"
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                }
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。