You need to enable JavaScript to run this app.
导航
createConditionalSegment - 简化创建离线规则分群接口(接口下线中,不建议进行使用)
最近更新时间:2024.08.29 17:13:48首次发布时间:2024.07.10 15:50:12

请求说明

  • 请求方式:POST
  • 接口名称:createConditionalSegment
  • 请求地址: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

createConditionalSegment

对应“请求说明”中的“接口名称”

ApiVersion

String

2023-08-08

版本号:2023-08-08

tenantId

Int

1

项目ID

Body

参数

类型

是否必选

示例值

描述

name

String

测试创建简化分群名称1

分群名称,长度128

desc

String

“”

分群描述,长度255

targetIdTypeId

Integer

8

导出实体id

filter

Object

{
    "filters":
    [
        {
            "filters":
            [
                {
                    "tagId": 356,
                    "operator": "in",
                    "value":
                    [
                        "兴趣"
                    ]
                }
            ],
            "operator": "And"
        }
    ],
    "operator": "And"
}

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

{
    "filters":
    [
        {
            "filters":
            [
                {
                    "tagId": 356,
                    "operator": "in",
                    "value":
                    [
                        "兴趣"
                    ]
                }
            ],
            "operator": "And"
        }
    ],
    "operator": "And"
}

scheduleType

String

Daily

Once, Daily

scheduleTime

String

00:00

不填默认为00:00

sourcePlatform

String

365

来源平台: 365

返回参数

参数

类型

示例值

描述

code

Int

0

状态码:0 为成功。错误码见附录7.3

msg

String

成功

状态信息

data

String

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

成功或失败信息

请求示例

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

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。