/basicOpen/multiplatform/ads/queryAdvertiserList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryAdvertiserList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryAdvertiserList?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 \"advertiserType\": [],\n \"bidStrategies\": [],\n \"budgetTypes\": [],\n \"currencies\": [\"USD\",\"CNY\"],\n \"displayTimezones\": [\"America\\/New_York\"],\n \"orderField\": \"spend\",\n \"orderType\": \"DESC\",\n \"ownerBcIds\": [],\n \"searchType\": \"advertiser_name\",\n \"searchValue\": [],\n \"serviceStatus\": [],\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
}
}| 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 | advertiserType | 广告主类型列表 | array<any> | — | Optional | 广告主类型列表,String数组 |
| 7 | bidStrategies | 出价策略列表 | array<any> | — | Optional | 出价策略列表,String数组 |
| 8 | budgetTypes | 预算类型列表 | array<any> | — | Optional | 预算类型列表,String数组 |
| 9 | currencies | 币种列表 | array<any> | — | Optional | 币种列表,String数组 |
| 10 | displayTimezones | 地区时区列表 | array<any> | — | Optional | 地区时区列表,String数组 |
| 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 | 搜索值列表 |
| 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> | — | Optional | 数据列表 |
| 2.1.1 | advertiserId | 广告账号Id | string | 1234567890123456 | Optional | 广告账号Id |
| 2.1.2 | advertiserName | 广告账号名称 | string | 示例广告账号 | Optional | 广告账号名称 |
| 2.1.3 | averageVideoPlay | 平均视频播放时长(秒) | number | 15.5 | Optional | 平均视频播放时长(秒) |
| 2.1.4 | averageVideoPlayCount | 平均视频播放时长计数 | integer | 200 | Optional | 平均视频播放时长计数 |
| 2.1.5 | averageVideoPlayPerUser | 用户平均播放时长(秒) | number | 12.3 | Optional | 用户平均播放时长(秒) |
| 2.1.6 | averageVideoPlayPerUserCount | 用户平均播放时长计数 | integer | 150 | Optional | 用户平均播放时长计数 |
| 2.1.7 | averageVideoPlayPerUserSum | 用户平均播放时长汇总 | number | 12.3 | Optional | 用户平均播放时长汇总 |
| 2.1.8 | averageVideoPlaySum | 平均视频播放时长汇总 | number | 15.5 | Optional | 平均视频播放时长汇总 |
| 2.1.9 | balance | 账号余额 | number | 1000.5 | Optional | 账号余额 |
| 2.1.10 | basicCnyRateMissingCount | 基础人民币汇率缺失计数 | integer | 0 | Optional | 基础人民币汇率缺失计数 |
| 2.1.11 | billedCost | 净消耗 | number | 4800 | Optional | 净消耗 |
| 2.1.12 | cashSpend | 现金消耗(仅支持广告组层级) | number | 4500 | Optional | 现金消耗(仅支持广告组层级) |
| 2.1.13 | clicks | 点击量 | integer | 5000 | Optional | 点击量 |
| 2.1.14 | cnyBalance | 人民币余额 | number | 7000 | Optional | 人民币余额 |
| 2.1.15 | cnyBilledCost | 人民币净消耗 | number | 33600 | Optional | 人民币净消耗 |
| 2.1.16 | cnyCashSpend | 人民币现金消耗 | number | 31500 | Optional | 人民币现金消耗 |
| 2.1.17 | cnyCostPerOnsiteInitiateCheckoutCount | 人民币开始结账平均成本(商店) | number | 116.67 | Optional | 人民币开始结账平均成本(商店) |
| 2.1.18 | cnyCostPerOnsiteInitiateCheckoutCountCount | 人民币开始结账平均成本计数 | integer | 5 | Optional | 人民币开始结账平均成本计数 |
| 2.1.19 | cnyCostPerOnsiteInitiateCheckoutCountSum | 人民币开始结账平均成本汇总 | number | 30 | Optional | 人民币开始结账平均成本汇总 |
| 2.1.20 | cnyCostPerOnsiteOnWebCart | 人民币加入购物车平均成本(商店) | number | 43.75 | Optional | 人民币加入购物车平均成本(商店) |
| 2.1.21 | cnyCostPerOnsiteOnWebCartCount | 人民币加入购物车平均成本计数 | integer | 50 | Optional | 人民币加入购物车平均成本计数 |
| 2.1.22 | cnyCostPerOnsiteOnWebCartSum | 人民币加入购物车平均成本汇总 | number | 20 | Optional | 人民币加入购物车平均成本汇总 |
| 2.1.23 | cnyCostPerOnsiteOnWebDetail | 人民币商品页浏览平均成本(商店) | number | 7 | Optional | 人民币商品页浏览平均成本(商店) |
| 2.1.24 | cnyCostPerOnsiteOnWebDetailCount | 人民币商品页浏览平均成本计数 | integer | 100 | Optional | 人民币商品页浏览平均成本计数 |
| 2.1.25 | cnyCostPerOnsiteOnWebDetailSum | 人民币商品页浏览平均成本汇总 | number | 10 | Optional | 人民币商品页浏览平均成本汇总 |
| 2.1.26 | cnyCostPerOnsiteShopping | 人民币平均付费成本(商店) | number | 233.33 | Optional | 人民币平均付费成本(商店) |
| 2.1.27 | cnyCostPerOnsiteShoppingCount | 人民币付费平均成本计数 | integer | 10 | Optional | 人民币付费平均成本计数 |
| 2.1.28 | cnyCostPerOnsiteShoppingSum | 人民币付费平均成本汇总 | number | 50 | Optional | 人民币付费平均成本汇总 |
| 2.1.29 | cnySpend | 人民币花费 | number | 35000 | Optional | 人民币花费 |
| 2.1.30 | cnyTotalOnsiteShoppingValue | 人民币总收入(商店) | number | 122500 | Optional | 人民币总收入(商店) |
| 2.1.31 | companyId | 公司id | string | company_123 | Optional | 公司id |
| 2.1.32 | conversion | 转化量 | integer | 100 | Optional | 转化量 |
| 2.1.33 | conversionRate | 转化率 | number | 0.02 | Optional | 转化率 |
| 2.1.34 | costPer1000Reached | 覆盖千人成本 | number | 100 | Optional | 覆盖千人成本 |
| 2.1.35 | costPerConversion | 平均转化成本 | number | 50 | Optional | 平均转化成本 |
| 2.1.36 | costPerOnsiteInitiateCheckoutCount | 开始结账平均成本(商店) | number | 16.67 | Optional | 开始结账平均成本(商店) |
| 2.1.37 | costPerOnsiteOnWebCart | 加入购物车平均成本(商店) | number | 6.25 | Optional | 加入购物车平均成本(商店) |
| 2.1.38 | costPerOnsiteOnWebDetail | 商品页浏览平均成本(商店) | number | 1 | Optional | 商品页浏览平均成本(商店) |
| 2.1.39 | costPerOnsiteShopping | 平均付费成本(商店) | number | 33.33 | Optional | 平均付费成本(商店) |
| 2.1.40 | costPerResult | 平均成效成本 | number | 33.33 | Optional | 平均成效成本 |
| 2.1.41 | country | 国家 | string | US | Optional | 国家 |
| 2.1.42 | cpc | CPC(单次点击成本) | number | 1 | Optional | CPC(单次点击成本) |
| 2.1.43 | cpm | CPM(千次展示成本) | number | 50 | Optional | CPM(千次展示成本) |
| 2.1.44 | ctr | 点击率 | number | 0.05 | Optional | 点击率 |
| 2.1.45 | currency | 币种 | string | USD | Optional | 币种 |
| 2.1.46 | displayTimezone | 地区&时区(地区中文) | string | 美国东部时间 | Optional | 地区&时区(地区中文) |
| 2.1.47 | engagedView | 播放6秒次数(专注观看) | integer | 45000 | Optional | 播放6秒次数(专注观看) |
| 2.1.48 | engagedView15s | 播放15秒次数(专注观看) | integer | 30000 | Optional | 播放15秒次数(专注观看) |
| 2.1.49 | frequency | 频次 | integer | 2 | Optional | 频次 |
| 2.1.50 | gmtOffset | 地区&时区(时区) | string | -05:00 | Optional | 地区&时区(时区) |
| 2.1.51 | grossImpressions | 总展示数(包含无效展示) | integer | 105000 | Optional | 总展示数(包含无效展示) |
| 2.1.52 | id | id(与各层级的维度id如campaignId | string | 1234567890123456 | Optional | id(与各层级的维度id如campaignId,adgroupId,adId相同) |
| 2.1.53 | impressions | 展示量 | integer | 100000 | Optional | 展示量 |
| 2.1.54 | liveEffectiveViews | 直播播放10秒次数 | integer | 10000 | Optional | 直播播放10秒次数 |
| 2.1.55 | liveProductClicks | 直播商品点击数 | integer | 1200 | Optional | 直播商品点击数 |
| 2.1.56 | liveUniqueViews | 直播去重播放量 | integer | 12000 | Optional | 直播去重播放量 |
| 2.1.57 | liveViews | 直播播放量 | integer | 15000 | Optional | 直播播放量 |
| 2.1.58 | metricsCnyRateMissingCount | 指标人民币汇率缺失计数 | integer | 0 | Optional | 指标人民币汇率缺失计数 |
| 2.1.59 | onsiteInitiateCheckoutCount | 开始结账数(商店) | integer | 300 | Optional | 开始结账数(商店) |
| 2.1.60 | onsiteInitiateCheckoutCountRate | 开始结账率(商店) | number | 0.05 | Optional | 开始结账率(商店) |
| 2.1.61 | onsiteInitiateCheckoutCountRateCount | 开始结账率计数 | integer | 40 | Optional | 开始结账率计数 |
| 2.1.62 | onsiteInitiateCheckoutCountRateSum | 开始结账率汇总 | number | 0.05 | Optional | 开始结账率汇总 |
| 2.1.63 | onsiteOnWebCart | 加入购物车数(商店) | integer | 800 | Optional | 加入购物车数(商店) |
| 2.1.64 | onsiteOnWebCartRate | 加入购物车率(商店) | number | 0.08 | Optional | 加入购物车率(商店) |
| 2.1.65 | onsiteOnWebCartRateCount | 加入购物车率计数 | integer | 60 | Optional | 加入购物车率计数 |
| 2.1.66 | onsiteOnWebCartRateSum | 加入购物车率汇总 | number | 0.08 | Optional | 加入购物车率汇总 |
| 2.1.67 | onsiteOnWebDetail | 商品页浏览数(商店) | integer | 5000 | Optional | 商品页浏览数(商店) |
| 2.1.68 | onsiteOnWebDetailRate | 商品页浏览率(商店) | number | 0.15 | Optional | 商品页浏览率(商店) |
| 2.1.69 | onsiteOnWebDetailRateCount | 商品页浏览率计数 | integer | 80 | Optional | 商品页浏览率计数 |
| 2.1.70 | onsiteOnWebDetailRateSum | 商品页浏览率汇总 | number | 0.15 | Optional | 商品页浏览率汇总 |
| 2.1.71 | onsiteShopping | 付费数(商店) | integer | 150 | Optional | 付费数(商店) |
| 2.1.72 | onsiteShoppingRate | 付费率(商店) | number | 0.03 | Optional | 付费率(商店) |
| 2.1.73 | onsiteShoppingRateCount | 付费率计数 | integer | 30 | Optional | 付费率计数 |
| 2.1.74 | onsiteShoppingRateSum | 付费率汇总 | number | 0.03 | Optional | 付费率汇总 |
| 2.1.75 | onsiteShoppingRoas | ROAS(商店) | number | 3.5 | Optional | ROAS(商店) |
| 2.1.76 | onsiteShoppingRoasCount | ROAS(商店)计数 | integer | 20 | Optional | ROAS(商店)计数 |
| 2.1.77 | onsiteShoppingRoasSum | ROAS(商店)汇总 | number | 3.5 | Optional | ROAS(商店)汇总 |
| 2.1.78 | ownerBcId | 广告主BusinessId | string | 987654321 | Optional | 广告主BusinessId |
| 2.1.79 | ownerBcName | 广告主Business名称 | string | 示例商家 | Optional | 广告主Business名称 |
| 2.1.80 | reach | 覆盖人数 | integer | 50000 | Optional | 覆盖人数 |
| 2.1.81 | realTimeConversion | 实时转化量 | integer | 120 | Optional | 实时转化量 |
| 2.1.82 | realTimeConversionRateV2 | 实时转化率(展示) | number | 0.025 | Optional | 实时转化率(展示) |
| 2.1.83 | realTimeCostPerConversion | 实时平均转化成本 | number | 41.67 | Optional | 实时平均转化成本 |
| 2.1.84 | realTimeCostPerResult | 实时平均成效成本 | number | 27.78 | Optional | 实时平均成效成本 |
| 2.1.85 | realTimeResult | 实时成效数 | integer | 180 | Optional | 实时成效数 |
| 2.1.86 | reportDate | 报告日期 | string | 2024-11-01 | Optional | 报告日期,格式:yyyy-MM-dd |
| 2.1.87 | reportUpdateTime | 报告更新时间(北京时间) | string | 2024-11-17 14:44:05 | Optional | 报告更新时间(北京时间) |
| 2.1.88 | result | 成效数 | integer | 150 | Optional | 成效数 |
| 2.1.89 | resultRate | 成效率 | number | 0.03 | Optional | 成效率 |
| 2.1.90 | serviceStatus | 服务状态 | string | ACTIVE | Optional | 服务状态 |
| 2.1.91 | spend | 花费 | number | 5000 | Optional | 花费 |
| 2.1.92 | status | 状态 | string | STATUS_ENABLE | Optional | 状态,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户 |
| 2.1.93 | totalOnsiteInitiateCheckoutCountValue | 开始结账价值(商店) | number | 30000 | Optional | 开始结账价值(商店) |
| 2.1.94 | totalOnsiteOnWebCartValue | 加入购物车价值(商店) | number | 64000 | Optional | 加入购物车价值(商店) |
| 2.1.95 | totalOnsiteOnWebDetailValue | 商品页浏览价值(商店) | number | 250000 | Optional | 商品页浏览价值(商店) |
| 2.1.96 | totalOnsiteShoppingValue | 总收入(商店) | number | 17500 | Optional | 总收入(商店) |
| 2.1.97 | valuePerOnsiteInitiateCheckoutCount | 开始结账平均价值(商店) | number | 100 | Optional | 开始结账平均价值(商店) |
| 2.1.98 | valuePerOnsiteInitiateCheckoutCountCount | 开始结账平均价值计数 | integer | 40 | Optional | 开始结账平均价值计数 |
| 2.1.99 | valuePerOnsiteInitiateCheckoutCountSum | 开始结账平均价值汇总 | number | 100 | Optional | 开始结账平均价值汇总 |
| 2.1.100 | valuePerOnsiteOnWebCart | 加入购物车平均价值(商店) | number | 80 | Optional | 加入购物车平均价值(商店) |
| 2.1.101 | valuePerOnsiteOnWebCartCount | 加入购物车平均价值计数 | integer | 60 | Optional | 加入购物车平均价值计数 |
| 2.1.102 | valuePerOnsiteOnWebCartSum | 加入购物车平均价值汇总 | number | 80 | Optional | 加入购物车平均价值汇总 |
| 2.1.103 | valuePerOnsiteOnWebDetail | 商品页浏览平均价值(商店) | number | 50 | Optional | 商品页浏览平均价值(商店) |
| 2.1.104 | valuePerOnsiteOnWebDetailCount | 商品页浏览平均价值计数 | integer | 100 | Optional | 商品页浏览平均价值计数 |
| 2.1.105 | valuePerOnsiteOnWebDetailSum | 商品页浏览平均价值汇总 | number | 50 | Optional | 商品页浏览平均价值汇总 |
| 2.1.106 | valuePerOnsiteShopping | 平均订单价值(商店) | number | 116.67 | Optional | 平均订单价值(商店) |
| 2.1.107 | valuePerOnsiteShoppingCount | 平均订单价值计数 | integer | 30 | Optional | 平均订单价值计数 |
| 2.1.108 | valuePerOnsiteShoppingSum | 平均订单价值汇总 | number | 120 | Optional | 平均订单价值汇总 |
| 2.1.109 | videoCompletionRate | 完播率 | number | 0.25 | Optional | 完播率 |
| 2.1.110 | videoPlayActions | 视频播放量 | integer | 80000 | Optional | 视频播放量 |
| 2.1.111 | videoViews2sRate | 2s完播率 | number | 0.875 | Optional | 2s完播率 |
| 2.1.112 | videoViews6sRate | 6s完播率 | number | 0.625 | Optional | 6s完播率 |
| 2.1.113 | videoViewsP100 | 播放完成次数 | integer | 20000 | Optional | 播放完成次数 |
| 2.1.114 | videoViewsP25 | 播放25%次数 | integer | 60000 | Optional | 播放25%次数 |
| 2.1.115 | videoViewsP25Rate | 播放25%占比 | number | 0.75 | Optional | 播放25%占比 |
| 2.1.116 | videoViewsP50 | 播放50%次数 | integer | 40000 | Optional | 播放50%次数 |
| 2.1.117 | videoViewsP50Rate | 播放50%占比 | number | 0.5 | Optional | 播放50%占比 |
| 2.1.118 | videoViewsP75 | 播放75%次数 | integer | 25000 | Optional | 播放75%次数 |
| 2.1.119 | videoViewsP75Rate | 播放75%占比 | number | 0.3125 | Optional | 播放75%占比 |
| 2.1.120 | videoWatched2s | 视频播放2秒次数 | integer | 70000 | Optional | 视频播放2秒次数 |
| 2.1.121 | videoWatched6s | 视频播放6秒次数 | integer | 50000 | Optional | 视频播放6秒次数 |
| 2.2 | total | 总条数 | integer | 1000 | Optional | 总条数 |
| 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/queryAdvertiserList) 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.