Lingxing
切换旧版

查询TikTok - 推广广告 - 广告帐号

POST/basicOpen/multiplatform/ads/queryAdvertiserList

接口信息

API Path请求协议请求方式令牌桶容量
/basicOpen/multiplatform/ads/queryAdvertiserListHTTPSPOST1

请求参数

endDatestring
结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天
lengthinteger
每页条数,必填,小于2000
pageinteger
页码,必填
startDatestring
开始日期,必填,格式:yyyy-MM-dd
advertiserIdsarray<any>
广告账号Id列表,Long数组
advertiserTypearray<any>
广告主类型列表,String数组
bidStrategiesarray<any>
出价策略列表,String数组
budgetTypesarray<any>
预算类型列表,String数组
currenciesarray<any>
币种列表,String数组
displayTimezonesarray<any>
地区时区列表,String数组
orderFieldstring
排序字段(驼峰格式)
orderTypestring
排序方式
ownerBcIdsarray<any>
广告主BusinessId列表,Long数组
searchTypestring
搜索字段,当字段searchValue有值时该字段也必须有值,枚举值:advertiser_name-广告账号, ad_group_name-广告组, campaign_name-推广系列, ad_name-广告
searchValuearray<any>
搜索值列表
serviceStatusarray<any>
服务状态列表,String数组
statusarray<any>
状态列表,String数组,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户
summaryCurrencystring
汇总币种

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryAdvertiserList?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
    "endDate": "2024-11-12",
    "length": 20,
    "page": 1,
    "startDate": "2024-11-01",
    "advertiserIds": [123456789012345],
    "advertiserType": [],
    "bidStrategies": [],
    "budgetTypes": [],
    "currencies": ["USD","CNY"],
    "displayTimezones": ["America\/New_York"],
    "orderField": "spend",
    "orderType": "DESC",
    "ownerBcIds": [],
    "searchType": "advertiser_name",
    "searchValue": [],
    "serviceStatus": [],
    "status": ["STATUS_ENABLE","STATUS_DISABLE"],
    "summaryCurrency": "CNY"
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>
数据列表
隐藏子属性
advertiserIdstring
广告账号Id
示例 1234567890123456
advertiserNamestring
广告账号名称
示例 示例广告账号
averageVideoPlaynumber
平均视频播放时长(秒)
示例 15.5
averageVideoPlayCountinteger
平均视频播放时长计数
示例 200
averageVideoPlayPerUsernumber
用户平均播放时长(秒)
示例 12.3
averageVideoPlayPerUserCountinteger
用户平均播放时长计数
示例 150
averageVideoPlayPerUserSumnumber
用户平均播放时长汇总
示例 12.3
averageVideoPlaySumnumber
平均视频播放时长汇总
示例 15.5
balancenumber
账号余额
示例 1000.5
basicCnyRateMissingCountinteger
基础人民币汇率缺失计数
示例 0
billedCostnumber
净消耗
示例 4800
cashSpendnumber
现金消耗(仅支持广告组层级)
示例 4500
clicksinteger
点击量
示例 5000
cnyBalancenumber
人民币余额
示例 7000
cnyBilledCostnumber
人民币净消耗
示例 33600
cnyCashSpendnumber
人民币现金消耗
示例 31500
cnyCostPerOnsiteInitiateCheckoutCountnumber
人民币开始结账平均成本(商店)
示例 116.67
cnyCostPerOnsiteInitiateCheckoutCountCountinteger
人民币开始结账平均成本计数
示例 5
cnyCostPerOnsiteInitiateCheckoutCountSumnumber
人民币开始结账平均成本汇总
示例 30
cnyCostPerOnsiteOnWebCartnumber
人民币加入购物车平均成本(商店)
示例 43.75
cnyCostPerOnsiteOnWebCartCountinteger
人民币加入购物车平均成本计数
示例 50
cnyCostPerOnsiteOnWebCartSumnumber
人民币加入购物车平均成本汇总
示例 20
cnyCostPerOnsiteOnWebDetailnumber
人民币商品页浏览平均成本(商店)
示例 7
cnyCostPerOnsiteOnWebDetailCountinteger
人民币商品页浏览平均成本计数
示例 100
cnyCostPerOnsiteOnWebDetailSumnumber
人民币商品页浏览平均成本汇总
示例 10
cnyCostPerOnsiteShoppingnumber
人民币平均付费成本(商店)
示例 233.33
cnyCostPerOnsiteShoppingCountinteger
人民币付费平均成本计数
示例 10
cnyCostPerOnsiteShoppingSumnumber
人民币付费平均成本汇总
示例 50
cnySpendnumber
人民币花费
示例 35000
cnyTotalOnsiteShoppingValuenumber
人民币总收入(商店)
示例 122500
companyIdstring
公司id
示例 company_123
conversioninteger
转化量
示例 100
conversionRatenumber
转化率
示例 0.02
costPer1000Reachednumber
覆盖千人成本
示例 100
costPerConversionnumber
平均转化成本
示例 50
costPerOnsiteInitiateCheckoutCountnumber
开始结账平均成本(商店)
示例 16.67
costPerOnsiteOnWebCartnumber
加入购物车平均成本(商店)
示例 6.25
costPerOnsiteOnWebDetailnumber
商品页浏览平均成本(商店)
示例 1
costPerOnsiteShoppingnumber
平均付费成本(商店)
示例 33.33
costPerResultnumber
平均成效成本
示例 33.33
countrystring
国家
示例 US
cpcnumber
CPC(单次点击成本)
示例 1
cpmnumber
CPM(千次展示成本)
示例 50
ctrnumber
点击率
示例 0.05
currencystring
币种
示例 USD
displayTimezonestring
地区&时区(地区中文)
示例 美国东部时间
engagedViewinteger
播放6秒次数(专注观看)
示例 45000
engagedView15sinteger
播放15秒次数(专注观看)
示例 30000
frequencyinteger
频次
示例 2
gmtOffsetstring
地区&时区(时区)
示例 -05:00
grossImpressionsinteger
总展示数(包含无效展示)
示例 105000
idstring
id(与各层级的维度id如campaignId,adgroupId,adId相同)
示例 1234567890123456
impressionsinteger
展示量
示例 100000
liveEffectiveViewsinteger
直播播放10秒次数
示例 10000
liveProductClicksinteger
直播商品点击数
示例 1200
liveUniqueViewsinteger
直播去重播放量
示例 12000
liveViewsinteger
直播播放量
示例 15000
metricsCnyRateMissingCountinteger
指标人民币汇率缺失计数
示例 0
onsiteInitiateCheckoutCountinteger
开始结账数(商店)
示例 300
onsiteInitiateCheckoutCountRatenumber
开始结账率(商店)
示例 0.05
onsiteInitiateCheckoutCountRateCountinteger
开始结账率计数
示例 40
onsiteInitiateCheckoutCountRateSumnumber
开始结账率汇总
示例 0.05
onsiteOnWebCartinteger
加入购物车数(商店)
示例 800
onsiteOnWebCartRatenumber
加入购物车率(商店)
示例 0.08
onsiteOnWebCartRateCountinteger
加入购物车率计数
示例 60
onsiteOnWebCartRateSumnumber
加入购物车率汇总
示例 0.08
onsiteOnWebDetailinteger
商品页浏览数(商店)
示例 5000
onsiteOnWebDetailRatenumber
商品页浏览率(商店)
示例 0.15
onsiteOnWebDetailRateCountinteger
商品页浏览率计数
示例 80
onsiteOnWebDetailRateSumnumber
商品页浏览率汇总
示例 0.15
onsiteShoppinginteger
付费数(商店)
示例 150
onsiteShoppingRatenumber
付费率(商店)
示例 0.03
onsiteShoppingRateCountinteger
付费率计数
示例 30
onsiteShoppingRateSumnumber
付费率汇总
示例 0.03
onsiteShoppingRoasnumber
ROAS(商店)
示例 3.5
onsiteShoppingRoasCountinteger
ROAS(商店)计数
示例 20
onsiteShoppingRoasSumnumber
ROAS(商店)汇总
示例 3.5
ownerBcIdstring
广告主BusinessId
示例 987654321
ownerBcNamestring
广告主Business名称
示例 示例商家
reachinteger
覆盖人数
示例 50000
realTimeConversioninteger
实时转化量
示例 120
realTimeConversionRateV2number
实时转化率(展示)
示例 0.025
realTimeCostPerConversionnumber
实时平均转化成本
示例 41.67
realTimeCostPerResultnumber
实时平均成效成本
示例 27.78
realTimeResultinteger
实时成效数
示例 180
reportDatestring
报告日期,格式:yyyy-MM-dd
示例 2024-11-01
reportUpdateTimestring
报告更新时间(北京时间)
示例 2024-11-17 14:44:05
resultinteger
成效数
示例 150
resultRatenumber
成效率
示例 0.03
serviceStatusstring
服务状态
示例 ACTIVE
spendnumber
花费
示例 5000
statusstring
状态,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户
示例 STATUS_ENABLE
totalOnsiteInitiateCheckoutCountValuenumber
开始结账价值(商店)
示例 30000
totalOnsiteOnWebCartValuenumber
加入购物车价值(商店)
示例 64000
totalOnsiteOnWebDetailValuenumber
商品页浏览价值(商店)
示例 250000
totalOnsiteShoppingValuenumber
总收入(商店)
示例 17500
valuePerOnsiteInitiateCheckoutCountnumber
开始结账平均价值(商店)
示例 100
valuePerOnsiteInitiateCheckoutCountCountinteger
开始结账平均价值计数
示例 40
valuePerOnsiteInitiateCheckoutCountSumnumber
开始结账平均价值汇总
示例 100
valuePerOnsiteOnWebCartnumber
加入购物车平均价值(商店)
示例 80
valuePerOnsiteOnWebCartCountinteger
加入购物车平均价值计数
示例 60
valuePerOnsiteOnWebCartSumnumber
加入购物车平均价值汇总
示例 80
valuePerOnsiteOnWebDetailnumber
商品页浏览平均价值(商店)
示例 50
valuePerOnsiteOnWebDetailCountinteger
商品页浏览平均价值计数
示例 100
valuePerOnsiteOnWebDetailSumnumber
商品页浏览平均价值汇总
示例 50
valuePerOnsiteShoppingnumber
平均订单价值(商店)
示例 116.67
valuePerOnsiteShoppingCountinteger
平均订单价值计数
示例 30
valuePerOnsiteShoppingSumnumber
平均订单价值汇总
示例 120
videoCompletionRatenumber
完播率
示例 0.25
videoPlayActionsinteger
视频播放量
示例 80000
videoViews2sRatenumber
2s完播率
示例 0.875
videoViews6sRatenumber
6s完播率
示例 0.625
videoViewsP100integer
播放完成次数
示例 20000
videoViewsP25integer
播放25%次数
示例 60000
videoViewsP25Ratenumber
播放25%占比
示例 0.75
videoViewsP50integer
播放50%次数
示例 40000
videoViewsP50Ratenumber
播放50%占比
示例 0.5
videoViewsP75integer
播放75%次数
示例 25000
videoViewsP75Ratenumber
播放75%占比
示例 0.3125
videoWatched2sinteger
视频播放2秒次数
示例 70000
videoWatched6sinteger
视频播放6秒次数
示例 50000
totalinteger
总条数
示例 1000
error_detailsarray<any>必填
错误详情
messagestring必填
提示信息
request_idstring必填
请求id
response_timestring必填
响应时间
totalinteger必填
总记录数

返回成功示例

{
    "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
}