You need to enable JavaScript to run this app.
导航
生成导出人群 - genExportSqlSeg
最近更新时间:2024.12.06 13:07:28首次发布时间:2024.07.10 15:50:04

请求说明

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

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

X-Tenant

String

1

项目ID

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

genExportSqlSeg

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

ApiVersion

String

2024-05-22

固定值,版本号: 2024-05-22

analysisModuleObjId

Int

指标id

Body

参数

类型

是否必选

示例值

描述

name

String

人群包名称

desc

String

人群包描述

isHidden

Bool

是否隐藏

sourceModel

String

来源模块

sourcePlatform

String

来源平台

taskConf

Object

任务配置

condition

Object

条件

groupIds

Array

授权分组

grantSubjects

Array

授权对象

idType

Int

实体ID

period

Object

时间条件

segFilter

Object

人群要素

authUser

String

行权限用户,可以不传入

baseDimension

Object

基础维度

hashMethod

String

哈希方法

返回参数

参数

类型

示例值

描述

msg

String

接口返回信息

code

Number

状态码,0表示正常

data

Onject

接口返回数据体

traceId

String

跟踪id

data数组元素字段内容

参数

类型

示例值

描述

id

Int

人群id

desc

String

人群描述

name

String

人群名称

count

Int

人群数量

idType

Object

人群id类型

taskConf

Object

任务配置

condition

Object

人群条件

createdBy

String

创建人

updatedBy

String

最近更新人

createTime

String

创建时间

updateTime

String

最近更新时间

segType

String

人群类型

sourcePlatform

String

来源平台

sourceModule

String

来源模块

deletedFlag

Int

删除标识

isHidden

Bool

是否隐藏(GMP人群可能会隐藏)

readable

Bool

是否可读

childSegments

Array

子包

请求示例


返回示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "id": 1001990,
        "desc": null,
        "name": "openapi2024-12-03T15:31:48.373",
        "count": null,
        "idType": {
            "id": 1,
            "subjectId": 1,
            "code": "baseid",
            "name": "主体1的基准ID",
            "dataType": null,
            "entityType": "BaseId",
            "needEncrypt": null,
            "referFinderId": null,
            "baseId": true
        },
        "taskConf": {
            "skipCheck": null,
            "notAutoRun": null,
            "scheduleType": "Trigger",
            "scheduleTime": "00:00"
        },
        "condition": {
            "targetIdTypeId": 1,
            "majorIdValues": null,
            "encryptionMethod": null,
            "onlineServiceEnabled": false,
            "extraCondition": {
                "type": "SqlExport",
                "sql": "xxx",
                "showConf": null
            },
            "realtimeEnabled": null,
            "sampleLimit": null,
            "kvKeyFormat": null
        },
        "createdBy": "admin",
        "updatedBy": "admin",
        "createTime": "2024-12-03T23:31:49.000+08:00",
        "updateTime": "2024-12-03T23:31:49.000+08:00",
        "segType": "SqlExport",
        "sourcePlatform": "CDP",
        "sourceModule": null,
        "deletedFlag": 0,
        "isHidden": false,
        "readable": true,
        "childSegments": null
    }
}

错误码

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

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。