/basicOpen/multiplatform/ads/queryTiktokAdGroupList{
"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×tamp=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
}
}| 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 | bidStrategies | 出价策略列表 | array<any> | — | Optional | 出价策略列表,String数组 |
| 7 | budgetTypes | 预算类型列表 | array<any> | — | Optional | 预算类型列表,String数组 |
| 8 | campaignIds | 广告活动id列表 | array<any> | — | Optional | 广告活动id列表,Long数组 |
| 9 | currencies | 币种列表 | array<any> | — | Optional | 币种列表,String数组 |
| 10 | objectiveType | 推广目标列表 | array<any> | — | Optional | 推广目标列表,String数组,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量 |
| 11 | orderField | 排序字段(驼峰) | string | — | Optional | 排序字段(驼峰) |
| 12 | orderType | 排序方式 | string | — | Optional | 排序方式 |
| 13 | ownerBcIds | 广告主BusinessId列表 | array<any> | — | Optional | 广告主BusinessId列表,Long数组 |
| 14 | searchType | 搜索字段 | string | — | Optional | 搜索字段,当字段searchValue有值时,该字段也必须有值,且根据报告类型填写对应的值(advertiser_name-广告账号,ad_group_name-广告组,campaign_name推广系列,ad_name-广告) |
| 15 | searchValue | 搜索值 | array<any> | — | Optional | 搜索值,String数组 |
| 16 | serviceStatus | 服务状态列表 | array<any> | — | Optional | 服务状态列表,String数组 |
| 17 | status | 状态列表 | array<any> | — | Optional | 状态列表,String数组,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户 |
| 18 | summaryCurrency | 汇总币种 | string | — | Optional | 汇总币种 |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | Required | 响应码 |
| 2 | data | 返回数据 | object | — | Required | 返回数据 |
| 2.1 | list | 列表数据 | array<object> | — | Required | 列表数据 |
| 2.1.1 | adGroupId | 广告组Id | string | 7123456789012345678 | Optional | 广告组Id |
| 2.1.2 | adGroupName | 广告组名称 | string | 测试广告组 | Optional | 广告组名称 |
| 2.1.3 | advertiserId | 广告账号Id | string | 7123456789012345678 | Optional | 广告账号Id |
| 2.1.4 | advertiserName | 广告账号名称 | string | 测试广告账号 | Optional | 广告账号名称 |
| 2.1.5 | attributionEventCount | 归因事件数 | string | 25 | Optional | 归因事件数 |
| 2.1.6 | averageVideoPlay | 平均视频播放时长 | string | 12.5 | Optional | 平均视频播放时长 |
| 2.1.7 | averageVideoPlayPerUser | 用户平均播放时长 | string | 10.2 | Optional | 用户平均播放时长 |
| 2.1.8 | bid | 竞价 | string | 1.5 | Optional | 竞价 |
| 2.1.9 | bidDisplayMode | 出价展示模式 | string | BID_DISPLAY_MODE_STANDARD | Optional | 出价展示模式 |
| 2.1.10 | bidMode | 出价模式 | string | BID_MODE_CUSTOM | Optional | 出价模式 |
| 2.1.11 | bidStrategy | 竞价策略 | string | BID_TYPE_CUSTOM | Optional | 竞价策略,枚举值:BID_TYPE_CUSTOM-手动出价, BID_TYPE_NO_BID-最大投放量 |
| 2.1.12 | billedCost | 净消耗 | string | 245.6 | Optional | 净消耗 |
| 2.1.13 | billingEvent | 计费事件 | string | CPC | Optional | 计费事件 |
| 2.1.14 | budget | 预算 | string | 100.5 | Optional | 预算 |
| 2.1.15 | budgetType | 预算类型 | string | BUDGET_MODE_DAY | Optional | 预算类型,枚举值:BUDGET_MODE_INFINITE-不限预算, BUDGET_MODE_TOTAL-总预算, BUDGET_MODE_DAY-日预算, BUDGET_MODE_DYNAMIC_DAILY_BUDGET-动态日预算 |
| 2.1.16 | campaignId | 推广系列Id | string | 7123456789012345678 | Optional | 推广系列Id |
| 2.1.17 | campaignName | 推广系列名称 | string | 测试推广系列 | Optional | 推广系列名称 |
| 2.1.18 | cashSpend | 现金消耗(只支持广告组层级) | integer | 240 | Optional | 现金消耗(只支持广告组层级) |
| 2.1.19 | clickAttributionWindow | 点击归因窗口 | string | 7 | Optional | 点击归因窗口 |
| 2.1.20 | clicks | 点击量 | integer | 500 | Optional | 点击量 |
| 2.1.21 | cnyBilledCost | 人民币净消耗 | number | 1715.2 | Optional | 人民币净消耗 |
| 2.1.22 | cnyCashSpend | 人民币现金消耗 | number | 1680 | Optional | 人民币现金消耗 |
| 2.1.23 | cnyCostPerOnsiteInitiateCheckoutCount | 人民币开始结账平均成本(商店) | number | 43.88 | Optional | 人民币开始结账平均成本(商店) |
| 2.1.24 | cnyCostPerOnsiteOnWebCart | 人民币加入购物车平均成本(商店) | number | 21.91 | Optional | 人民币加入购物车平均成本(商店) |
| 2.1.25 | cnyCostPerOnsiteOnWebDetail | 人民币商品页浏览平均成本(商店) | number | 8.75 | Optional | 人民币商品页浏览平均成本(商店) |
| 2.1.26 | cnyCostPerOnsiteShopping | 人民币平均付费成本(商店) | number | 70.01 | Optional | 人民币平均付费成本(商店) |
| 2.1.27 | cnySpend | 人民币花费 | number | 1750.25 | Optional | 人民币花费 |
| 2.1.28 | cnyTotalOnsiteShoppingValue | 人民币总收入(商店) | number | 6125 | Optional | 人民币总收入(商店) |
| 2.1.29 | companyId | 公司id | string | 1001 | Optional | 公司id |
| 2.1.30 | conversion | 转化量 | integer | 25 | Optional | 转化量 |
| 2.1.31 | conversionRate | 转化率 | string | 0.025 | Optional | 转化率 |
| 2.1.32 | costPer1000Reached | 覆盖千人成本 | string | 29.48 | Optional | 覆盖千人成本 |
| 2.1.33 | costPerConversion | 平均转化成本 | string | 10.03 | Optional | 平均转化成本 |
| 2.1.34 | costPerOnsiteInitiateCheckoutCount | 开始结账平均成本(商店) | string | 6.27 | Optional | 开始结账平均成本(商店) |
| 2.1.35 | costPerOnsiteOnWebCart | 加入购物车平均成本(商店) | string | 3.13 | Optional | 加入购物车平均成本(商店) |
| 2.1.36 | costPerOnsiteOnWebDetail | 商品页浏览平均成本(商店) | string | 1.25 | Optional | 商品页浏览平均成本(商店) |
| 2.1.37 | costPerOnsiteShopping | 平均付费成本(商店) | string | 10.03 | Optional | 平均付费成本(商店) |
| 2.1.38 | costPerResult | 平均成效成本 | string | 8.36 | Optional | 平均成效成本 |
| 2.1.39 | cpc | cpc | string | 0.5 | Optional | CPC |
| 2.1.40 | cpm | cpm | string | 25.08 | Optional | CPM |
| 2.1.41 | createTime | 创建时间 | string | 2024-11-01 10:00:00 | Optional | 创建时间 |
| 2.1.42 | ctr | 点击率 | string | 0.05 | Optional | 点击率 |
| 2.1.43 | currency | 币种 | string | USD | Optional | 币种 |
| 2.1.44 | displayTimezone | 地区&时区(地区中文) | string | 美国东部时间 | Optional | 地区&时区(地区中文) |
| 2.1.45 | engagedView | 播放6秒次数(专注观看) | integer | 750 | Optional | 播放6秒次数(专注观看) |
| 2.1.46 | engagedView15s | 播放15秒次数(专注观看) | integer | 600 | Optional | 播放15秒次数(专注观看) |
| 2.1.47 | frequency | 频次 | integer | 1 | Optional | 频次 |
| 2.1.48 | gmtOffset | 地区&时区(时区) | string | -05:00 | Optional | 地区&时区(时区) |
| 2.1.49 | grossImpressions | 总展示数(包含无效展示) | integer | 10500 | Optional | 总展示数(包含无效展示) |
| 2.1.50 | id | id(与各层级的维度id如campaignId | string | 7123456789012345678 | Optional | id(与各层级的维度id如campaignId,adgroupId,adId相同) |
| 2.1.51 | impressions | 展示量 | integer | 10000 | Optional | 展示量 |
| 2.1.52 | investEndTime | 投放结束时间 | string | 2024-11-30 | Optional | 投放结束时间 |
| 2.1.53 | investStartTime | 投放开始时间 | string | 2024-11-01 | Optional | 投放开始时间 |
| 2.1.54 | liveEffectiveViews | 直播播放10秒次数 | integer | 450 | Optional | 直播播放10秒次数 |
| 2.1.55 | liveProductClicks | 直播商品点击数 | integer | 50 | Optional | 直播商品点击数 |
| 2.1.56 | liveUniqueViews | 直播去重播放量 | integer | 480 | Optional | 直播去重播放量 |
| 2.1.57 | liveViews | 直播播放量 | integer | 500 | Optional | 直播播放量 |
| 2.1.58 | metricsCnyRateMissingCount | 指标人民币汇率缺失计数 | integer | 0 | Optional | 指标人民币汇率缺失计数 |
| 2.1.59 | modifyTime | 修改时间 | string | 2024-11-12 15:30:00 | Optional | 修改时间 |
| 2.1.60 | objectiveType | 推广目标 | string | PRODUCT_SALES | Optional | 推广目标,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量 |
| 2.1.61 | onsiteInitiateCheckoutCount | 开始结账数(商店) | integer | 40 | Optional | 开始结账数(商店) |
| 2.1.62 | onsiteInitiateCheckoutCountRate | 开始结账率(商店) | string | 0.08 | Optional | 开始结账率(商店) |
| 2.1.63 | onsiteOnWebCart | 加入购物车数(商店) | integer | 80 | Optional | 加入购物车数(商店) |
| 2.1.64 | onsiteOnWebCartRate | 加入购物车率(商店) | string | 0.16 | Optional | 加入购物车率(商店) |
| 2.1.65 | onsiteOnWebDetail | 商品页浏览数(商店) | integer | 200 | Optional | 商品页浏览数(商店) |
| 2.1.66 | onsiteOnWebDetailRate | 商品页浏览率(商店) | string | 0.4 | Optional | 商品页浏览率(商店) |
| 2.1.67 | onsiteShopping | 付费数(商店) | integer | 25 | Optional | 付费数(商店) |
| 2.1.68 | onsiteShoppingRate | 付费率(商店) | string | 0.05 | Optional | 付费率(商店) |
| 2.1.69 | onsiteShoppingRoas | ROAS(商店) | string | 3.5 | Optional | ROAS(商店) |
| 2.1.70 | ownerBcId | 广告主BusinessId | string | 123456 | Optional | 广告主BusinessId |
| 2.1.71 | ownerBcName | 广告主Business名称 | string | 测试广告主 | Optional | 广告主Business名称 |
| 2.1.72 | pacing | 投放进度 | string | PACING_MODE_SMOOTH | Optional | 投放进度 |
| 2.1.73 | productSource | 产品来源 | string | CATALOG | Optional | 产品来源 |
| 2.1.74 | reach | 覆盖人数 | integer | 8500 | Optional | 覆盖人数 |
| 2.1.75 | realTimeConversion | 实时转化量 | integer | 28 | Optional | 实时转化量 |
| 2.1.76 | realTimeConversionRateV2 | 实时转化率(展示) | string | 0.0028 | Optional | 实时转化率(展示) |
| 2.1.77 | realTimeCostPerConversion | 实时平均转化成本 | string | 8.96 | Optional | 实时平均转化成本 |
| 2.1.78 | realTimeCostPerResult | 实时平均成效成本 | string | 7.84 | Optional | 实时平均成效成本 |
| 2.1.79 | realTimeResult | 实时成效数 | integer | 32 | Optional | 实时成效数 |
| 2.1.80 | reportDate | 报告日期 | string | 2024-11-12 | Optional | 报告日期 |
| 2.1.81 | reportUpdateTime | 报告更新时间(北京) | string | 2024-11-12 16:00:00 | Optional | 报告更新时间(北京) |
| 2.1.82 | result | 成效数 | integer | 30 | Optional | 成效数 |
| 2.1.83 | resultRate | 成效率 | string | 0.003 | Optional | 成效率 |
| 2.1.84 | scheduledBudget | 计划预算 | string | 1000 | Optional | 计划预算 |
| 2.1.85 | serviceStatus | 服务状态 | string | ACTIVE | Optional | 服务状态 |
| 2.1.86 | shoppingAdsType | 购物广告类型 | string | VIDEO_SHOPPING_ADS | Optional | 购物广告类型 |
| 2.1.87 | spend | 花费 | string | 250.75 | Optional | 花费 |
| 2.1.88 | splitTestStatus | 分割测试状态 | string | NOT_IN_TEST | Optional | 分割测试状态 |
| 2.1.89 | status | 状态 | string | STATUS_ENABLE | Optional | 状态 |
| 2.1.90 | totalOnsiteInitiateCheckoutCountValue | 开始结账价值(商店) | string | 875 | Optional | 开始结账价值(商店) |
| 2.1.91 | totalOnsiteOnWebCartValue | 加入购物车价值(商店) | string | 875 | Optional | 加入购物车价值(商店) |
| 2.1.92 | totalOnsiteOnWebDetailValue | 商品页浏览价值(商店) | string | 875 | Optional | 商品页浏览价值(商店) |
| 2.1.93 | totalOnsiteShoppingValue | 总收入(商店) | string | 875 | Optional | 总收入(商店) |
| 2.1.94 | valuePerOnsiteInitiateCheckoutCount | 开始结账平均价值(商店) | string | 21.88 | Optional | 开始结账平均价值(商店) |
| 2.1.95 | valuePerOnsiteOnWebCart | 加入购物车平均价值(商店) | string | 10.94 | Optional | 加入购物车平均价值(商店) |
| 2.1.96 | valuePerOnsiteOnWebDetail | 商品页浏览平均价值(商店) | string | 4.38 | Optional | 商品页浏览平均价值(商店) |
| 2.1.97 | valuePerOnsiteShopping | 平均订单价值(商店) | string | 35 | Optional | 平均订单价值(商店) |
| 2.1.98 | videoCompletionRate | 完播率(接口无返回) | string | 0.15 | Optional | 完播率(接口无返回) |
| 2.1.99 | videoPlayActions | 视频播放量 | integer | 1200 | Optional | 视频播放量 |
| 2.1.100 | videoViews2sRate | 2s完播率 | string | 0.83 | Optional | 2s完播率 |
| 2.1.101 | videoViews6sRate | 6s完播率 | string | 0.67 | Optional | 6s完播率 |
| 2.1.102 | videoViewsP100 | 播放完成次数 | integer | 180 | Optional | 播放完成次数 |
| 2.1.103 | videoViewsP25 | 播放25%次数 | integer | 900 | Optional | 播放25%次数 |
| 2.1.104 | videoViewsP25Rate | 播放25%占比 | string | 0.75 | Optional | 播放25%占比 |
| 2.1.105 | videoViewsP50 | 播放50%次数 | integer | 600 | Optional | 播放50%次数 |
| 2.1.106 | videoViewsP50Rate | 播放50%占比 | string | 0.5 | Optional | 播放50%占比 |
| 2.1.107 | videoViewsP75 | 播放75%次数 | integer | 300 | Optional | 播放75%次数 |
| 2.1.108 | videoViewsP75Rate | 播放75%占比 | string | 0.25 | Optional | 播放75%占比 |
| 2.1.109 | videoWatched2s | 视频播放2秒次数 | integer | 1000 | Optional | 视频播放2秒次数 |
| 2.1.110 | videoWatched6s | 视频播放6秒次数 | integer | 800 | Optional | 视频播放6秒次数 |
| 2.1.111 | viewAttributionWindow | 浏览归因窗口 | string | 1 | Optional | 浏览归因窗口 |
| 2.2 | total | 总记录数 | integer | 100 | 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 - 推广广告 - 广告组 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.
Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.