阿里大于 -

请求地址：

环境	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_ocpx_effect_request	IsvOcpxEffectDataRequest	必须			效果数据查询参数
└ channel_id Number 必须 1 渠道id └ seller_id Number 必须 782361 商家id └ advertiser_ids String 必须 111,222 广告账户列表，英文逗号分隔 └ data_type Number 必须 1 数据类型，1：媒体坑位数据 └ start_ds Number 必须 20241101 开始日期,格式为YYYYMMDD └ end_ds Number 必须 20241111 结束日期，最大范围不超过30天 └ page Number 必须 1 页码 └ page_size Number 必须 20 页大小

名称	类型	示例值	描述
result	Result		Result
└ success Boolean true true表示成功 model PagedResult 效果分页数据 └ page_count Number 10 页数 └ total_num Number 100 总数 data_list IsvOcpxEffectDataDto [] 效果数据列表 └ channel_id Number 1 渠道 └ seller_id Number 1234 商家id └ advertiser_id Number 1234 广告主id └ advertiser_name String 测试11 广告主名称 └ ds Number 20241111 日期 └ data_type Number 1 数据类型 └ data_scene String 抖音数据场景，dataType为1时表示坑位 └ fields String {"exp_pv":1,"gmv":110} 指标数据json └ msg_code String 错误码错误码 └ msg_info String 错误信息错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest req = new AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest();
AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest.IsvOcpxEffectDataRequest obj1 = new AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest.IsvOcpxEffectDataRequest();
obj1.setChannelId(1L);
obj1.setSellerId(782361L);
obj1.setAdvertiserIds("111,222");
obj1.setDataType(1L);
obj1.setStartDs(20241101L);
obj1.setEndDs(20241111L);
obj1.setPage(1L);
obj1.setPageSize(20L);
req.setIsvOcpxEffectRequest(obj1);
AlibabaAlihealthYtWtMediaOcpxEffectQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest req = new AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest();
AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest.IsvOcpxEffectDataRequestDomain obj1 = new AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest.IsvOcpxEffectDataRequestDomain();
obj1.ChannelId = 1L;
obj1.SellerId = 782361L;
obj1.AdvertiserIds = "111,222";
obj1.DataType = 1L;
obj1.StartDs = 20241101L;
obj1.EndDs = 20241111L;
obj1.Page = 1L;
obj1.PageSize = 20L;
req.IsvOcpxEffectRequest_ = obj1;
AlibabaAlihealthYtWtMediaOcpxEffectQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthYtWtMediaOcpxEffectQueryRequest;
$isv_ocpx_effect_request = new IsvOcpxEffectDataRequest;
$isv_ocpx_effect_request->channel_id="1";
$isv_ocpx_effect_request->seller_id="782361";
$isv_ocpx_effect_request->advertiser_ids="111,222";
$isv_ocpx_effect_request->data_type="1";
$isv_ocpx_effect_request->start_ds="20241101";
$isv_ocpx_effect_request->end_ds="20241111";
$isv_ocpx_effect_request->page="1";
$isv_ocpx_effect_request->page_size="20";
$req->setIsvOcpxEffectRequest(json_encode($isv_ocpx_effect_request));
$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.media.ocpx.effect.query' \
-d 'partner_id=apidoc' \
-d 'sign=6505FD88CEF1C38471B68B364518978E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+14%3A58%3A57' \
-d 'v=2.0' \
-d 'isv_ocpx_effect_request=null'

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

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

req.isv_ocpx_effect_request="数据结构示例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.media.ocpx.effect.query");
add_param(pRequest,"isv_ocpx_effect_request","数据结构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.media.ocpx.effect.query', {
	'isv_ocpx_effect_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_yt_wt_media_ocpx_effect_query_response>
    <result>
        <success>true</success>
        <model>
            <page_count>10</page_count>
            <total_num>100</total_num>
            <data_list>
                <isv_ocpx_effect_data_dto>
                    <channel_id>1</channel_id>
                    <seller_id>1234</seller_id>
                    <advertiser_id>1234</advertiser_id>
                    <advertiser_name>测试11</advertiser_name>
                    <ds>20241111</ds>
                    <data_type>1</data_type>
                    <data_scene>抖音</data_scene>
                    <fields>{&quot;exp_pv&quot;:1,&quot;gmv&quot;:110}</fields>
                </isv_ocpx_effect_data_dto>
            </data_list>
        </model>
        <msg_code>错误码</msg_code>
        <msg_info>错误信息</msg_info>
    </result>
</alibaba_alihealth_yt_wt_media_ocpx_effect_query_response>

{
    "alibaba_alihealth_yt_wt_media_ocpx_effect_query_response":{
        "result":{
            "success":true,
            "model":{
                "page_count":10,
                "total_num":100,
                "data_list":{
                    "isv_ocpx_effect_data_dto":[
                        {
                            "channel_id":1,
                            "seller_id":1234,
                            "advertiser_id":1234,
                            "advertiser_name":"测试11",
                            "ds":20241111,
                            "data_type":1,
                            "data_scene":"抖音",
                            "fields":"{\"exp_pv\":1,\"gmv\":110}"
                        }
                    ]
                }
            },
            "msg_code":"错误码",
            "msg_info":"错误信息"
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案

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

DSP-API

alibaba.alihealth.yt.wt.media.ocpx.effect.query (阿里健康广告站外投放OCPX效果数据查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ