小程序 open 字节如意接入规范

小程序 open 字节如意根据搜索结果展示样式,给出了详细的规范说明以及具体的字段含义说明。开发者需要将必须字段填写完整,可选字段可根据站点情况来选择填写。

  • 数据填写越完整,搜索侧越能得到更好的用户体验,从而获取更多自然搜索流量
  • 该方式支持在头条 iOS 端搜索小程序
  • 宿主支持:今日头条
  • 仅小程序可进行配置,目前小游戏暂不支持。

一、卡片样式示例:

二、提交方式:

进入小程序开发者后台,流量页面—新增入口—小程序 opne 字节如意。

图片名称

三、数据 XML 文件要求

  1. 数据 XML 文件的根节点必须为
  2. 数据 XML 文件编码必须为 UTF-8,第一行为:
  3. 数据 XML 文件禁止使用命名空间,禁止使用规定之外的属性。
  4. 数据 XML 单个文件大小不得超过 5M(必须满足),item 数目不得超过 5000 条。
  5. item 节点中节点为必需节点。
  6. 除根节点之外的其它节点,标签名建议采用英文小写字母及下划线‘_’。
  7. 数据节点中包含转义字符,请使用 CDATA。
  8. 对于数组型的节点,请在只有一个子节点时保证和多个节点时的结构相同。

四、数据字段说明

注意:图片需要保证头条服务器可以访问到,如果不可访问,线上体验会很差。建议:将此服务*.snssdk.com 加白名单。

字段名称必填详细含义规则
key以随机数字+合作方名称命名,key 长度限制在 64 字符内,唯一不变。例:123456toutiao文字类型
display数据区域,不能修改或者删除字段,可增加字段,节点总大小上限 20KB,不建议超过 3KB数据区域
title网站名称文字类型
tmaid字节跳动小程序平台分配的小程序 id,例:tta1e1b2xxx字符串
path标识 h5 跳转 url,例:http://toutiao.com字符串
lightappid_path字节跳动小程序平台分配的小程序 id,例:tta1eb2xxx字符串
lightapp_path小程序内部 PATH,PATH 开头省略/,例如:pages/xxx,而不是/pages/xxx字符串
slogan运用于官网样式 title 后缀,字数控制在 10 字符内,==短摘要(<20 字)可以不填写此字段,长摘要(>20 字)必选字段==文字类型
description摘要描述,摘要小于 20 字,前端展示弱卡样式,摘要在 20-40 字之间,前端展示强卡样式。文字类型
logo网站 logo,用于前端展示链接格式
square正方形 logo,像素是 153*153,==摘要小于 20 字提供正方形图,与 rectangle 二选一==链接格式
rectangle长方形 logo,像素是 327*216,==摘要大于 20 字提供长方形 logo,与 square 二选一==链接格式
funcs在头条搜索里,展现的功能 tab数组类型

五、XML 数据文件示例

<?xml version="1.0" encoding="utf-8"?>
<DOCUMENT version="1">
	<!--根节点必须为⼤写DOCUMENT,标记整个xml⽂件的开始和结束-->
	<item>
		<!-- item: 一个item为一条数据,单文件最大允许5000条,且文件大小不应超过5M -->
		<key>
			<![CDATA[123456douguo]]>
		</key>
		<display type="object">
			<!-- display:数据区域,不能修改或者删除字段,可增加字段,节点总大小上限20KB,不建议超过3KB,必须字段 -->
			<title type="string">
				<![CDATA[豆果美食]]>
			</title>
			<!-- title: 网站名称,字符串类型,必须字段 -->
			<path type="string">
				<![CDATA[http://toutiao.com]]>
			</path>
			<tmaid type="string">
				<![CDATA[tta1e1b2c3d4a5]]>
			</tmaid>
			<!-- tmaid: 字节跳动小程序平台分配的小程序id,字符串类型,必须字段 -->
			<lightappid_path type="string">
				<![CDATA[tta1e1b2c3d4a5]]>
			</lightappid_path>
			<!-- lightappid_path: 字节跳动小程序平台分配的小程序id(内容与tmaid一样),字符串类型,必须字段 -->
			<lightapp_path type="string">
				<![CDATA[pages/xxx]]>
			</lightapp_path>
			<!-- lightapp_path: 小程序内部PATHPATH开头省略/,例如:pages/xxx,而不是/pages/xxx,字符串类型,必须字段 -->
			<slogan type="string">
				<![CDATA[家常美食]]>
			</slogan>
			<!--slogn type:运用于官网大功能样式title后缀,字数控制在10字符内,短摘要可以不填写此字段,长摘要必选字段 -->
			<description type="string">
				<![CDATA[豆果美食,开启美好生活]]>
			</description>
			<!-- description: 小程序简介,官网小功能字数不超过20字,官网大功能字数应控制在20-40字内,字符串类型,必须字段 -->
			<logo type="object">
				<!-- logo: 官网logo,如果是选择正方形logo选择square type,长方形logo选择rectangle type,必须字段 -->
				<square type="object">
					<!-- square: 正方形的官网logo,可选字段 -->
					<url type="string">
						<![CDATA[https://image.xiaohongshu.com/wise/toutiao/light_app/logo/img/square.jpg]]>
					</url>
					<!-- url: icon对应的图片链接,字符串类型,长度不超过1024个字符,可选类型 -->
					<height type="integer">
						<![CDATA[153]]>
					</height>
					<!-- height: icon对应的图片高度,数字类型,可选类型 -->
					<width type="integer">
						<![CDATA[153]]>
					</width>
					<!-- width: icon对应的图片宽度,数字类型,可选类型 -->
				</square>
				<rectangle type="object">
					<!-- rectangle: 长方形的官网logo,可选字段 -->
					<url type="string">
						<![CDATA[https://image.xiaohongshu.com/wise/toutiao/light_app/logo/img/square.jpg]]>
					</url>
					<!-- url: icon对应的图片链接,字符串类型,长度不超过1024个字符,可选类型 -->
					<height type="integer">
						<![CDATA[216]]>
					</height>
					<!-- height: icon对应的图片高度,数字类型,可选类型 -->
					<width type="integer">
						<![CDATA[327]]>
					</width>
					<!-- width: icon对应的图片宽度,数字类型,可选类型 -->
				</rectangle>
			</logo>
			<funcs type="array">
				<!-- funcs: 在头条搜索里,展现的功能tab,必选字段,最多出现1-->
				<value type="object">
					<!-- value: tab详细信息,对象类型,可出现1到多次 -->
					<name type="string">
						<![CDATA[功能列表1]]>
					</name>
					<!-- name: icon上的文字,字符串类型,长度不超过4个字符,必选类型 -->
					<lightapp_link_path type="string">
						<![CDATA[pages/xxx]]>
					</lightapp_link_path>
					<!-- lightapp_link_path: 小程序内部PATHPATH开头省略/,例如:pages/xxx,而不是/pages/xxx,字符串类型,必须字段 -->
					<lightappid_link_path type="string">
						<![CDATA[tta1e1b2c3d4a5]]>
					</lightappid_link_path>
					<!-- lightappid_link_path: 字节跳动小程序平台分配的小程序id,字符串类型,必须字段 -->
					<path type="string">
						<![CDATA[http://toutiao.com/funcs1]]>
					</path>
				</value>
				<value type="object">
					<!-- value: tab详细信息,对象类型,可以出现1到多次 -->
					<name type="string">
						<![CDATA[功能列表2]]>
					</name>
					<!-- name: icon上的文字,字符串类型,长度不超过4个字符,必选类型 -->
					<lightapp_link_path type="string">
						<![CDATA[pages/xxx]]>
					</lightapp_link_path>
					<!-- lightapp_link_path: 小程序内部PATHPATH开头省略/,例如:pages/xxx,而不是/pages/xxx,字符串类型,必须字段 -->
					<lightappid_link_path type="string">
						<![CDATA[tta1e1b2c3d4a5]]>
					</lightappid_link_path>
					<!-- lightappid_link_path: 字节跳动小程序平台分配的小程序id,字符串类型,必须字段 -->
					<path type="string">
						<![CDATA[http://toutiao.com/funcs2]]>
					</path>
				</value>
			</funcs>
		</display>
	</item>
</DOCUMENT>
点击纠错