# 获取广告位（除封面广告位）或指定广告单元的信息

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

GetAdunitList

# 功能描述

该 API 用于查询广告位（除封面广告位）或指定广告单元的信息。使用过程中如遇到问题，可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。

# 注意事项

其中access_token为authorizer_access_token

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/wxa/operationams?action=agency_get_adunit_list&access_token=xxxxxxxxxxxxxxx

# 请求参数

属性	类型	必填	说明
page	number	是	返回第几页数据
page_size	number	是	当页返回数据条数
ad_slot	string	否	广告位类型名称
ad_unit_id	string	否	广告单元ID

# 返回参数

属性

类型

说明

ret

number

错误码

err_msg

string

错误信息

ad_unit

array<object>

ad_unit

属性

类型

说明

ad_slot

string

广告位类型名称

ad_unit_id

string

广告单元ID

ad_unit_name

string

广告单元名称

ad_unit_size

object

广告单元大小

	属性	类型	说明

ad_unit_status

number

广告单元开关状态 1：开启 2：关闭

video_duration_max

number

广告展示时长最大值

video_duration_min

number

广告展示时长最小值

total_num

number

总广告单元数据量

# 其他说明

1、返回的广告单元列表按照创建时间倒序，用户请以分页的形式获取。当需要获取全部广告位的清单时，无需传递广告位类型名称及广告单元ID；当需要获取某类型广告位的清单时，仅需传递广告位类型名称；当需要获取某广告位 id 的数据时，仅需传递广告单元ID。

# 广告类型名称说明

广告位类型名称（ad_slot/type）	广告位类型
SLOT_ID_WEAPP_BANNER	小程序banner
SLOT_ID_WEAPP_REWARD_VIDEO	小程序激励视频
SLOT_ID_WEAPP_INTERSTITIAL	小程序插屏广告
SLOT_ID_WEAPP_VIDEO_FEEDS	小程序视频广告
SLOT_ID_WEAPP_VIDEO_BEGIN	小程序视频贴片广告
SLOT_ID_WEAPP_COVER	小程序封面广告
SLOT_ID_WEAPP_TEMPLATE	小程序模板广告

# 调用示例

示例说明: HTTPS请求

# 请求数据示例


{
    "page": 1,
    "page_size": 8,
    "ad_unit_id": "adunit-44e668410cxxxx",
    "ad_slot": "SLOT_ID_WEAPP_REWARD_VIDEO"
}

# 返回数据示例


{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "ad_unit":[
        {
            "ad_slot":"SLOT_ID_WEAPP_REWARD_VIDEO",
            "ad_unit_id":"adunit-e9418ee19XXXXX",
            "ad_unit_name":"rewaXXXX",
            "ad_unit_size":[
                {
                    "height":166,
                    "width":582
                }
            ],
            "ad_unit_status":1,
            "ad_unit_type":"AD_UNIT_TYPE_REWARED_VIDEO",
            "appid":"wx0afc78670fXXXX",
            "video_duration_max":30,
            "video_duration_min":6
        }
    ],
    "total_num":1
}

# 错误码

错误码	错误码取值	解决方案
0	ok	ok
-202	内部错误	可在一段时间后重试
1700	参数错误	检验输入参数是否符合文档说明
1701	参数错误	检验输入参数是否符合文档说明
1735	商户未完成协议签署流程	完成签约操作
1737	操作过快	等待一分钟后重新操作
1807	无效流量主	通过开通流量主接口为该appid开通流量主
2009	无效流量主	通过开通流量主接口为该appid开通流量主
2056	服务商未在变现专区开通账户	在第三方平台页面的变现专区开通服务