# 获取原生模板广告自定义模板绑定情况

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

接口英文名：GetAgencyTmplIdList

该 API 用于查询服务商自定义创建的原生模板绑定的广告单元列表。使用过程中如遇到问题，可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

本接口不支持云调用

# 第三方调用

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

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
page	number	是	返回第几页数据
page_size	number	是	当页返回数据条数
ad_slot	string	是	广告位类型名称
tmpl_id	string	否	模板广告单元ID
is_return_tmpl_bind_list	number	否	是否返回该模板广告单元ID绑定的商户广告单元信息

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
ret	number	错误码
err_msg	string	错误信息
total_num	string	服务商的总模板广告单元数据量
ad_unit_list	objarray	ad_unit_list

# Res.ad_unit_list(Array) `Object Payload`

ad_unit_list

参数名	类型	说明
tmpl_id	string	模板广告ID
ad_unit_name	string	模板广告单元名称
slot_id	string	广告位类型名称
tmpl_bind_total_num	number	该模板广告单元绑定的商户广告单元数量
tmpl_bind_list	objarray	tmpl_bind_list

# Res.ad_unit_list(Array).tmpl_bind_list`Object Payload`

tmpl_bind_list

参数名	类型	说明
ad_slot	string	广告位类型名称
ad_unit_id	string	广告单元ID
ad_unit_name	string	广告单元名称
ad_unit_size	object	广告单元大小

# Res.ad_unit_list(Array).tmpl_bind_list.ad_unit_size `Object Payload`

广告单元大小

参数名	类型	说明
ad_unit_status	number	广告单元开关状态 1：开启 2：关闭
video_duration_max	number	广告展示时长最大值
video_duration_min	number	广告展示时长最小值

# 4. 注意事项

其中access_token为authorizer_access_token

# 其他说明

1、当仅需要获取原生模板广告自定义模板信息时，不需要传递ad_unit_id及is_return_tmpl_bind_list参数；当需要获取某个自定义模板绑定的商户广告单元信息时，需要传递ad_unit_id及is_return_tmpl_bind_list参数。返回的广告单元列表按照创建时间倒序，用户请以分页的形式获取。

# 5. 代码示例

# 5.1 获取模板广告单元信息请求数据示例：

请求示例

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

{
    "page": 1,
    "page_size": 8,
    "ad_slot": "SLOT_ID_WEAPP_TEMPLATE"
}

返回示例

{
   "ret":0,
    "err_msg": "",
    "ad_unit_list":[
        {
            "tmpl_id": "adunit-e9418ee19XXXXX",
            "ad_unit_name": "",
            "ad_slot": ""
        },
        {
            "tmpl_id": "adunit-e9418ee19XXXXX",
            "ad_unit_name": "",
            "ad_slot": ""
        }
    ],
    "total_num":2
}

# 5.2 获取指定模板广告单元绑定商户的广告单元信息请求数据示例：

请求示例

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

{
    "page": 1,
    "page_size": 8,
    "ad_slot": "SLOT_ID_WEAPP_TEMPLATE",
    "tmpl_id": "adunit-44e668410cxxxx",
    "is_return_tmpl_bind_list": 1
}

返回示例


{
   "ret":0,
    "err_msg": "",
    "ad_unit_list":[
        "tmpl_id": "adunit-e9418ee19XXXXX",
        "ad_unit_name": "",
        "tmpl_text": "",
        "slot_id": "SLOT_ID_WEAPP_TEMPLATE",
        "tmpl_bind_list": [{
                "ad_slot":"SLOT_ID_WEAPP_TEMPLATE",
                "ad_unit_id":"adunit-e9XXXXXXXXXXXX",
                "ad_unit_name":"rewaXXXX",
                "ad_unit_size":[
                    {
                        "height":166,
                        "width":582
                    }
                ],
                "ad_unit_status":1,
                "ad_unit_type":"AD_UNIT_TYPE_TEMPLATE_CUSTOM",
                "appid":"wx0afc78670fXXXX",
                "video_duration_max":30,
                "video_duration_min":6
            }
        ],
        "tmpl_bind_total_num": 1
    ],
    "total_num":1
}

# 6. 错误码

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

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

# 7. 适用范围

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