淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
isv_ad_plan_dto	IsvAdPlanDTO	必须			广告配置
└ id Number 可选 100000 广告配置id └ name String 必须广告名称广告计划名称 └ ads_desc String 必须广告描述广告计划描述 └ ads_type Number 必须 1 落地页类别：1 商详，4 自研页 └ item_id Number 必须 123456 商品id └ customize_ads_url String 可选 https:// 自研页链接，落地页选自研页时必填 └ customize_deep_link String 可选 https:// 唤端链接（输入https地址），落地页选自研页时必填 └ media_id Number 必须 1 渠道：1-抖音1.0，2-抖音2.0，3-快手，4-腾讯，5-B站，6-UC，7-百度 isv_attribution_dto IsvAttributionDTO 必须归因配置 └ user_action_level Number 必须 1 监控维度：1 店铺，2 品牌，3 商品 └ user_action_type Number 必须 1 监控维度行为：1 加购，2 下单，3 加购+下单，4 支付 └ attribution_type Number 必须 1 归因范围：1 有效播放与点击，2 点击，3 曝光 └ attribution_time Number 必须 1 归因周期：1 1天，7 7天，15 15天 └ shop_report_black_list String 可选 123456,123456 店铺归因上报，商品黑名单，多个值用英文逗号分隔 └ item_report_white_list String 可选 123456,123456 店铺归因上报，商品白名单，多个值用英文逗号分隔 isv_postback_dto IsvPostbackDTO 必须上报配置 └ report_type Number 必须 1 回传标记：抖音：1-下单，6-加购；快手：3-下单；腾讯：5-下单；B站：7-支付；UC：8-下单；百度：9-下单；小红书：11-下单；支付宝：13-支付；小荷医疗：14-下单 └ report_freq_type Number 必须 1 频控类型：1 点击频控，5 不频控 └ report_proportion Number 必须 90 抽量占比（订单回传百分比）：0/10/20/30/40/50/60/70/80/90 └ delay_time Number 必须 10 延迟上报时间（单位:分钟）：范围[0-60] └ filter_fee String 可选 100.05 回传过滤金额，支持2位小数 isv_assist_dto IsvAssistDTO 可选助攻配置 └ assist_type Number 可选 1 助攻类别：1 同店铺助攻，2 同店铺同品牌，3 同店铺同商品 └ report_switch Number 必须 1 是否归因上报：1 开启 -1 关闭

名称	类型	示例值	描述
result	Result		返回结果
└ success Boolean true 是否成功 model IsvAdPlanResultDTO 返回值 └ id Number 1 广告配置id └ exposure_monitor_url String http:// 曝光监测链接 └ click_monitor_url String http:// 点击监测链接 └ deep_link String tbopen:// 唤端链接 └ track_url String http:// 直达链接 └ msg_info String null 响应信息 └ msg_code String null 响应码

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthYtWtAdPlanSaveRequest req = new AlibabaAlihealthYtWtAdPlanSaveRequest();
AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAdPlanDTO obj1 = new AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAdPlanDTO();
obj1.setId(100000L);
obj1.setName("广告名称");
obj1.setAdsDesc("广告描述");
obj1.setAdsType(1L);
obj1.setItemId(123456L);
obj1.setCustomizeAdsUrl("https://");
obj1.setCustomizeDeepLink("https://");
obj1.setMediaId(1L);
AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAttributionDTO obj2 = new AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAttributionDTO();
obj2.setUserActionLevel(1L);
obj2.setUserActionType(1L);
obj2.setAttributionType(1L);
obj2.setAttributionTime(1L);
obj2.setShopReportBlackList("123456,123456");
obj2.setItemReportWhiteList("123456,123456");
obj1.setIsvAttributionDto(obj2);
AlibabaAlihealthYtWtAdPlanSaveRequest.IsvPostbackDTO obj3 = new AlibabaAlihealthYtWtAdPlanSaveRequest.IsvPostbackDTO();
obj3.setReportType(1L);
obj3.setReportFreqType(1L);
obj3.setReportProportion(90L);
obj3.setDelayTime(10L);
obj3.setFilterFee("100.05");
obj1.setIsvPostbackDto(obj3);
AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAssistDTO obj4 = new AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAssistDTO();
obj4.setAssistType(1L);
obj1.setIsvAssistDto(obj4);
obj1.setReportSwitch(1L);
req.setIsvAdPlanDto(obj1);
AlibabaAlihealthYtWtAdPlanSaveResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthYtWtAdPlanSaveRequest req = new AlibabaAlihealthYtWtAdPlanSaveRequest();
AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAdPlanDTODomain obj1 = new AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAdPlanDTODomain();
obj1.Id = 100000L;
obj1.Name = "广告名称";
obj1.AdsDesc = "广告描述";
obj1.AdsType = 1L;
obj1.ItemId = 123456L;
obj1.CustomizeAdsUrl = "https://";
obj1.CustomizeDeepLink = "https://";
obj1.MediaId = 1L;
AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAttributionDTODomain obj2 = new AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAttributionDTODomain();
obj2.UserActionLevel = 1L;
obj2.UserActionType = 1L;
obj2.AttributionType = 1L;
obj2.AttributionTime = 1L;
obj2.ShopReportBlackList = "123456,123456";
obj2.ItemReportWhiteList = "123456,123456";
obj1.IsvAttributionDto= obj2;
AlibabaAlihealthYtWtAdPlanSaveRequest.IsvPostbackDTODomain obj3 = new AlibabaAlihealthYtWtAdPlanSaveRequest.IsvPostbackDTODomain();
obj3.ReportType = 1L;
obj3.ReportFreqType = 1L;
obj3.ReportProportion = 90L;
obj3.DelayTime = 10L;
obj3.FilterFee = "100.05";
obj1.IsvPostbackDto= obj3;
AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAssistDTODomain obj4 = new AlibabaAlihealthYtWtAdPlanSaveRequest.IsvAssistDTODomain();
obj4.AssistType = 1L;
obj1.IsvAssistDto= obj4;
obj1.ReportSwitch = 1L;
req.IsvAdPlanDto_ = obj1;
AlibabaAlihealthYtWtAdPlanSaveResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthYtWtAdPlanSaveRequest;
$isv_ad_plan_dto = new IsvAdPlanDTO;
$isv_ad_plan_dto->id="100000";
$isv_ad_plan_dto->name="广告名称";
$isv_ad_plan_dto->ads_desc="广告描述";
$isv_ad_plan_dto->ads_type="1";
$isv_ad_plan_dto->item_id="123456";
$isv_ad_plan_dto->customize_ads_url="https://";
$isv_ad_plan_dto->customize_deep_link="https://";
$isv_ad_plan_dto->media_id="1";
$isv_attribution_dto = new IsvAttributionDTO;
$isv_attribution_dto->user_action_level="1";
$isv_attribution_dto->user_action_type="1";
$isv_attribution_dto->attribution_type="1";
$isv_attribution_dto->attribution_time="1";
$isv_attribution_dto->shop_report_black_list="123456,123456";
$isv_attribution_dto->item_report_white_list="123456,123456";
$isv_ad_plan_dto->isv_attribution_dto = $isv_attribution_dto;
$isv_postback_dto = new IsvPostbackDTO;
$isv_postback_dto->report_type="1";
$isv_postback_dto->report_freq_type="1";
$isv_postback_dto->report_proportion="90";
$isv_postback_dto->delay_time="10";
$isv_postback_dto->filter_fee="100.05";
$isv_ad_plan_dto->isv_postback_dto = $isv_postback_dto;
$isv_assist_dto = new IsvAssistDTO;
$isv_assist_dto->assist_type="1";
$isv_ad_plan_dto->isv_assist_dto = $isv_assist_dto;
$isv_ad_plan_dto->report_switch="1";
$req->setIsvAdPlanDto(json_encode($isv_ad_plan_dto));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.alihealth.yt.wt.ad.plan.save' \
-d 'partner_id=apidoc' \
-d 'sign=65AF870B61EFC16426230C5616BB69DF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+16%3A44%3A11' \
-d 'v=2.0' \
-d 'isv_ad_plan_dto=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaAlihealthYtWtAdPlanSaveRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.isv_ad_plan_dto="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.alihealth.yt.wt.ad.plan.save");
add_param(pRequest,"isv_ad_plan_dto","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.alihealth.yt.wt.ad.plan.save', {
	'isv_ad_plan_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_yt_wt_ad_plan_save_response>
    <result>
        <success>true</success>
        <model>
            <id>1</id>
            <exposure_monitor_url>http://</exposure_monitor_url>
            <click_monitor_url>http://</click_monitor_url>
            <deep_link>tbopen://</deep_link>
            <track_url>http://</track_url>
        </model>
        <msg_info>null</msg_info>
        <msg_code>null</msg_code>
    </result>
</alibaba_alihealth_yt_wt_ad_plan_save_response>

{
    "alibaba_alihealth_yt_wt_ad_plan_save_response":{
        "result":{
            "success":true,
            "model":{
                "id":1,
                "exposure_monitor_url":"http:\/\/",
                "click_monitor_url":"http:\/\/",
                "deep_link":"tbopen:\/\/",
                "track_url":"http:\/\/"
            },
            "msg_info":"null",
            "msg_code":"null"
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案
system-busy	系统繁忙	请联系技术支持
service-unavailable	服务不可用	请联系技术支持
visit-busy	访问频繁	降低访问频次
invalid-parameters	广告信息配置错误	根据文档提示填写
invalid-attribution	归因配置错误	根据文档提示填写
invalid-report	回传配置错误	根据文档提示填写
invalid-assist	助攻配置错误	根据文档提示填写

API测试工具错误码查询工具 SDK下载

DSP-API

alibaba.alihealth.yt.wt.ad.plan.save (阿里健康外投广告计划创建变更)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ