/basicOpen/multiplatform/ads/queryTiktokCampaignList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryTiktokCampaignList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryTiktokCampaignList?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,987654321098765],\n \"bidStrategies\": [\"BID_TYPE_CUSTOM\"],\n \"budgetTypes\": [\"BUDGET_MODE_DAY\"],\n \"campaignIds\": [123456789,987654321],\n \"currencies\": [\"USD\",\"CNY\"],\n \"objectiveType\": [\"PRODUCT_SALES\",\"WEB_CONVERSIONS\"],\n \"orderField\": \"spend\",\n \"orderType\": \"DESC\",\n \"ownerBcIds\": [123456789,987654321],\n \"searchType\": \"campaign_name\",\n \"searchValue\": [\"\\u6d4b\\u8bd5\\u6d3b\\u52a8\"],\n \"serviceStatus\": [\"ACTIVE\"],\n \"status\": [\"STATUS_ENABLE\",\"STATUS_DISABLE\"],\n \"summaryCurrency\": \"CNY\"\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 | advertiserIds | 广告账号Id列表 | array<any> | — | 可选 | 广告账号Id列表,Long数组 |
| 6 | bidStrategies | 出价策略列表 | array<any> | — | 可选 | 出价策略列表,String数组 |
| 7 | budgetTypes | 预算类型列表 | array<any> | — | 可选 | 预算类型列表,String数组 |
| 8 | campaignIds | 广告活动id列表 | array<any> | — | 可选 | 广告活动id列表,Long数组 |
| 9 | currencies | 币种列表 | array<any> | — | 可选 | 币种列表,String数组 |
| 10 | objectiveType | 推广目标列表 | array<any> | — | 可选 | 推广目标列表,String数组,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量 |
| 11 | orderField | 排序字段(驼峰格式) | string | — | 可选 | 排序字段(驼峰格式) |
| 12 | orderType | 排序方式 | string | — | 可选 | 排序方式,枚举值:ASC-升序, DESC-降序 |
| 13 | ownerBcIds | 广告主BusinessId列表 | array<any> | — | 可选 | 广告主BusinessId列表,Long数组 |
| 14 | searchType | 搜索字段 | string | — | 可选 | 搜索字段,枚举值:advertiser_name-广告账号, ad_group_name-广告组, campaign_name-推广系列, ad_name-广告。当字段searchValue有值时,该字段也必须有值 |
| 15 | searchValue | 搜索值 | array<any> | — | 可选 | 搜索值,String数组 |
| 16 | serviceStatus | 服务状态列表 | array<any> | — | 可选 | 服务状态列表,String数组 |
| 17 | status | 状态列表 | array<any> | — | 可选 | 状态列表,String数组,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户 |
| 18 | summaryCurrency | 汇总币种 | string | — | 可选 | 汇总币种 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | 必填 | 响应码 |
| 2 | data | 返回数据 | object | — | 必填 | 返回数据 |
| 2.1 | list | 列表数据 | array<object> | — | 必填 | 列表数据 |
| 2.1.1 | advertiserId | 广告账号Id | string | 123456789012345 | 可选 | 广告账号Id |
| 2.1.2 | advertiserName | 广告账号名称 | string | 测试账号 | 可选 | 广告账号名称 |
| 2.1.3 | averageVideoPlay | 平均视频播放时长(秒) | string | 12.5 | 可选 | 平均视频播放时长(秒) |
| 2.1.4 | averageVideoPlayPerUser | 用户平均播放时长(秒) | string | 15.8 | 可选 | 用户平均播放时长(秒) |
| 2.1.5 | bid | 竞价金额 | string | 2.5 | 可选 | 竞价金额 |
| 2.1.6 | bidStrategy | 竞价策略 | string | BID_TYPE_CUSTOM | 可选 | 竞价策略,枚举值:BID_TYPE_CUSTOM-手动出价, BID_TYPE_NO_BID-最大投放量 |
| 2.1.7 | billedCost | 净消耗 | string | 850 | 可选 | 净消耗 |
| 2.1.8 | budget | 预算金额 | string | 1000.5 | 可选 | 预算金额 |
| 2.1.9 | budgetType | 预算类型 | string | BUDGET_MODE_DAY | 可选 | 预算类型,枚举值:BUDGET_MODE_INFINITE-不限预算, BUDGET_MODE_TOTAL-总预算, BUDGET_MODE_DAY-日预算, BUDGET_MODE_DYNAMIC_DAILY_BUDGET-动态日预算 |
| 2.1.10 | campaignId | 推广系列Id | string | 1234567890 | 可选 | 推广系列Id |
| 2.1.11 | campaignName | 推广系列名称 | string | 双十一大促活动 | 可选 | 推广系列名称 |
| 2.1.12 | campaignProductSource | 产品来源 | string | CATALOG | 可选 | 产品来源 |
| 2.1.13 | cashSpend | 现金消耗(只支持广告组层级) | integer | 850 | 可选 | 现金消耗(只支持广告组层级) |
| 2.1.14 | clicks | 点击量 | integer | 1280 | 可选 | 点击量 |
| 2.1.15 | companyId | 公司id | string | 100001 | 可选 | 公司id |
| 2.1.16 | conversion | 转化量 | integer | 45 | 可选 | 转化量 |
| 2.1.17 | conversionRate | 转化率 | string | 0.0352 | 可选 | 转化率 |
| 2.1.18 | costPer1000Reached | 覆盖千人成本 | string | 24.47 | 可选 | 覆盖千人成本 |
| 2.1.19 | costPerConversion | 平均转化成本 | string | 19.03 | 可选 | 平均转化成本 |
| 2.1.20 | costPerOnsiteInitiateCheckoutCount | 开始结账平均成本(商店) | string | 6.85 | 可选 | 开始结账平均成本(商店) |
| 2.1.21 | costPerOnsiteOnWebCart | 加入购物车平均成本(商店) | string | 3 | 可选 | 加入购物车平均成本(商店) |
| 2.1.22 | costPerOnsiteOnWebDetail | 商品页浏览平均成本(商店) | string | 1.48 | 可选 | 商品页浏览平均成本(商店) |
| 2.1.23 | costPerOnsiteShopping | 平均付费成本(商店) | string | 12.59 | 可选 | 平均付费成本(商店) |
| 2.1.24 | costPerResult | 平均成效成本 | string | 17.84 | 可选 | 平均成效成本 |
| 2.1.25 | cpc | CPC(单次点击成本) | string | 0.67 | 可选 | CPC(单次点击成本) |
| 2.1.26 | cpm | CPM(千次展示成本) | string | 17.13 | 可选 | CPM(千次展示成本) |
| 2.1.27 | createTime | 创建时间 | string | 2024-11-01 10:00:00 | 可选 | 创建时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.28 | ctr | 点击率 | string | 0.0256 | 可选 | 点击率 |
| 2.1.29 | currency | 币种 | string | USD | 可选 | 币种 |
| 2.1.30 | displayTimezone | 地区&时区(地区中文) | string | 美国/洛杉矶 | 可选 | 地区&时区(地区中文) |
| 2.1.31 | engagedView | 播放6秒次数(专注观看) | integer | 6200 | 可选 | 播放6秒次数(专注观看) |
| 2.1.32 | engagedView15s | 播放15秒次数(专注观看) | integer | 4800 | 可选 | 播放15秒次数(专注观看) |
| 2.1.33 | frequency | 频次 | integer | 1 | 可选 | 频次 |
| 2.1.34 | gmtOffset | 地区&时区(时区) | string | UTC-8 | 可选 | 地区&时区(时区) |
| 2.1.35 | grossImpressions | 总展示数(包含无效展示) | integer | 52000 | 可选 | 总展示数(包含无效展示) |
| 2.1.36 | id | id(与各层级的维度id如campaignId | string | 1234567890 | 可选 | id(与各层级的维度id如campaignId,adgroupId,adId相同) |
| 2.1.37 | impressions | 展示量 | integer | 50000 | 可选 | 展示量 |
| 2.1.38 | liveEffectiveViews | 直播播放10秒次数 | integer | 2500 | 可选 | 直播播放10秒次数 |
| 2.1.39 | liveProductClicks | 直播商品点击数 | integer | 450 | 可选 | 直播商品点击数 |
| 2.1.40 | liveUniqueViews | 直播去重播放量 | integer | 2800 | 可选 | 直播去重播放量 |
| 2.1.41 | liveViews | 直播播放量 | integer | 3200 | 可选 | 直播播放量 |
| 2.1.42 | modifyTime | 修改时间 | string | 2024-11-17 14:44:18 | 可选 | 修改时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.43 | objectiveType | 推广目标 | string | PRODUCT_SALES | 可选 | 推广目标,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量 |
| 2.1.44 | onsiteInitiateCheckoutCount | 开始结账数(商店) | integer | 125 | 可选 | 开始结账数(商店) |
| 2.1.45 | onsiteInitiateCheckoutCountRate | 开始结账率(商店) | string | 0.098 | 可选 | 开始结账率(商店) |
| 2.1.46 | onsiteOnWebCart | 加入购物车数(商店) | integer | 285 | 可选 | 加入购物车数(商店) |
| 2.1.47 | onsiteOnWebCartRate | 加入购物车率(商店) | string | 0.223 | 可选 | 加入购物车率(商店) |
| 2.1.48 | onsiteOnWebDetail | 商品页浏览数(商店) | integer | 580 | 可选 | 商品页浏览数(商店) |
| 2.1.49 | onsiteOnWebDetailRate | 商品页浏览率(商店) | string | 0.453 | 可选 | 商品页浏览率(商店) |
| 2.1.50 | onsiteShopping | 付费数(商店) | integer | 68 | 可选 | 付费数(商店) |
| 2.1.51 | onsiteShoppingRate | 付费率(商店) | string | 0.053 | 可选 | 付费率(商店) |
| 2.1.52 | onsiteShoppingRoas | ROAS(商店) | string | 2.85 | 可选 | ROAS(商店) |
| 2.1.53 | ownerBcId | 广告主BusinessId | string | 987654321 | 可选 | 广告主BusinessId |
| 2.1.54 | ownerBcName | 广告主Business名称 | string | 测试商家 | 可选 | 广告主Business名称 |
| 2.1.55 | reach | 覆盖人数 | integer | 35000 | 可选 | 覆盖人数 |
| 2.1.56 | realTimeConversion | 实时转化量 | integer | 42 | 可选 | 实时转化量 |
| 2.1.57 | realTimeConversionRateV2 | 实时转化率(展示) | string | 0.0328 | 可选 | 实时转化率(展示) |
| 2.1.58 | realTimeCostPerConversion | 实时平均转化成本 | string | 20.39 | 可选 | 实时平均转化成本 |
| 2.1.59 | realTimeCostPerResult | 实时平均成效成本 | string | 19.03 | 可选 | 实时平均成效成本 |
| 2.1.60 | realTimeResult | 实时成效数 | integer | 45 | 可选 | 实时成效数 |
| 2.1.61 | result | 成效数 | integer | 48 | 可选 | 成效数 |
| 2.1.62 | resultRate | 成效率 | string | 0.0375 | 可选 | 成效率 |
| 2.1.63 | serviceStatus | 服务状态 | string | ACTIVE | 可选 | 服务状态 |
| 2.1.64 | spend | 花费金额 | string | 856.32 | 可选 | 花费金额 |
| 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 | 2440 | 可选 | 开始结账价值(商店) |
| 2.1.67 | totalOnsiteOnWebCartValue | 加入购物车价值(商店) | string | 2439.6 | 可选 | 加入购物车价值(商店) |
| 2.1.68 | totalOnsiteOnWebDetailValue | 商品页浏览价值(商店) | string | 2441.8 | 可选 | 商品页浏览价值(商店) |
| 2.1.69 | totalOnsiteShoppingValue | 总收入(商店) | string | 2440.12 | 可选 | 总收入(商店) |
| 2.1.70 | valuePerOnsiteInitiateCheckoutCount | 开始结账平均价值(商店) | string | 19.52 | 可选 | 开始结账平均价值(商店) |
| 2.1.71 | valuePerOnsiteOnWebCart | 加入购物车平均价值(商店) | string | 8.56 | 可选 | 加入购物车平均价值(商店) |
| 2.1.72 | valuePerOnsiteOnWebDetail | 商品页浏览平均价值(商店) | string | 4.21 | 可选 | 商品页浏览平均价值(商店) |
| 2.1.73 | valuePerOnsiteShopping | 平均订单价值(商店) | string | 35.88 | 可选 | 平均订单价值(商店) |
| 2.1.74 | videoCompletionRate | 完播率 | string | 0.35 | 可选 | 完播率 |
| 2.1.75 | videoPlayActions | 视频播放量 | integer | 8500 | 可选 | 视频播放量 |
| 2.1.76 | videoViews2sRate | 2s完播率 | string | 0.92 | 可选 | 2s完播率 |
| 2.1.77 | videoViews6sRate | 6s完播率 | string | 0.76 | 可选 | 6s完播率 |
| 2.1.78 | videoViewsP100 | 播放完成次数 | integer | 2975 | 可选 | 播放完成次数 |
| 2.1.79 | videoViewsP25 | 播放25%次数 | integer | 6800 | 可选 | 播放25%次数 |
| 2.1.80 | videoViewsP25Rate | 播放25%占比 | string | 0.8 | 可选 | 播放25%占比 |
| 2.1.81 | videoViewsP50 | 播放50%次数 | integer | 5200 | 可选 | 播放50%次数 |
| 2.1.82 | videoViewsP50Rate | 播放50%占比 | string | 0.61 | 可选 | 播放50%占比 |
| 2.1.83 | videoViewsP75 | 播放75%次数 | integer | 3800 | 可选 | 播放75%次数 |
| 2.1.84 | videoViewsP75Rate | 播放75%占比 | string | 0.45 | 可选 | 播放75%占比 |
| 2.1.85 | videoWatched2s | 视频播放2秒次数 | integer | 7800 | 可选 | 视频播放2秒次数 |
| 2.1.86 | videoWatched6s | 视频播放6秒次数 | integer | 6500 | 可选 | 视频播放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/queryTiktokCampaignList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。