Lingxing
切换旧版

查询TikTok - 推广广告 - 广告

POST/basicOpen/multiplatform/ads/queryTiktokAdList

接口信息

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

请求参数

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

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryTiktokAdList?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",
    "adIds": ["1111111111"],
    "adStyles": ["VIDEO_AD"],
    "adgroupIds": ["9876543210"],
    "advertiserIds": ["123456789012345"],
    "bidStrategies": ["LOWEST_COST"],
    "budgetTypes": ["DAILY"],
    "campaignIds": ["1234567890"],
    "creativeMaterialTypes": ["CUSTOMIZED_CREATIVE"],
    "currencies": ["USD","CNY"],
    "orderField": "spend",
    "orderType": "DESC",
    "ownerBcIds": ["123456"],
    "searchType": "ad_name",
    "searchValue": ["\u6d4b\u8bd5\u5e7f\u544a"],
    "serviceStatus": ["ACTIVE"],
    "status": ["STATUS_ENABLE","SYSTEM_STATUS_IN_REVIEW"],
    "summaryCurrency": "CNY",
    "videoTypes": ["USER_GENERATE"]
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
列表数据
隐藏子属性
adFormatstring
广告样式
示例 VIDEO_AD
adGroupIdstring
广告组Id
示例 7023456789012345678
adGroupNamestring
广告组名称
示例 测试广告组
adIdstring
广告Id
示例 7123456789012345678
adNamestring
广告名称
示例 测试广告
advertiserIdstring
广告账号Id
示例 123456789012345
advertiserNamestring
广告账号名称
示例 测试账号
averageVideoPlaystring
平均视频播放时长,单位:秒
示例 15.5
averageVideoPlayPerUserstring
用户平均播放时长,单位:秒
示例 18.2
billedCoststring
净消耗
示例 1200
campaignIdstring
推广系列Id
示例 6923456789012345678
campaignNamestring
推广系列名称
示例 测试推广系列
cashSpendstring
现金消耗(只支持广告组层级)
示例 1100
clicksinteger
点击量
示例 500
companyIdstring
公司id
示例 100001
conversioninteger
转化量
示例 25
conversionRatestring
转化率
示例 0.05
costPer1000Reachedstring
覆盖千人成本
示例 150
costPerConversionstring
平均转化成本
示例 50.02
costPerOnsiteInitiateCheckoutCountstring
开始结账平均成本(商店)
示例 31.26
costPerOnsiteOnWebCartstring
加入购物车平均成本(商店)
示例 15.63
costPerOnsiteOnWebDetailstring
商品页浏览平均成本(商店)
示例 6.25
costPerOnsiteShoppingstring
平均付费成本(商店)
示例 50.02
costPerResultstring
平均成效成本
示例 41.68
cpcstring
CPC,单次点击成本
示例 2.5
cpmstring
CPM,千次展示成本
示例 125.05
createTimestring
创建时间,格式:yyyy-MM-dd HH:mm:ss
示例 2024-11-01 10:00:00
creativeTypestring
创意素材类型
示例 CUSTOMIZED_CREATIVE
ctrstring
点击率
示例 0.05
currencystring
币种
示例 USD
displayTimezonestring
地区&时区(地区中文)
示例 Asia/Shanghai
engagedViewinteger
播放6秒次数(专注观看)
示例 750
engagedView15sinteger
播放15秒次数(专注观看)
示例 600
frequencyinteger
频次
示例 2
gmtOffsetstring
地区&时区(时区)
示例 +08:00
grossImpressionsinteger
总展示数(包含无效展示)
示例 10500
idstring
id,与各层级的维度id如campaignId,adgroupId,adId相同
示例 7123456789012345678
impressionsinteger
展示量
示例 10000
liveEffectiveViewsinteger
直播播放10秒次数
示例 3800
liveProductClicksinteger
直播商品点击数
示例 150
liveUniqueViewsinteger
直播去重播放量
示例 4500
liveViewsinteger
直播播放量
示例 5000
modifyTimestring
修改时间,格式:yyyy-MM-dd HH:mm:ss
示例 2024-11-12 15:30:00
onsiteInitiateCheckoutCountinteger
开始结账数(商店)
示例 40
onsiteInitiateCheckoutCountRatestring
开始结账率(商店)
示例 0.08
onsiteOnWebCartinteger
加入购物车数(商店)
示例 80
onsiteOnWebCartRatestring
加入购物车率(商店)
示例 0.16
onsiteOnWebDetailinteger
商品页浏览数(商店)
示例 200
onsiteOnWebDetailRatestring
商品页浏览率(商店)
示例 0.4
onsiteShoppinginteger
付费数(商店)
示例 25
onsiteShoppingRatestring
付费率(商店)
示例 0.05
onsiteShoppingRoasstring
ROAS(商店),广告支出回报率
示例 2.5
ownerBcIdstring
广告主BusinessId
示例 123456
ownerBcNamestring
广告主Business名称
示例 测试广告主
reachinteger
覆盖人数
示例 8000
realTimeConversioninteger
实时转化量
示例 28
realTimeConversionRateV2string
实时转化率(展示)
示例 0.0028
realTimeCostPerConversionstring
实时平均转化成本
示例 44.66
realTimeCostPerResultstring
实时平均成效成本
示例 39.08
realTimeResultinteger
实时成效数
示例 32
resultinteger
成效数
示例 30
resultRatestring
成效率
示例 0.06
serviceStatusstring
服务状态
示例 ACTIVE
spendstring
花费
示例 1250.5
statusstring
状态,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户
示例 STATUS_ENABLE
totalOnsiteInitiateCheckoutCountValuestring
开始结账价值(商店)
示例 3125.6
totalOnsiteOnWebCartValuestring
加入购物车价值(商店)
示例 3125.6
totalOnsiteOnWebDetailValuestring
商品页浏览价值(商店)
示例 3125
totalOnsiteShoppingValuestring
总收入(商店)
示例 3125.5
valuePerOnsiteInitiateCheckoutCountstring
开始结账平均价值(商店)
示例 78.14
valuePerOnsiteOnWebCartstring
加入购物车平均价值(商店)
示例 39.07
valuePerOnsiteOnWebDetailstring
商品页浏览平均价值(商店)
示例 15.63
valuePerOnsiteShoppingstring
平均订单价值(商店)
示例 125.02
videoCompletionRatestring
完播率
示例 0.35
videoIdstring
视频Id
示例 v1234567890
videoPlayActionsinteger
视频播放量
示例 1200
videoTypestring
视频类型
示例 USER_GENERATE
videoViews2sRatestring
2s完播率
示例 0.83
videoViews6sRatestring
6s完播率
示例 0.67
videoViewsP100integer
播放完成次数
示例 420
videoViewsP25integer
播放25%次数
示例 900
videoViewsP25Ratestring
播放25%占比
示例 0.75
videoViewsP50integer
播放50%次数
示例 700
videoViewsP50Ratestring
播放50%占比
示例 0.58
videoViewsP75integer
播放75%次数
示例 500
videoViewsP75Ratestring
播放75%占比
示例 0.42
videoWatched2sinteger
视频播放2秒次数
示例 1000
videoWatched6sinteger
视频播放6秒次数
示例 800
totalinteger必填
总记录数
示例 100
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
}