文档中心 > API类目 > miniapp开放API

taobao.miniapp.distribution.material.get (小程序投放---读取投放入口素材信息)

读取已录入的投放入口素材信息。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
material_request MiniAppEntranceMaterialBizOpenDTO 必须 投放入口素材信息
  • └ app_id
  • Number
  • 必须
  • 300002222222
  • 对应的可投放的小程序id
  • └ material_id_list
  • Number []
  • 必须
  • 1,2
  • 素材id列表

响应参数

名称 类型 示例值 描述
material_success Boolean true 调用是否成功
material_error_code String 1000 错误码
model Model [] {} 素材信息
  • └ id
  • Number
  • 1
  • 素材id
  • └ name
  • String
  • 测试素材
  • 素材名字
  • └ app_id
  • Number
  • 322222
  • 小程序appid
  • └ card_id
  • Number
  • 22
  • 支持的投放入口卡片id
  • └ scene_id
  • Number
  • 16
  • 支持的投放入口场景id
  • └ data_str
  • String
  • {"x":"y"}
  • 场景卡片对应的动态表单内容
  • └ path
  • String
  • pages/index
  • 素材对应的页面路径
  • └ q_params_value_str
  • String
  • {"b":"x"}
  • 素材对应的页面参数值:全局参数值
  • └ p_params_value_str
  • String
  • {"z":"d"}
  • 素材对应的页面参数值:页面参数值
material_error_message String 读取失败 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
MiniappDistributionMaterialGetRequest req = new MiniappDistributionMaterialGetRequest();
MiniappDistributionMaterialGetRequest.MiniAppEntranceMaterialBizOpenDTO obj1 = new MiniappDistributionMaterialGetRequest.MiniAppEntranceMaterialBizOpenDTO();
obj1.setAppId(300002222222L);
obj1.setMaterialIdList(new Long[] { 1,2 };
);
req.setMaterialRequest(obj1);
MiniappDistributionMaterialGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<miniapp_distribution_material_get_response>
    <material_success>true</material_success>
    <material_error_code>1000</material_error_code>
    <model>
        <model>
            <id>1</id>
            <name>测试素材</name>
            <app_id>322222</app_id>
            <card_id>22</card_id>
            <scene_id>16</scene_id>
            <data_str>{&quot;x&quot;:&quot;y&quot;}</data_str>
            <path>pages/index</path>
            <q_params_value_str>{&quot;b&quot;:&quot;x&quot;}</q_params_value_str>
            <p_params_value_str>{&quot;z&quot;:&quot;d&quot;}</p_params_value_str>
        </model>
    </model>
    <material_error_message>读取失败</material_error_message>
</miniapp_distribution_material_get_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

FAQ

返回
顶部