Lingxing
切换旧版

查询TikTok - 推广广告 - 广告系列

POST/basicOpen/multiplatform/ads/queryTiktokCampaignList

接口信息

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

请求参数

endDatestring
结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天
lengthinteger
每页条数,必填,小于2000
pageinteger
页码,必填
startDatestring
开始日期,必填,格式:yyyy-MM-dd
advertiserIdsarray<any>
广告账号Id列表,Long数组
bidStrategiesarray<any>
出价策略列表,String数组
budgetTypesarray<any>
预算类型列表,String数组
campaignIdsarray<any>
广告活动id列表,Long数组
currenciesarray<any>
币种列表,String数组
objectiveTypearray<any>
推广目标列表,String数组,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量
orderFieldstring
排序字段(驼峰格式)
orderTypestring
排序方式,枚举值:ASC-升序, DESC-降序
ownerBcIdsarray<any>
广告主BusinessId列表,Long数组
searchTypestring
搜索字段,枚举值:advertiser_name-广告账号, ad_group_name-广告组, campaign_name-推广系列, ad_name-广告。当字段searchValue有值时,该字段也必须有值
searchValuearray<any>
搜索值,String数组
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/queryTiktokCampaignList?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,987654321098765],
    "bidStrategies": ["BID_TYPE_CUSTOM"],
    "budgetTypes": ["BUDGET_MODE_DAY"],
    "campaignIds": [123456789,987654321],
    "currencies": ["USD","CNY"],
    "objectiveType": ["PRODUCT_SALES","WEB_CONVERSIONS"],
    "orderField": "spend",
    "orderType": "DESC",
    "ownerBcIds": [123456789,987654321],
    "searchType": "campaign_name",
    "searchValue": ["\u6d4b\u8bd5\u6d3b\u52a8"],
    "serviceStatus": ["ACTIVE"],
    "status": ["STATUS_ENABLE","STATUS_DISABLE"],
    "summaryCurrency": "CNY"
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
列表数据
隐藏子属性
advertiserIdstring
广告账号Id
示例 123456789012345
advertiserNamestring
广告账号名称
示例 测试账号
averageVideoPlaystring
平均视频播放时长(秒)
示例 12.5
averageVideoPlayPerUserstring
用户平均播放时长(秒)
示例 15.8
bidstring
竞价金额
示例 2.5
bidStrategystring
竞价策略,枚举值:BID_TYPE_CUSTOM-手动出价, BID_TYPE_NO_BID-最大投放量
示例 BID_TYPE_CUSTOM
billedCoststring
净消耗
示例 850
budgetstring
预算金额
示例 1000.5
budgetTypestring
预算类型,枚举值:BUDGET_MODE_INFINITE-不限预算, BUDGET_MODE_TOTAL-总预算, BUDGET_MODE_DAY-日预算, BUDGET_MODE_DYNAMIC_DAILY_BUDGET-动态日预算
示例 BUDGET_MODE_DAY
campaignIdstring
推广系列Id
示例 1234567890
campaignNamestring
推广系列名称
示例 双十一大促活动
campaignProductSourcestring
产品来源
示例 CATALOG
cashSpendinteger
现金消耗(只支持广告组层级)
示例 850
clicksinteger
点击量
示例 1280
companyIdstring
公司id
示例 100001
conversioninteger
转化量
示例 45
conversionRatestring
转化率
示例 0.0352
costPer1000Reachedstring
覆盖千人成本
示例 24.47
costPerConversionstring
平均转化成本
示例 19.03
costPerOnsiteInitiateCheckoutCountstring
开始结账平均成本(商店)
示例 6.85
costPerOnsiteOnWebCartstring
加入购物车平均成本(商店)
示例 3
costPerOnsiteOnWebDetailstring
商品页浏览平均成本(商店)
示例 1.48
costPerOnsiteShoppingstring
平均付费成本(商店)
示例 12.59
costPerResultstring
平均成效成本
示例 17.84
cpcstring
CPC(单次点击成本)
示例 0.67
cpmstring
CPM(千次展示成本)
示例 17.13
createTimestring
创建时间,格式:yyyy-MM-dd HH:mm:ss
示例 2024-11-01 10:00:00
ctrstring
点击率
示例 0.0256
currencystring
币种
示例 USD
displayTimezonestring
地区&时区(地区中文)
示例 美国/洛杉矶
engagedViewinteger
播放6秒次数(专注观看)
示例 6200
engagedView15sinteger
播放15秒次数(专注观看)
示例 4800
frequencyinteger
频次
示例 1
gmtOffsetstring
地区&时区(时区)
示例 UTC-8
grossImpressionsinteger
总展示数(包含无效展示)
示例 52000
idstring
id(与各层级的维度id如campaignId,adgroupId,adId相同)
示例 1234567890
impressionsinteger
展示量
示例 50000
liveEffectiveViewsinteger
直播播放10秒次数
示例 2500
liveProductClicksinteger
直播商品点击数
示例 450
liveUniqueViewsinteger
直播去重播放量
示例 2800
liveViewsinteger
直播播放量
示例 3200
modifyTimestring
修改时间,格式:yyyy-MM-dd HH:mm:ss
示例 2024-11-17 14:44:18
objectiveTypestring
推广目标,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量
示例 PRODUCT_SALES
onsiteInitiateCheckoutCountinteger
开始结账数(商店)
示例 125
onsiteInitiateCheckoutCountRatestring
开始结账率(商店)
示例 0.098
onsiteOnWebCartinteger
加入购物车数(商店)
示例 285
onsiteOnWebCartRatestring
加入购物车率(商店)
示例 0.223
onsiteOnWebDetailinteger
商品页浏览数(商店)
示例 580
onsiteOnWebDetailRatestring
商品页浏览率(商店)
示例 0.453
onsiteShoppinginteger
付费数(商店)
示例 68
onsiteShoppingRatestring
付费率(商店)
示例 0.053
onsiteShoppingRoasstring
ROAS(商店)
示例 2.85
ownerBcIdstring
广告主BusinessId
示例 987654321
ownerBcNamestring
广告主Business名称
示例 测试商家
reachinteger
覆盖人数
示例 35000
realTimeConversioninteger
实时转化量
示例 42
realTimeConversionRateV2string
实时转化率(展示)
示例 0.0328
realTimeCostPerConversionstring
实时平均转化成本
示例 20.39
realTimeCostPerResultstring
实时平均成效成本
示例 19.03
realTimeResultinteger
实时成效数
示例 45
resultinteger
成效数
示例 48
resultRatestring
成效率
示例 0.0375
serviceStatusstring
服务状态
示例 ACTIVE
spendstring
花费金额
示例 856.32
statusstring
状态,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户
示例 STATUS_ENABLE
totalOnsiteInitiateCheckoutCountValuestring
开始结账价值(商店)
示例 2440
totalOnsiteOnWebCartValuestring
加入购物车价值(商店)
示例 2439.6
totalOnsiteOnWebDetailValuestring
商品页浏览价值(商店)
示例 2441.8
totalOnsiteShoppingValuestring
总收入(商店)
示例 2440.12
valuePerOnsiteInitiateCheckoutCountstring
开始结账平均价值(商店)
示例 19.52
valuePerOnsiteOnWebCartstring
加入购物车平均价值(商店)
示例 8.56
valuePerOnsiteOnWebDetailstring
商品页浏览平均价值(商店)
示例 4.21
valuePerOnsiteShoppingstring
平均订单价值(商店)
示例 35.88
videoCompletionRatestring
完播率
示例 0.35
videoPlayActionsinteger
视频播放量
示例 8500
videoViews2sRatestring
2s完播率
示例 0.92
videoViews6sRatestring
6s完播率
示例 0.76
videoViewsP100integer
播放完成次数
示例 2975
videoViewsP25integer
播放25%次数
示例 6800
videoViewsP25Ratestring
播放25%占比
示例 0.8
videoViewsP50integer
播放50%次数
示例 5200
videoViewsP50Ratestring
播放50%占比
示例 0.61
videoViewsP75integer
播放75%次数
示例 3800
videoViewsP75Ratestring
播放75%占比
示例 0.45
videoWatched2sinteger
视频播放2秒次数
示例 7800
videoWatched6sinteger
视频播放6秒次数
示例 6500
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
}