Lingxing
切换旧版

查询DSP报告列表 - 订单

POST/basicOpen/dspReport/order/list

接口信息

API Path请求协议请求方式令牌桶容量
/basicOpen/dspReport/order/listHTTPSPOST10

请求参数

offsetinteger
分页偏移量,默认0
lengthinteger
分页长度,默认20
next_tokenstring
Base64 编码的上一页最后一条记录 ID。首次请求可省略。
profile_idstring
DSP账户 ID,对应查询广告账号列表接口返回字段【profile_id】;与dsp_advertiser_id至少传一个,两者同时传入时以dsp_advertiser_id为查询条件。
dsp_advertiser_idinteger
DSP广告主 ID,对应查询DSP广告主列表接口返回字段【advertiserId】;与profile_id至少传一个
start_datestring必填
报告开始日期,双闭区间,格式:Y-m-d,时间间隔最长不超过90天
end_datestring必填
报告结束日期,双闭区间,格式:Y-m-d,时间间隔最长不超过90天

请求示例

{
    "offset": 0,
    "length": 20,
    "profile_id": "4796787438420",
    "start_date": "2022-10-05",
    "end_date": "2022-12-01"
}

返回结果

Json Object

codeinteger必填
状态码,0 成功
示例 0
messagestring必填
消息提示
示例 success
error_detailsarray<any>必填
错误信息
request_idstring必填
请求链路id
示例 C3D9F541-8083-E376-EB5C-606A872F5C89
response_timestring必填
响应时间
示例 2022-12-08 18:27:13
totalinteger必填
总数
示例 0
next_tokenstring必填
当前页最后一条记录 ID 的 Base64 编码;无数据时为空字符串。
示例 NzI1
dataarray<object>必填
响应数据
隐藏子属性
datestring必填
报告日期,格式:yyyy-MM-dd
示例 2022-10-05
profile_idstring必填
亚马逊店铺数字id
示例 1196801708955240
order_idstring必填
订单id
示例 584358905613169595
order_namestring必填
订单名称
示例 DEMO-order_name
advertiser_idstring必填
广告主id
示例 1234567890
advertiser_namestring必填
广告主名称
示例 DEMO-adv
order_start_datestring必填
开始时间
示例 2022-09-13
order_end_datestring必填
结束时间
示例 2023-01-01
order_budgetstring必填
预算
示例 2715.00
spendsstring必填
花费
示例 26.88
salesstring必填
销售额
示例 330.59
ordersstring必填
订单数
示例 10
impressionsstring必填
曝光
示例 4053
viewable_impressionsstring必填
可见展示次数
示例 2176
clicksstring必填
点击
示例 3
dpvstring必填
商品详情页浏览次数
示例 51
total_add_to_cartstring必填
加购次数
示例 22
order_currencystring必填
币种
示例 USD
ad_unitsstring必填
销量
示例 11
idinteger必填
报表记录 ID。
add_to_watchlist_views14dinteger
浏览归因添加到观察列表。
survey_finish_cpa14dnumber
旧版 DSP 指标(survey_finish_cpa14d);说明表未提供业务定义,具体含义及统计口径待确认。
application_views14dinteger
旧版 DSP 指标(application_views14d);说明表未提供业务定义,具体含义及统计口径待确认。
brand_store_engagement5_clicksinteger
旧版 DSP 指标(brand_store_engagement5_clicks);说明表未提供业务定义,具体含义及统计口径待确认。
click_on_redirect_clicks14dinteger
旧版 DSP 指标(click_on_redirect_clicks14d);说明表未提供业务定义,具体含义及统计口径待确认。
dpv_views14dinteger
浏览归因DPV。所推广商品由广告浏览产生的商品详情页浏览量。
sign_up_button_views14dinteger
旧版 DSP 指标(sign_up_button_views14d);说明表未提供业务定义,具体含义及统计口径待确认。
mashup_subscribe_and_save_click_views14dinteger
旧版 DSP 指标(mashup_subscribe_and_save_click_views14d);说明表未提供业务定义,具体含义及统计口径待确认。
referral_cvr14dnumber
旧版 DSP 指标(referral_cvr14d);说明表未提供业务定义,具体含义及统计口径待确认。
total_purchases14dinteger
总订单量。由广告浏览或点击产生的购买活动中包含任意数量的品牌商品的次数。
amazon_platform_feenumber
亚马逊平台费用。
dpvr14dinteger
DPVR。商品详情页浏览率。所推广商品的商品详情页浏览量与广告曝光量之比。DPVR=DPV/曝光量 *100%。
mobile_app_first_starts_cpa14dnumber
旧版 DSP 指标(mobile_app_first_starts_cpa14d);说明表未提供业务定义,具体含义及统计口径待确认。
brand_store_engagement2_clicksinteger
旧版 DSP 指标(brand_store_engagement2_clicks);说明表未提供业务定义,具体含义及统计口径待确认。
total_add_to_cart14dinteger
总ATC。由广告浏览或点击产生的、顾客将品牌商品加入其购物车的次数。
application_cvr14dnumber
旧版 DSP 指标(application_cvr14d);说明表未提供业务定义,具体含义及统计口径待确认。
dpv_clicks14dinteger
点击归因DPV。由广告点击产生的所推广商品商品详情页浏览量。
entity_idstring
DSP 实体 ID;说明表未提供该实体与账户、广告主之间的对应关系。
widget_interaction_clicks14dinteger
旧版 DSP 指标(widget_interaction_clicks14d);说明表未提供业务定义,具体含义及统计口径待确认。
brand_store_engagement1_cpanumber
旧版 DSP 指标(brand_store_engagement1_cpa);说明表未提供业务定义,具体含义及统计口径待确认。
total_roas14dnumber
总ROAS。广告投资回报率,以每笔广告支出为品牌商品带来的归因于广告的销售额来衡量。总ROAS = 总销售额/广告花费。
total_units_sold14dinteger
总销量,由广告浏览或点击产生的品牌商品购买数量。
email_interaction_clicks14dinteger
旧版 DSP 指标(email_interaction_clicks14d);说明表未提供业务定义,具体含义及统计口径待确认。
order_external_idstring
DSP 广告活动外部 ID。
dpv14dinteger
DPV。所推广商品由广告浏览或点击产生的商品详情页浏览量。
rentals_views14dinteger
旧版 DSP 指标(rentals_views14d);说明表未提供业务定义,具体含义及统计口径待确认。
purchase_button14dinteger
旧版 DSP 指标(purchase_button14d);说明表未提供业务定义,具体含义及统计口径待确认。
referral_cpa14dnumber
旧版 DSP 指标(referral_cpa14d);说明表未提供业务定义,具体含义及统计口径待确认。
marketing_landing_page14dinteger
旧版 DSP 指标(marketing_landing_page14d);说明表未提供业务定义,具体含义及统计口径待确认。
total_costnumber
广告总花费;返回值保留两位小数。
total_sales14dnumber
总销售额。归因于广告浏览或点击的品牌商品销售额。
total_detail_page_clicks14dinteger
点击归因总商品详情页浏览量,由广告点击产生的品牌商品详情页浏览次数。
total_detail_page_views14dinteger
总DPV。所有品牌商品由广告浏览或点击产生的商品详情页浏览量。
total_detail_page_view_views14dinteger
浏览归因总商品详情页浏览量,由广告浏览产生的品牌商品详情页浏览次数。
reachinteger
触达人数。自广告活动开始以来接触广告的独立用户数量。
measurable_impressionsinteger
可衡量展示量。
frequency_averagenumber
频率平均值。
gross_click_throughsinteger
总点击量。
gross_impressionsinteger
总展示量。
invalid_click_throughsinteger
无效点击量。
invalid_impressionsinteger
无效展示。
product_review_page_visitsinteger
PRPV。由广告浏览或点击产生的顾客访问所推广商品的商品评论页面的次数。
product_review_page_visits_clicksinteger
PRPV 点击量。由广告点击产生的顾客访问所推广商品的商品评论页面的次数。
product_review_page_visits_viewsinteger
PRPV 浏览量。由广告浏览产生的顾客访问所推广商品的商品评论页面的次数。
total_product_review_page_visitsinteger
总PRPV。由广告浏览或点击产生的顾客访问品牌商品的商品评论页面的次数。
total_product_review_page_visits_clicksinteger
总PRPV 点击量。由广告点击产生的顾客访问品牌商品的商品评论页面的次数。
total_product_review_page_visits_viewsinteger
总PRPV 浏览量。由广告浏览产生的顾客访问品牌商品的商品评论页面的次数。
add_to_listinteger
添加到列表。
add_to_list_clicksinteger
点击归因添加到列表。
add_to_list_viewsinteger
浏览归因添加到列表。
total_add_to_listinteger
总ATL。由广告浏览或点击产生的,顾客将品牌商品添加到心愿单、礼品清单或注册计划的次数。
total_add_to_list_clicksinteger
总ATL 点击量。由广告点击产生的,顾客将品牌商品添加到心愿单、礼品清单或注册计划的次数。
total_add_to_list_viewsinteger
总ATL 浏览量。由广告浏览产生的,顾客将品牌商品添加到心愿单、礼品清单或注册计划的次数。
add_to_cartinteger
ATC。顾客在浏览或点击广告后将所推广商品加入购物车的次数。
add_to_cart_clicksinteger
ATC 点击量。顾客在点击广告后将所推广商品加入购物车的次数。
add_to_cart_viewsinteger
ATC 浏览量。顾客在浏览广告后将所推广商品加入购物车的次数。
total_add_to_cart_clicksinteger
总ATC 点击量。由广告点击产生的、顾客将品牌商品加入其购物车的次数。
total_add_to_cart_viewsinteger
总ATC 浏览量。由广告浏览产生的、顾客将品牌商品加入其购物车的次数。
add_to_shopping_cartinteger
添加到商城购物车。
add_to_shopping_cart_clicksinteger
点击归因添加到商城购物车。
add_to_shopping_cart_viewsinteger
浏览归因添加到商城购物车。
add_to_watchlistinteger
添加到观察列表。
add_to_watchlist_clicksinteger
点击归因添加到观察列表。
total_purchases_viewsinteger
浏览归因总订单量。
total_purchases_clicksinteger
点击归因总订单量。
purchasesinteger
直接订单量。由广告浏览或点击产生的购买活动中包含任意数量的推广的商品的次数。
purchases_clicksinteger
点击归因直接订单量。由广告点击产生的购买活动中包含任意数量的推广的商品的次数。
purchases_viewsinteger
浏览归因直接订单量。由广告浏览产生的购买活动中包含任意数量的推广的商品的次数。
units_soldinteger
直接销量。由广告浏览或点击产生的推广的商品购买量。
roasnumber
ROAS。所推广商品的广告投资回报率,ROAS=直接销售额/广告花费。
combined_purchasesinteger
站内外综合订单量。由广告浏览或点击产生的亚马逊站内及站外购买活动数量。
combined_units_soldinteger
站内外综合销量。由广告浏览或点击产生的从亚马逊站内及站外购买的商品数量。
combined_product_salesnumber
站内外综合销售额。归因于浏览或点击的亚马逊站内及站外购买量所对应的销售额。
combined_purchases_viewsinteger
站内外综合浏览归因购买次数。由广告浏览产生的亚马逊站内及站外购买活动数量。
combined_purchases_clicksinteger
站内外综合点击归因购买次数。由广告点击产生的亚马逊站内及站外购买活动数量。
long_term_salesnumber
长期销售额。
brand_searchesinteger
品牌搜索量。根据与广告活动中的精选 ASIN 相关的品牌,在亚马逊上搜索品牌关键词的次数。
brand_searches_clicksinteger
点击归因的品牌搜索量。
brand_searches_viewsinteger
浏览归因的品牌搜索量。
brand_search_ratenumber
品牌搜索率。品牌搜索量与广告曝光量之比。品牌搜索率=品牌搜索量/曝光量*100%。
new_to_brand_purchasesinteger
品牌新客直接订单量。所推广商品由广告浏览或点击产生的品牌新客购买量。
new_to_brand_purchases_viewsinteger
浏览归因品牌新客直接订单量。
new_to_brand_purchases_clicksinteger
点击归因品牌新客直接订单量。
new_to_brand_units_soldinteger
品牌新客直接销量。由广告浏览或点击产生的、曾经是品牌新客的顾客购买所推广商品的数量。
new_to_brand_product_salesnumber
品牌新客直接销售额。归因于广告浏览或点击产生的品牌新客购买所推广商品产生的销售额。
new_to_brand_detail_page_viewsinteger
品牌新客DPV。所推广商品由广告浏览或点击产生的品牌新客商品详情页浏览量。
new_to_brand_detail_page_view_ratenumber
品牌新客DPVR。所推广商品的品牌新客商品详情页浏览量与广告曝光量之比。品牌新客DPVR=品牌新客DPV/曝光量 *100%。
total_new_to_brand_purchasesinteger
品牌新客总订单量。由广告浏览或点击产生的品牌商品的品牌新客购买量。
total_new_to_brand_purchases_clicksinteger
点击归因品牌新客总订单量。
total_new_to_brand_purchases_viewsinteger
浏览归因品牌新客总订单量。
total_new_to_brand_units_soldinteger
品牌新客总销量,由广告浏览或点击产生的品牌新客购买品牌商品的数量。
total_new_to_brand_salesnumber
品牌新客总销售额。品牌商品归因于广告浏览或点击的品牌新客购买量销售额。
total_new_to_brand_purchases_percentagenumber
品牌新客总订单量占比。品牌商品的品牌新客购买转化量所占的百分比。品牌新客总订单量占比=品牌新客总订单量/总订单量 *100%。
total_new_to_brand_dpvsinteger
品牌新客总DPV。归因于广告浏览或点击的所有品牌商品的品牌新客商品详情页浏览量。
agency_feenumber
代理费用。
total_feenumber
总费用。
video_ad_startinteger
视频开始播放次数。
video_ad_first_quartileinteger
视频播放到1/4进度的次数。
video_ad_midpointinteger
视频播放到一半进度的次数。
video_ad_third_quartileinteger
视频播放到3/4进度的次数。
video_ad_completeinteger
视频完播次数。
measurable_ratenumber必填
可衡量比率。可衡量比率=可衡量展示量/曝光量 *100%。measurable_impressions / impressions × 100,保留两位小数。
viewable_ratenumber必填
可见率。当前接口口径为可见展示量 / 曝光量:viewable_impressions / impressions × 100,保留两位小数。
indirect_purchasesinteger必填
间接订单量。系统计算,间接订单量=总订单量-直接订单量。total_purchases14d - purchases。
indirect_units_soldinteger必填
间接销量。系统计算,间接销量=总销量-直接销量。total_units_sold14d - units_sold。
indirect_salesnumber必填
间接销售额。系统计算,间接销售额=总销售额-直接销售额。total_sales14d - sales,保留两位小数。
total_new_to_brand_purchase_ratenumber必填
品牌新客总购买率。品牌商品的品牌新客购买转化量与广告曝光量之比。品牌新客总购买率 = 品牌新客总订单量/曝光量 * 100%。total_new_to_brand_purchases / impressions × 100,保留两位小数。
new_to_brand_purchases_percentagenumber必填
品牌新客订单量占比,品牌新客直接订单量占直接订单量的百分比。new_to_brand_purchases / purchases × 100,保留两位小数。
ctrnumber
点击率(CTR),广告点击量与曝光量之比。返回数据库存储值,保留两位小数。
ecpmnumber
千次曝光成本(eCPM),每千次广告展示的花费。返回数据库存储值,保留两位小数。
eCPCnumber必填
每次点击成本(eCPC),每次广告点击所需支付的金额。实时计算:total_cost / clicks,保留两位小数并采用 HALF_UP;total_cost 或 clicks 缺失、clicks=0 时返回 0.00。
eCPBrandSearchnumber
品牌搜索成本。
combinedROASnumber
站内外综合ROAS。在亚马逊站内及站外销售的商品的广告投资回报率,计算方式为归因于广告的销售额除以广告支出。站内外综合ROAS=站内外综合商品销售额/广告花费。
longTermROASnumber
长期广告投资回报率(长期 ROAS)。
newToBrandROASnumber
品牌新客ROAS。所推广商品的品牌新客购买对应的广告投资回报率,计算方式为所推广商品由广告产生的品牌新客销售额除以广告支出。品牌新客ROAS = 品牌新客直接销售额/广告花费。
totalNewToBrandROASnumber
品牌新客总ROAS。品牌新客购买量对应的广告投资回报率,计算方式为归因于广告的品牌商品的品牌新客销售额除以广告支出。品牌新客总ROAS = 品牌新客总销售额/广告花费。
totalNewToBrandDPVRatenumber
品牌新客总DPVR。品牌商品的品牌新客 (NTB) 商品详情页浏览率,相对于广告的曝光量。品牌新客总DPVR=品牌新客总DPV/曝光量 * 100%。
3PFeesnumber
第三方费用(3P 费用)。
totalDPVRnumber必填
总DPVR。品牌商品的商品详情页浏览率,相对于广告的展示次数。总DPVR=总DPV /曝光量*100%。total_detail_page_views14d / impressions × 100,保留两位小数。
PRPVRnumber必填
PRPVR。所推广商品的商品评论页面访问量与广告展示量之比。PRPVR = PRPV/展示量*100%。product_review_page_visits / impressions × 100,保留两位小数。
totalPRPVRnumber必填
品牌商品评论页面访问率(总 PRPVR),品牌商品评论页面访问量与广告曝光量之比。total_product_review_page_visits / impressions × 100,保留两位小数。
ATCRnumber必填
ATCR。“加入购物车”转化量与展示量之比。ATCR = ATC/曝光量 *100%。add_to_cart / impressions × 100,保留两位小数。
totalATCRnumber必填
总ATCR。品牌商品的“加入购物车”转化量与广告展示量之比。总 ATCR = 总 ATC/曝光量 *100%。total_add_to_cart14d / impressions × 100,保留两位小数。
ACOSnumber必填
ACOS。系统计算,ACOS=广告花费/总销售额 * 100%。total_cost / total_sales14d × 100,保留两位小数。

返回成功示例

{
    "code": 0,
    "message": "success",
    "error_details": [],
    "request_id": "fab4046bfb224000ad496c1c7d99cdec.1700209671099",
    "response_time": "2023-11-17 16:27:51",
    "next_token": "NzI1",
    "data": [
        {
            "id": 725,
            "date": "2022-10-05",
            "profile_id": "1196801708955240",
            "order_id": "584358905613169595",
            "order_name": "DEMO-order_name",
            "advertiser_id": "1234567890",
            "advertiser_name": "DEMO-adv",
            "order_start_date": "2022-09-13",
            "order_end_date": "2023-01-01",
            "order_budget": "2715.00",
            "total_cost": 26.88,
            "spends": "26.88",
            "sales": "330.59",
            "orders": "10",
            "impressions": "4053",
            "viewable_impressions": "2176",
            "clicks": "3",
            "dpv": "51",
            "total_add_to_cart": "22",
            "order_currency": "USD",
            "ad_units": "11"
        }
    ],
    "total": 1
}