# 更新广告单元
接口应在服务器端调用,详细说明参见服务端API。
# 接口说明
# 接口英文名
AgencyUpdateAdunit
# 功能描述
该 API 用于为小程序更新广告单元。使用过程中如遇到问题,可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。
# 注意事项
其中access_token为authorizer_access_token
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/operationams?action=agency_update_adunit&access_token=xxxxxxxxxxxxxxx
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 广告单元名称 |
ad_unit_id | string | 是 | 广告单元ID |
status | string | 是 | 广告单元开关状态:AD_UNIT_STATUS_ON开通,AD_UNIT_STATUS_OFF关闭 |
video_duration_min | number | 否 | 激励视频广告位必填,广告展示时长最小值。目前可选值:6 |
video_duration_max | number | 否 | 激励视频广告位必填,广告展示时长最大值。目前可选值:15/30/60/86400 |
tmpl_type | number | 否 | 原生模板广告位必填tmpl_type或tmpl_id。方式一:tmpl_type 选择固定模板样式,当前可选值:6竖版上图下文,7竖版上文下图,12竖版上图下文叠加A,13竖版上图下文叠加B,2横幅上图下文,3横幅下图上文,4横板上图下文叠加A,11横板上图下文叠加B,9横幅左图右文,10横幅右图左文,20横幅单图,100001单格子无动画,100003多格子无轮播 |
tmpl_id | string | 否 | 原生模板模板广告位必填tmpl_type或tmpl_id。方式二:自定义创建模板,填入【第三方平台->变现专区->原生模板广告位管理中】自定义创建的模板ID。操作指引见:服务商-原生模板编辑能力指引 |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
ret | number | 错误码 |
err_msg | string | 错误信息 |
# 其他说明
# 广告类型名称说明
广告位类型名称(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_TEMPLATE | 小程序模板广告 |
# 调用示例
示例说明: banner广告位:
# 请求数据示例
{
"name": "测试广告单元",
"ad_unit_id": "adunit-04a286aaed8xxxx",
"status": "AD_UNIT_STATUS_ON"
}
# 返回数据示例
{
"ret": 0,
"err_msg":""
}
示例说明: 激励视频广告位:
# 请求数据示例
{
"name": "测试广告单元",
"ad_unit_id": "adunit-04a286aaed8xxxx",
"status": "AD_UNIT_STATUS_ON",
"video_duration_min": 6,
"video_duration_max": 30
}
# 返回数据示例
{
"ret": 0,
"err_msg":""
}
示例说明: 原生模板广告位:
# 请求数据示例
{
"name": "测试广告单元",
"ad_unit_id": "adunit-04a286aaed8xxxx",
"status": "AD_UNIT_STATUS_ON",
"tmpl_type": 6
}
# 返回数据示例
{
"ret": 0,
"err_msg":""
}
# 错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
0 | ok | ok |
-202 | 内部错误 | 可在一段时间后重试 |
1700 | 参数错误 | 检验输入参数是否符合文档说明 |
1701 | 参数错误 | 检验输入参数是否符合文档说明 |
1735 | 商户未完成协议签署流程 | 完成签约操作 |
1737 | 操作过快 | 等待一分钟后重新操作 |
1803 | 广告单元名称重复 | 修改输入的广告单元名称 |
1807 | 无效流量主 | 通过开通流量主接口为该appid开通流量主 |
2009 | 无效流量主 | 通过开通流量主接口为该appid开通流量主 |
2056 | 服务商未在变现专区开通账户 | 在第三方平台页面的变现专区开通服务 |