Qeasy Cloud
Get Started

领星ERP 查询TikTok - 推广广告 - 广告组 API

Platform
领星ERP
Type
WebAPI
Effect
QUERY
API Version
1.0
Adapter
\Adapter\LingXing\LXQueryAdapter
Auth Mode
OTHER
Description
多平台 / 广告 / TikTok广告 · POST · 请求参数 18 个(必填 0) · 响应参数 120 个 · 限流令牌桶容量 1
Updated At
2026-11-21

查询TikTok - 推广广告 - 广告组

POST/basicOpen/multiplatform/ads/queryTiktokAdGroupList
Factory
{
  "operation": {
    "method": "POST",
    "path": "/basicOpen/multiplatform/ads/queryTiktokAdGroupList"
  },
  "protocol": "HTTPS",
  "host": "https://openapi.lingxing.com",
  "rateLimit": {
    "tokenBucketCapacity": 1,
    "text": ""
  },
  "requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryTiktokAdGroupList?access_token=value&timestamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"endDate\": \"2024-11-12\",\n    \"length\": 20,\n    \"page\": 1,\n    \"startDate\": \"2024-11-01\",\n    \"advertiserIds\": [123456789012345],\n    \"bidStrategies\": [\"BID_TYPE_CUSTOM\"],\n    \"budgetTypes\": [\"BUDGET_MODE_DAY\"],\n    \"campaignIds\": [123456789012345,987654321098765],\n    \"currencies\": [\"USD\",\"CNY\"],\n    \"objectiveType\": [\"PRODUCT_SALES\",\"WEB_CONVERSIONS\"],\n    \"orderField\": \"spend\",\n    \"orderType\": \"DESC\",\n    \"ownerBcIds\": [123456,789012],\n    \"searchType\": \"ad_group_name\",\n    \"searchValue\": [\"\\u6d4b\\u8bd5\\u5e7f\\u544a\\u7ec4\"],\n    \"serviceStatus\": [\"ACTIVE\"],\n    \"status\": [\"STATUS_ENABLE\",\"STATUS_DISABLE\"],\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
  }
}

Request Parameters

No.FieldNameTypeDefaultRequiredDescription
1endDate结束日期string—Optional结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天
2length每页条数integer—Optional每页条数,必填,小于2000
3page页码integer—Optional页码,必填
4startDate开始日期string—Optional开始日期,必填,格式:yyyy-MM-dd
5advertiserIds广告账号Id列表array<any>—Optional广告账号Id列表,Long数组
6bidStrategies出价策略列表array<any>—Optional出价策略列表,String数组
7budgetTypes预算类型列表array<any>—Optional预算类型列表,String数组
8campaignIds广告活动id列表array<any>—Optional广告活动id列表,Long数组
9currencies币种列表array<any>—Optional币种列表,String数组
10objectiveType推广目标列表array<any>—Optional推广目标列表,String数组,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量
11orderField排序字段(驼峰)string—Optional排序字段(驼峰)
12orderType排序方式string—Optional排序方式
13ownerBcIds广告主BusinessId列表array<any>—Optional广告主BusinessId列表,Long数组
14searchType搜索字段string—Optional搜索字段,当字段searchValue有值时,该字段也必须有值,且根据报告类型填写对应的值(advertiser_name-广告账号,ad_group_name-广告组,campaign_name推广系列,ad_name-广告)
15searchValue搜索值array<any>—Optional搜索值,String数组
16serviceStatus服务状态列表array<any>—Optional服务状态列表,String数组
17status状态列表array<any>—Optional状态列表,String数组,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户
18summaryCurrency汇总币种string—Optional汇总币种

Response Parameters

No.FieldNameTypeDefaultRequiredDescription
1code响应码integer—Required响应码
2data返回数据object—Required返回数据
2.1list列表数据array<object>—Required列表数据
2.1.1adGroupId广告组Idstring7123456789012345678Optional广告组Id
2.1.2adGroupName广告组名称string测试广告组Optional广告组名称
2.1.3advertiserId广告账号Idstring7123456789012345678Optional广告账号Id
2.1.4advertiserName广告账号名称string测试广告账号Optional广告账号名称
2.1.5attributionEventCount归因事件数string25Optional归因事件数
2.1.6averageVideoPlay平均视频播放时长string12.5Optional平均视频播放时长
2.1.7averageVideoPlayPerUser用户平均播放时长string10.2Optional用户平均播放时长
2.1.8bid竞价string1.5Optional竞价
2.1.9bidDisplayMode出价展示模式stringBID_DISPLAY_MODE_STANDARDOptional出价展示模式
2.1.10bidMode出价模式stringBID_MODE_CUSTOMOptional出价模式
2.1.11bidStrategy竞价策略stringBID_TYPE_CUSTOMOptional竞价策略,枚举值:BID_TYPE_CUSTOM-手动出价, BID_TYPE_NO_BID-最大投放量
2.1.12billedCost净消耗string245.6Optional净消耗
2.1.13billingEvent计费事件stringCPCOptional计费事件
2.1.14budget预算string100.5Optional预算
2.1.15budgetType预算类型stringBUDGET_MODE_DAYOptional预算类型,枚举值:BUDGET_MODE_INFINITE-不限预算, BUDGET_MODE_TOTAL-总预算, BUDGET_MODE_DAY-日预算, BUDGET_MODE_DYNAMIC_DAILY_BUDGET-动态日预算
2.1.16campaignId推广系列Idstring7123456789012345678Optional推广系列Id
2.1.17campaignName推广系列名称string测试推广系列Optional推广系列名称
2.1.18cashSpend现金消耗(只支持广告组层级)integer240Optional现金消耗(只支持广告组层级)
2.1.19clickAttributionWindow点击归因窗口string7Optional点击归因窗口
2.1.20clicks点击量integer500Optional点击量
2.1.21cnyBilledCost人民币净消耗number1715.2Optional人民币净消耗
2.1.22cnyCashSpend人民币现金消耗number1680Optional人民币现金消耗
2.1.23cnyCostPerOnsiteInitiateCheckoutCount人民币开始结账平均成本(商店)number43.88Optional人民币开始结账平均成本(商店)
2.1.24cnyCostPerOnsiteOnWebCart人民币加入购物车平均成本(商店)number21.91Optional人民币加入购物车平均成本(商店)
2.1.25cnyCostPerOnsiteOnWebDetail人民币商品页浏览平均成本(商店)number8.75Optional人民币商品页浏览平均成本(商店)
2.1.26cnyCostPerOnsiteShopping人民币平均付费成本(商店)number70.01Optional人民币平均付费成本(商店)
2.1.27cnySpend人民币花费number1750.25Optional人民币花费
2.1.28cnyTotalOnsiteShoppingValue人民币总收入(商店)number6125Optional人民币总收入(商店)
2.1.29companyId公司idstring1001Optional公司id
2.1.30conversion转化量integer25Optional转化量
2.1.31conversionRate转化率string0.025Optional转化率
2.1.32costPer1000Reached覆盖千人成本string29.48Optional覆盖千人成本
2.1.33costPerConversion平均转化成本string10.03Optional平均转化成本
2.1.34costPerOnsiteInitiateCheckoutCount开始结账平均成本(商店)string6.27Optional开始结账平均成本(商店)
2.1.35costPerOnsiteOnWebCart加入购物车平均成本(商店)string3.13Optional加入购物车平均成本(商店)
2.1.36costPerOnsiteOnWebDetail商品页浏览平均成本(商店)string1.25Optional商品页浏览平均成本(商店)
2.1.37costPerOnsiteShopping平均付费成本(商店)string10.03Optional平均付费成本(商店)
2.1.38costPerResult平均成效成本string8.36Optional平均成效成本
2.1.39cpccpcstring0.5OptionalCPC
2.1.40cpmcpmstring25.08OptionalCPM
2.1.41createTime创建时间string2024-11-01 10:00:00Optional创建时间
2.1.42ctr点击率string0.05Optional点击率
2.1.43currency币种stringUSDOptional币种
2.1.44displayTimezone地区&时区(地区中文)string美国东部时间Optional地区&时区(地区中文)
2.1.45engagedView播放6秒次数(专注观看)integer750Optional播放6秒次数(专注观看)
2.1.46engagedView15s播放15秒次数(专注观看)integer600Optional播放15秒次数(专注观看)
2.1.47frequency频次integer1Optional频次
2.1.48gmtOffset地区&时区(时区)string-05:00Optional地区&时区(时区)
2.1.49grossImpressions总展示数(包含无效展示)integer10500Optional总展示数(包含无效展示)
2.1.50idid(与各层级的维度id如campaignIdstring7123456789012345678Optionalid(与各层级的维度id如campaignId,adgroupId,adId相同)
2.1.51impressions展示量integer10000Optional展示量
2.1.52investEndTime投放结束时间string2024-11-30Optional投放结束时间
2.1.53investStartTime投放开始时间string2024-11-01Optional投放开始时间
2.1.54liveEffectiveViews直播播放10秒次数integer450Optional直播播放10秒次数
2.1.55liveProductClicks直播商品点击数integer50Optional直播商品点击数
2.1.56liveUniqueViews直播去重播放量integer480Optional直播去重播放量
2.1.57liveViews直播播放量integer500Optional直播播放量
2.1.58metricsCnyRateMissingCount指标人民币汇率缺失计数integer0Optional指标人民币汇率缺失计数
2.1.59modifyTime修改时间string2024-11-12 15:30:00Optional修改时间
2.1.60objectiveType推广目标stringPRODUCT_SALESOptional推广目标,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量
2.1.61onsiteInitiateCheckoutCount开始结账数(商店)integer40Optional开始结账数(商店)
2.1.62onsiteInitiateCheckoutCountRate开始结账率(商店)string0.08Optional开始结账率(商店)
2.1.63onsiteOnWebCart加入购物车数(商店)integer80Optional加入购物车数(商店)
2.1.64onsiteOnWebCartRate加入购物车率(商店)string0.16Optional加入购物车率(商店)
2.1.65onsiteOnWebDetail商品页浏览数(商店)integer200Optional商品页浏览数(商店)
2.1.66onsiteOnWebDetailRate商品页浏览率(商店)string0.4Optional商品页浏览率(商店)
2.1.67onsiteShopping付费数(商店)integer25Optional付费数(商店)
2.1.68onsiteShoppingRate付费率(商店)string0.05Optional付费率(商店)
2.1.69onsiteShoppingRoasROAS(商店)string3.5OptionalROAS(商店)
2.1.70ownerBcId广告主BusinessIdstring123456Optional广告主BusinessId
2.1.71ownerBcName广告主Business名称string测试广告主Optional广告主Business名称
2.1.72pacing投放进度stringPACING_MODE_SMOOTHOptional投放进度
2.1.73productSource产品来源stringCATALOGOptional产品来源
2.1.74reach覆盖人数integer8500Optional覆盖人数
2.1.75realTimeConversion实时转化量integer28Optional实时转化量
2.1.76realTimeConversionRateV2实时转化率(展示)string0.0028Optional实时转化率(展示)
2.1.77realTimeCostPerConversion实时平均转化成本string8.96Optional实时平均转化成本
2.1.78realTimeCostPerResult实时平均成效成本string7.84Optional实时平均成效成本
2.1.79realTimeResult实时成效数integer32Optional实时成效数
2.1.80reportDate报告日期string2024-11-12Optional报告日期
2.1.81reportUpdateTime报告更新时间(北京)string2024-11-12 16:00:00Optional报告更新时间(北京)
2.1.82result成效数integer30Optional成效数
2.1.83resultRate成效率string0.003Optional成效率
2.1.84scheduledBudget计划预算string1000Optional计划预算
2.1.85serviceStatus服务状态stringACTIVEOptional服务状态
2.1.86shoppingAdsType购物广告类型stringVIDEO_SHOPPING_ADSOptional购物广告类型
2.1.87spend花费string250.75Optional花费
2.1.88splitTestStatus分割测试状态stringNOT_IN_TESTOptional分割测试状态
2.1.89status状态stringSTATUS_ENABLEOptional状态
2.1.90totalOnsiteInitiateCheckoutCountValue开始结账价值(商店)string875Optional开始结账价值(商店)
2.1.91totalOnsiteOnWebCartValue加入购物车价值(商店)string875Optional加入购物车价值(商店)
2.1.92totalOnsiteOnWebDetailValue商品页浏览价值(商店)string875Optional商品页浏览价值(商店)
2.1.93totalOnsiteShoppingValue总收入(商店)string875Optional总收入(商店)
2.1.94valuePerOnsiteInitiateCheckoutCount开始结账平均价值(商店)string21.88Optional开始结账平均价值(商店)
2.1.95valuePerOnsiteOnWebCart加入购物车平均价值(商店)string10.94Optional加入购物车平均价值(商店)
2.1.96valuePerOnsiteOnWebDetail商品页浏览平均价值(商店)string4.38Optional商品页浏览平均价值(商店)
2.1.97valuePerOnsiteShopping平均订单价值(商店)string35Optional平均订单价值(商店)
2.1.98videoCompletionRate完播率(接口无返回)string0.15Optional完播率(接口无返回)
2.1.99videoPlayActions视频播放量integer1200Optional视频播放量
2.1.100videoViews2sRate2s完播率string0.83Optional2s完播率
2.1.101videoViews6sRate6s完播率string0.67Optional6s完播率
2.1.102videoViewsP100播放完成次数integer180Optional播放完成次数
2.1.103videoViewsP25播放25%次数integer900Optional播放25%次数
2.1.104videoViewsP25Rate播放25%占比string0.75Optional播放25%占比
2.1.105videoViewsP50播放50%次数integer600Optional播放50%次数
2.1.106videoViewsP50Rate播放50%占比string0.5Optional播放50%占比
2.1.107videoViewsP75播放75%次数integer300Optional播放75%次数
2.1.108videoViewsP75Rate播放75%占比string0.25Optional播放75%占比
2.1.109videoWatched2s视频播放2秒次数integer1000Optional视频播放2秒次数
2.1.110videoWatched6s视频播放6秒次数integer800Optional视频播放6秒次数
2.1.111viewAttributionWindow浏览归因窗口string1Optional浏览归因窗口
2.2total总记录数integer100Required总记录数
3error_details错误详情array<any>—Required错误详情
4message提示信息string—Required提示信息
5request_id请求idstring—Required请求id
6response_time响应时间string—Required响应时间
7total总记录数integer—Required总记录数

The 查询TikTok - 推广广告 - 广告组 API (/basicOpen/multiplatform/ads/queryTiktokAdGroupList) 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.

Need to integrate this API?

Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.