# 获取广告位或指定广告单元的信息

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:GetAdunitList

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

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/operationams?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 authorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
pagenumber返回第几页数据
page_sizenumber当页返回数据条数
ad_slotstring广告位类型名称
ad_unit_idstring广告单元ID

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
retnumber错误码
err_msgstring错误信息
ad_unitobjarrayad_unit
total_numnumber总广告单元数据量

# Res.ad_unit(Array) Object Payload

ad_unit

参数名类型说明
ad_slotstring广告位类型名称
ad_unit_idstring广告单元ID
ad_unit_namestring广告单元名称
ad_unit_sizeobject广告单元大小
ad_unit_statusnumber广告单元开关状态 1:开启 2:关闭
video_duration_maxnumber广告展示时长最大值
video_duration_minnumber广告展示时长最小值

# Res.ad_unit(Array).ad_unit_size Object Payload

广告单元大小

参数名类型说明
ad_unit_statusnumber广告单元开关状态 1:开启 2:关闭
video_duration_maxnumber广告展示时长最大值
video_duration_minnumber广告展示时长最小值

# 4. 注意事项

其中access_token为authorizer_access_token

# 其他说明

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 小程序模板广告

# 5. 代码示例

请求示例

POST https://api.weixin.qq.com/wxa/operationams?action=agency_get_adunit_list&access_token=xxxxxxxxxxxxxxx
{
  "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
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

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

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。