/pb/openapi/newad/listHsaKeywordPlacementReport{
"operation": {
"method": "POST",
"path": "/pb/openapi/newad/listHsaKeywordPlacementReport"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 10,
"text": ""
},
"requestExample": {
"sid": 109,
"sponsored_type": "ALL",
"target_type": "keyword",
"report_date": "2022-06-01",
"offset": 0,
"length": 15
}
}| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | next_token | 分页游标 | string | — | Optional | 分页游标,使用上次响应中的 next_token。首次请求无需传入;与 offset 同时传入时,以 next_token 为准 |
| 2 | sid | 店铺id | integer | — | Required | 店铺id ,对应查询亚马逊店铺列表接口对应字段【sid】 |
| 3 | profile_id | VC广告店铺profile_id | integer | — | Required | VC广告店铺profile_id,对应查询广告账号列表接口对应字段【profile_id】,sid跟profile_id其中一个必填 |
| 4 | sponsored_type | 广告类型 | string | — | Required | 广告类型: ALL |
| 5 | target_type | 投放类型 | string | — | Required | 投放类型: keyword |
| 6 | report_date | 报告日期 | string | — | Required | 报告日期,格式:Y-m-d |
| 7 | offset | 分页偏移量 | integer | — | Optional | 分页偏移量,默认0 |
| 8 | length | 分页长度 | integer | — | Optional | 分页长度,默认15 |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | next_token | 分页游标 | string | ODAwMDAwMDAwMDAwMDAyNDE3 | Required | 分页游标,作为 next_token 传入下一次请求 |
| 2 | code | 状态码 | integer | 0 | Required | 状态码,0 成功 |
| 3 | message | 提示消息 | string | 操作成功 | Required | 提示消息 |
| 4 | error_details | 错误信息 | array<any> | — | Required | 错误信息 |
| 5 | request_id | 请求链路id | string | nd8492d4-7a15-11ed-b162-0242ac1c0004 | Required | 请求链路id |
| 6 | response_time | 响应时间 | string | 2022-11-03 14:09:15 | Required | 响应时间 |
| 7 | total | 总数 | integer | 1 | Required | 总数 |
| 8 | data | 响应数据 | array<object> | — | Required | 响应数据 |
| 8.1 | report_date | 报告日期 | string | 2019-10-20 | Required | 报告日期 |
| 8.2 | profile_id | 亚马逊店铺数字id | number | — | Required | 亚马逊店铺数字id |
| 8.3 | match_type | 匹配方式 | string | — | Required | 匹配方式 |
| 8.4 | keyword_id | 关键词id | number | — | Required | 关键词id |
| 8.5 | keyword_text | 关键词内容 | string | — | Required | 关键词内容 |
| 8.6 | campaign_id | 广告活动id | number | — | Required | 广告活动id |
| 8.7 | clicks | 点击 | number | — | Required | 点击 |
| 8.8 | cost | 花费 | number | — | Required | 花费 |
| 8.9 | impressions | 曝光 | number | — | Required | 曝光 |
| 8.10 | orders | 订单数 | number | — | Required | 订单数 |
| 8.11 | new_to_brand_orders | 品牌新买家订单数量 | number | — | Required | 品牌新买家订单数量 |
| 8.12 | new_to_brand_units | 品牌新买家销量 | number | — | Required | 品牌新买家销量 |
| 8.13 | new_to_brand_order_percentage | 品牌新买家订单百分比 | number | — | Required | 品牌新买家订单百分比 |
| 8.14 | new_to_brand_order_rate | 品牌新买家转换率 | number | — | Required | 品牌新买家转换率 |
| 8.15 | new_to_brand_sales | 品牌新买家销售额 | number | — | Required | 品牌新买家销售额 |
| 8.16 | sales | 销售额 | number | — | Required | 销售额 |
| 8.17 | creative_type | 广告类型 | string | SB | Required | 广告类型: default=》SB video=》SBV |
| 8.18 | placement_type | 广告位类型 | integer | 1 | Required | 广告位类型: 1 Other Placements 2 Other on-Amazon 3 Top of Search |
The SB关键词 - 广告位报告 API (/pb/openapi/newad/listHsaKeywordPlacementReport) of 领星ERP is curated by the API asset management module of the Qeasy Cloud data integration platform and kept in sync with 领星ERP version updates.
Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.