[中文] Linkrall渠道API对接文档v3.7

Linkrall是一个稳定、高效、精细运营的自动化第三方广告平台，助力效果广告客户提高运营效率，增强运营的精细度，降低平台成本，持续提升业务。更多详情请访问：http://www.linkrall.com

0. 版本更新历史

[2020/08/20] v3.6: 应对iOS14新政策，新增点击链接参数：ip, lang, ua

[2020/01/11] v3.7: 新增两个响应参数：click_cap和cap_timezone

1. 简介

Linkrall API是用于渠道从服务端获取offer，该文档指导用户如何对接Linkrall平台的API接口。以下为对接注意事项：

• API接口通过GET方式请求，并返回JSON数据。

• 该接口属于离线API，不应从客户端直接请求。

• 为保证offer状态的时效性，建议每10-15分钟请求一次API接口。

• 如果响应参数"deviceid_required"等于1，则必须在点击链接种传递客户端的GAID或者IDFA。

2. API请求方法

请求链接: http://广告主域名/v3/api_v3?key=[API key]

请求方式: GET

请求参数

参数	描述	必传
key	API Key，需要从AM处获取	是
limit	单页offer数量，默认3000	否
page	页码，默认1	否
os	广告类型，安卓/IOS	否

响应参数

参数	描述
message	响应消息
data	响应数据
id	offer id
name	offer名称
payout	offer单价
currency	结算货币 参考值：USD
countries	offer推广国家，以英文逗号分隔 参考值：US,IN,JP
click_url	点击链接
preview_link	预览链接
package	包名
description	描述
device	offer要求的设备类型 参考值：all/mobile/tablet
os	offer要求的设备操作系统 参考值：ios/android
min_osv	offer要求的设备最小版本号
incentive	是否允许激励流量 0代表不允许，1代表允许
deviceid_required	offer是否必传GAID/IDFA 0代表非必传，1代表必传
icon	offer缩略图地址
cap	offer每天的转化数预算，其中99999代表没有限制
click_cap	offer每天的click限制，-1代表没有限制
cap_timezone	offer cap时区, 例如8代表GMT+8
creatives	offer素材
creatives.type	素材类型 参考值: image/zip
creatives.size	图片素材文件大小
creatives.width	图片素材宽度
creatives.height	图片素材高度
creatives.url	图片素材链接
video	视频素材链接
video.size	视频素材文件大小(KB)
video.url	视频素材链接
status	offer状态，参考值为active
convert_type	参考值：CPI/CPE/CPS
page	当前页码
totalData	offer总数量
limit	单页offer数量

响应示例

{
  "message": "Success",
  "data": [
      {
          "id": 12345,
          "name": "Lazada IN",
          "payout": "2.66",
          "currency": "USD",
          "countries": "IN",
          "click_url":"http://xxx.com/clk.php?offer_id=1&aff_id=123",
          "preview_link": "https://play.google.com/store/apps/details?id=com.lazada.in",
          "package": "com.lazada.in",
          "description": "",
          "device": "all",
          "os": "android",
          "min_osv": "0",
          "incentive": 0,
          "deviceid_required": 0,
          "icon": "http://xxx.com/creatives/icon?id=12345",
          "cap": 99999,
          "click_cap": -1,
          "cap_timezone": 8,
          "creatives": [{
              "type": "image",
              "size": "37",
              "width": "728",
              "height": "90",
              "url": "http://xxx.com/creative/1.jpg"
          }],
          "video": [{
              "url": "http://xxx.com/creative/1.mp4",
              "size": "741"
          }],
          "status": "active",
          "convert_type": "CPI"
      }
  ],
  "page": 1,
  "totalData": 6,
  "limit": 1
}

3. 点击链接参数

参数	说明
aff_sub1	用于传click id
aff_sub2	用于传自定义参数
aff_sub3	用于传自定义参数
aff_sub4	用于传自定义参数
aff_sub5	用于传自定义参数
source_id	用于传渠道source
google_aid	用于传GAID
ios_idfa	用于传IDFA
app_name	用于传app name
ip	用于传设备ip，仅用于iOS版本高于14.0 参考值：192.168.0.0
lang	用于传设备语言，仅用于iOS版本高于14.0 参考值：en-US
ua	用于传设备UA，需要URL编码，仅用于iOS版本高于14.0 参考值：Mozilla%2F5.0%20(iPhone%3B%20CPU%20iPhone%20OS%2 11_0%20like%20Mac%20OS%20X)%20AppleWebKit%2F604.1.38%20 (KHTML%2C%20like%20Gecko)%20Version%2F11.0%20Mobile%2F1 5A372%20Safari%2F604.1

Click URL示例

http://[广告主域名]/clk.php?offer_id=12345&aff_id=123&aff_sub1=[CLICK ID]&source_id=[SOURCE ID]&google_aid=[GAID]&ios_idfa=[IDFA]&app_name=[APP NAME]&ip=[CLIENT IP]&lang=[CLIENT LANGUAGE]&ua=[CLIENT UA]

4. Postback回传参数

参数宏	说明
{aff_sub1}	Click ID
{aff_sub2}	自定义参数
{aff_sub3}	自定义参数
{aff_sub4}	自定义参数
{aff_sub5}	自定义参数
{source_id}	Source ID
{google_aid}	Google Advertising ID
{ios_idfa}	IOS Identifier for Advertising
{app_name}	App名称
{pkg_name}	App包名
{payout}	转化价格
{offer_id}	Offer ID
{country_code}	国家代码 (2位大写字母，如US)
{click_ip}	点击IP
{click_time}	点击时间
{conv_ip}	转化IP
{conv_time}	转化时间