基础信息

API 名称：获取推广链接接口

API 描述：支持获取活动物料、到店/到家/买菜业务类型的推广链接；支持按活动物料ID、商品券展示ID、目标链接的形式获取对应的推广链接；支持appkey-sid两级渠道追踪推广效果。需要用POST方法调用接口。

API 地址：https://media.meituan.com/cps_open/common/api/v1/get_referral_link

接口参数

入参

参数名称 类型 是否必填 描述
公共签名请求头 - 必填 公共请求签名参数
S-Ca-App String 必填 分配的AppKey
S-Ca-Signature String 必填 签名字符串
S-Ca-Timestamp String 必填 API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为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 - 必填 接口请求body内容，JSON结构
platform Integer 非必填 商品所属业务一级分类类型；请求的商品推广链接所属的业务类型信息，即只有输入productViewSign时才需要传本字段：1 到家及其他业务类型，2 到店业务类型；不填则默认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 非必填 链接类型，枚举值：1 H5长链接；2 H5短链接；3 deeplink(唤起)链接；4 微信小程序唤起路径；5 团口令；6 小程序码
text String 非必填 单个转链链接。只支持到家（外卖商品券、医药）商品链接、到店（到店美食、休闲生活、酒店、门票）商品链接、活动物料链接。活动链接，即想要推广的目标链接，出参会返回成自己可推的链接，限定为当前可推广的活动链接或者商品券链接，请求内容尽量保持在200字以内，链接类型目前支持长链、短链、deeplink(唤起)链接、圈圈小程序唤起路径、美团小程序活动链接
linkTypeList List<Integer> 非必填 链接类型列表，(linkType和linkTypeList必传一个，linkType和linkTypeList都传时，只处理linkTypeList)。枚举值：1 H5长链接；2 H5短链接；3 deeplink(唤起)链接；4 微信小程序唤起路径；5 团口令；6 小程序码;注：团口令、h5短链、小程序二维码有效期60天 ，其余无限制
textList List<String> 非必填 批量转链链接。只支持到家（外卖商品券、医药）商品链接、到店（到店美食、休闲生活、酒店、门票）商品链接、活动物料链接。活动链接，即想要推广的目标链接，出参会返回成自己可推的链接，限定为当前可推广的活动链接或者商品券链接，请求内容尽量保持在200字以内，请求链接数量控制在20条以下, 链接类型目前支持长链、短链、deeplink(唤起)链接、圈圈小程序唤起路径、美团小程序活动链接

出参

参数名称 类型 是否必填 描述
code Integer 必填 响应码，0成功，其他失败
message String 必填 响应文案
data String 非必填 返回对应的推广链接，这里的链接才能实现跟单计佣
skuViewId String 非必填 若用text进行入参取链，且返回的推广链接为商品券链接，则返回对应商品的展示ID，可以根据该ID查商品券接口获取对应的展示信息和佣金信息
productViewSign String 非必填 若用text进行入参取链，且返回的推广链接为商品券链接，则返回对应商品的展示ID，可以根据该ID查商品券接口获取对应的展示信息和佣金信息
referralLinkMap Map 非必填 多链接类型结果映射，对应入参linkTypeList中的各个有效链接类型（key:链接类型, value:推广链接）
skuDetailInfo - 非必填 用text进行入参取链（即转链）时，若解析为单品详情页链接时，根据解析的商品id返回商品信息
availablePoiInfo - 非必填 可用门店信息
availablePoiNum Integer 非必填 可用门店数量。针对到店、到家医药业务类型商品，若传入经纬度信息，则为经纬度所在城市可用的门店数。若不传入经纬度信息，则输出北京可用的门店数
brandInfo - 非必填 品牌信息
brandName String 非必填 品牌名称
brandLogoUrl String 非必填 品牌Logo的url
commissionInfo - 非必填 佣金信息
commissionPercent String 非必填 查询当时生效的佣金比例， 商品券拉取、通过商品券ID查询、通过榜单listTopiId查询，返回的数据需要除以100表示对应的佣金比例，如返回400表示佣金比例为4%
commission String 非必填 只支持到店、到家医药业务类型。查询当时生效的佣金值。单位元，保留小数点后两位
couponPackDetail - 非必填 商品详情
name String 非必填 商品名称
skuViewId String 非必填 商品skuViewId，传入开放平台取链接口的skuViewId，取得对应推广链接才能正常归因订单
skuViewId String 非必填 商品productViewSign，传入开放平台取链接口的productViewSign，取得对应推广链接才能正常归因订单
specification String 非必填 规格信息，只支持到家医药商品业务类型
couponNum Integer 非必填 只支持到家外卖商品券业务类型，券包中券的数量
validTime Integer 非必填 只支持到家外卖商品券业务类型，活动截止有效日期，仅作参考，具体结束时间详见couponValidTimeInfo中的信息
headUrl String 非必填 商品头图的url
saleVolume String 非必填 美团累计销量，例：100+，1000+，10000+
startTime Long 非必填 只支持到家外卖商品券业务类型，活动有效期开始时间
endTime Long 非必填 只支持到家外卖商品券业务类型，活动有效期结束时间
saleStatus Boolean 非必填 售卖状态，可售为是，不可售为否。不可售商品不返回商品数据
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 - 非必填 商品详情信息，当转链为单品详情页链接时返回的商品信息
availablePoiInfo - 非必填 可用门店信息
availablePoiNum Integer 非必填 可用门店数量。针对到店、到家医药业务类型商品，若传入经纬度信息，则为经纬度所在城市可用的门店数。若不传入经纬度信息，则输出北京可用的门店数
brandInfo - 非必填 品牌信息
brandName String 非必填 品牌名称
brandLogoUrl String 非必填 品牌Logo的url
commissionInfo - 非必填 佣金信息
commissionPercent String 非必填 查询当时生效的佣金比例， 商品券拉取、通过商品券ID查询、通过榜单listTopiId查询，返回的数据需要除以100表示对应的佣金比例，如返回400表示佣金比例为4%
commission String 非必填 只支持到店、到家医药业务类型。查询当时生效的佣金值。单位元，保留小数点后两位
couponPackDetail - 非必填 商品详情
name String 非必填 商品名称
skuViewId String 非必填 商品skuViewId，传入开放平台取链接口的skuViewId，取得对应推广链接才能正常归因订单
specification String 非必填 规格信息，只支持到家医药商品业务类型
couponNum Integer 非必填 只支持到家外卖商品券业务类型，券包中券的数量
validTime Integer 非必填 只支持到家外卖商品券业务类型，活动截止有效日期，仅作参考，具体结束时间详见couponValidTimeInfo中的信息
headUrl String 非必填 商品头图的url
saleVolume String 非必填 美团累计销量，例：100+，1000+，10000+
startTime Long 非必填 只支持到家外卖商品券业务类型，活动有效期开始时间
endTime Long 非必填 只支持到家外卖商品券业务类型，活动有效期结束时间
saleStatus Boolean 非必填 售卖状态，可售为是，不可售为否。不可售商品不返回商品数据
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有效
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
}

公共错误码