Lingxing
切换旧版

查询TikTok - GMV MAX - 广告商品

POST/basicOpen/multiplatform/ads/queryGmvItemGroupReportList

唯一键:subjectId + reportDate

接口信息

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

请求参数

endDatestring
结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天
lengthinteger
每页条数,必填,小于2000
pageinteger
页码,必填
startDatestring
开始日期,必填,格式:yyyy-MM-dd
advertiserIdsarray<any>
广告账号ID列表,Long数组
bidTypeCodesarray<any>
优化模式编码列表,String数组,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量
campaignIdsarray<any>
推广系列ID列表,Long数组
itemGroupIdsarray<any>
广告商品ID列表,Long数组
orderFieldstring
排序字段
orderTypestring
排序方式,枚举值:ASC-升序, DESC-降序
ownerBcIdsarray<any>
广告主账号ID列表,Long数组
statusarray<any>
商品状态编码列表,String数组,枚举值:available-可用, unavailable-不可用
storeIdsarray<any>
店铺ID列表,Long数组
summaryCurrencystring
汇总币种编码

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryGmvItemGroupReportList?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
    "endDate": "2024-11-17",
    "length": 20,
    "page": 1,
    "startDate": "2024-11-01",
    "advertiserIds": [123456789012345],
    "bidTypeCodes": ["CUSTOM","NO_BID"],
    "campaignIds": [123456789012345],
    "itemGroupIds": [123456789012345],
    "orderField": "grossRevenue",
    "orderType": "DESC",
    "ownerBcIds": [123456789012345],
    "status": ["available","unavailable"],
    "storeIds": [123456789012345],
    "summaryCurrency": "USD"
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
报告列表,Report对象数组
隐藏子属性
bidTypeCodestring必填
优化模式编码,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量
示例 CUSTOM
bidTypeNamestring必填
优化模式名称
示例 目标ROI
currencyCodestring必填
币种编码
示例 USD
currencyRateMissingCountstring必填
币种汇率缺失计数
示例 0
enabledCampaignIdstring必填
启用的推广系列ID
示例 123456789012345
enabledCampaignNamestring必填
启用的推广系列名称
示例 双十一推广系列
endDatestring必填
结束日期,格式:yyyy-MM-dd
示例 2024-11-17
grossRevenuestring必填
总收入
示例 12345.67
itemGroupIdstring必填
商品SPU ID
示例 123456789012345
ordersstring必填
订单数
示例 150
productImageUrlstring必填
商品图片URL
示例 https://example.com/product.jpg
productStatusCodestring必填
商品状态编码,枚举值:available-可用, unavailable-不可用
示例 available
productStatusNamestring必填
商品状态名称
示例 可用
startDatestring必填
开始日期,格式:yyyy-MM-dd
示例 2024-11-01
storeCodestring必填
店铺编码
示例 STORE001
storeIdstring必填
店铺ID
示例 123456789012345
storeNamestring必填
店铺名称
示例 旗舰店
subjectIdstring必填
报告主体ID
示例 REPORT_123456
titlestring必填
商品标题
示例 iPhone 15 Pro Max
reportDatestring
当startDate与endDate一致时返回
示例 2024-11-30
totalstring必填
总记录数
示例 1000
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
}