Lingxing
切换旧版

查询TikTok - GMV MAX - 广告帐号

POST/basicOpen/multiplatform/ads/queryGmvAdvertiserReportList

唯一键:subjectId + reportDate

接口信息

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

请求参数

endDatestring
结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天
lengthinteger
每页条数,必填,小于2000
pageinteger
页码,必填,从1开始
startDatestring
开始日期,必填,格式:yyyy-MM-dd
advertiserIdsarray<any>
广告账号ID列表,Long数组,用于筛选特定广告账号
gmvMaxPromotionTypeCodesarray<any>
GMV Max类型编码列表,String数组,枚举值:PRODUCT-商品GMV, LIVE-直播GMV
orderFieldstring
排序字段名称,如:cost, orders, roi
orderTypestring
排序方式,枚举值:ASC-升序, DESC-降序
ownerBcIdsarray<any>
广告主账号ID列表,Long数组,业务负责人的BC ID列表
statusarray<any>
广告账号状态编码列表,String数组,枚举值:STATUS_ENABLE-已启用, SYSTEM_STATUS_IN_REVIEW-审核中, SYSTEM_STATUS_NOT_PASS-未通过, STATUS_LIMIT-惩罚中, STATUS_DISABLE-已关户
storeIdsarray<any>
店铺ID列表,Long数组,用于筛选特定店铺的数据
summaryCurrencystring
汇总币种编码,默认USD,用于统一汇总不同币种的数据

请求cURL示例

curl --location 'https://openapi.lingxing.com/multiplatform/ads/queryGmvAdvertiserReportList?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,987654321098765],
    "gmvMaxPromotionTypeCodes": ["PRODUCT","LIVE"],
    "orderField": "cost",
    "orderType": "DESC",
    "ownerBcIds": [123456789012345,987654321098765],
    "status": ["STATUS_ENABLE","STATUS_DISABLE"],
    "storeIds": [123456,789012],
    "summaryCurrency": "USD"
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
报告列表,Report对象数组
隐藏子属性
advertiserIdstring必填
广告账号ID
示例 7123456789012345678
advertiserNamestring必填
广告账号名称
示例 TikTok Shop US AD Account
balancestring必填
余额,广告账号当前可用余额
示例 25680.9
coststring必填
成本,广告花费总金额
示例 15800.5
costPerOrderstring必填
平均下单成本,计算公式:cost / orders
示例 12.5
currencyCodestring必填
币种编码,如:USD, CNY, EUR
示例 USD
currencyRateMissingCountstring必填
币种汇率缺失计数,标识汇率数据缺失的天数
示例 0
endDatestring必填
结束日期,格式:yyyy-MM-dd
示例 2024-11-30
grossRevenuestring必填
总收入,GMV总金额
示例 98765.8
netCoststring必填
净成本,扣除退款等后的实际成本
示例 14520.3
ordersstring必填
订单数,广告带来的总订单量
示例 1264
roistring必填
ROI(投资回报率),计算公式:grossRevenue / cost
示例 6.25
startDatestring必填
开始日期,格式:yyyy-MM-dd
示例 2024-11-01
statusCodestring必填
状态编码,枚举值:STATUS_DISABLE-已关户, STATUS_PENDING_CONFIRM-审核中, STATUS_PENDING_VERIFIED-审核中, STATUS_CONFIRM_FAIL-未通过, STATUS_ENABLE-已启用, STATUS_CONFIRM_FAIL_END-未通过, STATUS_PENDING_CONFIRM_MODIFY-审核中, STATUS_CONFIRM_MODIFY_FAIL-未通过, STATUS_LIMIT-惩罚中, STATUS_WAIT_FOR_BPM_AUDIT-审核中, STATUS_WAIT_FOR_PUBLIC_AUTH-未通过, STATUS_SELF_SERVICE_UNAUDITED-未通过, STATUS_CONTRACT_PENDING-未通过
示例 STATUS_ENABLE
statusNamestring必填
状态名称,如:已启用、审核中、未通过、惩罚中、已关户
示例 已启用
storesarray<object>必填
店铺列表,Store对象数组,包含该广告账号关联的店铺信息
隐藏子属性
storeCodestring必填
店铺编码
示例 TIKTOK_US_STORE_001
storeIdstring必填
店铺ID
示例 7234567890123456
storeNamestring必填
店铺名称
示例 Official TikTok Store
storesDisplayNamestring必填
店铺显示名称,多个店铺用逗号分隔
示例 Official Store, Brand Shop
subjectIdstring必填
报告主体ID,用于标识报告的唯一性
示例 gmv_advertiser_20241101_20241130
timezoneCodestring必填
时区编码,如:GMT-8, GMT+8
示例 GMT-8
timezoneNamestring必填
时区名称,广告账号所在时区
示例 America/Los_Angeles
reportDatestring
当startDate与endDate一致时返回
示例 2024-11-30
totalstring必填
总数,返回符合条件的总记录数
示例 1523
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
}