/basicOpen/multiplatform/ads/queryGmvItemGroupReportList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryGmvItemGroupReportList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryGmvItemGroupReportList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"endDate\": \"2024-11-17\",\n \"length\": 20,\n \"page\": 1,\n \"startDate\": \"2024-11-01\",\n \"advertiserIds\": [123456789012345],\n \"bidTypeCodes\": [\"CUSTOM\",\"NO_BID\"],\n \"campaignIds\": [123456789012345],\n \"itemGroupIds\": [123456789012345],\n \"orderField\": \"grossRevenue\",\n \"orderType\": \"DESC\",\n \"ownerBcIds\": [123456789012345],\n \"status\": [\"available\",\"unavailable\"],\n \"storeIds\": [123456789012345],\n \"summaryCurrency\": \"USD\"\n}'",
"responseExample": {
"code": 0,
"message": "success",
"error_details": [],
"request_id": "a0d54debf93140f3b58d1ed81e8e3583.178.17255922733991817",
"response_time": "2024-11-12 16:00:00",
"data": {
"list": [
{
"bidTypeCode": "CUSTOM",
"bidTypeName": "目标ROI",
"currencyCode": "USD",
"currencyRateMissingCount": "0",
"enabledCampaignId": "123456789012345",
"enabledCampaignName": "双十一推广系列",
"endDate": "2024-11-01",
"grossRevenue": "251.25",
"itemGroupId": "123456789012345",
"orders": "10",
"productImageUrl": "https://example.com/product.jpg",
"productStatusCode": "available",
"productStatusName": "可用",
"startDate": "2024-11-01",
"storeCode": "STORE001",
"storeId": "123456789012345",
"storeName": "旗舰店",
"subjectId": "REPORT_123456",
"title": "iPhone 15 Pro Max",
"reportDate": "2024-11-01",
"cost": 100.5,
"costPerOrder": 10.05,
"roi": 2.5
}
],
"total": 100
},
"total": 1
}
}| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | endDate | 结束日期 | string | — | Optional | 结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天 |
| 2 | length | 每页条数 | integer | — | Optional | 每页条数,必填,小于2000 |
| 3 | page | 页码 | integer | — | Optional | 页码,必填 |
| 4 | startDate | 开始日期 | string | — | Optional | 开始日期,必填,格式:yyyy-MM-dd |
| 5 | advertiserIds | 广告账号ID列表 | array<any> | — | Optional | 广告账号ID列表,Long数组 |
| 6 | bidTypeCodes | 优化模式编码列表 | array<any> | — | Optional | 优化模式编码列表,String数组,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量 |
| 7 | campaignIds | 推广系列ID列表 | array<any> | — | Optional | 推广系列ID列表,Long数组 |
| 8 | itemGroupIds | 广告商品ID列表 | array<any> | — | Optional | 广告商品ID列表,Long数组 |
| 9 | orderField | 排序字段 | string | — | Optional | 排序字段 |
| 10 | orderType | 排序方式 | string | — | Optional | 排序方式,枚举值:ASC-升序, DESC-降序 |
| 11 | ownerBcIds | 广告主账号ID列表 | array<any> | — | Optional | 广告主账号ID列表,Long数组 |
| 12 | status | 商品状态编码列表 | array<any> | — | Optional | 商品状态编码列表,String数组,枚举值:available-可用, unavailable-不可用 |
| 13 | storeIds | 店铺ID列表 | array<any> | — | Optional | 店铺ID列表,Long数组 |
| 14 | summaryCurrency | 汇总币种编码 | string | — | Optional | 汇总币种编码 |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | Required | 响应码 |
| 2 | data | 返回数据 | object | — | Required | 返回数据 |
| 2.1 | list | 报告列表 | array<object> | — | Required | 报告列表,Report对象数组 |
| 2.1.1 | bidTypeCode | 优化模式编码 | string | CUSTOM | Required | 优化模式编码,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量 |
| 2.1.2 | bidTypeName | 优化模式名称 | string | 目标ROI | Required | 优化模式名称 |
| 2.1.3 | currencyCode | 币种编码 | string | USD | Required | 币种编码 |
| 2.1.4 | currencyRateMissingCount | 币种汇率缺失计数 | string | 0 | Required | 币种汇率缺失计数 |
| 2.1.5 | enabledCampaignId | 启用的推广系列ID | string | 123456789012345 | Required | 启用的推广系列ID |
| 2.1.6 | enabledCampaignName | 启用的推广系列名称 | string | 双十一推广系列 | Required | 启用的推广系列名称 |
| 2.1.7 | endDate | 结束日期 | string | 2024-11-17 | Required | 结束日期,格式:yyyy-MM-dd |
| 2.1.8 | grossRevenue | 总收入 | string | 12345.67 | Required | 总收入 |
| 2.1.9 | itemGroupId | 商品SPU ID | string | 123456789012345 | Required | 商品SPU ID |
| 2.1.10 | orders | 订单数 | string | 150 | Required | 订单数 |
| 2.1.11 | productImageUrl | 商品图片URL | string | https://example.com/product.jpg | Required | 商品图片URL |
| 2.1.12 | productStatusCode | 商品状态编码 | string | available | Required | 商品状态编码,枚举值:available-可用, unavailable-不可用 |
| 2.1.13 | productStatusName | 商品状态名称 | string | 可用 | Required | 商品状态名称 |
| 2.1.14 | startDate | 开始日期 | string | 2024-11-01 | Required | 开始日期,格式:yyyy-MM-dd |
| 2.1.15 | storeCode | 店铺编码 | string | STORE001 | Required | 店铺编码 |
| 2.1.16 | storeId | 店铺ID | string | 123456789012345 | Required | 店铺ID |
| 2.1.17 | storeName | 店铺名称 | string | 旗舰店 | Required | 店铺名称 |
| 2.1.18 | subjectId | 报告主体ID | string | REPORT_123456 | Required | 报告主体ID |
| 2.1.19 | title | 商品标题 | string | iPhone 15 Pro Max | Required | 商品标题 |
| 2.1.20 | reportDate | 当startDate与endDate一致时返回 | string | 2024-11-30 | Optional | 当startDate与endDate一致时返回 |
| 2.1.21 | cost | 成本 | number | 100.5 | Required | 成本 |
| 2.1.22 | costPerOrder | 平均下单成本 | number | 10.05 | Required | 平均下单成本 |
| 2.1.23 | roi | roi | number | 2.5 | Required | ROI |
| 2.2 | total | 总记录数 | string | 1000 | Required | 总记录数 |
| 3 | error_details | 错误详情 | array<any> | — | Required | 错误详情 |
| 4 | message | 提示信息 | string | — | Required | 提示信息 |
| 5 | request_id | 请求id | string | — | Required | 请求id |
| 6 | response_time | 响应时间 | string | — | Required | 响应时间 |
| 7 | total | 总记录数 | integer | — | Required | 总记录数 |
The 查询TikTok - GMV MAX - 广告商品 API (/basicOpen/multiplatform/ads/queryGmvItemGroupReportList) 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.