# 创建广告单元

调试诊断

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

接口英文名:AgencyCreateAdunit

该 API 用于为小程序创建广告单元。使用过程中如遇到问题,可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

# 2. 请求参数

# 查询参数 Query String parameters

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

# 请求体 Request Payload

参数名类型必填说明
namestring广告单元名称
typestring广告单元类型
video_duration_minnumber激励视频广告位必填,广告展示时长最小值。目前可选值:6
video_duration_maxnumber激励视频广告位必填,广告展示时长最大值。目前可选值:15/30/60/86400
tmpl_typenumber模板广告位必填tmpl_type或tmpl_id。方式一:tmpl_type 选择固定模板样式,当前可选值:6竖版上图下文,7竖版上文下图,12竖版上图下文叠加A,13竖版上图下文叠加B,2横幅上图下文,3横幅下图上文,4横板上图下文叠加A,11横板上图下文叠加B,9横幅左图右文,10横幅右图左文,20横幅单图,100001单格子无动画,100003多格子无轮播
tmpl_idnumber模板广告位必填tmpl_type或tmpl_id。方式二:自定义创建模板,填入变现专区-原生模板管理自定义创建的模板ID。操作指引见:原生模板编辑能力指引

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
retnumber错误码
err_msgstring错误信息
ad_unit_idstring广告单元ID

# 4. 注意事项

其中access_token为authorizer_access_token

# 其他说明

# 广告类型名称说明

广告位类型名称(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. 代码示例

# 5.1 banner广告位:

请求示例

POST https://api.weixin.qq.com/wxa/operationams?action=agency_create_adunit&access_token=xxxxxxxxxxxxxxx
{
    "name": "测试广告单元",
    "type": "SLOT_ID_WEAPP_BANNER"
}

返回示例

{
    "ret": 0,
    "err_msg":"""ad_unit_id" : "adunit-04a286aaed8xxxx"
} 

# 5.2 激励视频广告位:

请求示例

POST https://api.weixin.qq.com/wxa/operationams?action=agency_create_adunit&access_token=xxxxxxxxxxxxxxx
{
    "name": "测试广告单元",
    "type": "SLOT_ID_WEAPP_REWARD_VIDEO""video_duration_min": 6,
    "video_duration_max": 30
} 

返回示例

{
    "ret": 0,
    "err_msg":"""ad_unit_id" : "adunit-04a286aaed8xxxx"
} 

# 5.3 模板广告位:

请求示例

POST https://api.weixin.qq.com/wxa/operationams?action=agency_create_adunit&access_token=xxxxxxxxxxxxxxx
{
    "name": "测试广告单元",
    "type": "SLOT_ID_WEAPP_TEMPLATE""tmpl_type": 6
} 

返回示例

{
    "ret": 0,
    "err_msg":"""ad_unit_id" : "adunit-04a286aaed8xxxx"
}

# 6. 错误码

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

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

# 7. 适用范围

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