Lingxing
切换旧版

查询TikTok - 推广广告 - 广告组

POST/basicOpen/multiplatform/ads/queryTiktokAdGroupList

接口信息

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

请求参数

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
排序方式
ownerBcIdsarray<any>
广告主BusinessId列表,Long数组
searchTypestring
搜索字段,当字段searchValue有值时,该字段也必须有值,且根据报告类型填写对应的值(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
汇总币种

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryTiktokAdGroupList?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],
    "bidStrategies": ["BID_TYPE_CUSTOM"],
    "budgetTypes": ["BUDGET_MODE_DAY"],
    "campaignIds": [123456789012345,987654321098765],
    "currencies": ["USD","CNY"],
    "objectiveType": ["PRODUCT_SALES","WEB_CONVERSIONS"],
    "orderField": "spend",
    "orderType": "DESC",
    "ownerBcIds": [123456,789012],
    "searchType": "ad_group_name",
    "searchValue": ["\u6d4b\u8bd5\u5e7f\u544a\u7ec4"],
    "serviceStatus": ["ACTIVE"],
    "status": ["STATUS_ENABLE","STATUS_DISABLE"],
    "summaryCurrency": "USD"
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
列表数据
隐藏子属性
adGroupIdstring
广告组Id
示例 7123456789012345678
adGroupNamestring
广告组名称
示例 测试广告组
advertiserIdstring
广告账号Id
示例 7123456789012345678
advertiserNamestring
广告账号名称
示例 测试广告账号
attributionEventCountstring
归因事件数
示例 25
averageVideoPlaystring
平均视频播放时长
示例 12.5
averageVideoPlayPerUserstring
用户平均播放时长
示例 10.2
bidstring
竞价
示例 1.5
bidDisplayModestring
出价展示模式
示例 BID_DISPLAY_MODE_STANDARD
bidModestring
出价模式
示例 BID_MODE_CUSTOM
bidStrategystring
竞价策略,枚举值:BID_TYPE_CUSTOM-手动出价, BID_TYPE_NO_BID-最大投放量
示例 BID_TYPE_CUSTOM
billedCoststring
净消耗
示例 245.6
billingEventstring
计费事件
示例 CPC
budgetstring
预算
示例 100.5
budgetTypestring
预算类型,枚举值:BUDGET_MODE_INFINITE-不限预算, BUDGET_MODE_TOTAL-总预算, BUDGET_MODE_DAY-日预算, BUDGET_MODE_DYNAMIC_DAILY_BUDGET-动态日预算
示例 BUDGET_MODE_DAY
campaignIdstring
推广系列Id
示例 7123456789012345678
campaignNamestring
推广系列名称
示例 测试推广系列
cashSpendinteger
现金消耗(只支持广告组层级)
示例 240
clickAttributionWindowstring
点击归因窗口
示例 7
clicksinteger
点击量
示例 500
cnyBilledCostnumber
人民币净消耗
示例 1715.2
cnyCashSpendnumber
人民币现金消耗
示例 1680
cnyCostPerOnsiteInitiateCheckoutCountnumber
人民币开始结账平均成本(商店)
示例 43.88
cnyCostPerOnsiteOnWebCartnumber
人民币加入购物车平均成本(商店)
示例 21.91
cnyCostPerOnsiteOnWebDetailnumber
人民币商品页浏览平均成本(商店)
示例 8.75
cnyCostPerOnsiteShoppingnumber
人民币平均付费成本(商店)
示例 70.01
cnySpendnumber
人民币花费
示例 1750.25
cnyTotalOnsiteShoppingValuenumber
人民币总收入(商店)
示例 6125
companyIdstring
公司id
示例 1001
conversioninteger
转化量
示例 25
conversionRatestring
转化率
示例 0.025
costPer1000Reachedstring
覆盖千人成本
示例 29.48
costPerConversionstring
平均转化成本
示例 10.03
costPerOnsiteInitiateCheckoutCountstring
开始结账平均成本(商店)
示例 6.27
costPerOnsiteOnWebCartstring
加入购物车平均成本(商店)
示例 3.13
costPerOnsiteOnWebDetailstring
商品页浏览平均成本(商店)
示例 1.25
costPerOnsiteShoppingstring
平均付费成本(商店)
示例 10.03
costPerResultstring
平均成效成本
示例 8.36
cpcstring
CPC
示例 0.5
cpmstring
CPM
示例 25.08
createTimestring
创建时间
示例 2024-11-01 10:00:00
ctrstring
点击率
示例 0.05
currencystring
币种
示例 USD
displayTimezonestring
地区&时区(地区中文)
示例 美国东部时间
engagedViewinteger
播放6秒次数(专注观看)
示例 750
engagedView15sinteger
播放15秒次数(专注观看)
示例 600
frequencyinteger
频次
示例 1
gmtOffsetstring
地区&时区(时区)
示例 -05:00
grossImpressionsinteger
总展示数(包含无效展示)
示例 10500
idstring
id(与各层级的维度id如campaignId,adgroupId,adId相同)
示例 7123456789012345678
impressionsinteger
展示量
示例 10000
investEndTimestring
投放结束时间
示例 2024-11-30
investStartTimestring
投放开始时间
示例 2024-11-01
liveEffectiveViewsinteger
直播播放10秒次数
示例 450
liveProductClicksinteger
直播商品点击数
示例 50
liveUniqueViewsinteger
直播去重播放量
示例 480
liveViewsinteger
直播播放量
示例 500
metricsCnyRateMissingCountinteger
指标人民币汇率缺失计数
示例 0
modifyTimestring
修改时间
示例 2024-11-12 15:30:00
objectiveTypestring
推广目标,枚举值:REACH-覆盖人数, TRAFFIC-访问量, VIDEO_VIEWS-视频播放量, LEAD_GENERATION-线索收集, ENGAGEMENT-社区互动, APP_PROMOTION-应用推广, WEB_CONVERSIONS-网站转化量, PRODUCT_SALES-商品销量
示例 PRODUCT_SALES
onsiteInitiateCheckoutCountinteger
开始结账数(商店)
示例 40
onsiteInitiateCheckoutCountRatestring
开始结账率(商店)
示例 0.08
onsiteOnWebCartinteger
加入购物车数(商店)
示例 80
onsiteOnWebCartRatestring
加入购物车率(商店)
示例 0.16
onsiteOnWebDetailinteger
商品页浏览数(商店)
示例 200
onsiteOnWebDetailRatestring
商品页浏览率(商店)
示例 0.4
onsiteShoppinginteger
付费数(商店)
示例 25
onsiteShoppingRatestring
付费率(商店)
示例 0.05
onsiteShoppingRoasstring
ROAS(商店)
示例 3.5
ownerBcIdstring
广告主BusinessId
示例 123456
ownerBcNamestring
广告主Business名称
示例 测试广告主
pacingstring
投放进度
示例 PACING_MODE_SMOOTH
productSourcestring
产品来源
示例 CATALOG
reachinteger
覆盖人数
示例 8500
realTimeConversioninteger
实时转化量
示例 28
realTimeConversionRateV2string
实时转化率(展示)
示例 0.0028
realTimeCostPerConversionstring
实时平均转化成本
示例 8.96
realTimeCostPerResultstring
实时平均成效成本
示例 7.84
realTimeResultinteger
实时成效数
示例 32
reportDatestring
报告日期
示例 2024-11-12
reportUpdateTimestring
报告更新时间(北京)
示例 2024-11-12 16:00:00
resultinteger
成效数
示例 30
resultRatestring
成效率
示例 0.003
scheduledBudgetstring
计划预算
示例 1000
serviceStatusstring
服务状态
示例 ACTIVE
shoppingAdsTypestring
购物广告类型
示例 VIDEO_SHOPPING_ADS
spendstring
花费
示例 250.75
splitTestStatusstring
分割测试状态
示例 NOT_IN_TEST
statusstring
状态
示例 STATUS_ENABLE
totalOnsiteInitiateCheckoutCountValuestring
开始结账价值(商店)
示例 875
totalOnsiteOnWebCartValuestring
加入购物车价值(商店)
示例 875
totalOnsiteOnWebDetailValuestring
商品页浏览价值(商店)
示例 875
totalOnsiteShoppingValuestring
总收入(商店)
示例 875
valuePerOnsiteInitiateCheckoutCountstring
开始结账平均价值(商店)
示例 21.88
valuePerOnsiteOnWebCartstring
加入购物车平均价值(商店)
示例 10.94
valuePerOnsiteOnWebDetailstring
商品页浏览平均价值(商店)
示例 4.38
valuePerOnsiteShoppingstring
平均订单价值(商店)
示例 35
videoCompletionRatestring
完播率(接口无返回)
示例 0.15
videoPlayActionsinteger
视频播放量
示例 1200
videoViews2sRatestring
2s完播率
示例 0.83
videoViews6sRatestring
6s完播率
示例 0.67
videoViewsP100integer
播放完成次数
示例 180
videoViewsP25integer
播放25%次数
示例 900
videoViewsP25Ratestring
播放25%占比
示例 0.75
videoViewsP50integer
播放50%次数
示例 600
videoViewsP50Ratestring
播放50%占比
示例 0.5
videoViewsP75integer
播放75%次数
示例 300
videoViewsP75Ratestring
播放75%占比
示例 0.25
videoWatched2sinteger
视频播放2秒次数
示例 1000
videoWatched6sinteger
视频播放6秒次数
示例 800
viewAttributionWindowstring
浏览归因窗口
示例 1
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
}