活动投放API

更新时间:2017-06-07 13:26:11

这已经是运用定向营销服务的最后一个环节。

当您完成了创建APP、SDK数据采集、创建人群、创建活动这4个步骤,最后只需要在您的移动APP(服务端)调用“活动投放API“,当用户访问移动APP时即可实时投放个性化内容。

我们以一个简单的移动APP为例,首页首屏的位置有一个营销位(坑位)会投放1张活动图片,营销位CODE为“1”。

API说明

host:shujuapi.aliyun.com

dplus_org_code:用户数加申请到的“组织名称” ,可以在API列表看到.

注意:使用API时, 需要增加 header:x-dataplus-timeout=60000* 请参见数加鉴权规范

  • 接口说明:获取在线投放内容
  • API用户授权类型:数加API鉴权 *
  • 地址:${host}/${dplus_org_code}/ot-man/activity_match
  • method: post
  • 请求参数:
参数 类型 是否必填 实例 默认值 描述
marketing_id int 1 null 营销位CODE
user_id string “user_a” null 用户ID
top_num int 1 null 最优的TOP N个投放内容

输入样例(不包括数加身份验证headers,下同):

  1. curl -X POST ${身份验证headers} -d '{"user_id": "user_a","marketing_id": 1,"top_num":1}' 'https://shujuapi.aliyun.com/dataplus_100/ot-man/activity_match'

返回结果:

参数 类型 实例 描述
id int 10000 活动ID
documents_type int 1 内容类型,1:图片;2:文本
documents string https://www.aliyun.com/1.png 图片类型为图片链接;文本类型为文本内容
activity_url string https://www.aliyun.com 投放内容被点击后的跳转链接
priority int 1 最优TOP N个投放内容的排序

正确返回示例:

  1. {
  2. "data": {
  3. "RES_MSG": {
  4. " activity_list ": [
  5. {
  6. "id": 10000,
  7. "documents_type ": 1,
  8. "documents": "https://www.aliyun.com/1.png",
  9. "activity_url": "http://www.aliyun.com",
  10. " priority ": 1
  11. }
  12. ],
  13. "success": true
  14. },
  15. "SUB_MSG": "---"
  16. }
  17. }

错误返回示例:

  1. {
  2.   "message ":"Error: Illegal operation! ",
  3.   "errorCode":"101010"
  4. }
  5. }

错误码

错误码 描述
100000 或空 成功
100001 服务端无数据
100002 服务端请求超时
100400 一般请求错误
101001 json不合法
101002 请求参数不全,或者类型错误
101010 非法操作
101000 、100500、100503 服务端错误