Lingxing
切换旧版

查询TikTok - GMV MAX - 推广系列

POST/basicOpen/multiplatform/ads/queryGmvCampaignReportList

唯一键:subjectId + reportDate

接口信息

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

请求参数

endDatestring
结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天
lengthinteger
每页条数,必填,小于2000
pageinteger
页码,必填,从1开始
startDatestring
开始日期,必填,格式:yyyy-MM-dd
advertiserIdsarray<any>
广告账号ID列表,Long数组,用于筛选特定广告账号
bidTypeCodesarray<any>
优化模式编码列表,String数组,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量
campaignIdinteger
推广系列ID,用于筛选单个推广系列
campaignIdsarray<any>
推广系列ID列表,Long数组,用于查询多个推广系列
gmvMaxPromotionTypeCodesarray<any>
GMV Max类型编码列表,String数组,枚举值:PRODUCT-商品GMV, LIVE-直播GMV
itemGroupIdsarray<any>
广告商品ID列表,Long数组,用于筛选特定商品
orderFieldstring
排序字段名称,如:cost, orders, roi
orderTypestring
排序类型,枚举值:ASC-升序, DESC-降序
ownerBcIdsarray<any>
广告主账号ID列表,Long数组,业务负责人的BC ID列表
scheduleEndDatestring
排期结束日期,格式:yyyy-MM-dd
scheduleStartDatestring
排期开始日期,格式:yyyy-MM-dd
statusarray<any>
推广系列操作状态编码列表,String数组,枚举值:ENABLE-已开启, DISABLE-已暂停, DELETE-已删除
storeIdsarray<any>
店铺ID列表,Long数组,用于筛选特定店铺的数据
summaryCurrencystring
汇总币种编码,用于统一汇总不同币种的数据

请求cURL示例

curl --location 'https://openapi.lingxing.com/multiplatform/ads/queryGmvCampaignReportList?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
    "endDate": "2024-11-30",
    "length": 20,
    "page": 1,
    "startDate": "2024-11-01",
    "advertiserIds": [123456789012345,123456789012346],
    "bidTypeCodes": ["CUSTOM","NO_BID"],
    "campaignId": 1234567890123456789,
    "campaignIds": [1234567890,1234567891],
    "gmvMaxPromotionTypeCodes": ["LIVE","PRODUCT"],
    "itemGroupIds": [111111,222222],
    "orderField": "cost",
    "orderType": "DESC",
    "ownerBcIds": [1001,1002],
    "scheduleEndDate": "2024-12-31",
    "scheduleStartDate": "2024-11-01",
    "status": ["ENABLE","DISABLE"],
    "storeIds": [123456,234567],
    "summaryCurrency": "USD"
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
报告列表,Report对象数组
隐藏子属性
advertiserIdstring必填
广告账号ID
示例 123456789012345
bidTypeCodestring必填
优化模式编码,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量
示例 CUSTOM
bidTypeNamestring必填
优化模式名称,如:目标ROI、最大投放量
示例 目标ROI
campaignIdstring必填
推广系列ID
示例 1234567890123456789
campaignNamestring必填
推广系列名称
示例 双十一促销活动
coststring必填
成本,广告花费总金额
示例 1586.5
costPerLiveViewstring必填
直播播放平均成本,计算公式:cost / liveViews
示例 0.0104
costPerLiveView10Secondstring必填
直播播放达10秒平均成本,计算公式:cost / liveViews10Second
示例 0.0132
costPerOrderstring必填
平均下单成本,计算公式:cost / orders
示例 15.86
currencyCodestring必填
币种编码,如:USD, CNY, EUR
示例 USD
currencyRateMissingCountstring必填
币种汇率缺失计数,标识汇率数据缺失的天数
示例 0
endDatestring必填
结束日期,格式:yyyy-MM-dd
示例 2024-11-30
gmvMaxPromotionTypeCodestring必填
GMV Max类型编码,枚举值:PRODUCT-商品GMV, LIVE-直播GMV
示例 LIVE
gmvMaxPromotionTypeNamestring必填
GMV Max类型名称,如:商品GMV、直播GMV
示例 直播GMV
grossRevenuestring必填
总收入,GMV总金额
示例 5156.13
itemGroupsarray<object>必填
商品列表,ItemGroup对象数组,包含该推广系列关联的商品信息
隐藏子属性
campaignIdstring必填
推广系列ID
示例 1234567890123456789
itemGroupIdstring必填
商品SPU ID
示例 111111
ordersstring必填
订单数,该商品带来的订单量
示例 25
productImageUrlstring必填
商品图片URL,商品主图的完整URL地址
示例 https://example.com/image/product123.jpg
titlestring必填
商品标题,商品的完整标题
示例 TikTok爆款商品
liveFollowsstring必填
直播关注数,直播间新增关注数量
示例 256
liveViewsstring必填
直播播放量,直播间总观看次数
示例 15230
liveViews10Secondstring必填
直播播放达10秒播放量,观看超过10秒的次数
示例 12050
maxDeliveryBudgetstring必填
最大投放量预算,最大投放量模式下的预算限额
示例 10000
netCoststring必填
净成本,扣除退款等后的实际成本
示例 158.5
operationStatusCodestring必填
操作状态编码,枚举值:ENABLE-已开启, DISABLE-已暂停, DELETE-已删除
示例 ENABLE
operationStatusNamestring必填
操作状态名称,如:已开启、已暂停、已删除
示例 已开启
ordersstring必填
订单数,广告带来的总订单量
示例 100
productSpecificTypeCodestring必填
选择商品的维度编码,标识商品选择的维度类型
示例 DIMENSION_SPU
roasBidstring必填
目标ROI,目标ROI模式下设置的目标值
示例 2.5
roistring必填
ROI(投资回报率),计算公式:grossRevenue / cost
示例 3.25
scheduleEndTimestring必填
排期结束时间,格式:yyyy-MM-dd HH:mm:ss
示例 2024-11-30 23:59:59
scheduleStartTimestring必填
排期起始时间,格式:yyyy-MM-dd HH:mm:ss
示例 2024-11-01 00:00:00
startDatestring必填
开始日期,格式:yyyy-MM-dd
示例 2024-11-01
storeCodestring必填
店铺编码
示例 STORE_001
storeIdstring必填
店铺ID
示例 123456
storeNamestring必填
店铺名称
示例 TikTok官方旗舰店
subjectIdstring必填
报告主体ID,用于标识报告的唯一性
示例 1234567890
targetRoiBudgetstring必填
目标ROI预算,目标ROI模式下的预算限额
示例 3
reportDatestring
当startDate与endDate一致时返回
示例 2024-11-30
totalstring必填
总数,返回符合条件的总记录数
示例 158
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
}