Lingxing
切换旧版

SB广告活动 - 广告位报告

POST/pb/openapi/newad/hsaCampaignPlacementReports

基本信息

API Path请求协议请求方式令牌桶容量
/pb/openapi/newad/hsaCampaignPlacementReportsHTTPSPOST10

请求头

标签必填说明类型示例
X-API-VERSION是【兼容旧版本】
不添加标签:offset 为分页页码,从1开始
值为 2 时:offset 为分页偏移量,从0开始
[int]2

请求参数

sidinteger必填
店铺id ,对应查询亚马逊店铺列表接口对应字段【sid】
profile_idinteger必填
VC广告店铺profile_id,对应查询广告账号列表接口对应字段【profile_id】,sid跟profile_id其中一个必填
report_datestring必填
报表日期,格式:Y-m-d
offsetinteger
分页偏移量,默认0
lengthinteger
分页长度,默认15

请求示例

{
    "sid": 109,
    "report_date": "2022-06-01",
    "offset": 0,
    "length": 15
}

返回结果

Json Object

codeinteger必填
状态码,0 成功
示例 0
messagestring必填
提示消息
示例 操作成功
error_detailsarray<any>必填
错误信息
request_idstring必填
请求链路id
示例 478WOD3-7404-9BDF-8F41-01F0401D1305
response_timestring必填
响应时间
示例 2023-02-17 09:59:19
totalinteger必填
总数
示例 1
dataarray<object>必填
响应数据
隐藏子属性
clicksnumber必填
点击量
示例 14
costnumber必填
花费
示例 12.61
profile_idnumber必填
亚马逊店铺数字id
示例 121923590660074
impressionsnumber必填
展示量
示例 865
report_datestring必填
报表日期
示例 2021-06-23
campaign_idnumber必填
广告活动id
示例 162632371880150
placement_typestring必填
广告位类型
示例 Otheron-Amazon
ordersnumber必填
订单数
示例 3
new_to_brand_ordersnumber必填
品牌新买家订单数量
new_to_brand_unitsnumber必填
品牌新买家销量
new_to_brand_salesnumber必填
品牌新买家销售额
示例 0
new_to_brand_order_percentagenumber必填
品牌新买家订单百分比
示例 0
new_to_brand_order_ratenumber必填
品牌新买家转换率
示例 0
salesnumber必填
销售额
示例 42.48
creative_typestring必填
广告类型: default=》SB video=》SBV
因亚马逊接口变更,已作废,具体创意类型请以SB广告创意对应ad_group_id ad_id对应的 creative->type 为准
示例 video
unitsnumber必填
销量
示例 453
same_unitsnumber必填
直接成交量
示例 453
videofirstquartileviewsnumber必填
播放25%的次数
示例 1002
videomidpointviewsnumber必填
播放50%的次数
示例 100
videothirdquartileviewsnumber必填
播放75%的次数
示例 52
video5secondviewsnumber必填
5秒观看次数
示例 1223
video5secondviewratenumber必填
5秒观看率
示例 22.52
branded_searchesnumber必填
品牌搜索次数
示例 322

返回成功示例

{
    "code": 0,
    "message": "操作成功",
    "error_details": [],
    "request_id": "478WOD3-7404-9BDF-8F41-01F0401D1305",
    "response_time": "2023-02-24 10:56:58",
    "total": 1,
    "data": [
        {
            "clicks": 14,
            "cost": 12.61,
            "profile_id": 121923590660074,
            "impressions": 865,
            "report_date": "2021-06-23",
            "campaign_id": 162632371880150,
            "placement_type": "Otheron-Amazon",
            "orders": 3,
            "same_orders": 3,
            "new_to_brand_orders": null,
            "new_to_brand_units": null,
            "new_to_brand_sales": null,
            "same_sales": 42.48,
            "new_to_brand_order_percentage": null,
            "new_to_brand_order_rate": null,
            "sales": 42.48,
            "creative_type": "video",
            "videofirstquartileviews": 1002,
            "videomidpointviews": 100,
            "videothirdquartileviews": 52,
            "video5secondviews": 1223,
            "video5secondviewrate": 22.52,
            "branded_searches": 322
        }
    ]
}