轻易云
注册体验

领星ERP查询TikTok - GMV MAX - 推广系列接口

所属平台
领星ERP
类型
WebAPI
作用
QUERY
接口版本
1.0
适配器
\Adapter\LingXing\LXQueryAdapter
授权方式
OTHER
描述
多平台 / 广告 / TikTok广告 · POST · 请求参数 18 个(必填 0) · 响应参数 50 个 · 限流令牌桶容量 1
更新日期
2026-11-21

查询TikTok - GMV MAX - 推广系列

POST/basicOpen/multiplatform/ads/queryGmvCampaignReportList
加工厂
{
  "operation": {
    "method": "POST",
    "path": "/basicOpen/multiplatform/ads/queryGmvCampaignReportList"
  },
  "protocol": "HTTPS",
  "host": "https://openapi.lingxing.com",
  "rateLimit": {
    "tokenBucketCapacity": 1,
    "text": ""
  },
  "requestExample": "curl --location 'https://openapi.lingxing.com/multiplatform/ads/queryGmvCampaignReportList?access_token=value&timestamp=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,123456789012346],\n    \"bidTypeCodes\": [\"CUSTOM\",\"NO_BID\"],\n    \"campaignId\": 1234567890123456789,\n    \"campaignIds\": [1234567890,1234567891],\n    \"gmvMaxPromotionTypeCodes\": [\"LIVE\",\"PRODUCT\"],\n    \"itemGroupIds\": [111111,222222],\n    \"orderField\": \"cost\",\n    \"orderType\": \"DESC\",\n    \"ownerBcIds\": [1001,1002],\n    \"scheduleEndDate\": \"2024-12-31\",\n    \"scheduleStartDate\": \"2024-11-01\",\n    \"status\": [\"ENABLE\",\"DISABLE\"],\n    \"storeIds\": [123456,234567],\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
  }
}

接口请求参数

序号字段名称类型默认值必填描述
1endDate结束日期string—可选结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天
2length每页条数integer—可选每页条数,必填,小于2000
3page页码integer—可选页码,必填,从1开始
4startDate开始日期string—可选开始日期,必填,格式:yyyy-MM-dd
5advertiserIds广告账号ID列表array<any>—可选广告账号ID列表,Long数组,用于筛选特定广告账号
6bidTypeCodes优化模式编码列表array<any>—可选优化模式编码列表,String数组,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量
7campaignId推广系列IDinteger—可选推广系列ID,用于筛选单个推广系列
8campaignIds推广系列ID列表array<any>—可选推广系列ID列表,Long数组,用于查询多个推广系列
9gmvMaxPromotionTypeCodesGMV Max类型编码列表array<any>—可选GMV Max类型编码列表,String数组,枚举值:PRODUCT-商品GMV, LIVE-直播GMV
10itemGroupIds广告商品ID列表array<any>—可选广告商品ID列表,Long数组,用于筛选特定商品
11orderField排序字段名称string—可选排序字段名称,如:cost, orders, roi
12orderType排序类型string—可选排序类型,枚举值:ASC-升序, DESC-降序
13ownerBcIds广告主账号ID列表array<any>—可选广告主账号ID列表,Long数组,业务负责人的BC ID列表
14scheduleEndDate排期结束日期string—可选排期结束日期,格式:yyyy-MM-dd
15scheduleStartDate排期开始日期string—可选排期开始日期,格式:yyyy-MM-dd
16status推广系列操作状态编码列表array<any>—可选推广系列操作状态编码列表,String数组,枚举值:ENABLE-已开启, DISABLE-已暂停, DELETE-已删除
17storeIds店铺ID列表array<any>—可选店铺ID列表,Long数组,用于筛选特定店铺的数据
18summaryCurrency汇总币种编码string—可选汇总币种编码,用于统一汇总不同币种的数据

接口响应参数

序号字段名称类型默认值必填描述
1code响应码integer—必填响应码
2data返回数据object—必填返回数据
2.1list报告列表array<object>—必填报告列表,Report对象数组
2.1.1advertiserId广告账号IDstring123456789012345必填广告账号ID
2.1.2bidTypeCode优化模式编码stringCUSTOM必填优化模式编码,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量
2.1.3bidTypeName优化模式名称string目标ROI必填优化模式名称,如:目标ROI、最大投放量
2.1.4campaignId推广系列IDstring1234567890123456789必填推广系列ID
2.1.5campaignName推广系列名称string双十一促销活动必填推广系列名称
2.1.6cost成本string1586.5必填成本,广告花费总金额
2.1.7costPerLiveView直播播放平均成本string0.0104必填直播播放平均成本,计算公式:cost / liveViews
2.1.8costPerLiveView10Second直播播放达10秒平均成本string0.0132必填直播播放达10秒平均成本,计算公式:cost / liveViews10Second
2.1.9costPerOrder平均下单成本string15.86必填平均下单成本,计算公式:cost / orders
2.1.10currencyCode币种编码stringUSD必填币种编码,如:USD, CNY, EUR
2.1.11currencyRateMissingCount币种汇率缺失计数string0必填币种汇率缺失计数,标识汇率数据缺失的天数
2.1.12endDate结束日期string2024-11-30必填结束日期,格式:yyyy-MM-dd
2.1.13gmvMaxPromotionTypeCodeGMV Max类型编码stringLIVE必填GMV Max类型编码,枚举值:PRODUCT-商品GMV, LIVE-直播GMV
2.1.14gmvMaxPromotionTypeNameGMV Max类型名称string直播GMV必填GMV Max类型名称,如:商品GMV、直播GMV
2.1.15grossRevenue总收入string5156.13必填总收入,GMV总金额
2.1.16itemGroups商品列表array<object>—必填商品列表,ItemGroup对象数组,包含该推广系列关联的商品信息
2.1.16.1campaignId推广系列IDstring1234567890123456789必填推广系列ID
2.1.16.2itemGroupId商品SPU IDstring111111必填商品SPU ID
2.1.16.3orders订单数string25必填订单数,该商品带来的订单量
2.1.16.4productImageUrl商品图片URLstringhttps://example.com/image/product123.jpg必填商品图片URL,商品主图的完整URL地址
2.1.16.5title商品标题stringTikTok爆款商品必填商品标题,商品的完整标题
2.1.17liveFollows直播关注数string256必填直播关注数,直播间新增关注数量
2.1.18liveViews直播播放量string15230必填直播播放量,直播间总观看次数
2.1.19liveViews10Second直播播放达10秒播放量string12050必填直播播放达10秒播放量,观看超过10秒的次数
2.1.20maxDeliveryBudget最大投放量预算string10000必填最大投放量预算,最大投放量模式下的预算限额
2.1.21netCost净成本string158.5必填净成本,扣除退款等后的实际成本
2.1.22operationStatusCode操作状态编码stringENABLE必填操作状态编码,枚举值:ENABLE-已开启, DISABLE-已暂停, DELETE-已删除
2.1.23operationStatusName操作状态名称string已开启必填操作状态名称,如:已开启、已暂停、已删除
2.1.24orders订单数string100必填订单数,广告带来的总订单量
2.1.25productSpecificTypeCode选择商品的维度编码stringDIMENSION_SPU必填选择商品的维度编码,标识商品选择的维度类型
2.1.26roasBid目标ROIstring2.5必填目标ROI,目标ROI模式下设置的目标值
2.1.27roiROI(投资回报率)string3.25必填ROI(投资回报率),计算公式:grossRevenue / cost
2.1.28scheduleEndTime排期结束时间string2024-11-30 23:59:59必填排期结束时间,格式:yyyy-MM-dd HH:mm:ss
2.1.29scheduleStartTime排期起始时间string2024-11-01 00:00:00必填排期起始时间,格式:yyyy-MM-dd HH:mm:ss
2.1.30startDate开始日期string2024-11-01必填开始日期,格式:yyyy-MM-dd
2.1.31storeCode店铺编码stringSTORE_001必填店铺编码
2.1.32storeId店铺IDstring123456必填店铺ID
2.1.33storeName店铺名称stringTikTok官方旗舰店必填店铺名称
2.1.34subjectId报告主体IDstring1234567890必填报告主体ID,用于标识报告的唯一性
2.1.35targetRoiBudget目标ROI预算string3必填目标ROI预算,目标ROI模式下的预算限额
2.1.36reportDate当startDate与endDate一致时返回string2024-11-30可选当startDate与endDate一致时返回
2.2total总数string158必填总数,返回符合条件的总记录数
3error_details错误详情array<any>—必填错误详情
4message提示信息string—必填提示信息
5request_id请求idstring—必填请求id
6response_time响应时间string—必填响应时间
7total总记录数integer—必填总记录数

领星ERP的接口:查询TikTok - GMV MAX - 推广系列(/basicOpen/multiplatform/ads/queryGmvCampaignReportList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。

需要对接这个接口?

轻易云已预置该接口的适配能力,联系我们即可开始配置数据集成。