/basicOpen/multiplatform/ads/queryGmvAdvertiserReportList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryGmvAdvertiserReportList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/multiplatform/ads/queryGmvAdvertiserReportList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"endDate\": \"2024-11-30\",\n \"length\": 20,\n \"page\": 1,\n \"startDate\": \"2024-11-01\",\n \"advertiserIds\": [123456789012345,987654321098765],\n \"gmvMaxPromotionTypeCodes\": [\"PRODUCT\",\"LIVE\"],\n \"orderField\": \"cost\",\n \"orderType\": \"DESC\",\n \"ownerBcIds\": [123456789012345,987654321098765],\n \"status\": [\"STATUS_ENABLE\",\"STATUS_DISABLE\"],\n \"storeIds\": [123456,789012],\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": [],
"total": 100
},
"total": 1
}
}| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | endDate | 结束日期 | string | — | 可选 | 结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天 |
| 2 | length | 每页条数 | integer | — | 可选 | 每页条数,必填,小于2000 |
| 3 | page | 页码 | integer | — | 可选 | 页码,必填,从1开始 |
| 4 | startDate | 开始日期 | string | — | 可选 | 开始日期,必填,格式:yyyy-MM-dd |
| 5 | advertiserIds | 广告账号ID列表 | array<any> | — | 可选 | 广告账号ID列表,Long数组,用于筛选特定广告账号 |
| 6 | gmvMaxPromotionTypeCodes | GMV Max类型编码列表 | array<any> | — | 可选 | GMV Max类型编码列表,String数组,枚举值:PRODUCT-商品GMV, LIVE-直播GMV |
| 7 | orderField | 排序字段名称 | string | — | 可选 | 排序字段名称,如:cost, orders, roi |
| 8 | orderType | 排序方式 | string | — | 可选 | 排序方式,枚举值:ASC-升序, DESC-降序 |
| 9 | ownerBcIds | 广告主账号ID列表 | array<any> | — | 可选 | 广告主账号ID列表,Long数组,业务负责人的BC ID列表 |
| 10 | status | 广告账号状态编码列表 | array<any> | — | 可选 | 广告账号状态编码列表,String数组,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户 |
| 11 | storeIds | 店铺ID列表 | array<any> | — | 可选 | 店铺ID列表,Long数组,用于筛选特定店铺的数据 |
| 12 | summaryCurrency | 汇总币种编码 | string | — | 可选 | 汇总币种编码,默认USD,用于统一汇总不同币种的数据 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | 必填 | 响应码 |
| 2 | data | 返回数据 | object | — | 必填 | 返回数据 |
| 2.1 | list | 报告列表 | array<object> | — | 必填 | 报告列表,Report对象数组 |
| 2.1.1 | advertiserId | 广告账号ID | string | 7123456789012345678 | 必填 | 广告账号ID |
| 2.1.2 | advertiserName | 广告账号名称 | string | TikTok Shop US AD Account | 必填 | 广告账号名称 |
| 2.1.3 | balance | 余额 | string | 25680.9 | 必填 | 余额,广告账号当前可用余额 |
| 2.1.4 | cost | 成本 | string | 15800.5 | 必填 | 成本,广告花费总金额 |
| 2.1.5 | costPerOrder | 平均下单成本 | string | 12.5 | 必填 | 平均下单成本,计算公式:cost / orders |
| 2.1.6 | currencyCode | 币种编码 | string | USD | 必填 | 币种编码,如:USD, CNY, EUR |
| 2.1.7 | currencyRateMissingCount | 币种汇率缺失计数 | string | 0 | 必填 | 币种汇率缺失计数,标识汇率数据缺失的天数 |
| 2.1.8 | endDate | 结束日期 | string | 2024-11-30 | 必填 | 结束日期,格式:yyyy-MM-dd |
| 2.1.9 | grossRevenue | 总收入 | string | 98765.8 | 必填 | 总收入,GMV总金额 |
| 2.1.10 | netCost | 净成本 | string | 14520.3 | 必填 | 净成本,扣除退款等后的实际成本 |
| 2.1.11 | orders | 订单数 | string | 1264 | 必填 | 订单数,广告带来的总订单量 |
| 2.1.12 | roi | ROI(投资回报率) | string | 6.25 | 必填 | ROI(投资回报率),计算公式:grossRevenue / cost |
| 2.1.13 | startDate | 开始日期 | string | 2024-11-01 | 必填 | 开始日期,格式:yyyy-MM-dd |
| 2.1.14 | statusCode | 状态编码 | string | STATUS_ENABLE | 必填 | 状态编码,枚举值:STATUS_DISABLE-已关户, STATUS_PENDING_CONFIRM-审核中, STATUS_PENDING_VERIFIED-审核中, STATUS_CONFIRM_FAIL-未通过, STATUS_ENABLE-已启用, STATUS_CONFIRM_FAIL_END-未通过, STATUS_PENDING_CONFIRM_MODIFY-审核中, STATUS_CONFIRM_MODIFY_FAIL-未通过, STATUS_LIMIT-惩罚中, STATUS_WAIT_FOR_BPM_AUDIT-审核中, STATUS_WAIT_FOR_PUBLIC_AUTH-未通过, STATUS_SELF_SERVICE_UNAUDITED-未通过, STATUS_CONTRACT_PENDING-未通过 |
| 2.1.15 | statusName | 状态名称 | string | 已启用 | 必填 | 状态名称,如:已启用、审核中、未通过、惩罚中、已关户 |
| 2.1.16 | stores | 店铺列表 | array<object> | — | 必填 | 店铺列表,Store对象数组,包含该广告账号关联的店铺信息 |
| 2.1.16.1 | storeCode | 店铺编码 | string | TIKTOK_US_STORE_001 | 必填 | 店铺编码 |
| 2.1.16.2 | storeId | 店铺ID | string | 7234567890123456 | 必填 | 店铺ID |
| 2.1.16.3 | storeName | 店铺名称 | string | Official TikTok Store | 必填 | 店铺名称 |
| 2.1.17 | storesDisplayName | 店铺显示名称 | string | Official Store, Brand Shop | 必填 | 店铺显示名称,多个店铺用逗号分隔 |
| 2.1.18 | subjectId | 报告主体ID | string | gmv_advertiser_20241101_20241130 | 必填 | 报告主体ID,用于标识报告的唯一性 |
| 2.1.19 | timezoneCode | 时区编码 | string | GMT-8 | 必填 | 时区编码,如:GMT-8, GMT+8 |
| 2.1.20 | timezoneName | 时区名称 | string | America/Los_Angeles | 必填 | 时区名称,广告账号所在时区 |
| 2.1.21 | reportDate | 当startDate与endDate一致时返回 | string | 2024-11-30 | 可选 | 当startDate与endDate一致时返回 |
| 2.2 | total | 总数 | string | 1523 | 必填 | 总数,返回符合条件的总记录数 |
| 3 | error_details | 错误详情 | array<any> | — | 必填 | 错误详情 |
| 4 | message | 提示信息 | string | — | 必填 | 提示信息 |
| 5 | request_id | 请求id | string | — | 必填 | 请求id |
| 6 | response_time | 响应时间 | string | — | 必填 | 响应时间 |
| 7 | total | 总记录数 | integer | — | 必填 | 总记录数 |
领星ERP的接口:查询TikTok - GMV MAX - 广告帐号(/basicOpen/multiplatform/ads/queryGmvAdvertiserReportList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。