文档中心 > API类目 > 天猫精灵开放API

taobao.ailab.aicloud.top.desktop.card.config (桌面卡片数据上传接口)

定制机B端用户需要配置部分坑位的卡片数据，将桌面卡片中的部分数据展示为此用户期望展示的数据。

公共参数

请求地址：

环境	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。

请求参数

名称	类型	是否必须	描述
open_base_info	OpenBaseInfo	必须	基本参数
└ schema String 可选 36653b6e-f41a-11e6-bc64- 92361f002671 账户体系隔离 └ ext String 可选 {"appType":"device","appVersion": "1.0"} 扩展信息 └ utd_id String 可选 V944n0HrnZ4DAAtOStvvDat7 用户设备唯一识别码 └ user_id String 可选 13911112222 用户ID，此处传入第三方账户体系的用户
desktop_info	DesktopInfo	必须	上传的桌面的信息
└ mode byte 可选 1 模式，0-成人模式，1-儿童模式 cards DesktopCardExternalDTO [] 必须 [ { "effectiveStartTime": 1590744347000, "picUrl": "https://ailabs.alibabausercontent.com/karsfgmh/6318f21c-0dc9-4413-897a-d8ce2b05a86e.jpeg", "shortPicUrl": "https://ailabs.alibabausercontent.com/karsfgmh/6318f21c-0dc9-4413-897a-d8ce2b05a86e.jpeg", "jumpUri": "", "subTitle": "社会热点", "promptCorpus": "天猫精灵，你好", "effectiveEndTime": 1590744347999, "title": "社会热点" } ] 上传的桌面卡片的详细信息的列表 └ pic_url String 可选 https://ailabs.alibabausercontent.com/karsfgmh/6318f21c-0dc9-4413-897a-d8ce2b05a86e.jpeg 卡片图地址(远距) └ short_pic_url String 可选 https://ailabs.alibabausercontent.com/karsfgmh/6318f21c-0dc9-4413-897a-d8ce2b05a86e.jpeg 卡片图地址(近距，可空，复用远距图) └ jump_uri String 可选 https://ailabs.alibabausercontent.com/karsfgmh/6318f21c-0dc9-4413-897a-d8ce2b05a86e.jpeg 卡片跳转uri └ title String 可选主标题主标题 └ sub_title String 可选副标题副标题 └ prompt_corpus String 可选精灵说精灵说 └ effective_start_time Number 可选 1596544635000 生效起始时间 └ effective_end_time Number 可选 1596544635000 生效结束时间 └ data_pool_code String 可选 ops 第三方的数据池唯一标识

响应参数

名称	类型	示例值	描述
result	BaseResult	{}	返回包装类
ret_value DesktopUploadResponse {"batchId":"12345"} 上传的结果 └ batch_id String 12345 上传的批次的id └ ret_code Number 错误码上传出错的错误码, 1-上传成功，3000-参数错误，4015-资源错误，5001-服务器内部错误 └ ret_msg String 错误信息上传出错的错误信息

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AilabAicloudTopDesktopCardConfigRequest req = new AilabAicloudTopDesktopCardConfigRequest();
AilabAicloudTopDesktopCardConfigRequest.OpenBaseInfo obj1 = new AilabAicloudTopDesktopCardConfigRequest.OpenBaseInfo();
obj1.setSchema("36653b6e-f41a-11e6-bc64- 92361f002671");
obj1.setExt("{\"appType\":\"device\",\"appVersion\": \"1.0\"}");
obj1.setUtdId("V944n0HrnZ4DAAtOStvvDat7");
obj1.setUserId("13911112222");
req.setOpenBaseInfo(obj1);
AilabAicloudTopDesktopCardConfigRequest.DesktopInfo obj2 = new AilabAicloudTopDesktopCardConfigRequest.DesktopInfo();
obj2.setMode("1");
List<AilabAicloudTopDesktopCardConfigRequest.DesktopCardExternalDTO> list4 = new ArrayList<AilabAicloudTopDesktopCardConfigRequest.DesktopCardExternalDTO>();
AilabAicloudTopDesktopCardConfigRequest.DesktopCardExternalDTO obj5 = new AilabAicloudTopDesktopCardConfigRequest.DesktopCardExternalDTO();
list4.add(obj5);
obj5.setPicUrl("https://ailabs.alibabausercontent.com/karsfgmh/6318f21c-0dc9-4413-897a-d8ce2b05a86e.jpeg");
obj5.setShortPicUrl("https://ailabs.alibabausercontent.com/karsfgmh/6318f21c-0dc9-4413-897a-d8ce2b05a86e.jpeg");
obj5.setJumpUri("https://ailabs.alibabausercontent.com/karsfgmh/6318f21c-0dc9-4413-897a-d8ce2b05a86e.jpeg");
obj5.setTitle("主标题");
obj5.setSubTitle("副标题");
obj5.setPromptCorpus("精灵说");
obj5.setEffectiveStartTime(1596544635000L);
obj5.setEffectiveEndTime(1596544635000L);
obj2.setCards(list4);
obj2.setDataPoolCode("ops");
req.setDesktopInfo(obj2);
AilabAicloudTopDesktopCardConfigResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<ailab_aicloud_top_desktop_card_config_response>
    <result>
        <ret_value>
            <batch_id>12345</batch_id>
        </ret_value>
        <ret_code>错误码</ret_code>
        <ret_msg>错误信息</ret_msg>
    </result>
</ailab_aicloud_top_desktop_card_config_response>

异常示例

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>

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

天猫精灵开放API

taobao.ailab.aicloud.top.desktop.card.config (桌面卡片数据上传接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ