菜单

素材报表API

一、汇总渠道报表

1、v2接口说明

（1）同样的请求参数会缓存半小时数据，如需定时获取更新数据建议设置请求间隔大于30分钟

（2）可查询 XMP 素材库+媒体素材库创建的素材数据

（3）更新频率：1-2小时

（4）QPM限频为20，一分钟内请求超过20次会返回“请求太频繁”，需要等下一分钟才能再请求

2、接口路径

POST https://xmp-open.mobvista.com/v2/media/material_report/list

3、请求参数

公共请求参数：请参考接口请求协议

参数	类型	必填	说明
start_date	string	Y	YYYY-MM-DD
end_date	string	Y	YYYY-MM-DD，最长跨度不超过30天
dimension	[]string	N	固定维度： material_name（素材名称） md5_file_id（素材md5）可附加多选： date（日期） module（渠道） account_id（广告账户id） account_name（广告账户名称） campaign_id（广告系列 id） campaign_name（广告系列名称） adset_id（广告组 id） adset_name（广告组名称） ad_id（广告 id） ad_name（广告名称） channel_material_id（媒体素材 id，如视频 id、图片 id等） product_id（xmp 产品 id） product_name（ xmp 产品名称） store_package_id（商店 id ）可附加单选： geo（地区）
metrics	[]string	Y	需要拉取的指标，从查询可用指标接口获取
md5_file_id	[]string	N	素材 md5，最多传1000个
module	string	N	媒体渠道，见渠道枚举值
account_id	[]string	N	广告账户 id
geo	[]string	N	地区，只有选地区维度查询才生效，示例：CN
product_id	[]int	N	xmp 产品 id
third_party_timezone	string	N	三方数据指标的时区，见时区枚举值。注意：当在XMP后台已开启三方指标时区切换，通过API拉取三方指标时该字段必传
cost_currency	string	Y	币种，可选：cny、usd、eur
page	int	N	当前页数，默认1。如果返回的 data.list 非空，请将页码+1继续获取下一页内容，直到 data.list 为空
page_size	int	N	每页数量，默认200，可选1至1000

4、请求示例

let dimension=["md5_file_id","material_name"]
request = {
    url:uri,
    method:'POST',
    header:{'Content-Type':'application/json'},
    body:{
        mode:'raw',
        raw:JSON.stringify({
            client_id:clientId,
            timestamp:timestamp,
            sign:sign,
            start_date:startDate,
            end_date:endDate,
            dimension:dimension,
            product_id:[],
            module:"facebook",
            geo:["US","KR"],
            metrics:["impression","ecpm","currency_cost","active_register_rate","video_play_p100_rate"],
            page:page,
            page_size:page_size,
            cost_currency:currency,
            third_party_timezone:"+8"
        }),
        options: {
            raw: {
                language: 'json'
            }
        }
    }
}

5、返回参数

参数	类型	说明
list	[]object	返回的数据列表
page	object	页码
page.page	int	当前页
page.page_size	int	每页数量

（1）list里的维度/属性

参数	类型	说明
material_name	string	素材名称，固定维度。素材md5对应多个素材名称时，取创建时间最新的素材返回
md5_file_id	string	素材md5，固定维度
date	string	日期
module	string	渠道
geo	string	地区
account_id	string	广告账户id
account_name	string	广告账户名称
campaign_id	string	广告系列 id
campaign_name	string	广告系列名称
adset_id	string	广告组 id
adset_name	string	广告组名称
ad_id	string	广告 id
ad_name	string	广告名称
channel_material_id	string	媒体素材 id，如视频id、图片id等
product_id	string	xmp 产品 id
product_name	string	xmp 产品名称
store_package_id	string	商店 id

6、返回示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "active_register_rate": 0,
                "currency_cost": 2568.17,
                "ecpm": 8.91,
                "impression": 288202,
                "video_play_p100_rate": 0,
                "xmp_material_id": "14723131"
            }
        ],
        "page": {
            "page": 1,
            "page_size": 1,
            "next_page": 1
        }
    }
}

上一个

广告报表API

下一个

素材库API

最近修改: 2024-11-22Powered by

大纲