任务接口

上传 ID 文件

有一些客情分析任务,需要上传一个座标列表、用户ID、IMEI、IDFA 或者 MAC 地址列表,在创建任务之前,需要先向系统上传这个列表文件。

URL

POST v1/custominsight/carapi/task_idupload

请求参数

key 必选 含义 解释
file_type Y 文件类型 [coor-list, user-list, 4s-shop]
file_name Y 文件名称

请求示例

说明:全大写的字符串为需要替换的字符串

curl  'http://XXX/v1/custominsight/api/task_idupload' \
-H 'Content-Type: multipart/form-data' \
-H 'X-Bce-Account: CLOUD_UID' \
-F "file_type=coor-list"  \
-F 'file=@FILE_NAME'

文件规范

如果 file_type 的值是 coor-list,它的文件小于20MB,lbs点个数少于100,它的格式必须是下面这种:

3 # 第一个字符代表 lbs 类型。2: 家;3: 公司; 4: 常访地; 下面每一行是圈人的莫卡托座标的 x,y,半径(单位:米,范围[50, 5000])
北京市-北京市 #省份-城市名,参见文档后附表
13720901.4423,5955246.29112,500
11863671.4196,3391628.72711,500
12720026.5214,3573654.1187,500
12698898.1787,4196728.01751,500
14193642.3151,4409318.8246,500
13025056.6708,4367359.23119,500

第一行,使用一个数字代表 lbs 类型,取值如下:

  • 2: 家
  • 3: 公司
  • 4: 常访地

从第二行开始,每一行是一个莫卡托座标的 x,y,半径(单位: 米)

如果 file_type 的值是 user-list,文件行数必须大于300,小于100万,且文件小于20MB,它的格式必须是下面这种:

4
000145081194840D649C1CF4291B818C
00019A711CAFB9E0A3B79EB66CBC8D2D
00019EAC5F91E9A0C1696A5165B40085
0001C91560448826308B5EA4B089B82E
000208877605309EB859FE80FBE439CA
000228339610AEFCC5E16BB601EE53AC
0003438E77298540EF66B4467CEB2020

第一行,使用一个数字代表 ID 类型:

  • 1: IMEI (354960056441535)
  • 2: MAC (A4:57:C4:89:E4:E7)
  • 3: IDFA (009DA6AD-B52F-4022-A223-476C86736103)
  • 4: 手机号md5 (00019EAC5F91E9A0C1696A5165B40085)

从第二行开始,每一行都是一个 ID。

返回结果

如果请求成功,返回的 content 如下

{
    "content": {
        "file": {
            "file_token": "55330c4ee66dc6853b37ad7edc9b5947",
            "file_size": 34234,
            "file_name": "test.txt"
            "row_count": 5000
            "file_type": "coor-list",
            "rel_path": "ci-upload\/uid\/2018-03-20\/64f09df907119925d8b8e87e7cc58537.txt",
            "file_ln": 280
        }
    }
}

创建任务 -- 关键词任务

用来创建一个客情分析任务,圈人的类型为通过检索的关键词圈人。

URL

POST v1/custominsight/api/task_create

请求参数

key 必选 含义 解释
action_type Y 任务类型 keyword
action_name Y 任务名称
keyword_combine Y 多个词的计算规则 #: 与; $: 或
date_range Y 检索发生的日期 10: 一个月;11: 两个月; 12: 三个月
keyword_list Y 检索词列表 通过“;” 分割的关键词列表

请求示例

curl  'http://XXX/v1/custominsight/api/task_create' \
-H 'X-Bce-Account: CLOUD_UID' \
-d 'action_type=keyword&action_name=test1&keyword_combine=#&date_range=12&keyword_list=三里屯;车'

返回结果

请求成功,返回系统生成的任务ID号,content格式如下

{
    "content": {
        "task": 10000034
}

创建任务 -- LBS任务

用户上传一个代表“经纬度、半径”信息的文件,来指定任务的目标用户群体进行计算。

URL

POST v1/custominsight/api/task_create

请求参数

key 必选 含义 解释
action_type Y 任务类型 lbs1
action_name Y 任务名称
file_token Y 文件上传接口返回的 file_token

请求示例

curl  'http://XXX/v1/custominsight/api/task_create' \
-H 'X-Bce-Account:CLOUDUID' \
-d 'action_type=lbs1&action_name=test1&file_token=FILE_TOKEN'

返回结果

请求成功,返回系统生成的任务ID号,content格式如下

{
    "content": {
        "task": 10000034
}

创建任务 -- 用户列表

用户上传一个代表“用户 ID”信息的文件,来指定任务的目标用户群体进行计算。用户 ID 目前支持MAC、IMEI、IDFA 和手机号 md5。

URL

POST v1/custominsight/api/task_create

请求参数

key 必选 含义 解释
action_type Y 任务类型 user-list
action_name Y 任务名称
file_token Y 文件上传接口返回的 file_token

请求示例

curl  'http://yq01-sys-rpm012d8e78b.yq01.baidu.com:8090/v1/custominsight/api/task_create' \
-H 'X-Bce-Account:CLOUDUID' \
-d 'action_type=user-list&action_name=test1&file_token=FILE_TOKEN'

返回结果

请求成功,返回系统生成的任务ID号,content格式如下

{
    "content": {
        "task": 10000034
}

获取任务列表

获取当前 token 创建的任务列表

URL

GET v1/custominsight/api/task_list

请求参数

key 必选 含义 解释
page N 页码 默认为1,从 1 开始的正整数
count N 每页数量 默认 20,最大 50

请求示例

curl  'http://XXX/v1/custominsight/api/task_list' \
-H 'X-Bce-Account:CLOUDUID' \
-d 'page=1&count=50'

返回结果

返回一个 json,content 为详细信息

{
  "content": {
    "total": 14,
    "page": 1,
    "count": 2,
    "task_list": [
      {
        "id":"100000005",
        "name": "lichao06-test",
        "task_type": "0",
        "created_at": "2017-11-27 14:24:30",
        "task_status": "-4",
        "task_restrict": {
          "actionType": "keyword",
          "dateRange": 11,
          "actionName": "lichao06-test",
          "keywordCombine": "#",
          "keywordList": "本田;雅阁"
        }
      },
      {
        "id":"10000004",
        "name": "测试lbs1圈人",
        "task_type": "1",
        "created_at": "2017-11-27 17:05:52",
        "task_status": "4",
        "task_restrict": {
          "actionType": "lbs1",
          "actionName": "测试lbs1圈人",
          "fileToken":"b566789ce19321d6ca9768bc12e5fc1b",
          "fileName":"test.txt",
          "fileSize":12345}
      }
    ]
  }
}

修改任务

修改指定任务的信息(只支持删除)

URL

POST v1/custominsight/api/task_edit

请求参数

key 必选 含义 解释
task_id Y task-id
status Y 删除 -6

请求示例

curl  'http://XXX/v1/custominsight/api/task_edit' \
-H 'X-Bce-Account:CLOUDUID' \
-d 'task_id=TASK_ID&status=-6'

返回结果

请求成功,返回被删除任务信息,content格式如下

{
    "content": {
        "id": "10000030",
        "name": "test1",
        "task_status": "-6"
    }
}

读取任务数据

读取指定任务的计算结果。

URL

POST v1/custominsight/api/task_data

请求参数

表1:

key 必选 含义 解释
task_id Y task id 任务ID
data_list Y 数据种类 “,“ 分隔的数据类型 ID 列表,ID 及其具体含义见下方表格

表2:

ID 大分类 含义
1001 人口属性 性别
1002 人口属性 年龄
1003 人口属性 人生阶段
1004 人口属性 收入水平
1005 人口属性 教育水平
1006 人口属性 所在行业
1007 人口属性 职业类别
1008 人口属性 婚姻状况
1009 人口属性 消费水平
1010 人口属性 品类消费水平
2001 位置属性 常访地
2002 位置属性 公司
2003 位置属性 居住地
3001 兴趣偏好 餐饮美食
3002 兴趣偏好 汽车
3003 兴趣偏好 服饰鞋包
3004 兴趣偏好 影视音乐
3005 兴趣偏好 花鸟萌宠
3006 兴趣偏好 游戏
3007 兴趣偏好 房产
3008 兴趣偏好 软件应用
3009 兴趣偏好 个护美容
3010 兴趣偏好 非汽车机动车
3011 兴趣偏好 公益
3012 兴趣偏好 家电数码
3013 兴趣偏好 资讯
3014 兴趣偏好 休闲爱好
3015 兴趣偏好 体育健身
3016 兴趣偏好 书籍阅读
3017 兴趣偏好 网络购物
3018 兴趣偏好 生活服务
3019 兴趣偏好 商务服务
3020 兴趣偏好 母婴亲子
3021 兴趣偏好 旅游出行
3022 兴趣偏好 金融财经
3023 兴趣偏好 建材家居
3024 兴趣偏好 教育培训
3025 兴趣偏好 求职创业
3026 兴趣偏好 婚恋交友
4001 品牌偏好 通用
4002 品牌偏好 汽车
5001 媒体关注 通用
5002 媒体关注 汽车
5003 媒体关注 网站组合

请求示例

curl  'http://yq01-sys-rpm012d8e78b.yq01.baidu.com:8090/v1/custominsight/api/task_data' \
-H 'X-Bce-Account:CLOUDUID' \
-d 'task_id=TASK_ID&data_list=1001,3019'

返回结果

会返回如下的一个 json 结果:

{
  "task-list": {
    "id": 1234,
    "name": "圈人任务1",
    "task_type":"0",
    "task_status":"1",
    "created-at": "2017-11-06 10:10:10",
    "task_restrict": {
        "actionType": "keyword",
        "dateRange": "12",
        "actionName": "test1",
        "keywordCombine": "#",
        "keywordList": "one;two"
    }
  },
  "data": {
    "1001": [
      {
        "name": "男",
        "percent": 20,
        "count": 1000
      },
      {
        "name": "女",
        "value": 80,
        "count": 4000
      }
    ],
    "1002": [
      {
        "name": "高中及以下",
        "percent": 20,
        "count": 2000
      },
      {
        "name": "大专",
        "value": 40,
        "count": 4000
      },
      {
        "name": "本科及以上",
        "value": 40,
        "count": 4000
      }
    ]
  }
}

data参数说明

类型1000结果说明

返回结果字段含义如下,

参数名称 参数含义 具体解释
cout 覆盖人数 -
whole_percent 全网覆盖率 所有百度用户该属性占比
percent 覆盖率 该标签占目标人群比例

类型2000结果说明

返回结果字段含义如下

参数名称 参数含义 具体解释
count 覆盖人数 -
name 名称 -
percent 覆盖率 该标签占目标人群比例
lon 加密后经度 -
lat 加密后维度 -

类型3000结果说明

返回结果字段含义如下,

参数名称 参数含义 具体解释
count 覆盖人数 -
name 名称 -
avg 平均兴趣标签打分 范围[0, 100],值越大,兴趣越大
tgi 处理后目标群体指数 范围[-100,100], 值越大,目标群体在该标签越强势,0表示与总群体持平

类型4000,5000结果说明

返回结果字段含义如下,

参数名称 参数含义 具体解释
count 覆盖人数 -
name 名称 -
percent 覆盖率 该标签占目标人群比例

类型5003结果说明

返回结果字段含义如下,一共有1-5个网站组合的情况,每种组合返回top500数据

第一层参数名称 第二层参数名称 参数含义
1 一个网站组合
2 二个网站组合
3 三个网站组合
4 四个网站组合
5 五个网站组合
website 具体网站名称,顿号分隔
count 覆盖人数