文档中心 > API类目 > 国际站外贸直通车操作

alibaba.scbp.ad.report.query.keyword.effect (关键词报告)

关键词报告

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
top_context TopContextDto 必须 用户信息
  • └ product_line_id
  • Number
  • 必须
  • 110101
  • 产品线id
  • └ product_id
  • Number
  • 可选
  • 110101010
  • 产品id
keyword_report_operation KeywordReportOperationDto 必须 请求参数
  • └ keyword
  • String
  • 可选
  • test
  • 效果报告模糊搜索关键词
  • └ keyword_list
  • String []
  • 可选
  • []
  • 精确搜索关键词
  • └ get_detail_data
  • String
  • 可选
  • true
  • 获取明细数据("true"/"false"),如果为"true"则为明细数据
  • └ date_begin
  • String
  • 可选
  • 2021-01-01
  • 开始时间(yyyy-MM-dd)
  • └ date_end
  • String
  • 必须
  • 2021-01-01
  • 结束时间(yyyy-MM-dd)
  • └ date_range
  • Number
  • 必须
  • 3
  • 时间段
  • └ campaign_type
  • Number
  • 可选
  • 1
  • 营销目标
  • └ campaign_id
  • Number
  • 可选
  • 1
  • 计划ID
  • └ order_field
  • String
  • 可选
  • impr
  • 排序字段(impr/click/ctr/cost/cpc)
  • └ order_type
  • String
  • 可选
  • asc
  • 排序方式(asc/desc)
  • └ page_size
  • Number
  • 必须
  • 10
  • 分页数量
  • └ page_index
  • Number
  • 必须
  • 1
  • 页码

响应参数

名称 类型 示例值 描述
result KeywordReportDto {} 返回数据
  • └ total_count
  • Number
  • 10
  • 总数目
  • keyword_effect_list
  • KeywordEffectDto []
  • []
  • 返回数据详情
  • └ keyword
  • String
  • test
  • 关键词
  • └ stat_date
  • String
  • 2021-01-01
  • 日期(yyyy-MM-dd)
  • └ impr
  • Number
  • 1
  • 曝光
  • └ click
  • Number
  • 1
  • 点击
  • └ cost
  • Number
  • 1
  • 消耗
  • └ online_min
  • Number
  • 1
  • 推广时长

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaScbpAdReportQueryKeywordEffectRequest req = new AlibabaScbpAdReportQueryKeywordEffectRequest();
AlibabaScbpAdReportQueryKeywordEffectRequest.TopContextDto obj1 = new AlibabaScbpAdReportQueryKeywordEffectRequest.TopContextDto();
obj1.setProductLineId(110101L);
obj1.setProductId(110101010L);
req.setTopContext(obj1);
AlibabaScbpAdReportQueryKeywordEffectRequest.KeywordReportOperationDto obj2 = new AlibabaScbpAdReportQueryKeywordEffectRequest.KeywordReportOperationDto();
obj2.setKeyword("test");
obj2.setKeywordList("");
obj2.setGetDetailData("true");
obj2.setDateBegin("2021-01-01");
obj2.setDateEnd("2021-01-01");
obj2.setDateRange(3L);
obj2.setCampaignType(1L);
obj2.setCampaignId(1L);
obj2.setOrderField("impr");
obj2.setOrderType("asc");
obj2.setPageSize(10L);
obj2.setPageIndex(1L);
req.setKeywordReportOperation(obj2);
AlibabaScbpAdReportQueryKeywordEffectResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_scbp_ad_report_query_keyword_effect_response>
    <result>
        <total_count>10</total_count>
        <keyword_effect_list>
            <keyword_effect_dto>
                <keyword>test</keyword>
                <stat_date>2021-01-01</stat_date>
                <impr>1</impr>
                <click>1</click>
                <cost>1</cost>
                <online_min>1</online_min>
            </keyword_effect_dto>
        </keyword_effect_list>
    </result>
</alibaba_scbp_ad_report_query_keyword_effect_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

返回
顶部