轻易云
注册体验

领星ERP查询TikTok - GMV MAX - 广告帐号接口

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

查询TikTok - GMV MAX - 广告帐号

POST/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&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,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
  }
}

接口请求参数

序号字段名称类型默认值必填描述
1endDate结束日期string—可选结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天
2length每页条数integer—可选每页条数,必填,小于2000
3page页码integer—可选页码,必填,从1开始
4startDate开始日期string—可选开始日期,必填,格式:yyyy-MM-dd
5advertiserIds广告账号ID列表array<any>—可选广告账号ID列表,Long数组,用于筛选特定广告账号
6gmvMaxPromotionTypeCodesGMV Max类型编码列表array<any>—可选GMV Max类型编码列表,String数组,枚举值:PRODUCT-商品GMV, LIVE-直播GMV
7orderField排序字段名称string—可选排序字段名称,如:cost, orders, roi
8orderType排序方式string—可选排序方式,枚举值:ASC-升序, DESC-降序
9ownerBcIds广告主账号ID列表array<any>—可选广告主账号ID列表,Long数组,业务负责人的BC ID列表
10status广告账号状态编码列表array<any>—可选广告账号状态编码列表,String数组,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户
11storeIds店铺ID列表array<any>—可选店铺ID列表,Long数组,用于筛选特定店铺的数据
12summaryCurrency汇总币种编码string—可选汇总币种编码,默认USD,用于统一汇总不同币种的数据

接口响应参数

序号字段名称类型默认值必填描述
1code响应码integer—必填响应码
2data返回数据object—必填返回数据
2.1list报告列表array<object>—必填报告列表,Report对象数组
2.1.1advertiserId广告账号IDstring7123456789012345678必填广告账号ID
2.1.2advertiserName广告账号名称stringTikTok Shop US AD Account必填广告账号名称
2.1.3balance余额string25680.9必填余额,广告账号当前可用余额
2.1.4cost成本string15800.5必填成本,广告花费总金额
2.1.5costPerOrder平均下单成本string12.5必填平均下单成本,计算公式:cost / orders
2.1.6currencyCode币种编码stringUSD必填币种编码,如:USD, CNY, EUR
2.1.7currencyRateMissingCount币种汇率缺失计数string0必填币种汇率缺失计数,标识汇率数据缺失的天数
2.1.8endDate结束日期string2024-11-30必填结束日期,格式:yyyy-MM-dd
2.1.9grossRevenue总收入string98765.8必填总收入,GMV总金额
2.1.10netCost净成本string14520.3必填净成本,扣除退款等后的实际成本
2.1.11orders订单数string1264必填订单数,广告带来的总订单量
2.1.12roiROI(投资回报率)string6.25必填ROI(投资回报率),计算公式:grossRevenue / cost
2.1.13startDate开始日期string2024-11-01必填开始日期,格式:yyyy-MM-dd
2.1.14statusCode状态编码stringSTATUS_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.15statusName状态名称string已启用必填状态名称,如:已启用、审核中、未通过、惩罚中、已关户
2.1.16stores店铺列表array<object>—必填店铺列表,Store对象数组,包含该广告账号关联的店铺信息
2.1.16.1storeCode店铺编码stringTIKTOK_US_STORE_001必填店铺编码
2.1.16.2storeId店铺IDstring7234567890123456必填店铺ID
2.1.16.3storeName店铺名称stringOfficial TikTok Store必填店铺名称
2.1.17storesDisplayName店铺显示名称stringOfficial Store, Brand Shop必填店铺显示名称,多个店铺用逗号分隔
2.1.18subjectId报告主体IDstringgmv_advertiser_20241101_20241130必填报告主体ID,用于标识报告的唯一性
2.1.19timezoneCode时区编码stringGMT-8必填时区编码,如:GMT-8, GMT+8
2.1.20timezoneName时区名称stringAmerica/Los_Angeles必填时区名称,广告账号所在时区
2.1.21reportDate当startDate与endDate一致时返回string2024-11-30可选当startDate与endDate一致时返回
2.2total总数string1523必填总数,返回符合条件的总记录数
3error_details错误详情array<any>—必填错误详情
4message提示信息string—必填提示信息
5request_id请求idstring—必填请求id
6response_time响应时间string—必填响应时间
7total总记录数integer—必填总记录数

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

需要对接这个接口?

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