字節(jié)跳動(dòng)小程序 open 字節(jié)如意接入規(guī)范

2020-02-12 22:57 更新

小程序 open 字節(jié)如意根據(jù)搜索結(jié)果展示樣式，給出了詳細(xì)的規(guī)范說明以及具體的字段含義說明。開發(fā)者需要將必須字段填寫完整，可選字段可根據(jù)站點(diǎn)情況來選擇填寫。

  • 數(shù)據(jù)填寫越完整，搜索側(cè)越能得到更好的用戶體驗(yàn)，從而獲取更多自然搜索流量
  • 該方式支持在頭條 iOS 端搜索小程序
  • 宿主支持：今日頭條
  • 僅小程序可進(jìn)行配置，目前小游戲暫不支持。

一、卡片樣式示例：

二、提交方式：

進(jìn)入小程序開發(fā)者后臺(tái)，流量頁面—新增入口—小程序 opne 字節(jié)如意。

圖片名稱

三、數(shù)據(jù) XML 文件要求

  1. 數(shù)據(jù) XML 文件的根節(jié)點(diǎn)必須為 。
  2. 數(shù)據(jù) XML 文件編碼必須為 UTF-8，第一行為:
  3. 數(shù)據(jù) XML 文件禁止使用命名空間，禁止使用規(guī)定之外的屬性。
  4. 數(shù)據(jù) XML 單個(gè)文件大小不得超過 5M(必須滿足)，item 數(shù)目不得超過 5000 條。
  5. item 節(jié)點(diǎn)中 、 節(jié)點(diǎn)為必需節(jié)點(diǎn)。
  6. 除根節(jié)點(diǎn)之外的其它節(jié)點(diǎn)，標(biāo)簽名建議采用英文小寫字母及下劃線‘_’。
  7. 數(shù)據(jù)節(jié)點(diǎn)中包含轉(zhuǎn)義字符，請使用 CDATA。
  8. 對于數(shù)組型的節(jié)點(diǎn)，請?jiān)谥挥幸粋€(gè)子節(jié)點(diǎn)時(shí)保證和多個(gè)節(jié)點(diǎn)時(shí)的結(jié)構(gòu)相同。

四、數(shù)據(jù)字段說明

注意：圖片需要保證頭條服務(wù)器可以訪問到，如果不可訪問，線上體驗(yàn)會(huì)很差。建議：將此服務(wù)*.snssdk.com 加白名單。

字段名稱 必填 詳細(xì)含義 規(guī)則
key 是 以隨機(jī)數(shù)字+合作方名稱命名，key 長度限制在 64 字符內(nèi)，唯一不變。例：123456toutiao 文字類型
display 是 數(shù)據(jù)區(qū)域，不能修改或者刪除字段，可增加字段，節(jié)點(diǎn)總大小上限 20KB，不建議超過 3KB 數(shù)據(jù)區(qū)域
title 是 網(wǎng)站名稱 文字類型
tmaid 是 字節(jié)跳動(dòng)小程序平臺(tái)分配的小程序 id，例：tta1e1b2xxx 字符串
path 否 標(biāo)識(shí) h5 跳轉(zhuǎn) url，例：http://toutiao.com 字符串
lightappid_path 是 字節(jié)跳動(dòng)小程序平臺(tái)分配的小程序 id，例：tta1eb2xxx 字符串
lightapp_path 是 小程序內(nèi)部 PATH，PATH 開頭省略/，例如：pages/xxx，而不是/pages/xxx 字符串
slogan 是 運(yùn)用于官網(wǎng)樣式 title 后綴，字?jǐn)?shù)控制在 10 字符內(nèi)，==短摘要（<20 字）可以不填寫此字段，長摘要（>20 字）必選字段== 文字類型
description 是 摘要描述，摘要小于 20 字，前端展示弱卡樣式，摘要在 20-40 字之間，前端展示強(qiáng)卡樣式。 文字類型
logo 是 網(wǎng)站 logo，用于前端展示 鏈接格式
square 否 正方形 logo，像素是 153*153，==摘要小于 20 字提供正方形圖，與 rectangle 二選一== 鏈接格式
rectangle 否 長方形 logo，像素是 327*216，==摘要大于 20 字提供長方形 logo，與 square 二選一== 鏈接格式
funcs 是 在頭條搜索里，展現(xiàn)的功能 tab 數(shù)組類型

五、XML 數(shù)據(jù)文件示例

<?xml version="1.0" encoding="utf-8"?>
<DOCUMENT version="1">
	<!--根節(jié)點(diǎn)必須為?寫DOCUMENT，標(biāo)記整個(gè)xml?件的開始和結(jié)束-->
	<item>
		<!-- item: 一個(gè)item為一條數(shù)據(jù)，單文件最大允許5000條，且文件大小不應(yīng)超過5M -->
		<key>
			<![CDATA[123456douguo]]>
		</key>
		<display type="object">
			<!-- display：數(shù)據(jù)區(qū)域，不能修改或者刪除字段，可增加字段，節(jié)點(diǎn)總大小上限20KB，不建議超過3KB，必須字段 -->
			<title type="string">
				<![CDATA[豆果美食]]>
			</title>
			<!-- title: 網(wǎng)站名稱，字符串類型，必須字段 -->
			<path type="string">
				<![CDATA[http://toutiao.com]]>
			</path>
			<tmaid type="string">
				<![CDATA[tta1e1b2c3d4a5]]>
			</tmaid>
			<!-- tmaid: 字節(jié)跳動(dòng)小程序平臺(tái)分配的小程序id，字符串類型，必須字段 -->
			<lightappid_path type="string">
				<![CDATA[tta1e1b2c3d4a5]]>
			</lightappid_path>
			<!-- lightappid_path: 字節(jié)跳動(dòng)小程序平臺(tái)分配的小程序id（內(nèi)容與tmaid一樣），字符串類型，必須字段 -->
			<lightapp_path type="string">
				<![CDATA[pages/xxx]]>
			</lightapp_path>
			<!-- lightapp_path: 小程序內(nèi)部PATH，PATH開頭省略/，例如：pages/xxx，而不是/pages/xxx，字符串類型，必須字段 -->
			<slogan type="string">
				<![CDATA[家常美食]]>
			</slogan>
			<!--slogn type:運(yùn)用于官網(wǎng)大功能樣式title后綴，字?jǐn)?shù)控制在10字符內(nèi)，短摘要可以不填寫此字段，長摘要必選字段 -->
			<description type="string">
				<![CDATA[豆果美食，開啟美好生活]]>
			</description>
			<!-- description: 小程序簡介，官網(wǎng)小功能字?jǐn)?shù)不超過20字，官網(wǎng)大功能字?jǐn)?shù)應(yīng)控制在20-40字內(nèi)，字符串類型，必須字段 -->
			<logo type="object">
				<!-- logo: 官網(wǎng)logo，如果是選擇正方形logo選擇square type，長方形logo選擇rectangle type，必須字段 -->
				<square type="object">
					<!-- square: 正方形的官網(wǎng)logo，可選字段 -->
					<url type="string">
						<![CDATA[https://image.xiaohongshu.com/wise/toutiao/light_app/logo/img/square.jpg]]>
					</url>
					<!-- url: icon對應(yīng)的圖片鏈接，字符串類型，長度不超過1024個(gè)字符，可選類型 -->
					<height type="integer">
						<![CDATA[153]]>
					</height>
					<!-- height: icon對應(yīng)的圖片高度，數(shù)字類型，可選類型 -->
					<width type="integer">
						<![CDATA[153]]>
					</width>
					<!-- width: icon對應(yīng)的圖片寬度，數(shù)字類型，可選類型 -->
				</square>
				<rectangle type="object">
					<!-- rectangle: 長方形的官網(wǎng)logo，可選字段 -->
					<url type="string">
						<![CDATA[https://image.xiaohongshu.com/wise/toutiao/light_app/logo/img/square.jpg]]>
					</url>
					<!-- url: icon對應(yīng)的圖片鏈接，字符串類型，長度不超過1024個(gè)字符，可選類型 -->
					<height type="integer">
						<![CDATA[216]]>
					</height>
					<!-- height: icon對應(yīng)的圖片高度，數(shù)字類型，可選類型 -->
					<width type="integer">
						<![CDATA[327]]>
					</width>
					<!-- width: icon對應(yīng)的圖片寬度，數(shù)字類型，可選類型 -->
				</rectangle>
			</logo>
			<funcs type="array">
				<!-- funcs: 在頭條搜索里，展現(xiàn)的功能tab，必選字段，最多出現(xiàn)1次 -->
				<value type="object">
					<!-- value: tab詳細(xì)信息，對象類型，可出現(xiàn)1到多次 -->
					<name type="string">
						<![CDATA[功能列表1]]>
					</name>
					<!-- name: icon上的文字，字符串類型，長度不超過4個(gè)字符，必選類型 -->
					<lightapp_link_path type="string">
						<![CDATA[pages/xxx]]>
					</lightapp_link_path>
					<!-- lightapp_link_path: 小程序內(nèi)部PATH，PATH開頭省略/，例如：pages/xxx，而不是/pages/xxx，字符串類型，必須字段 -->
					<lightappid_link_path type="string">
						<![CDATA[tta1e1b2c3d4a5]]>
					</lightappid_link_path>
					<!-- lightappid_link_path: 字節(jié)跳動(dòng)小程序平臺(tái)分配的小程序id，字符串類型，必須字段 -->
					<path type="string">
						<![CDATA[http://toutiao.com/funcs1]]>
					</path>
				</value>
				<value type="object">
					<!-- value: tab詳細(xì)信息，對象類型，可以出現(xiàn)1到多次 -->
					<name type="string">
						<![CDATA[功能列表2]]>
					</name>
					<!-- name: icon上的文字，字符串類型，長度不超過4個(gè)字符，必選類型 -->
					<lightapp_link_path type="string">
						<![CDATA[pages/xxx]]>
					</lightapp_link_path>
					<!-- lightapp_link_path: 小程序內(nèi)部PATH，PATH開頭省略/，例如：pages/xxx，而不是/pages/xxx，字符串類型，必須字段 -->
					<lightappid_link_path type="string">
						<![CDATA[tta1e1b2c3d4a5]]>
					</lightappid_link_path>
					<!-- lightappid_link_path: 字節(jié)跳動(dòng)小程序平臺(tái)分配的小程序id，字符串類型，必須字段 -->
					<path type="string">
						<![CDATA[http://toutiao.com/funcs2]]>
					</path>
				</value>
			</funcs>
		</display>
	</item>
</DOCUMENT>


以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)