Lingxing
切换旧版

SP关键词报表

POST/pb/openapi/newad/spKeywordReports

接口信息

API Path请求协议请求方式令牌桶容量
/pb/openapi/newad/spKeywordReportsHTTPSPOST10

请求头

标签必填说明类型示例
X-API-VERSION是【兼容旧版本】
不添加标签：offset 为分页页码，从1开始
值为 2 时：offset 为分页偏移量，从0开始		[int]2

请求参数

sidinteger必填
店铺id ，对应查询亚马逊店铺列表接口对应字段【sid】
profile_idinteger必填
VC广告店铺profile_id，对应查询广告账号列表接口对应字段【profile_id】，sid跟profile_id其中一个必填
report_datestring必填
报告日期，格式：Y-m-d
typestring
关键词类型，ALL-全部位置，AMAZON_BUSINESS-亚马逊企业购。默认为ALL
show_detailinteger
是否展示完整归因期信息【默认0】：0 否，1 是
offsetinteger
分页偏移量，默认0
lengthinteger
分页长度，默认15

请求示例

{
    "sid": 109,
    "report_date": "2022-06-01",
    "type": "AMAZON_BUSINESS",
    "show_detail": 1,
    "offset": 0,
    "length": 15
}

返回结果

Json Object

codeinteger必填
状态码，0 成功
示例 0
messagestring必填
提示消息
示例 操作成功
error_detailsarray<any>必填
错误信息
request_idstring必填
请求链路id
示例 DHJ9190-7404-9BDF-3F41-01F0401D1315
response_timestring必填
响应时间
示例 2023-02-17 09:59:19
totalinteger必填
总数
示例 1
dataarray<object>必填
响应数据
隐藏子属性
keyword_idnumber必填
关键词id
示例 123103176635249
match_typestring必填
匹配类型
示例 BROAD
keyword_textstring必填
关键词；
关键词组的报告请通过【SP商品定位报表】接口获取，SP商品定位报表中的target_id和SP商品定位基础数据中的target_id进行关联。
示例 23
ad_group_idnumber必填
广告组id
示例 224579317070677
impressionsnumber必填
展示量
示例 1
clicksnumber必填
点击量
示例 100
costnumber必填
花费
示例 22.33
report_datestring必填
报表日期
示例 2021-06-22
profile_idnumber必填
亚马逊店铺数字id
示例 121923590660074
campaign_idnumber必填
广告活动id
示例 25392773070857
same_ordersnumber必填
直接成交订单数
示例 10
same_orders_1dnumber必填
直接成交订单数(1d)【show_detail=1时返回字段】
示例 0
same_orders_7dnumber必填
直接成交订单数(7d)【show_detail=1时返回字段】
示例 0
same_orders_14dnumber必填
直接成交订单数(14d)【show_detail=1时返回字段】
示例 0
same_orders_30dnumber必填
直接成交订单数(30d)【show_detail=1时返回字段】
示例 0
ordersnumber必填
订单数
示例 0
orders_1dnumber必填
订单数(1d)【show_detail=1时返回字段】
示例 0
orders_7dnumber必填
订单数(7d)【show_detail=1时返回字段】
示例 0
orders_14dnumber必填
订单数(14d)【show_detail=1时返回字段】
示例 0
orders_30dnumber必填
订单数(30d)【show_detail=1时返回字段】
示例 0
same_salesnumber必填
直接成交销售额
示例 0
same_sales_1dnumber必填
直接成交销售额(1d)【show_detail=1时返回字段】
示例 0
same_sales_7dnumber必填
直接成交销售额(7d)【show_detail=1时返回字段】
示例 0
same_sales_14dnumber必填
直接成交销售额(14d)【show_detail=1时返回字段】
示例 0
same_sales_30dnumber必填
直接成交销售额(30d)【show_detail=1时返回字段】
示例 0
salesnumber必填
销售额
示例 0
sales_1dnumber必填
销售额(1d)【show_detail=1时返回字段】
示例 0
sales_7dnumber必填
销售额(7d)【show_detail=1时返回字段】
示例 0
sales_14dnumber必填
销售额(14d)【show_detail=1时返回字段】
示例 0
sales_30dnumber必填
销售额(30d)【show_detail=1时返回字段】
示例 0
unitsnumber必填
销量
示例 45
units_7dnumber必填
销量(7d)【show_detail=1时返回字段】
示例 0
units_1dnumber必填
销量(1d)【show_detail=1时返回字段】
示例 0
units_14dnumber必填
销量(14d)【show_detail=1时返回字段】
示例 0
units_30dnumber必填
销量(30d)【show_detail=1时返回字段】
示例 0
same_unitsnumber必填
直接成交销量
示例 78
same_units_1dnumber必填
直接成交量(1d)【show_detail=1时返回字段】
示例 0
same_units_7dnumber必填
直接成交量(7d)【show_detail=1时返回字段】
示例 0
same_units_14dnumber必填
直接成交量(14d)【show_detail=1时返回字段】
示例 0
same_units_30dnumber必填
直接成交订单数(30d)【show_detail=1时返回字段】
示例 0

返回成功示例

{
    "code": 0,
    "message": "操作成功",
    "error_details": [],
    "request_id": "DHJ9190-7404-9BDF-3F41-01F0401D1315",
    "response_time": "2023-02-17 09:59:19",
    "total": 124,
    "data": [
        {
            "keyword_id": 123103176635249,
            "match_type": "BROAD",
            "keyword_text": "23",
            "ad_group_id": 224579317070677,
            "impressions": 1,
            "clicks": 0,
            "cost": 0.00,
            "report_date": "2021-06-23",
            "profile_id": 121923590660074,
            "campaign_id": 25392773070857,
            "same_orders": 0,
            "orders": 0,
            "same_sales": 0.00,
            "sales": 0.00,
            "units": 0,
            "same_units": 0,
            "same_orders_7d": 0,
            "orders_7d": 0,
            "same_sales_7d": 0.00,
            "sales_7d": 0.00,
            "units_7d": 0,
            "same_units_7d": 0,
            "same_orders_1d": 0,
            "orders_1d": 0,
            "same_sales_1d": 0.00,
            "sales_1d": 0.00,
            "same_orders_30d": 0,
            "orders_30d": 0,
            "same_sales_30d": 0.00,
            "sales_30d": 0.00,
            "same_orders_14d": 0,
            "orders_14d": 0,
            "same_sales_14d": 0.00,
            "sales_14d": 0.00,
            "units_1d": 0,
            "units_14d": 0,
            "units_30d": 0,
            "same_units_1d": 0,
            "same_units_14d": 0,
            "same_units_30d": 0
        }
    ]
}