获取推广链接接口
支持获取活动物料、到店/到家/买菜业务类型的推广链接;支持按活动物料ID、商品券展示ID、目标链接的形式获取对应的推广链接;支持 appkey-sid 两级渠道追踪推广效果。需用 POST 方式调用。
API 地址
https://media.meituan.com/cps_open/common/api/v1/get_referral_link
请求参数(入参)
公共签名请求头(Header)
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| S-Ca-App | String | 必填 | 分配的 AppKey |
| S-Ca-Signature | String | 必填 | 签名字符串 |
| S-Ca-Timestamp | String | 必填 | API 调用者传递时间戳,值为当前时间的毫秒数,时间戳有效时间为 2 分钟 |
| Content-MD5 | String | 必填 | Body MD5,有请求体接口必传 |
| S-Ca-Signature-Headers | String | 必填 | 将需要签名的 header 使用英文逗号分割放到 Request Header 中,其中必须包括 S-Ca-Timestamp,建议将 S-Ca-App 也添加进去,例如 S-Ca-Timestamp,S-Ca-App |
接口请求 Body(JSON 结构)
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| platform | Integer | 非必填 | 商品所属业务一级分类类型;只有输入 productViewSign 时才需要传本字段。不填则默认 1 |
| bizLine | Integer | 非必填 | 商品所属业务二级分类类型;只有输入 productViewSign 时才需要传本字段。当 platform=1(到家及其他)时:5 · 医药 不填则默认 null(表示外卖商品券)。当 platform=2(到店)时:1 · 到餐2 · 到综3 · 酒店4 · 门票 不填则默认 1 |
| actId | String | 非必填 | 活动物料 ID,我要推广-活动推广中第一列的 id 信息(和商品 id、活动链接三选一填写,不能全填) |
| skuViewId | String | 非必填 | ⚠️ 该字段已迭代升级为 productViewSign(推荐使用);SkuViewIds 字段会逐步下线,请尽快迁移至新字段 productViewSign |
| productViewSign | String | 非必填 | 商品 id,对商品查询接口返回的 productViewSign(和活动物料 ID、活动链接三选一,不能全填) |
| sid | String | 非必填 | 二级媒体身份标识,用于渠道效果追踪,限制 64 个字符,仅支持英文字母和数字 |
| linkType | Integer | 非必填 | 链接类型(linkType 和 linkTypeList 必传一个,都传时只处理 linkTypeList) |
| text | String | 非必填 | 单个转链链接。只支持到家(外卖商品券、医药)商品链接、到店(到店美食、休闲生活、酒店、门票)商品链接、活动物料链接。限定为当前可推广的活动链接或商品券链接,请求内容尽量保持在 200 字以内 |
| linkTypeList | List<Integer> | 非必填 | 链接类型列表(linkType 和 linkTypeList 必传一个,都传时只处理 linkTypeList)注:团口令、H5 短链、小程序二维码有效期 60 天,其余无限制 |
| textList | List<String> | 非必填 | 批量转链链接。请求内容尽量保持在 200 字以内,请求链接数量控制在 20 条以下。支持到家/到店商品链接、活动物料链接 |
返回参数(出参)
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| code | Integer | 必填 | 响应码 0 · 成功 非0 · 失败 |
| message | String | 必填 | 响应文案 |
| data | String | 非必填 | 返回对应的推广链接,这里的链接才能实现跟单计佣 |
| skuViewId | String | 非必填 | 若用 text 入参取链且返回的为商品券链接,则返回对应商品的展示 ID |
| productViewSign | String | 非必填 | 若用 text 入参取链且返回的为商品券链接,则返回对应商品的展示 ID |
| referralLinkMap | Map | 非必填 | 多链接类型结果映射,对应入参 linkTypeList 中的各个有效链接类型(key:链接类型, value:推广链接) |
| skuDetailInfo | — | 非必填 | 用 text 进行入参取链(即转链)时,若解析为单品详情页链接时,根据解析的商品 id 返回商品信息 |
| availablePoiInfo | — | 非必填 | 可用门店信息 |
| availablePoiNum | Integer | 非必填 | 可用门店数量。若传入经纬度则为所在城市可用门店数;不传则输出北京可用的门店数 |
| brandInfo | — | 非必填 | 品牌信息 |
| brandName | String | 非必填 | 品牌名称 |
| brandLogoUrl | String | 非必填 | 品牌 Logo 的 URL |
| commissionInfo | — | 非必填 | 佣金信息 |
| commissionPercent | String | 非必填 | 查询当时生效的佣金比例,需除以 100,如返回 400 表示佣金比例为 4% |
| commission | String | 非必填 | 佣金值(元),保留小数点后两位。仅支持到店、到家医药业务类型 |
| couponPackDetail | — | 非必填 | 商品券详情 |
| name | String | 非必填 | 商品名称 |
| skuViewId | String | 非必填 | 商品 skuViewId,传入取链接口才能正常归因订单 |
| productViewSign | String | 非必填 | 商品 productViewSign,传入取链接口才能正常归因订单 |
| specification | String | 非必填 | 规格信息,仅支持到家医药商品业务类型 |
| couponNum | Integer | 非必填 | 券包中券的数量,仅支持到家外卖商品券业务类型 |
| validTime | Integer | 非必填 | 活动截止有效日期,仅作参考(仅外卖商品券) |
| headUrl | String | 非必填 | 商品头图的 URL |
| saleVolume | String | 非必填 | 美团累计销量,例:100+,1000+,10000+ |
| startTime | Long | 非必填 | 活动有效期开始时间(仅外卖商品券) |
| endTime | Long | 非必填 | 活动有效期结束时间(仅外卖商品券) |
| saleStatus | Boolean | 非必填 | 售卖状态,可售为 true,不可售为 false。不可售商品不返回数据 |
| originalPrice | Integer | 非必填 | 原始价格 / 划线价(元) |
| sellPrice | Integer | 非必填 | 售卖价格(元) |
| platform | Integer | 非必填 | 平台:1-到家、2-到店 |
| bizLine | Integer | 非必填 | 二级分类:platform=1 时 null 代表外卖;platform=2 时 1 代表餐 |
| deliverablePoiInfo | — | 非必填 | 可配送门店信息(仅外卖商品券) |
| poiName | String | 非必填 | 门店名称,入参经纬度可展示附近配送门店名称 |
| poiLogoUrl | String | 非必填 | 门店 Logo URL,入参经纬度可展示附近配送门店 logo |
| deliveryDistance | String | 非必填 | 配送距离,入参经纬度可展示附近门店配送距离 |
| distributionCost | String | 非必填 | 配送费,入参经纬度可展示附近门店配送费 |
| deliveryDuration | String | 非必填 | 配送时长,入参经纬度可展示附近门店配送时长 |
| lastDeliveryFee | String | 非必填 | 起送额,入参经纬度可展示附近门店起送金额 |
| purchaseLimitInfo | — | 非必填 | 购买限制信息 |
| singleDayPurchaseLimit | Integer | 非必填 | 单日售卖上限 |
| couponValidTimeInfo | — | 非必填 | 券包活动有效时间信息(仅外卖商品券) |
| couponValidTimeType | Integer | 非必填 | 券包活动生效时间类型:1-按生效天数,2-按时间段 |
| couponValidDay | Integer | 非必填 | 券生效天数(couponValidTimeType=1 时有效) |
| couponValidSTime | Long | 非必填 | 券开始时间戳(秒),couponValidTimeType=2 时有效 |
| couponValidETime | Long | 非必填 | 券结束时间戳(秒),couponValidTimeType=2 时有效 |
| convertedLinkInfoList | List | 非必填 | 批量转链结果列表,包含多个转链信息 |
| msg | String | 非必填 | 转链结果响应文案 |
| originUrl | String | 非必填 | 原始链接地址,即转链前的 URL |
| link | String | 非必填 | 转换后的推广链接 |
| referralLinkMap | Map | 非必填 | 多链接类型结果映射(key:链接类型, value:推广链接) |
| skuViewId | String | 非必填 | 商品展示 ID,当转链结果为商品券链接时返回 |
| skuDetailInfo | — | 非必填 | 商品详情信息(转链为单品详情页链接时返回,结构同上 skuDetailInfo) |
| shareText | String | 非必填 | 分享文案,可用于分享的文本内容 |
| shareImage | String | 非必填 | 分享图片 URL,可用于分享的图片链接 |
请求示例
{
"actId": "1234",
"linkType": 1,
"sid": "f3a8c1",
"linkTypeList": [1, 2]
}返回示例
成功响应
{
"code": 0,
"message": "成功",
"data": "https://click.meitan.com/t?t=1&c=2&p=XXXXXXX",
"skuViewId": null,
"referralLinkMap": {
"1": "https://click.meitan.com/t?t=1&c=2&p=XXXXXXX",
"2": "http://dpurl.cn/XXXXXXXX"
}
}异常响应
{
"code": 1,
"message": "物料ID未查询到相关数据,请确认actId输入",
"data": null,
"skuViewId": null,
"referralLinkMap": null,
"skuDetailInfo": null
}