(LINE TW Shopping) 1 - 商品資料匯入技術文件 Data feed Specifications (zh-tw) ver. 2.1.0

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 16

[LINE ECAC]

商品資料匯入技術文件

Product Data Feed


Specifications
文件資訊

關於本文件

本文件將說明:

● 須以何種方式讓 LINE Server 取得合作廠商的商品資料


● 商品資料檔案格規範及欄位定義

對象:

● 使用本文的對象必須是 LINE購物 合作廠商的開發者

聯絡資訊:
● Eric Yang: ​eric.yang@linecorp.com
● Demi Yang: ​demi.yang@linecorp.com

1
修訂紀錄

版本 日期 變更紀錄

2.1.0 2019.10.10 減少API數量、欄位上限

2.0.2 2019.07.04 新增 Data Feed 六項欄位

2.0.1 2019.06.04 新增欄位

2.0.0 2019.05.24 文件格式調整

1.4.0 2019.01.03 http 強制改為 https、新增檔案格式規範

1.3.0 2018.12.07 新增欄位數據類型

1.2.0 2018.10.30 欄位格式調整、新增 IP 位址、price 欄位補充

1.1.0 2018.09.07 欄位格式調整、新增 emoji 說明、修正 product_id 長度限制

1.0.2 2018.08.14 欄位格式調整

1.0.1 2018.08.13 欄位格式調整、新增 IP 位址

1.0.0 2018.07.04 初稿

2
文件慣例

原始碼之標記方式

原始碼文字將以灰底綠字的方式呈現。

[{"product_id":"820144","product_name":"title of
product","description":"short description ","l_description":"detail
description of
product","link":"https:\/\/www.xxxxx.my\/xxxxxxxxxxxxxxxx\/item-820144.html
","image_link":"https:\/\/www.xxxxx.my\/xxxxxxxxxxxxxxxx\/item-820144.jpg",
"brand":"LINESHOPPING","color":"red/black","condition":"0","gtin":"12345678
9000","mpn":"12345","model_number":"","availability":"in
stock","price":"20","sale_price":"10","product_type":"3c","product_category
_value":"AXXXX2","age_group":"normal",
","import_flag":"Y","parallel_import":"N"},
{"product_id":"820144","product_name":"title of
product","description":"short description ","l_description":"detail
description of
product","link":"https:\/\/www.xxxxx.my\/xxxxxxxxxxxxxxxx\/item-820144.html
","image_link":"https:\/\/www.xxxxx.my\/xxxxxxxxxxxxxxxx\/item-820144.jpg",
"brand":"LINESHOPPING","color":"red/black","condition":"0","gtin":"12345678
9000","mpn":"12345","model_number":"","availability":"in
stock","price":"20","sale_price":"10","product_type":"3c","product_category
_value":"AXXXX2","age_group":"normal",
","import_flag":"Y","parallel_import":"N"}]

3
目錄

商品資料總覽 4

LINE購物商品資料組成 4

商品資料檔案 4

LINE購物商品資料比較 4

檔案格式規範 5

檔案下載網址 5

商品資料欄位說明 6

基本產品資料 6

價格與供應情形 9

產品類別 10

商品資料檔案範例 11

商品目錄欄位說明 12

商品目錄檔案 12

商品目錄檔案範例 13

附錄 14

顏色 14

4
商品資料總覽
LINE購物商品資料組成

商品資料檔案
為維持商品資料每日的正確性、即時性,須請合作夥伴提供下列三份 json 檔案,資料欄位請
參照下方「商品資料欄位說明」。

檔案名稱 更新頻率 檔案名稱規則

全部商品資料檔案 每日更新一次 product_full

商品目錄檔案 每日更新一次 cate_full

商品資料增刪修檔案 每小時更新一次 product_partial

LINE購物商品資料比較
項目 product_full product_partial

商品資料 ● 在LINE購物上可以正常供貨之商品。 ● 新商品


● 商品資料有變動之商品

更新週期 每日一次 每小時一次

備註 ● 新增新商品 ● 新增新商品
● 更新商品資訊 ● 更新商品資訊
● 下架缺貨商品 ● 下架缺貨商品
● 恢復補貨商品 ● 恢復補貨商品

5
檔案格式規範

● 商品資料檔的格式僅支援 json

● 僅接受 UTF-8 編碼

● 檔案內請過濾掉 emoji,關於 emoji 相關說明如:

(1) emoji 字元在LINE資料庫無法正常儲存。請將 product datafeed 資料中的


emoji 濾除,以確保資料儲存正確。

(2) emoji 字元,如:❤ (鍵盤符號ok),列表如下:

https://unicode.org/emoji/charts/full-emoji-list.html

https://unicode.org/emoji/charts/full-emoji-modifiers.html

● emoji 以外的標點符號,例如:Levi's 或 Agnès 等品牌名稱,可以正常顯示。

檔案下載網址

請合作夥伴製作 Data Feed API,將商品資料交換檔案放置於該固定網址,提供 LINE crawler


進行檔案下載工作。

並請協助將 LINE 購物的以下 IP 位址設定白名單,以利 LINE 購物成功獲取商品資料:

● 220.133.169.26
● 203.104.135.209
● 203.104.135.210
● 119.235.224.76
● 223.26.70.247

6
商品資料欄位說明
基本產品資料
屬性 格式 基本規定概覽

product_id 必填 ● 商品編號
產品的專屬識別碼
[ID] ● 商品編號是唯一值
範例
A1B2 ● 只能使用英文、數字以及連接符號 -
,不能使用其他字元,如控 制字
語法 元、功能字元、特殊字元
最多 49 varchar
● 請使用網頁使用的 prouct_id 為 主
,通常為網址使用的 id,若不同個
顏色、尺寸,存在於同一個網頁,
僅須提供一次即可。

product_name 必填 ● 商品名稱
產品的名稱
[名稱] ● 請明確簡要的描述商品,勿包含 促
範例 銷文字、特殊符號,如:免運費、
男性開領短袖襯衫 ▼降價

語法
最多 100 varchar

description 必填 ● 商品簡要說明或特色。
產品的說明
[說明] ● 勿提供 html, \r\n\t 等換行/tab符
範例 號。
紅色開領短袖男襯衫完全使用有
機棉製造,合身又有彈性,左胸
位置繡有代表性標誌。如要使用
洗衣機清洗,請以冷水洗滌;進
口商品。

語法
最多 5,000 varchar

l_description 必填 ● 商品詳細說明。
產品的專屬識別碼
[長說明] ● 允許使用 html 格式。
範例
<p><span style="font-size:
10pt; font-family:
&quot;Courier New&quot;;
color: rgb(24, 128, 56);
vertical-align: baseline;
">​這件經典紅色開領短袖男襯衫完
全使用有機棉製造,合身又有彈性
,左胸位置繡有代表性標誌。如要
使用洗衣機清洗,請以冷水洗滌;

7
進口商品。​</span></span></p>

語法
最多 60,000 varchar

link 必填 ● 開頭務必是​ https


產品的到達網頁
[連結] ● 特殊字元,如:中文,需經
範例 urlencode。
https://YourSite.tw/aa/bb

語法
最多 512 varchar

image_link 必填 ● 開頭務必是​ https


產品主要圖片的網址
[圖片連結] ● 特殊字元,如:中文,需經
範例 urlencode。
https://YourSite.tw/img/aa
.jpg

語法
最多 1,024 varchar

additional_image_link 選填 ● 開頭務必是​ https


產品其他圖片的網址
[其他圖片連結] ● 最多可以有10 張,使用逗點分隔。
範例
https://YourSite.tw/img/bb ● 特殊字元,如:中文,需經
.jpg,https://YourSite.tw/i urlencode。
mg/cc.jpg

語法
最多 1,024 varchar

brand 選填 ● 提供顧客容易辨識的產品品牌名稱
產品的品牌名稱
[品牌] ● 如果您是產品的製造者,或是您的
範例 產品屬於一般的品牌類別,可以只
全家便利商店 提供商店名稱。舉例來說,如果您
賣的是白標產品或客製化珠寶,就
語法 可以提交商店名稱。
最多 255 varchar
● 如果您無法提供品牌,就不要提交
任何值,例如不要使用「不適
用」、「一般」、「無品牌」或
「不存在」。

● 此參數將會影響到 LINE購物分類篩
選器的功能。

color 選填 ● 請依照LINE購物定義的17項顏色名
產品的顏色 稱填入,​點此查看​。
[顏色]
範例 ● 請勿使用單一數字 0 2 4 6 8
black/red/yellow
● 請勿使用非英數的字元,像是「
語法 #fff000」
最多 128 varchar

8
● 請勿使用單一字母,像是 R

● 請勿加入產品或圖片的參考資源,
例如「參見圖片」

● 請勿將不同顏色名稱結合成 1 個單
字 (如「redpinkblue),而是以「/」
分隔,例如「red/pink/blue」。 請
勿使用不是顏色的值,例如「多
色」、「多種款式」、「多樣」、
「男用」、「女用」或「不適用」

● 此參數將會影響到 LINE購物分類篩
選器的功能。

condition 選填 ● 若商品出售時的狀態為全新時,請
產品售出時的狀況。 提供 0;反之則為 1。
[商品狀態]
範例
0

支援的值
0 [新品]
1 [二手]

語法
最多 10 varchar

gtin 選填 ● 不可包含破折號和空格。
產品的全球交易品項識別碼 (GTIN)
[全球交易品項識別碼] ● UPC (北美洲 / GTIN-12) 12 位
範例 數,如:323456789012
3234567890126
● EAN (歐洲 / GTIN-13) 13 位數
語法 ,如:3001234567892
最多 20 varchar
● JAN (日本 / GTIN-13) 8 或 13
位數,如:49123456 或
4901234567894

● ISBN (書籍) 13 位數,如:


9781455582341

● 填入此欄位將有助於讓比價功能更
精準地顯示。

mpn 選填 ● 新產品沒有製造商指定的 gtin 時


產品的製造商零件編號 (mpn)。 才能使用。
[製造商零件編號]
範例 ● 僅提交製造商指定的 MPN。
GO12345OOGLE
● 填入此欄位將有助於讓比價功能更
語法 精準地顯示。
最多 70 varchar

選填 ● 支援大小寫英文字母、阿拉伯數字
model_number 產品的型號。
及"-"、"_"。
[商品型號] 範例
ABC-M333

9
語法 ● 填入此欄位將有助於讓比價功能更
最多 70 varchar 精準地顯示。

價格與供應情形
屬性 格式 基本規定概覽

availability 必填 ● 提交正確的產品供應情形,且應符合
產品的供應情形 到達網頁上的供應情形。
[供應情形]
範例 ● 預設情況下,discontinued 的商品不
in stock 會被搜尋到,也不會被投遞廣告。

支援的值
in stock [有現貨]
preorder [預訂]
discontinued [商品下架]

price 必填 ● 幣值為新台幣。
產品的價格
[價格] ● 僅限數字,必須為大於0的整數。
範例
199 ● 不可包含貨幣符號及千位數分隔符
號。

sale_price 選填 ● 幣值為新台幣。
產品的特價
[特價] ● 僅限數字,必須為大於0的整數。
範例
99 ● 不可包含貨幣符號及千位數分隔符
號。

● 若無可不提供。

● sale_price 不可大於 price。

10
產品類別
屬性 格式 基本規定概覽

product_type 選填 ● 商品分類。
產品的分類
[產品類型] ● 僅兩種類型(一般商品 / 3C 商
範例 品)。
normal

支援的值
normal [一般商品]
3c [3c商品]

product_category_value 必填 ● 該商品對應到目錄更新檔之分類
您為產品定義的產品類別 目錄編號。
[產品類別]
範例 ● 請參考下列目錄更新檔案說明。
AXXXX2
● 若商品同時存在兩個以上目錄,
語法 可用逗號區隔。
最多 50 varchar

age_group 必填 ● 成人商品(18+商品請濾除或提供
註明產品含有性暗示內容。 ”adult”)
[成人商品]
Example
normal

Supported values
normal
adult

import_flag 選填 ● 所有海外合作夥伴的商品資料請
註明此商品是否為海外運輸商品。 填入 Y。
[海外運輸商品] 範例
Y
支援的值
Y [是]
N [否]

parallel_import 選填 ● 若為平行輸入之商品請填入 Y。
註明此商品是否為平行輸入之商
[平行輸入商品] 品。
範例
Y
支援的值
Y [是]
N [否]

11
商品資料檔案範例

以下是必填欄位所產生的一個簡單範例。

[{"product_id":"820144","product_name":"title of
product","description":"short description ","l_description":"detail
description of
product","link":"https:\/\/www.xxxxx.my\/xxxxxxxxxxxxxxxx\/item-820144.html
","image_link":"https:\/\/www.xxxxx.my\/xxxxxxxxxxxxxxxx\/item-820144.jpg",
"brand":"LINESHOPPING","color":"red/black","condition":"0","gtin":"12345678
9000","mpn":"12345","model_number":"","availability":"in
stock","price":"20","sale_price":"10","product_type":"3c","product_category
_value":"AXXXX2","age_group":"normal",
","import_flag":"Y","parallel_import":"N"},
{"product_id":"820144","product_name":"title of
product","description":"short description ","l_description":"detail
description of
product","link":"https:\/\/www.xxxxx.my\/xxxxxxxxxxxxxxxx\/item-820144.html
","image_link":"https:\/\/www.xxxxx.my\/xxxxxxxxxxxxxxxx\/item-820144.jpg",
"brand":"LINESHOPPING","color":"red/black","condition":"0","gtin":"12345678
9000","mpn":"12345","model_number":"","availability":"in
stock","price":"20","sale_price":"10","product_type":"3c","product_category
_value":"AXXXX2","age_group":"normal",
","import_flag":"Y","parallel_import":"N"}]

12
商品目錄欄位說明
商品目錄檔案
屬性 格式 基本規定概覽

category_title 必填 ● 購物網站上商品分類目錄之名稱
產品目錄的名稱
[目錄名稱]
範例
美妝保養

語法
最多 50 varchar

category_value 必填 ● 商品目錄編號是唯一值,以購物網
產品目錄編號 站上目錄網址編號為主。
[目錄編號]
範例 ● 只能使用英文、數字以及連接符號 -
A00001 ,不能使用其他字元,如控制字
元、功能字元、特殊字元。
語法
最多 50 varchar

category_value_parent 必填 ● 分類目錄母層編號只能使用英文、
數字以及連接符號 -,不能使用其他
[目錄母層編號] 字元,如控制字元、功能字元、特
範例 殊字元。
A00010
● 購物網站上該商品分類目錄之上一
語法 層分類目錄編號,以購物網站上目
最多 50 varchar 錄網址編號為主。

● 如該商品分類目錄無上一層分類目
錄,屬於第一層商品分類目錄,該
數值請填寫0。

category_flag 必填 ● 分類目錄如在架上請填1,如已下
產品的製造商件編號(mpn) 架請填0。
[目錄狀態]
範例
0

支援的值
0 [已下架]

1 [已上架]

13
商品目錄檔案範例
以下是必填欄位所產生的一個簡單範例。

[{"category_title":"Fashion &
Jewelleries","category_value":"AXXXX2","category_value_parent":"AXX","categ
ory_flag":"1"},
{"category_title":"Digital &
Electronics","category_value":"AXXXX1","category_value_parent":"AXX","categ
ory_flag":"1"},
{"category_title":"Computer &
Software","category_value":"AXXXXXN","category_value_parent":"AXXX1","categ
ory_flag":"1"}]

資料更新規則:

● 若 id 存在則覆蓋。
● 若 id 不存在則新增
● 若上傳有錯誤,則該筆資料不新增或覆蓋。

14
附錄
顏色
請依照下表LINE購物定義之顏色提供商品相對應的英文顏色名稱。

color 顏色

blue 藍色

orange 橙色

yellow 黃色

grey 灰色

red 紅色

green 綠色

black 黑色

white 白色

purple 紫色

pink 粉紅色

gold 金色

silver 銀色

brown 棕色

beige 米色

khaki 卡其色

multicolor 多色

others 其他

15

You might also like