Lingxing
切换旧版

SB用户搜索词报表

POST/pb/openapi/newad/hsaQueryWordReports

基本信息

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

请求头

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

请求参数

sidinteger
店铺id ，对应查询亚马逊店铺列表接口对应字段【sid】，sid跟profile_id其中一个必填
profile_idinteger
VC广告店铺profile_id，对应查询广告账号列表接口对应字段【profile_id】，sid跟profile_id其中一个必填
report_datestring必填
报表日期
target_typestring
投放类型【默认 keyword】：keyword 关键词，target 商品投放
nextTokenstring
游标翻页，首次请求不传，后续传上次响应中的 nextToken，和 offset 二选一
offsetinteger
分页偏移量，默认0，和 nextToken 二选一
lengthinteger
分页条数，默认15

请求示例

{
    "sid": 109,
    "report_date": "2022-06-01",
    "target_type": "target",
    "nextToken": "MQ==",
    "length": 15
}

返回结果

Json Object

codeinteger必填
状态码，0 成功
示例 0
messagestring必填
消息提示
示例 操作成功
error_detailsarray<any>必填
错误信息
request_idstring必填
请求链路id
示例 52688b81-2398-4e60-9617-619fc2cf5b1e
response_timestring必填
响应时间
示例 2023-03-20 10:14:22
totalinteger必填
总数
示例 3
nextTokenstring
下一页游标，无更多数据时为空
示例 MQ==
dataarray<object>必填
响应数据
隐藏子属性
querystring必填
搜索词
示例 laptop stand
target_idnumber必填
投放id（关键词/商品投放 根据target_type）
示例 144272087511089300
match_typestring
匹配类型，仅 target_type=keyword 时返回
示例 EXACT
target_textstring必填
投放的内容
示例 laptop stand
is_asininteger
是否为 ASIN 商品投放（0：否，1：是），仅 target_type=target 时返回
示例 0
ad_group_idnumber必填
广告组id
示例 144329503293620480
impressionsnumber必填
展示量
示例 224
clicksnumber必填
点击量
示例 1
costnumber必填
花费
示例 1.03
profile_idnumber必填
亚马逊店铺数字id
示例 121923590660074
campaign_idnumber必填
广告活动id
示例 144264775656379200
report_datestring必填
报表日期
示例 2021-06-23
countrystring
国家，仅 target_type=target 时返回
示例 US
same_ordersnumber
直接成交订单数，仅 target_type=keyword 时返回
示例 0
ordersnumber必填
订单数
示例 0
same_salesnumber
直接成交销售额，仅 target_type=keyword 时返回
示例 0
salesnumber必填
销售额
示例 0
view_ordersnumber
浏览后归因订单数，仅 target_type=target 时返回
示例 0
view_salesnumber
浏览后归因销售额，仅 target_type=target 时返回
示例 0
units_orderednumber
点击归因销量，仅 target_type=target 时返回
示例 0
view_units_orderednumber
浏览后归因销量，仅 target_type=target 时返回
示例 0
new_to_brand_ordersnumber
品牌新买家订单数量，仅 target_type=keyword 时返回
示例 0
new_to_brand_order_percentagenumber
品牌新买家订单百分比，仅 target_type=keyword 时返回
示例 0
new_to_brand_order_ratenumber
品牌新买家转换率，仅 target_type=keyword 时返回
示例 0
new_to_brand_salesnumber
品牌新买家销售额，仅 target_type=keyword 时返回
示例 0
new_to_brand_unitsnumber
品牌新买家销量，仅 target_type=keyword 时返回
示例 0
viewable_impressionsinteger
可视展示量，仅 target_type=target 时返回
示例 0
add_to_listinteger
加入购物清单次数（合计），仅 target_type=target 时返回
示例 0
add_to_list_from_clicksinteger
通过点击加入购物清单次数，仅 target_type=target 时返回
示例 0
video_first_quartile_viewsinteger必填
播放25%的次数
示例 0
video_midpoint_viewsinteger必填
播放50%的次数
示例 0
video_third_quartile_viewsinteger必填
播放75%的次数
示例 0
video_complete_viewsinteger必填
播放100%的次数
示例 0
video_5_second_viewsinteger必填
观看完整视频或 5 秒（以较短者为准）的展示次数
示例 0
video_5_second_view_ratenumber必填
观看完整视频或 5 秒（以较短者为准）的展示次数百分比
示例 0
video_unmutesinteger必填
取消视频静音的展示次数
示例 0

返回成功示例

target_type=keyword

{
    "code": 0,
    "message": "操作成功",
    "error_details": [],
    "request_id": "52688b81-2398-4e60-9617-619fc2cf5b1e",
    "response_time": "2023-03-20 10:14:22",
    "total": 3,
    "nextToken": "MjA=",
    "data": [
        {
            "query": "laptop stand",
            "target_id": 144272087511089322,
            "match_type": "EXACT",
            "target_text": "laptop stand",
            "ad_group_id": 144329503293620476,
            "impressions": 224,
            "clicks": 1,
            "cost": 1.03,
            "profile_id": 121923590660074,
            "campaign_id": 144264775656379188,
            "report_date": "2021-06-23",
            "same_orders": 0,
            "orders": 0,
            "same_sales": 0.00,
            "sales": 0.00,
            "new_to_brand_orders": 0,
            "new_to_brand_order_percentage": 0.00,
            "new_to_brand_order_rate": 0.00,
            "new_to_brand_sales": 0.00,
            "new_to_brand_units": 0,
            "video_first_quartile_views": null,
            "video_midpoint_views": null,
            "video_third_quartile_views": null,
            "video_complete_views": null,
            "video_5_second_views": null,
            "video_5_second_view_rate": null,
            "video_unmutes": null
        }
    ]
}

target_type=target

{
    "code": 0,
    "message": "操作成功",
    "error_details": [],
    "request_id": "52688b81-2398-4e60-9617-619fc2cf5b1e",
    "response_time": "2023-03-20 10:14:22",
    "total": 3,
    "nextToken": "MjA=",
    "data": [
        {
            "query": "laptop stand",
            "target_id": 144272087511089322,
            "target_text": "B08N5WRWNW",
            "is_asin": 1,
            "ad_group_id": 144329503293620476,
            "impressions": 224,
            "clicks": 1,
            "cost": 1.03,
            "profile_id": 121923590660074,
            "campaign_id": 144264775656379188,
            "report_date": "2021-06-23",
            "country": "US",
            "orders": 0,
            "sales": 0.00,
            "view_orders": 0,
            "view_sales": 0.00,
            "units_ordered": 0,
            "view_units_ordered": 0,
            "viewable_impressions": 0,
            "add_to_list": 0,
            "add_to_list_from_clicks": 0,
            "video_first_quartile_views": null,
            "video_midpoint_views": null,
            "video_third_quartile_views": null,
            "video_complete_views": null,
            "video_5_second_views": null,
            "video_5_second_view_rate": null,
            "video_unmutes": null
        }
    ]
}