文档中心 > API类目 > 阿里妈妈-UniDesk

taobao.unidesk.rta.ad.raise.get (一键起量-信息查询)

一键起量-信息查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
adgroup_raise_top_dto AdgroupRaiseTopDTO 可选 查询参数
  • └ adgroup_id
  • Number
  • 可选
  • 1
  • 计划id 只支持字节2.0
  • └ advertiser_id
  • Number
  • 可选
  • 1
  • 广告主id

响应参数

名称 类型 示例值 描述
result AdgroupRaiseTopDTO 起量数据
  • └ advertiser_id
  • Number
  • 1
  • 广告主ID
  • └ adgrou_id
  • Number
  • 1
  • 计划id
  • toutiao_raise_info_v2
  • Long []
  • {}
  • 起量信息
  • └ raise_budget
  • Number
  • 1
  • 起量预算,单位分
  • └ effective
  • Number
  • 1
  • 是否立即生效,仅支持广告状态为“投放中”的广告,仅支持1个方案设置“立即生效”
  • └ repeated_day
  • String
  • [EVERY_DAY]
  • 重复周期,仅生效一次。不传则不重复,传入EVERY_DAY则每天重复 允许值:PER_MONDAY;PER_TUESDAY;PER_WEDNESDAY;PER_THURSDAY;PER_FRIDAY:PER_SATURDAY;PER_SUNDAY; EVERY_DAY EVERY_DAY和其他允许值不可同时传入
  • └ raise_time
  • String
  • 2023-01-01 00:00
  • 起量时间 重复周期不传时,格式为yyyy-mm-dd HH:MM 传重复周期时,格式为HH:MM

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
UnideskRtaAdRaiseGetRequest req = new UnideskRtaAdRaiseGetRequest();
UnideskRtaAdRaiseGetRequest.AdgroupRaiseTopDTO obj1 = new UnideskRtaAdRaiseGetRequest.AdgroupRaiseTopDTO();
obj1.setAdgroupId(1L);
obj1.setAdvertiserId(1L);
req.setAdgroupRaiseTopDto(obj1);
UnideskRtaAdRaiseGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<unidesk_rta_ad_raise_get_response>
    <result>
        <advertiser_id>1</advertiser_id>
        <adgrou_id>1</adgrou_id>
        <toutiao_raise_info_v2>
            <long>
                <raise_budget>1</raise_budget>
                <effective>1</effective>
                <repeated_day>[EVERY_DAY]</repeated_day>
                <raise_time>2023-01-01 00:00</raise_time>
            </long>
        </toutiao_raise_info_v2>
    </result>
</unidesk_rta_ad_raise_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

返回
顶部