You need to enable JavaScript to run this app.
导航
查询用户是否命中分群 - GetUserSegmentV2
最近更新时间:2025.02.14 15:25:10首次发布时间:2024.07.12 14:50:50

请求说明

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

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

用户idType类型

分群类型

是否支持

是否是同主体

说明

A

A

支持

A 表示是系统的中某个IdType,用户idType类型和分群类型 是相同的IdType

基准类型

非基准类型

支持

多个分群类型可以是不同的idType

非基准类型B

基准类型
或非基准类型B

支持

所有的分群只能是基准类型 或者与用户IdType 类型相同

非基准类型C

非基准类型D

不支持

C和D 指代不同的非基准类型

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

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

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

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

GetUserSegmentV2

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

ApiVersion

String

2023-06-20

固定值,版本号: 2023-06-20

segIds

String

1

逗号(半角符)分隔的分群ID,例如 1,2,3

Body

参数

类型

是否必选

示例值

描述

tenant_code

String

1

项目ID

seg_data

OnlineSegData

{}

请求

OnlineSegData

参数

类型

是否必选

示例值

描述

id

String

576465150349934594

用户id

id_type_code

String

baseid

用户的id类型,如baseid,uid,deviceid

segment_ids

Array

[1,2]

分群ids

ignore_illegal_data

Int

0

是否忽略不合法的数据,1代表忽略不合法数据,默认是0

返回参数

参数

类型

示例值

描述

code

String

0

状态码,0表示正常

msg

String

""

接口返回信息

data

Array

[1000147]

用户所在的分群ID

illegalData

Array

[-1]

非法分群

请求示例

{
    "tenant_code":"1",
    "seg_data":{
        "id":"576465150349934594",
        "segment_ids":[1000147],
        "id_type_code":"baseid",
        "ignore_illegal_data":0
    }
}

返回示例

{
  "code": "0",
  "message": "",
  "data": [
    "1000147"
  ],
  "illegalData": []
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。