接口文档SDK业务专题开发者工具

基于组件创建微信原生页
全部接口
V1.1
loading

所属权限 Ads Management
请求地址 wechat_pages_custom/add
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考，代码案例参考。

参数名称 参数类型
access_token 授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节
timestamp

当前的时间戳，单位为秒，允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8，例如当时间戳为 1494840119 时，表示 2017-05-15 17:21:59
nonce 随机字串标识，不超过 32 个字符，由调用方自行生成，需保证全局唯一性
fields get 接口增加 fields 字段，用于指定返回参数的字段列表，为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写，则根据默认值进行返回

请求参数

标有*的参数为必填项

名称 类型 描述
account_id*
 integer 推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id
page_name*
 string 落地页名称
字段长度最小 1 字节，长度最大 120 字节
page_specs_list*
 struct[] 页面列表，页面顺序与生成的原生页的顺序一致
bg_color
 string 背景颜色
字段长度为 7 字节
page_elements_spec_list*
 struct[] 页面组件列表, 页面顺序与生成的原生页的顺序一致
element_type*
 enum 原生页中组件类型，[枚举详情]
枚举列表：{ TOP_IMAGE, TOP_SLIDER, TOP_VIDEO, IMAGE, SLIDER, VIDEO, TEXT, APP_DOWNLOAD, WEAPP, GH, ENTERPRISE_WX, IMAGE_TEXT }
top_image_spec
 struct 顶部图片组件元素
图片大小: 不超过 300KB
图片尺寸: 朋友圈常规广告 800*800, 朋友圈卡片广告 800*450.
公众号及其他广告位 800*800/640*800/800*640/800*450
image_id*
 int64 图片 id. 通过 [images 模块] 上传图片后获得
字段长度最小 1 字节，长度最大 20 字节
width*
 integer 图片宽度
height*
 integer 图片高度
ad_location*
 string 广告位, sns 代表朋友圈, gzh 代表公众号
字段长度为 3 字节
outer_style
 integer ad_location 为 sns 时必填. 取值 0: 常规广告, 1: 卡片广告
最小值 0，最大值 1
top_slider_spec
 struct 顶部轮播图组件元素
图片大小: 不超过 300KB
图片尺寸: 800*800
image_id_list*
 string[] 图片 id 列表, 个数为 3,4,6.
数组最小长度 3，最大长度 6
width*
 integer 图片宽度
height*
 integer 图片高度
top_video_spec
 struct 顶部视频组件元素
视频时长 6-90 秒.
视频尺寸: 朋友圈常规 640*480/640*360/750*1536/750*1334/720*1280/1280*720/1280*960,
微信平台账号：朋友圈基础卡片广告:640*360/750*1536, 朋友圈全福式卡片广告:750*<=1536
腾讯广告账号：卡片广告：640*360
公众号及其他:750*<=1536
video_id*
 int64 视频 id, 通过 [videos 模块] 上传视频后获得
字段长度最小 1 字节，长度最大 20 字节
width*
 integer 视频宽度
height*
 integer 视频高度
ad_location*
 string 广告位, sns 代表朋友圈, gzh 代表公众号
字段长度为 3 字节
outer_style
 integer ad_location 为 sns 时必填
取值 0: 常规广告, 1: 基础卡片广告, 2: 全幅卡片广告
最小值 0，最大值 2
used_for_outer
 integer 仅微信平台账号有效. outer_style=1 时选填
取值 0:顶部素材用于广告外层, 1:顶部素材不用于广告外层. 默认 0.
最小值 0，最大值 1
image_spec
 struct 基础图片组件元素
图片大小: 不超过 300KB
图片尺寸: 宽度 750, 高度不超过 1536
image_id*
 int64 图片 id. 通过 [images 模块] 上传图片后获得
字段长度最小 1 字节，长度最大 20 字节
width*
 integer 图片宽度
height*
 integer 图片高度
padding_top
 integer 距离上一个组件距离. 默认值 0
最小值 0，最大值 100
padding_bottom
 integer 距离下一个组件距离. 默认值 0
最小值 0，最大值 100
slider_spec
 struct 基础轮播图组件元素
图片尺寸: 普通轮播样式: 750*(300-1125),
卡片轮播样式: 512*(288-920)
image_id_list*
 string[] 图片 id 列表, 个数为 2,3,4,5.
数组最小长度 2，最大长度 5
width*
 integer 图片宽度
height*
 integer 图片高度
slider_style*
 integer 轮播图样式. 0: 普通样式, 1: 卡片样式
最小值 0，最大值 1
bg_color
 string 轮播背景颜色. slider_style=1 时有效. 默认#FFFFFF
字段长度为 7 字节
video_spec
 struct 基础视频组件元素
视频时长 1-30 秒.
视频大小不超过 20MB.
视频尺寸: 750*<=1536
video_id*
 int64 视频 id, 通过 [videos 模块] 上传视频后获得
字段长度最小 1 字节，长度最大 20 字节
width*
 integer 视频宽度
height*
 integer 视频高度
in_middle
 integer 是否居中显示. 要求视频单独占用一页. 设置后视频可在页面上下居中显示
取值 0:不居中，1:居中. 默认 0.
最小值 0，最大值 1
text_spec
 struct 基础文本组件元素
text*
 string 文本内容
字段长度最小 1 字节，长度最大 30000 字节
padding_top
 integer 距离上一个组件距离. 默认值 22
最小值 0，最大值 100
padding_bottom
 integer 距离下一个组件距离. 默认值 22
最小值 0，最大值 100
font_size
 integer 字体大小
取值 14, 15, 16, 18, 20, 24, 36. 默认 15
最小值 14，最大值 36
font_color
 string 字体颜色. 默认#595959
字段长度为 7 字节
text_alignment
 integer 对齐方式
取值 0: left, 1: middle, 2: right. 默认 0
最小值 0，最大值 2
font_style
 integer 字体样式
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
app_download_spec
 struct 应用下载组件元素
title*
 string 按钮文案

审核规范：原生页当含有 app_android_spec 或 app_ios_spec 元素时，下载按钮文案必须含有“安装”或“下载”才允许使用


字段长度最小 1 字节，长度最大 30 字节
font_color
 string 下载按钮字体颜色. 默认#FFFFFF
字段长度为 7 字节
bg_color
 string 下载按钮填充色. 默认#07C160
字段长度为 7 字节
padding_top
 integer 距离上一个组件距离. 默认值 28
最小值 0，最大值 100
padding_bottom
 integer 距离下一个组件距离. 默认值 28
最小值 0，最大值 100
app_ios_spec
 struct 应用下载 iOS 元素
app_ios_id*
 string iOS 应用 id
字段长度最小 1 字节，长度最大 128 字节
deep_link_url
 string 应用直达页 url
字段长度最小 1 字节，长度最大 1024 字节
jump_appstore_type
 integer 点击按钮跳转. 取值 0: 外跳 appstore, 1: 内跳 appstore, 默认 0
最小值 0，最大值 1
app_android_spec
 struct 应用下载 Android 元素
app_android_id*
 string Android 应用 id
字段长度最小 1 字节，长度最大 128 字节
deep_link_url
 string 应用直达页 url
字段长度最小 1 字节，长度最大 1024 字节
app_android_channel_package_id
 string Android 应用渠道包 id，当前特指投放腾讯开放平台安卓应用的渠道包 id，从推广目标模块的读取接口可以获取
字段长度最小 1 字节，长度最大 128 字节
app_market_package
 string 跳转应用商店下载使用的 pkg name
字段长度最小 1 字节，长度最大 500 字节
weapp_spec
 struct 进入小程序组件元素
weapp_username*
 string 小程序原始 id
字段长度最小 1 字节，长度最大 50 字节
weapp_path*
 string 小程序路径
字段长度最小 1 字节，长度最大 250 字节
btn_title
 string 按钮文案,
use_icon 为 0 时，长度限制 1-10 ；
use_icon 为 1 时，长度限制 1-8 ；
不支持 emoji 表情，英文算半个字符。
默认：进入小程序
字段长度最小 1 字节，长度最大 10 字节
btn_border_color_theme
 string 边框色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
use_icon
 integer 是否使用图标
取值 0: 不使用图标, 1: 使用图标. 默认 0
最小值 0，最大值 1
padding_top
 integer 上边距. 默认值 28
最小值 0，最大值 100
padding_bottom
 integer 下边距. 默认值 28
最小值 0，最大值 100
gh_spec
 struct 关注公众号组件元素
fast_follow
 integer 是否开启一键关注，
取值 0: 关闭, 1: 开启. 默认 1
最小值 0，最大值 1
btn_title
 string 按钮文案,
use_icon 为 0 时，长度限制 1-10 ；
use_icon 为 1 时，长度限制 1-8 ；
不支持 emoji 表情，英文算半个字符。
默认：关注公众号
字段长度最小 1 字节，长度最大 10 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
btn_border_color_theme
 string 边框色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
padding_top
 integer 上边距. 默认值 28
最小值 0，最大值 100
padding_bottom
 integer 下边距. 默认值 28
最小值 0，最大值 100
use_icon
 integer 是否使用图标
取值 0: 不使用图标, 1: 使用图标. 默认 0
最小值 0，最大值 1
enterprise_wx_spec
 struct 添加商家微信组件元素
corp_id*
 string 绑定的企业 id
group_id*
 integer 客服组 id
最小值 0，最大值 999999999
btn_title
 string 按钮文案,
use_icon 为 0 时，长度限制 1-10 ；
use_icon 为 1 时，长度限制 1-8 ；
不支持 emoji 表情，英文算半个字符。
默认：联系商家
字段长度最小 1 字节，长度最大 10 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
btn_border_color_theme
 string 边框色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
padding_top
 integer 上边距. 默认值 28
最小值 0，最大值 100
padding_bottom
 integer 下边距. 默认值 28
最小值 0，最大值 100
use_icon
 integer 是否使用图标
取值 0: 不使用图标, 1: 使用图标. 默认 0
最小值 0，最大值 1
image_text_spec
 struct 图文复合组件元素
padding_top
 integer 上边距. 默认值 20
最小值 0，最大值 100
padding_bottom
 integer 下边距. 默认值 20
最小值 0，最大值 100
align_mode
 integer 两个商品的对其方式，0 左对齐，1 居中对齐，只有选一行 2 个的时候才生效. 默认值 0
最小值 0，最大值 1
image_text_item*
 struct[] 图文复合组件配置
border_color
 string 边框色，#000000-#FFFFFF，默认#e5e5e5
字段长度为 7 字节
title_color
 string 标题颜色，#000000-#FFFFFF. 默认#353535
字段长度为 7 字节
desc_color
 string 描述颜色，#000000-#FFFFFF. 默认#b2b2b2
字段长度为 7 字节
bg_color
 string 背景颜色，#000000-#FFFFFF. 默认#ffffff
字段长度为 7 字节
jump_mode
 enum 图文复合组件跳转方式，默认为 btn_jump，[枚举详情]
枚举列表：{ btn_jump, total_jump }
material_id*
 string 素材 id
字段长度最小 1 字节，长度最大 16 字节
title*
 string 标题,
一行一个商品,长度限制 1-12 ；
一行二个商品,长度限制 1-8 ；
字段长度最小 1 字节，长度最大 10 字节
desc*
 string 描述,
一行一个商品,长度限制 1-15 ；
一行二个商品,长度限制 1-10 ；
字段长度最小 1 字节，长度最大 10 字节
sub_elem_type*
 enum 图文复合组件转化类型，[枚举详情]
枚举列表：{ GH, ENTERPRISE_WX }
gh_spec
 struct 关注公众号组件元素
fast_follow
 integer 是否开启一键关注，
取值 0: 关闭, 1: 开启. 默认 1
最小值 0，最大值 1
btn_title
 string 按钮文案,
长度限制 1-5 ；
不支持 emoji 表情，英文算半个字符。
默认：关注公众号
字段长度最小 1 字节，长度最大 10 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
enterprise_wx_spec
 struct 添加商家微信组件元素
corp_id*
 string 绑定的企业 id
group_id*
 integer 客服组 id
最小值 0，最大值 999999999
btn_title
 string 按钮文案,
长度限制 1-5 ；
不支持 emoji 表情，英文算半个字符。
默认：联系商家
字段长度最小 1 字节，长度最大 10 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
global_spec
 struct 全局元素配置
global_elements_spec_list*
 struct[] 全局组件列表, 组件顺序与生成的原生页的顺序一致
element_type*
 enum 全局组件类型，[枚举详情]
枚举列表：{ FLOAT_BUTTON, SIDE_BAR_FLOAT_BUTTON }
float_button_spec
 struct 悬浮组件元素
style_type*
 integer 悬浮组件样式
取值 0: 图片+title+desc，1: title+desc, 2: title
最小值 0
image_id
 int64 style_type=0 时必填. 悬浮组件图片 id. 图片尺寸 96x96
字段长度最小 1 字节，长度最大 20 字节
title*
 string 悬浮组件标题
字段长度最小 1 字节，长度最大 30 字节
title_color
 string 悬浮组件标题颜色. 默认#171717
字段长度为 7 字节
desc
 string 悬浮组件描述. style_type=0,1 时必填
字段长度最小 1 字节，长度最大 42 字节
desc_color
 string 悬浮组件描述颜色. 默认#4C4C4C
字段长度为 7 字节
appear_type
 integer 出现方式
取值 0. 进入页面时出现, 1. 滑动页面时出现. 默认 0
如果 page_specs_list 只有一页必须为 0
最小值 0，最大值 1
disappear_type
 integer 消失方式
取值 0.不消失, 1.滑至页面底部时消失, 默认 0
如果 page_specs_list 只有一页必须为 0
最小值 0，最大值 1
forbid_page_list
 integer[] 悬浮按钮不出现的页面数组. [1,2]代表第 1,2 页不出现悬浮按钮, 依次类推.
数组最小长度 1，
最小值 1
element_type*
 enum 悬浮按钮内组件类型，[枚举详情]
枚举列表：{ APP_DOWNLOAD, WEAPP, GH, ENTERPRISE_WX }
app_download_spec
 struct 应用下载组件元素
title*
 string 按钮文案

审核规范：原生页当含有 app_android_spec 或 app_ios_spec 元素时，下载按钮文案必须含有“安装”或“下载”才允许使用


字段长度最小 1 字节，长度最大 15 字节
font_color
 string 下载按钮字体颜色. 默认#FFFFFF
字段长度为 7 字节
bg_color
 string 下载按钮填充色. 默认#07C160
字段长度为 7 字节
app_ios_spec
 struct 应用下载 iOS 元素
app_ios_id*
 string iOS 应用 id
字段长度最小 1 字节，长度最大 128 字节
deep_link_url
 string 应用直达页 url
字段长度最小 1 字节，长度最大 1024 字节
jump_appstore_type
 integer 点击按钮跳转. 取值 0: 外跳 appstore, 1: 内跳 appstore, 默认 0
最小值 0，最大值 1
app_android_spec
 struct 应用下载 Android 元素
app_android_id*
 string Android 应用 id
字段长度最小 1 字节，长度最大 128 字节
deep_link_url
 string 应用直达页 url
字段长度最小 1 字节，长度最大 1024 字节
app_android_channel_package_id
 string Android 应用渠道包 id，当前特指投放腾讯开放平台安卓应用的渠道包 id，从推广目标模块的读取接口可以获取
字段长度最小 1 字节，长度最大 128 字节
app_market_package
 string 跳转应用商店下载使用的 pkg name
字段长度最小 1 字节，长度最大 500 字节
weapp_spec
 struct 进入小程序组件元素
weapp_username*
 string 小程序原始 id
字段长度最小 1 字节，长度最大 50 字节
weapp_path*
 string 小程序路径
字段长度最小 1 字节，长度最大 250 字节
btn_title
 string 按钮文案,
长度限制 1-5 ；
不支持 emoji 表情，英文算半个字符。
默认：进入小程序
字段长度最小 1 字节，长度最大 10 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
gh_spec
 struct 关注公众号组件元素
fast_follow
 integer 是否开启一键关注，
取值 0: 关闭, 1: 开启. 默认 1
最小值 0，最大值 1
btn_title
 string 按钮文案,
长度限制 1-5 ；
不支持 emoji 表情，英文算半个字符。
默认：关注公众号
字段长度最小 1 字节，长度最大 10 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
enterprise_wx_spec
 struct 添加商家微信组件元素
corp_id*
 string 绑定的企业 id
group_id*
 integer 客服组 id
最小值 0，最大值 999999999
btn_title
 string 按钮文案,
长度限制 1-5 ；
不支持 emoji 表情，英文算半个字符。
默认：联系商家
字段长度最小 1 字节，长度最大 10 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
side_bar_float_spec
 struct 侧边悬浮组件元素
wording
 string 按钮上的文字，可修改. 当 elem_type=TEL 时，默认为【一键拨号】； 当 elem_type=WX_SERVICE 时，默认为【微信客服】； 当 elem_type=ENTERPRISE_WX 时，默认为【商家微信】；
字段长度最小 1 字节，长度最大 4 字节
title_color
 string 字体颜色，#000000-#FFFFFF. 默认#000000
字段长度为 7 字节
elem_type*
 enum 侧边悬浮组件转化类型，[枚举详情]
枚举列表：{ TEL, WX_SERVICE, ENTERPRISE_WX }
tel_spec*
 struct 一键拨号的参数结构
phone_number*
 string 电话
字段长度最小 1 字节，长度最大 11 字节
phone_type*
 string 电话类型，0：固话，1：手机
字段长度为 1 字节
wechat_service_spec*
 struct 微信客服元素
wechat_service_url*
 string 微信客服 url
字段长度最小 1 字节，长度最大 1024 字节
enterprise_wx_spec*
 struct 添加商家微信组件元素
corp_id*
 string 绑定的企业 id
group_id*
 integer 客服组 id
最小值 0，最大值 999999999
btn_title
 string 按钮文案,
use_icon 为 0 时，长度限制 1-10 ；
use_icon 为 1 时，长度限制 1-8 ；
不支持 emoji 表情，英文算半个字符。
默认：联系商家
字段长度最小 1 字节，长度最大 10 字节
font_color
 string 按钮文案颜色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_bg_color_theme
 string 按钮填充色，#000000-#FFFFFF，默认#07C160
字段长度为 7 字节
btn_border_color_theme
 string 边框色，#000000-#FFFFFF，默认#FFFFFF
字段长度为 7 字节
btn_font_type
 integer 按钮文案配置
取值 0: 常规, 1: 加粗. 默认 0
最小值 0，最大值 1
padding_top
 integer 上边距. 默认值 28
最小值 0，最大值 100
padding_bottom
 integer 下边距. 默认值 28
最小值 0，最大值 100
use_icon
 integer 是否使用图标
取值 0: 不使用图标, 1: 使用图标. 默认 0
最小值 0，最大值 1
share_content_spec*
 struct 分享信息，微信原生页分享信息
share_title*
 string 分享标题
字段长度最小 1 字节，长度最大 42 字节
share_description*
 string 分享描述
字段长度最小 1 字节，长度最大 60 字节

请求示例


curl 'https://api.e.qq.com/v1.1/wechat_pages_custom/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'page_specs_list=[
    {
        "page_elements_spec_list": [
            {
                "top_image_spec": [],
                "top_slider_spec": {
                    "image_id_list": []
                },
                "top_video_spec": [],
                "image_spec": [],
                "slider_spec": {
                    "image_id_list": []
                },
                "video_spec": [],
                "text_spec": [],
                "app_download_spec": {
                    "app_ios_spec": [],
                    "app_android_spec": []
                },
                "weapp_spec": [],
                "gh_spec": [],
                "enterprise_wx_spec": [],
                "image_text_spec": {
                    "image_text_item": [
                        {
                            "gh_spec": [],
                            "enterprise_wx_spec": []
                        }
                    ]
                }
            }
        ]
    }
]' \
-d 'global_spec={
    "global_elements_spec_list": [
        {
            "float_button_spec": {
                "forbid_page_list": [],
                "app_download_spec": {
                    "app_ios_spec": [],
                    "app_android_spec": []
                },
                "weapp_spec": [],
                "gh_spec": [],
                "enterprise_wx_spec": []
            },
            "side_bar_float_spec": {
                "tel_spec": [],
                "wechat_service_spec": [],
                "enterprise_wx_spec": []
            }
        }
    ]
}' \
-d 'share_content_spec=[]'

应答字段

名称 类型 描述
page_id
 int64 页面 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": ""
}

可视化调试工具

广告资源

广告技术

开发文档

辅助工具

帮助支持

手机浏览开发者官网

Copyright © 1998 - Tencent Inc. All Rights Reserved.