参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
X-Tenant | String | 是 | 1 | 项目ID |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ApiAction | String | 是 | genExportSqlSeg | 固定值,对应“请求说明”中的“接口名称” |
ApiVersion | String | 是 | 2024-05-22 | 固定值,版本号: 2024-05-22 |
analysisModuleObjId | Int | 是 | 指标id |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 | 参数非法,检查入参。 |