/pb/openapi/newad/hsaQueryWordReports{
"operation": {
"method": "POST",
"path": "/pb/openapi/newad/hsaQueryWordReports"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 10,
"text": ""
},
"requestExample": {
"sid": 109,
"report_date": "2022-06-01",
"target_type": "target",
"nextToken": "MQ==",
"length": 15
},
"responseExample": {
"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": 144272087511089300,
"match_type": "EXACT",
"target_text": "laptop stand",
"ad_group_id": 144329503293620480,
"impressions": 224,
"clicks": 1,
"cost": 1.03,
"profile_id": 121923590660074,
"campaign_id": 144264775656379200,
"report_date": "2021-06-23",
"same_orders": 0,
"orders": 0,
"same_sales": 0,
"sales": 0,
"new_to_brand_orders": 0,
"new_to_brand_order_percentage": 0,
"new_to_brand_order_rate": 0,
"new_to_brand_sales": 0,
"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
}
]
}
}| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | sid | 店铺id | integer | — | 可选 | 店铺id ,对应查询亚马逊店铺列表接口对应字段【sid】,sid跟profile_id其中一个必填 |
| 2 | profile_id | VC广告店铺profile_id | integer | — | 可选 | VC广告店铺profile_id,对应查询广告账号列表接口对应字段【profile_id】,sid跟profile_id其中一个必填 |
| 3 | report_date | 报表日期 | string | — | 必填 | 报表日期 |
| 4 | target_type | 投放类型【默认 keyword】 | string | — | 可选 | 投放类型【默认 keyword】:keyword 关键词,target 商品投放 |
| 5 | nextToken | 游标翻页 | string | — | 可选 | 游标翻页,首次请求不传,后续传上次响应中的 nextToken,和 offset 二选一 |
| 6 | offset | 分页偏移量 | integer | — | 可选 | 分页偏移量,默认0,和 nextToken 二选一 |
| 7 | length | 分页条数 | integer | — | 可选 | 分页条数,默认15 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 状态码 | integer | 0 | 必填 | 状态码,0 成功 |
| 2 | message | 消息提示 | string | 操作成功 | 必填 | 消息提示 |
| 3 | error_details | 错误信息 | array<any> | — | 必填 | 错误信息 |
| 4 | request_id | 请求链路id | string | 52688b81-2398-4e60-9617-619fc2cf5b1e | 必填 | 请求链路id |
| 5 | response_time | 响应时间 | string | 2023-03-20 10:14:22 | 必填 | 响应时间 |
| 6 | total | 总数 | integer | 3 | 必填 | 总数 |
| 7 | nextToken | 下一页游标 | string | MQ== | 可选 | 下一页游标,无更多数据时为空 |
| 8 | data | 响应数据 | array<object> | — | 必填 | 响应数据 |
| 8.1 | query | 搜索词 | string | laptop stand | 必填 | 搜索词 |
| 8.2 | target_id | target_id | number | 144272087511089300 | 必填 | 投放id(关键词/商品投放 根据target_type) |
| 8.3 | match_type | 匹配类型 | string | EXACT | 可选 | 匹配类型,仅 target_type=keyword 时返回 |
| 8.4 | target_text | 投放的内容 | string | laptop stand | 必填 | 投放的内容 |
| 8.5 | is_asin | 是否为 ASIN 商品投放(0 | integer | 0 | 可选 | 是否为 ASIN 商品投放(0:否,1:是),仅 target_type=target 时返回 |
| 8.6 | ad_group_id | 广告组id | number | 144329503293620480 | 必填 | 广告组id |
| 8.7 | impressions | 展示量 | number | 224 | 必填 | 展示量 |
| 8.8 | clicks | 点击量 | number | 1 | 必填 | 点击量 |
| 8.9 | cost | 花费 | number | 1.03 | 必填 | 花费 |
| 8.10 | profile_id | 亚马逊店铺数字id | number | 121923590660074 | 必填 | 亚马逊店铺数字id |
| 8.11 | campaign_id | 广告活动id | number | 144264775656379200 | 必填 | 广告活动id |
| 8.12 | report_date | 报表日期 | string | 2021-06-23 | 必填 | 报表日期 |
| 8.13 | country | 国家 | string | US | 可选 | 国家,仅 target_type=target 时返回 |
| 8.14 | same_orders | 直接成交订单数 | number | 0 | 可选 | 直接成交订单数,仅 target_type=keyword 时返回 |
| 8.15 | orders | 订单数 | number | 0 | 必填 | 订单数 |
| 8.16 | same_sales | 直接成交销售额 | number | 0 | 可选 | 直接成交销售额,仅 target_type=keyword 时返回 |
| 8.17 | sales | 销售额 | number | 0 | 必填 | 销售额 |
| 8.18 | view_orders | 浏览后归因订单数 | number | 0 | 可选 | 浏览后归因订单数,仅 target_type=target 时返回 |
| 8.19 | view_sales | 浏览后归因销售额 | number | 0 | 可选 | 浏览后归因销售额,仅 target_type=target 时返回 |
| 8.20 | units_ordered | 点击归因销量 | number | 0 | 可选 | 点击归因销量,仅 target_type=target 时返回 |
| 8.21 | view_units_ordered | 浏览后归因销量 | number | 0 | 可选 | 浏览后归因销量,仅 target_type=target 时返回 |
| 8.22 | new_to_brand_orders | 品牌新买家订单数量 | number | 0 | 可选 | 品牌新买家订单数量,仅 target_type=keyword 时返回 |
| 8.23 | new_to_brand_order_percentage | 品牌新买家订单百分比 | number | 0 | 可选 | 品牌新买家订单百分比,仅 target_type=keyword 时返回 |
| 8.24 | new_to_brand_order_rate | 品牌新买家转换率 | number | 0 | 可选 | 品牌新买家转换率,仅 target_type=keyword 时返回 |
| 8.25 | new_to_brand_sales | 品牌新买家销售额 | number | 0 | 可选 | 品牌新买家销售额,仅 target_type=keyword 时返回 |
| 8.26 | new_to_brand_units | 品牌新买家销量 | number | 0 | 可选 | 品牌新买家销量,仅 target_type=keyword 时返回 |
| 8.27 | viewable_impressions | 可视展示量 | integer | 0 | 可选 | 可视展示量,仅 target_type=target 时返回 |
| 8.28 | add_to_list | 加入购物清单次数(合计) | integer | 0 | 可选 | 加入购物清单次数(合计),仅 target_type=target 时返回 |
| 8.29 | add_to_list_from_clicks | 通过点击加入购物清单次数 | integer | 0 | 可选 | 通过点击加入购物清单次数,仅 target_type=target 时返回 |
| 8.30 | video_first_quartile_views | 播放25%的次数 | integer | 0 | 必填 | 播放25%的次数 |
| 8.31 | video_midpoint_views | 播放50%的次数 | integer | 0 | 必填 | 播放50%的次数 |
| 8.32 | video_third_quartile_views | 播放75%的次数 | integer | 0 | 必填 | 播放75%的次数 |
| 8.33 | video_complete_views | 播放100%的次数 | integer | 0 | 必填 | 播放100%的次数 |
| 8.34 | video_5_second_views | 观看完整视频或 5 秒(以较短者为准)的展示次数 | integer | 0 | 必填 | 观看完整视频或 5 秒(以较短者为准)的展示次数 |
| 8.35 | video_5_second_view_rate | video_5_second_view_rate | number | 0 | 必填 | 观看完整视频或 5 秒(以较短者为准)的展示次数百分比 |
| 8.36 | video_unmutes | 取消视频静音的展示次数 | integer | 0 | 必填 | 取消视频静音的展示次数 |
领星ERP的接口:SB用户搜索词报表(/pb/openapi/newad/hsaQueryWordReports),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。