/basicOpen/multiplatform/ads/queryTiktokAdList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryTiktokAdList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryTiktokAdList?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 \"adIds\": [\"1111111111\"],\n \"adStyles\": [\"VIDEO_AD\"],\n \"adgroupIds\": [\"9876543210\"],\n \"advertiserIds\": [\"123456789012345\"],\n \"bidStrategies\": [\"LOWEST_COST\"],\n \"budgetTypes\": [\"DAILY\"],\n \"campaignIds\": [\"1234567890\"],\n \"creativeMaterialTypes\": [\"CUSTOMIZED_CREATIVE\"],\n \"currencies\": [\"USD\",\"CNY\"],\n \"orderField\": \"spend\",\n \"orderType\": \"DESC\",\n \"ownerBcIds\": [\"123456\"],\n \"searchType\": \"ad_name\",\n \"searchValue\": [\"\\u6d4b\\u8bd5\\u5e7f\\u544a\"],\n \"serviceStatus\": [\"ACTIVE\"],\n \"status\": [\"STATUS_ENABLE\",\"SYSTEM_STATUS_IN_REVIEW\"],\n \"summaryCurrency\": \"CNY\",\n \"videoTypes\": [\"USER_GENERATE\"]\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 | — | 可选 | 页码,必填 |
| 4 | startDate | 开始日期 | string | — | 可选 | 开始日期,必填,格式:yyyy-MM-dd |
| 5 | adIds | 广告id列表 | array<any> | — | 可选 | 广告id列表,Long数组 |
| 6 | adStyles | 广告样式列表 | array<any> | — | 可选 | 广告样式列表,String数组 |
| 7 | adgroupIds | 广告组id列表 | array<any> | — | 可选 | 广告组id列表,String数组 |
| 8 | advertiserIds | 广告账号Id列表 | array<any> | — | 可选 | 广告账号Id列表,Long数组 |
| 9 | bidStrategies | 出价策略列表 | array<any> | — | 可选 | 出价策略列表,String数组 |
| 10 | budgetTypes | 预算类型列表 | array<any> | — | 可选 | 预算类型列表,String数组 |
| 11 | campaignIds | 推广系列id列表 | array<any> | — | 可选 | 推广系列id列表,String数组 |
| 12 | creativeMaterialTypes | 创意素材类型列表 | array<any> | — | 可选 | 创意素材类型列表,String数组 |
| 13 | currencies | 币种列表 | array<any> | — | 可选 | 币种列表,String数组 |
| 14 | orderField | 排序字段(驼峰) | string | — | 可选 | 排序字段(驼峰) |
| 15 | orderType | 排序方式 | string | — | 可选 | 排序方式,枚举值:ASC-升序, DESC-降序 |
| 16 | ownerBcIds | 广告主BusinessId列表 | array<any> | — | 可选 | 广告主BusinessId列表,Long数组 |
| 17 | searchType | 搜索字段 | string | — | 可选 | 搜索字段,枚举值:advertiser_name-广告账号, ad_group_name-广告组, campaign_name-推广系列, ad_name-广告 |
| 18 | searchValue | 搜索值 | array<any> | — | 可选 | 搜索值,String数组 |
| 19 | serviceStatus | 服务状态列表 | array<any> | — | 可选 | 服务状态列表,String数组 |
| 20 | status | 状态列表 | array<any> | — | 可选 | 状态列表,String数组,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户 |
| 21 | summaryCurrency | 汇总币种 | string | — | 可选 | 汇总币种 |
| 22 | videoTypes | 视频类型列表 | array<any> | — | 可选 | 视频类型列表,String数组 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | 必填 | 响应码 |
| 2 | data | 返回数据 | object | — | 必填 | 返回数据 |
| 2.1 | list | 列表数据 | array<object> | — | 必填 | 列表数据 |
| 2.1.1 | adFormat | 广告样式 | string | VIDEO_AD | 可选 | 广告样式 |
| 2.1.2 | adGroupId | 广告组Id | string | 7023456789012345678 | 可选 | 广告组Id |
| 2.1.3 | adGroupName | 广告组名称 | string | 测试广告组 | 可选 | 广告组名称 |
| 2.1.4 | adId | 广告Id | string | 7123456789012345678 | 可选 | 广告Id |
| 2.1.5 | adName | 广告名称 | string | 测试广告 | 可选 | 广告名称 |
| 2.1.6 | advertiserId | 广告账号Id | string | 123456789012345 | 可选 | 广告账号Id |
| 2.1.7 | advertiserName | 广告账号名称 | string | 测试账号 | 可选 | 广告账号名称 |
| 2.1.8 | averageVideoPlay | 平均视频播放时长 | string | 15.5 | 可选 | 平均视频播放时长,单位:秒 |
| 2.1.9 | averageVideoPlayPerUser | 用户平均播放时长 | string | 18.2 | 可选 | 用户平均播放时长,单位:秒 |
| 2.1.10 | billedCost | 净消耗 | string | 1200 | 可选 | 净消耗 |
| 2.1.11 | campaignId | 推广系列Id | string | 6923456789012345678 | 可选 | 推广系列Id |
| 2.1.12 | campaignName | 推广系列名称 | string | 测试推广系列 | 可选 | 推广系列名称 |
| 2.1.13 | cashSpend | 现金消耗(只支持广告组层级) | string | 1100 | 可选 | 现金消耗(只支持广告组层级) |
| 2.1.14 | clicks | 点击量 | integer | 500 | 可选 | 点击量 |
| 2.1.15 | companyId | 公司id | string | 100001 | 可选 | 公司id |
| 2.1.16 | conversion | 转化量 | integer | 25 | 可选 | 转化量 |
| 2.1.17 | conversionRate | 转化率 | string | 0.05 | 可选 | 转化率 |
| 2.1.18 | costPer1000Reached | 覆盖千人成本 | string | 150 | 可选 | 覆盖千人成本 |
| 2.1.19 | costPerConversion | 平均转化成本 | string | 50.02 | 可选 | 平均转化成本 |
| 2.1.20 | costPerOnsiteInitiateCheckoutCount | 开始结账平均成本(商店) | string | 31.26 | 可选 | 开始结账平均成本(商店) |
| 2.1.21 | costPerOnsiteOnWebCart | 加入购物车平均成本(商店) | string | 15.63 | 可选 | 加入购物车平均成本(商店) |
| 2.1.22 | costPerOnsiteOnWebDetail | 商品页浏览平均成本(商店) | string | 6.25 | 可选 | 商品页浏览平均成本(商店) |
| 2.1.23 | costPerOnsiteShopping | 平均付费成本(商店) | string | 50.02 | 可选 | 平均付费成本(商店) |
| 2.1.24 | costPerResult | 平均成效成本 | string | 41.68 | 可选 | 平均成效成本 |
| 2.1.25 | cpc | cpc | string | 2.5 | 可选 | CPC,单次点击成本 |
| 2.1.26 | cpm | cpm | string | 125.05 | 可选 | CPM,千次展示成本 |
| 2.1.27 | createTime | 创建时间 | string | 2024-11-01 10:00:00 | 可选 | 创建时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.28 | creativeType | 创意素材类型 | string | CUSTOMIZED_CREATIVE | 可选 | 创意素材类型 |
| 2.1.29 | ctr | 点击率 | string | 0.05 | 可选 | 点击率 |
| 2.1.30 | currency | 币种 | string | USD | 可选 | 币种 |
| 2.1.31 | displayTimezone | 地区&时区(地区中文) | string | Asia/Shanghai | 可选 | 地区&时区(地区中文) |
| 2.1.32 | engagedView | 播放6秒次数(专注观看) | integer | 750 | 可选 | 播放6秒次数(专注观看) |
| 2.1.33 | engagedView15s | 播放15秒次数(专注观看) | integer | 600 | 可选 | 播放15秒次数(专注观看) |
| 2.1.34 | frequency | 频次 | integer | 2 | 可选 | 频次 |
| 2.1.35 | gmtOffset | 地区&时区(时区) | string | +08:00 | 可选 | 地区&时区(时区) |
| 2.1.36 | grossImpressions | 总展示数(包含无效展示) | integer | 10500 | 可选 | 总展示数(包含无效展示) |
| 2.1.37 | id | id | string | 7123456789012345678 | 可选 | id,与各层级的维度id如campaignId,adgroupId,adId相同 |
| 2.1.38 | impressions | 展示量 | integer | 10000 | 可选 | 展示量 |
| 2.1.39 | liveEffectiveViews | 直播播放10秒次数 | integer | 3800 | 可选 | 直播播放10秒次数 |
| 2.1.40 | liveProductClicks | 直播商品点击数 | integer | 150 | 可选 | 直播商品点击数 |
| 2.1.41 | liveUniqueViews | 直播去重播放量 | integer | 4500 | 可选 | 直播去重播放量 |
| 2.1.42 | liveViews | 直播播放量 | integer | 5000 | 可选 | 直播播放量 |
| 2.1.43 | modifyTime | 修改时间 | string | 2024-11-12 15:30:00 | 可选 | 修改时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.44 | onsiteInitiateCheckoutCount | 开始结账数(商店) | integer | 40 | 可选 | 开始结账数(商店) |
| 2.1.45 | onsiteInitiateCheckoutCountRate | 开始结账率(商店) | string | 0.08 | 可选 | 开始结账率(商店) |
| 2.1.46 | onsiteOnWebCart | 加入购物车数(商店) | integer | 80 | 可选 | 加入购物车数(商店) |
| 2.1.47 | onsiteOnWebCartRate | 加入购物车率(商店) | string | 0.16 | 可选 | 加入购物车率(商店) |
| 2.1.48 | onsiteOnWebDetail | 商品页浏览数(商店) | integer | 200 | 可选 | 商品页浏览数(商店) |
| 2.1.49 | onsiteOnWebDetailRate | 商品页浏览率(商店) | string | 0.4 | 可选 | 商品页浏览率(商店) |
| 2.1.50 | onsiteShopping | 付费数(商店) | integer | 25 | 可选 | 付费数(商店) |
| 2.1.51 | onsiteShoppingRate | 付费率(商店) | string | 0.05 | 可选 | 付费率(商店) |
| 2.1.52 | onsiteShoppingRoas | ROAS(商店) | string | 2.5 | 可选 | ROAS(商店),广告支出回报率 |
| 2.1.53 | ownerBcId | 广告主BusinessId | string | 123456 | 可选 | 广告主BusinessId |
| 2.1.54 | ownerBcName | 广告主Business名称 | string | 测试广告主 | 可选 | 广告主Business名称 |
| 2.1.55 | reach | 覆盖人数 | integer | 8000 | 可选 | 覆盖人数 |
| 2.1.56 | realTimeConversion | 实时转化量 | integer | 28 | 可选 | 实时转化量 |
| 2.1.57 | realTimeConversionRateV2 | 实时转化率(展示) | string | 0.0028 | 可选 | 实时转化率(展示) |
| 2.1.58 | realTimeCostPerConversion | 实时平均转化成本 | string | 44.66 | 可选 | 实时平均转化成本 |
| 2.1.59 | realTimeCostPerResult | 实时平均成效成本 | string | 39.08 | 可选 | 实时平均成效成本 |
| 2.1.60 | realTimeResult | 实时成效数 | integer | 32 | 可选 | 实时成效数 |
| 2.1.61 | result | 成效数 | integer | 30 | 可选 | 成效数 |
| 2.1.62 | resultRate | 成效率 | string | 0.06 | 可选 | 成效率 |
| 2.1.63 | serviceStatus | 服务状态 | string | ACTIVE | 可选 | 服务状态 |
| 2.1.64 | spend | 花费 | string | 1250.5 | 可选 | 花费 |
| 2.1.65 | status | 状态 | string | STATUS_ENABLE | 可选 | 状态,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户 |
| 2.1.66 | totalOnsiteInitiateCheckoutCountValue | 开始结账价值(商店) | string | 3125.6 | 可选 | 开始结账价值(商店) |
| 2.1.67 | totalOnsiteOnWebCartValue | 加入购物车价值(商店) | string | 3125.6 | 可选 | 加入购物车价值(商店) |
| 2.1.68 | totalOnsiteOnWebDetailValue | 商品页浏览价值(商店) | string | 3125 | 可选 | 商品页浏览价值(商店) |
| 2.1.69 | totalOnsiteShoppingValue | 总收入(商店) | string | 3125.5 | 可选 | 总收入(商店) |
| 2.1.70 | valuePerOnsiteInitiateCheckoutCount | 开始结账平均价值(商店) | string | 78.14 | 可选 | 开始结账平均价值(商店) |
| 2.1.71 | valuePerOnsiteOnWebCart | 加入购物车平均价值(商店) | string | 39.07 | 可选 | 加入购物车平均价值(商店) |
| 2.1.72 | valuePerOnsiteOnWebDetail | 商品页浏览平均价值(商店) | string | 15.63 | 可选 | 商品页浏览平均价值(商店) |
| 2.1.73 | valuePerOnsiteShopping | 平均订单价值(商店) | string | 125.02 | 可选 | 平均订单价值(商店) |
| 2.1.74 | videoCompletionRate | 完播率 | string | 0.35 | 可选 | 完播率 |
| 2.1.75 | videoId | 视频Id | string | v1234567890 | 可选 | 视频Id |
| 2.1.76 | videoPlayActions | 视频播放量 | integer | 1200 | 可选 | 视频播放量 |
| 2.1.77 | videoType | 视频类型 | string | USER_GENERATE | 可选 | 视频类型 |
| 2.1.78 | videoViews2sRate | 2s完播率 | string | 0.83 | 可选 | 2s完播率 |
| 2.1.79 | videoViews6sRate | 6s完播率 | string | 0.67 | 可选 | 6s完播率 |
| 2.1.80 | videoViewsP100 | 播放完成次数 | integer | 420 | 可选 | 播放完成次数 |
| 2.1.81 | videoViewsP25 | 播放25%次数 | integer | 900 | 可选 | 播放25%次数 |
| 2.1.82 | videoViewsP25Rate | 播放25%占比 | string | 0.75 | 可选 | 播放25%占比 |
| 2.1.83 | videoViewsP50 | 播放50%次数 | integer | 700 | 可选 | 播放50%次数 |
| 2.1.84 | videoViewsP50Rate | 播放50%占比 | string | 0.58 | 可选 | 播放50%占比 |
| 2.1.85 | videoViewsP75 | 播放75%次数 | integer | 500 | 可选 | 播放75%次数 |
| 2.1.86 | videoViewsP75Rate | 播放75%占比 | string | 0.42 | 可选 | 播放75%占比 |
| 2.1.87 | videoWatched2s | 视频播放2秒次数 | integer | 1000 | 可选 | 视频播放2秒次数 |
| 2.1.88 | videoWatched6s | 视频播放6秒次数 | integer | 800 | 可选 | 视频播放6秒次数 |
| 2.2 | total | 总记录数 | integer | 100 | 必填 | 总记录数 |
| 3 | error_details | 错误详情 | array<any> | — | 必填 | 错误详情 |
| 4 | message | 提示信息 | string | — | 必填 | 提示信息 |
| 5 | request_id | 请求id | string | — | 必填 | 请求id |
| 6 | response_time | 响应时间 | string | — | 必填 | 响应时间 |
| 7 | total | 总记录数 | integer | — | 必填 | 总记录数 |
领星ERP的接口:查询TikTok - 推广广告 - 广告(/basicOpen/multiplatform/ads/queryTiktokAdList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。