/pb/openapi/newad/queryWordReports{
"operation": {
"method": "POST",
"path": "/pb/openapi/newad/queryWordReports"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 10,
"text": ""
},
"requestExample": {
"sid": 109,
"report_date": "2022-06-01",
"show_detail": 1,
"target_type": "keyword",
"offset": 0,
"length": 15
},
"responseExample": {
"code": 0,
"message": "操作成功",
"error_details": [],
"request_id": "52688b81-2398-4e60-9617-6ty71fcf5b1e",
"response_time": "2023-03-20 10:07:22",
"total": 20,
"data": [
{
"query": "iphone13 pro ケース",
"target_id": 257012918513585,
"match_type": "BROAD",
"target_text": "iphone 13 pro",
"ad_group_id": 876493198967,
"impressions": 327,
"clicks": 3,
"cost": 150.94,
"profile_id": 121923590660074,
"campaign_id": 223897112753433,
"same_orders": 0,
"orders": 0,
"same_sales": 0,
"sales": 0,
"units": 0,
"same_units": 0,
"report_date": "2021-07-15",
"same_orders_1d": 0,
"orders_1d": 0,
"same_sales_1d": 0,
"sales_1d": 0,
"same_orders_7d": 0,
"orders_7d": 0,
"same_sales_7d": 0,
"sales_7d": 0,
"same_orders_30d": 0,
"orders_30d": 0,
"same_sales_30d": 0,
"sales_30d": 0,
"same_orders_14d": 0,
"orders_14d": 0,
"same_sales_14d": 0,
"sales_14d": 0,
"units_1d": 0,
"units_7d": 0,
"units_14d": 0,
"units_30d": 0,
"same_units_1d": 0,
"same_units_7d": 0,
"same_units_14d": 0,
"same_units_30d": 0
}
]
}
}| 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 | report_date | 报表日期 | string | — | Required | 报表日期 |
| 5 | show_detail | 是否展示完整归因期信息【默认0】 | integer | — | Optional | 是否展示完整归因期信息【默认0】:0 否,1 是 |
| 6 | target_type | 投放类型【默认 keyword】 | string | — | Required | 投放类型【默认 keyword】: keyword 关键词 target 商品投放,SP关键词组的搜索词,也通过此参数进行获取。 |
| 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 | 52688b81-2398-4e60-9617-6ty71fcf5b1e | Required | 请求链路id |
| 6 | response_time | 响应时间 | string | 2023-03-20 10:07:22 | Required | 响应时间 |
| 7 | total | 总数 | integer | 20 | Required | 总数 |
| 8 | data | 响应数据 | array<object> | — | Required | 响应数据 |
| 8.1 | query | 搜索词 | string | iphone13 pro | Required | 搜索词 |
| 8.2 | target_id | 投放id(关键词/商品投放/关键词组 | number | 257012918513585 | Required | 投放id(关键词/商品投放/关键词组,入参中 target_type=keyword时、返回关键词ID; target_type=target时、返回商品投放ID或关键词组ID;) |
| 8.3 | match_type | 匹配类型 | string | BROAD | Required | 匹配类型 |
| 8.4 | target_text | 投放的内容 | string | iphone 13 pro | Required | 投放的内容 |
| 8.5 | ad_group_id | 广告组id | number | 876493198967 | Required | 广告组id |
| 8.6 | impressions | 展示量 | number | 327 | Required | 展示量 |
| 8.7 | clicks | 点击量 | number | 3 | Required | 点击量 |
| 8.8 | cost | 花费 | number | 150.94 | Required | 花费 |
| 8.9 | profile_id | 亚马逊店铺数字id | number | 121923590660074 | Required | 亚马逊店铺数字id |
| 8.10 | campaign_id | 广告活动id | number | 223897112753433 | Required | 广告活动id |
| 8.11 | same_orders | 直接成交订单数 | number | 0 | Required | 直接成交订单数 |
| 8.12 | orders | 订单数 | number | 0 | Required | 订单数 |
| 8.13 | same_sales | 直接成交销售额 | number | 0 | Required | 直接成交销售额 |
| 8.14 | sales | 销售额 | number | 0 | Required | 销售额 |
| 8.15 | units | 销量 | number | 0 | Required | 销量 |
| 8.16 | same_units | 直接成交销量 | number | 0 | Required | 直接成交销量 |
| 8.17 | report_date | 报表日期 | string | 2021-07-15 | Required | 报表日期 |
| 8.18 | same_orders_1d | same_orders_1d | number | 0 | Optional | 直接成交订单数(1d)【show_detail=1时返回字段】 |
| 8.19 | orders_1d | orders_1d | number | 0 | Optional | 订单数(1d)【show_detail=1时返回字段】 |
| 8.20 | same_sales_1d | same_sales_1d | number | 0 | Optional | 直接成交销售额(1d)【show_detail=1时返回字段】 |
| 8.21 | sales_1d | sales_1d | number | 0 | Optional | 销售额(1d)【show_detail=1时返回字段】 |
| 8.22 | same_orders_7d | same_orders_7d | number | 0 | Optional | 直接成交订单数(7d)【show_detail=1时返回字段】 |
| 8.23 | orders_7d | orders_7d | number | 0 | Optional | 订单数(7d)【show_detail=1时返回字段】 |
| 8.24 | same_sales_7d | same_sales_7d | number | 0 | Optional | 直接成交销售额(7d)【show_detail=1时返回字段】 |
| 8.25 | sales_7d | sales_7d | number | 0 | Optional | 销售额(7d)【show_detail=1时返回字段】 |
| 8.26 | same_orders_30d | same_orders_30d | number | 0 | Optional | 直接成交订单数(30d)【show_detail=1时返回字段】 |
| 8.27 | orders_30d | orders_30d | number | 0 | Optional | 订单数(30d)【show_detail=1时返回字段】 |
| 8.28 | same_sales_30d | same_sales_30d | number | 0 | Optional | 直接成交销售额(30d)【show_detail=1时返回字段】 |
| 8.29 | sales_30d | sales_30d | number | 0 | Optional | 销售额(30d)【show_detail=1时返回字段】 |
| 8.30 | same_orders_14d | same_orders_14d | number | 0 | Optional | 直接成交订单数(14d)【show_detail=1时返回字段】 |
| 8.31 | orders_14d | orders_14d | number | 0 | Optional | 订单数(14d)【show_detail=1时返回字段】 |
| 8.32 | same_sales_14d | same_sales_14d | number | 0 | Optional | 直接成交销售额(14d)【show_detail=1时返回字段】 |
| 8.33 | sales_14d | sales_14d | number | 0 | Optional | 销售额(14d)【show_detail=1时返回字段】 |
| 8.34 | units_1d | units_1d | number | 0 | Optional | 销量(1d)【show_detail=1时返回字段】 |
| 8.35 | units_7d | units_7d | number | 0 | Optional | 销量(7d)【show_detail=1时返回字段】 |
| 8.36 | units_14d | units_14d | number | 0 | Optional | 销量(14d)【show_detail=1时返回字段】 |
| 8.37 | units_30d | units_30d | number | 0 | Optional | 销量(30d)【show_detail=1时返回字段】 |
| 8.38 | same_units_1d | same_units_1d | number | 0 | Optional | 直接成交销量(1d)【show_detail=1时返回字段】 |
| 8.39 | same_units_7d | same_units_7d | number | 0 | Optional | 直接成交销量(7d)【show_detail=1时返回字段】 |
| 8.40 | same_units_14d | same_units_14d | number | 0 | Optional | 直接成交销量(14d)【show_detail=1时返回字段】 |
| 8.41 | same_units_30d | same_units_30d | number | 0 | Optional | 直接成交销量(30d)【show_detail=1时返回字段】 |
The SP用户搜索词报表 API (/pb/openapi/newad/queryWordReports) 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.