文档

线索收集接口对接

更新时间:

本文介绍如何对接增长云创意平台线索收集接口。

鉴权方式

  1. 用户需要提供对应的接口调用阿里云账号UID以及对应的主体ID

    说明

    对应的ID可咨询小二同学或者登录投放平台查看。

  2. 针对阿里云UID存在账号层级加白限制,非指定阿里云账号不允许进行业务查询。

  3. 针对阿里云UID和对应主体ID存在的映射关系,只允许查询当前阿里云账号对应主体ID下的品牌落地页线索数据。

接口依赖

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>imarketing20220704</artifactId>
    <version>1.0.0</version>
</dependency>

接口出入参数说明

接口名

GetLeadsListPage

接口入参

参数名

类型

是否必填

说明

举例

mainId

Long

账户主体ID

126777219941221

creativeId

Long

落地页ID,根据落地页ID维度筛选

12

pageIndex

Integer

分页页码

1

pageSize

Integer

分页大小

10

startTime

Long

选填

业务发生开始时间戳

1660720091040

endTime

Long

选填

业务发生结束时间戳

1660720101000

taskId

Long

选填

计划ID,可做计划维度的汇总

6873291

contentId

Long

选填

创意ID,可做创意维度的汇总

98049865

接口出参

参数名

类型

说明

举例

data

obj

出参对象

见 data对象

success

boolean

接口响应成功还是失败判断

true

errorMessage

String

错误信息

success = false时,该值为失败原因

data 

参数名

类型

说明

举例

list

array

线索列表数据

参见LeadsCluesVO对象

pageInfo

obj

分页加载对象

参见PageInfoobj

PageInfo

参数名

类型

说明

举例

pageSize

Integer

每页大小

10

totalNumber

Integer

总数

100

page

Integer

当前页码

1

LeadsCluesVO

参数名

类型

说明

举例

serialId

String

唯一业务标识

8243099002709147648

taskId

Long

计划ID

28785749

contentId

Long

创意ID

1229121

creativeId

Long

落地页ID

93

creativeName

String

落地页名称

测试主链路-表单

componentId

String

组件ID

MobiH5YunmaFormMutable

leadsDetail

String

线索详情 json string

{\"name\":\"cesium\",\"phone\":\"1894946****\",\"email\":\"***@qq.com\",\"address\":\"安徽省.安庆市.大观区\",\"addressDetail\":\"回想小区12幢1单元302号\",\"sex\":\"male\"}

leadsDetail

参数名

类型

说明

举例

name

String

姓名

张三

phone

String

电话

1894946****

email

String

邮箱

***@qq.com

address

String

省市区

安徽省.安庆市.大观区

addressDetail

String

详细住址

回想小区12幢1单元302号

sex

String

性别

male

出参示例

{
   "data": {
     "pageInfo": {
       "pageSize": 10,
       "totalNumber": 6,
       "page": 1
       },
     "list": [
        {
           "taskId": 123456,
           "leadsDetail": "{\"name\":\"裴俊\"}",
           "contentId": 1211234,
           "serialId": 8243099002709147648,
           "creativeId": 1,
           "componentId": "1231",
           "creativeName": "ceshi"
        },
 
       {
           "taskId": 28785749,
           "leadsDetail": "{\"name\":\"测试\",\"phone\":\"1894946****\",\"email\":\"2*@qq.com\",\"address\":\"安徽省.安庆市.大观区\",\"addressDetail\":\"详细地址\",\"sex\":\"male\"}",
           "contentId": 102911,
           "serialId": 8246271957005959168,
           "creativeId": 93,
           "componentId": "MobiH5YunmaFormMutable",
           "creativeName": "测试主链路-表单"
       }
     ]
    },
   "success": true,
 
}

异常出参

{
    "RequestId": "BA9DA4D4-6351-14DE-B884-A34726804CC3",
    "HostId": "imarketing-vpc.cn-hangzhou.aliyuncs.com",
    "Code": "false",
    "Message": "参数异常",
    "Recommend": "https://next.api.aliyun.com/troubleshoot?q=false&product=imarketing"
}

调用代码示例

  • AccessKey ID:用于标识用户。

  • AccessKey Secret:用于验证用户的密钥。AccessKey Secret必须保密。

image.png
  • 本页导读 (0)
文档反馈