资产输出接口--客户数据平台（私有化）-火山引擎

文档中心

导航

资产输出接口

最近更新时间：2024.07.11 17:32:54首次发布时间：2023.10.08 10:43:29

1. 获取分群明细任务列表

基本信息

生效版本	1.18
功能描述	获取分群明细任务列表
接口模块	FileDateAssetApi
接口名称	GetFileDateAssetTaskList
请求类型	GET

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	环境对应租户ID
Authorization	String	是	见《开发前必读》3.3中提到的签名

Query参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10

Body（无）

响应参数

名称	数据类型	描述
taskId	Int	任务ID
taskName	String	任务名称
taskStatus	String	任务状态
filePath	String	路径，仅状态为success的时候有路径输出

返回示例：

{
  "code": 0,
  "msg": "string",
  "data": [
        {
            "taskId": 12,
            "taskName": "API_hdfs",
            "taskStatus": "SUCCESS",
            "filePath": "2023-03-09" //仅状态为success的时候有路径输出
        },
        {
            "taskId": 12,
            "taskName": "API_hdfs",
            "taskStatus": "RUNNING",
            "filePath": null 
        }
  ]
}

2. 下载分群明细

基本信息

生效版本	1.18
功能描述	下载分群明细
接口模块	FileDateAssetApi
接口名称	DownloadFileDateAsset
请求类型	GET

请求参数

Header

名称	数据类型	是否必选	描述
Authorization	String	是	见《开发前必读》3.3中提到的签名
X-Tenant	String	是	环境对应租户ID

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-06-20
taskId	Integer	是	任务id
filePath	String	是	文件路径

Body（无）

返回示例：

成功后，会是文件数据流

3. 创建第三方输出任务

基本信息

生效版本	1.20（仅私部cdp）
功能描述	创建资产输出任务到oss存储
接口模块	AssetApi
接口名称	AssetTaskCreate
请求类型	POST

功能描述	火山鉴权版本
请求路径	/open_platform/openapi?ApiVersion=2023-08-08&ApiAction=AssetTaskCreate
请求类型	POST
ApiAction	AssetTaskCreate
ApiVersion	2023-08-08

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	环境对应租户ID

请求示例
请求体：
outputType：目前只支持ThirdChannel
dataAssetConf：输出资产配置
dataAssetType：只支持SegDetail
outputConf: 输出终端配置,没有明确字段要求，建议先自己手动建一个任务，然后参照任务作为模板来填写下面的参数
channel: oss存储类型
account：第三方渠道账号id
folder：输出文件夹的名字
withTimeStamp：输出文件夹是否附带时间后缀，建议为true
columnSchema: 这个来自接口的请求，值得注意的是colName会作为输出文件的列名，我们的系统不允许使用中文做列名
separator: 文件分隔符
fileFormat：输出文件格式

{
  "taskName": "1692786654588",
  "channelId": 56,
  "subjectId": 1, //主体id（IDMapping中基准baseid后缀）
  "outputType": "ThirdChannel",  // 第三方通道，这个值目前是固定的
  "dataAssetConf": {
    "dataAssetType": "SegDetail",   // 第三方通道，这个值目前是固定的
    "dataAssetDetail": {
      "showIdm":true //用来控制经过idm后的分群的输出值
    }
  },
  "outputConf": {
    "folder": "输出文件夹",
    "withTimeStamp": true,
    "columnSchema": [
      {
        "assetId": "1",
        "assetName": "baseid",
        "assetType": "BASEID",
        "assetTypeName": "基准Id",
        "colName": "base_id",
        "colType": "string",
        "disabled": false,
        "dependable": false,
        "dependEditEnable": false
      },
      {
        "assetId": "1000537",
        "assetName": "上架的分群被下架了会怎么样",
        "assetType": "SEGMENT",
        "assetTypeName": "分群",
        "colName": "上架的分群被下架了会怎么样",
        "colType": "string",
        "disabled": false,
        "dependable": false,
        "dependEditEnable": false
      },
      {
        "assetId": "1000538",
        "assetName": "基准",
        "assetType": "SEGMENT",
        "assetTypeName": "分群",
        "colName": "基准",
        "colType": "string",
        "disabled": false,
        "dependable": false,
        "dependEditEnable": false
      },
      {
        "assetName": "c_date",
        "assetType": "CDATE",
        "assetTypeName": "CDP业务日期",
        "colName": "c_date",
        "colType": "date",
        "disabled": false,
        "dependable": false,
        "dependEditEnable": false
      }
    ],
    "channel": "volcEngineOss", // 火山"volcEngineOss", 阿里"aliOss", 腾讯"tencentOss" 
    "separator": ",", //枚举值 "," ";" "\\t" "|" 
    "fileFormat": "ORC", //枚举值 CSV、ORC、PARQUET 
    "account": "3" // 对应对象存储的id 。 输出到第三方渠道，一般是obs对象存储。可以在项目中心->渠道管理->第三方渠道，在渠道列表中可以看到渠道「渠道ID」。
  }
}

响应示例

{"data":{},"code":0}

4. 输出任务结构预览

基本信息

生效版本	1.20（仅私部cdp）
功能描述	创建资产输出任务结构预览，配合4.4.3使用
接口模块	AssetApi
接口名称	AssetTablePreview
请求类型	POST

功能描述	火山鉴权版本
请求路径	/open_platform/openapi?ApiVersion=2023-08-08&ApiAction=AssetTablePreview
请求类型	POST
ApiAction	AssetTablePreview
ApiVersion	2023-08-08

请求参数

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	环境对应租户ID

请求体：

{
  "subjectId": 1,  // 主体ID
  "segIds": [      // 分群ID
    1000538,
    1000537
  ],
  "idTypeId": [123],  // 导出的ID在ID图谱中的ID，可以查看浏览器控制台 queryList 接口能返回的ID图谱列表，找到自己想要导出的ID的id
  "tagIds":[1232,123], 
  "properties":[
      {
          "datasourceId":123,  // 数据源ID ，可以在数据档案管理界面，点击数据源查看详情，URL中最后面可以找到数据源ID。
          "propertyId":123     // 属性ID ，在数据档案管理->主体属性那里，浏览器控制台找到接口 /profile_platform/api/v2/cdpMeta/dataSourceProperty/property ，在返回的response中找到想要导出的属性，属性ID 是 propertyId 的值。
      }
  ]   
}

返回体：

{
  "data": [
    {
      "assetId": "1",                   //资产id
      "assetName": "baseid",            //资产名称
      "assetType": "BASEID",            //资产类型 
      "assetTypeName": "基准Id",        //资产类型中文名称
      "colName": "base_id",            //输出列名 
      "colType": "string",             //输出类型
      "disabled": false,             
      "dependable": false,             //是否依赖
      "dependEditEnable": false
    },
    {
      "assetId": "1000537",
      "assetName": "上架的分群被下架了会怎么样",
      "assetType": "SEGMENT",
      "assetTypeName": "分群",
      "colName": "上架的分群被下架了会怎么样",
      "colType": "string",
      "disabled": false,
      "dependable": false,
      "dependEditEnable": false
    },
    {
      "assetId": "1000538",
      "assetName": "基准",
      "assetType": "SEGMENT",
      "assetTypeName": "分群",
      "colName": "基准",
      "colType": "string",
      "disabled": false,
      "dependable": false,
      "dependEditEnable": false
    },
    {
      "assetId": null,
      "assetName": "c_date",
      "assetType": "CDATE",
      "assetTypeName": "CDP业务日期",
      "colName": "c_date",
      "colType": "date",
      "disabled": false,
      "dependable": false,
      "dependEditEnable": false
    }
  ],
  "code": 0
}