捌、資料集詮釋資料欄位詳細說明
一、資料集詮釋資料欄位基本規定說明
本節設計一個共通表格,以列表形式說明檔案資料、API服務資料集詮釋資料欄位之規定項目,包括欄位名稱、英文欄位名稱、定義說明、目的和意義、選填條件、填寫規則說明、建議範例、不建議範例等,下表說明其基本規定。
| 規定項目 | 說明 |
|---|---|
| 欄位名稱 | 列出一個詮釋資料中文欄位名稱。 |
| 英文欄位名稱 | 列出一個建議的詮釋資料英文欄位名稱,以方便機器可讀之存取應用。 |
| 定義說明 | 簡述欄位定義,協助各類使用者了解其內容,避免錯誤之解讀。 |
| 目的和意義 | 說明欄位使用目的和意義,協助各類使用者了解此詮釋資料欄位的重要性與適用性。 |
| 資料提供屬性 | 說明該欄位適用之資料提供屬性,如檔案資料、API服務,或者兩種皆有。 |
| 選填條件 |
說明此欄位填寫之必要性:
|
| 資料型態 | 說明該詮釋資料欄位資料填寫內容之資料型態。請見表-6。 |
| 填寫規則說明 | 說明該詮釋資料欄位資料細部填寫規則,包括資料填寫選項或格式。 |
| 建議範例 | 本詮釋資料欄位以JSON格式示範詮釋資料之建議範例。 |
| 不建議範例 |
|
二、資料集詮釋資料資料型態說明
資料集詮釋資料欄位中的資料型態如下表所說明。
| 資料型態 | 說明 |
|---|---|
| 字串 | 字元字串(CharacterString),表示文字的資料型別。 |
| 陣列 | 由相同類型的元素(element)的集合所組成的資料結構。 |
| 物件 | 是類別的具體形象,或者是類別的展現。 |
| 整數 | 整數數值。 |
| 日期 | 日期。YYYY-MM-DD格式:YYYY為4位數西元年;MM為2位數月份,01至12;DD為2位數日,01至31。年月日之區隔符號為「-」。 |
| 時間 | 日期時間。以日期(date)為基礎再加上時間(時分秒),如YYYY-MM-DD hh:mm:ss,hh為小時00至23;mm為分鐘00至59;ss為秒鐘00至59。時分秒之區隔符號為「:」。
「年月日」與「時分秒」之間以空白字元分隔。 |
| 網址 | 統一資源定位符(Uniform Resource Locators,URL),俗稱網址。 |
| 電子郵件 | 電子郵件地址格式。 |
| 列舉 | 在固定的文字清單中挑選適當的值。 |
三、資料集詮釋資料欄位定義說明
(一)服務分類
| 欄位名稱 | 服務分類 |
| 英文欄位名稱 | categoryService |
| 定義說明 |
服務分類編號3碼18類。 (依政府入口網服務分類編號選填) |
| 目的和意義 | 使用統一分類編號辭彙表有助於使用者搜尋資料資源。 |
| 資料提供屬性 | 檔案資料、API服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 列舉 |
| 填寫規則說明 |
依據政府入口網服務分類編號選填,共計18個分類項目,編碼及類別為:
|
| 建議範例 | {"categoryService":"I00"} |
| 不建議範例 | 無 |
(二)資料提供屬性
| 欄位名稱 | 資料提供屬性 |
| 英文欄位名稱 | categoryDataset |
| 定義說明 | 檔案資料指以開放檔案格式提供資料,API服務指以提供開放應用程式介面方式取用資料,皆以無償方式,不限制使用目的、地區及期間,且不可撤回之方式授權利用為原則者。 |
| 目的和意義 | 作為識別資料集為檔案資料,或為API服務。 |
| 資料提供屬性 | 檔案資料、API服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 列舉 |
| 填寫規則說明 |
|
| 建議範例 | {"categoryDataset":"A"} |
| 不建議範例 | 無 |
(三)資料集識別碼
| 欄位名稱 | 資料集識別碼 |
| 英文欄位名稱 | datasetId |
| 定義說明 | 資料集識別唯一值。 |
| 目的和意義 | 作為識別資料集之唯一值,不能夠重覆與修改。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 系統產生 |
| 資料型態 | 整數 |
| 填寫規則說明 | 系統產出之流水號,有值為修改,空值為新增。 |
| 建議範例 | {"datasetId":"21246"} |
| 不建議範例 | 無 |
(四)資料集名稱
| 欄位名稱 | 資料集名稱 |
| 英文欄位名稱 | title |
| 定義說明 | 資料集的全名。 |
| 目的和意義 | 資料集名稱是資料資源集合的正式名稱,通常以熟悉且容易辨識名稱為之。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 1. 使用正式的名稱為該資料集命名。 2. 命名不可過於冗長,應盡量簡潔。 3. 避免過於專業之術語和難以解釋的縮寫。 4. 相同提供機關不可擁有重複之資料集名稱。 5. 資料集名稱不可與資料集描述(description)內容相同 |
| 建議範例 | 1. {"title":"臺南市國中各校男女生人數統計"} 2. {"title":"101 年度原住民族生物多樣性傳統知識調查提案部落"} |
| 不建議範例 | 1. {"title":"人數統計"} 2. {"title":"知識調查提案"} 3. 不被建議的原因: (1)較容易與其他資料集的資料集名稱重複 (2)較缺乏關鍵資訊,不易識別。 |
(五)資料集描述
| 欄位名稱 | 資料集描述 |
| 英文欄位名稱 | description |
| 定義說明 | 資料集內容描述。 |
| 目的和意義 | 提供一個清晰且簡明的陳述,讓使用者了解資料集內容及資料集使用說明。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 1. 說明資料集的目的及使用說明。 2. 記錄資料集內容的關鍵環節。 3. 記錄限制訊息,如資料集的有效性時間或區域段。 4. 避免過於專業之術語和難以解釋的縮寫。 5.資料集描述不可與資料集名稱 (title)內容相同。 |
| 建議範例 | {"description":"環保署發布區域性地下水水質監測資料,包括一般地下水背景監測值及重金屬污染物監測值等資料。由於監測資料為每季現場採樣,並經實驗室檢測分析及資料品保品管程序,通常需要每季監測結束後隔月始能提供資料。"} |
| 不建議範例 | 1. {"description":"地下水水質監測資料"} 2. 不被建議的原因:描述資訊過少,不易識別。 |
(六)資料集上架方式
| 欄位名稱 | 資料集上架方式 |
| 英文欄位名稱 | type |
| 定義說明 | 說明資料集上架於平臺的方式,為後臺手動上架或透過介接程式上架兩種方式。 |
| 目的和意義 | 提供使用者有關資料集上架方式。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 系統產生 |
| 資料型態 | 列舉 |
| 填寫規則說明 | 系統判斷資料集創建型態自動產生,包含後臺手動上架或透過介接程式上架兩種,其編碼及類別為: rawdata 後臺上架 api 介接程式上架 |
| 建議範例 | {"type":"rawdata"} {"type":"api"} |
| 不建議範例 | 無 |
(七)授權方式
| 欄位名稱 | 授權方式 |
| 英文欄位名稱 | license |
| 定義說明 | 資料集授權方式。 |
| 目的和意義 | 資料之開放授權規定,讓使用者合法利用資料。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 列舉 |
| 填寫規則說明 | 於政府資料開放平臺中上架的資料集,均需符合「政府資料開放授權條款第 N 版」,其編碼及類別為 N為授權條款版本編號,以數值為之,由 1開始編號,最大值視為最新版授權。 除授權條款,另加入創作共用相關授權標示。 1 政府資料開放授權條款第 1 版 11 創作共用,姓名標示(CC by 4.0) 12 創作共用 姓名標示-相同方式分享(CC by-SA 4.0) 13 開放字型授權條款 OFL-1.1 14 公眾領域貢獻宣告(CC0) |
| 建議範例 | {"license":"1"} |
| 不建議範例 | 無 |
(八)計費方式
| 欄位名稱 | 計費方式 |
| 英文欄位名稱 | cost |
| 定義說明 | 使用資料所應付之費用。 |
| 目的和意義 | 說明資料集計費資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 列舉 |
| 填寫規則說明 | 計費方式編碼及類別為: free 免費 |
| 建議範例 | {"cost":"free"} |
| 不建議範例 | 無 |
(九)資料提供者
| 欄位名稱 | 資料提供者 |
| 英文欄位名稱 | dataProvider |
| 定義說明 | 為資料集之提供人於電子化政府服務平臺公務帳號。 |
| 目的和意義 | 紀錄資料集之管理人員,僅能由此管理人員進行資料集之新增、修改、下架等動作。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 填寫資料提供者之電子化政府服務平臺公務帳號。 請參考電子化政府服務平臺公務帳號申請。 |
| 建議範例 | {"dataProvider":"loginaccount "} |
| 不建議範例 | 無 |
(十)提供機關物件識別碼
| 欄位名稱 | 提供機關物件識別碼 |
| 英文欄位名稱 | publisherOID |
| 定義說明 | 資料集之提供機關物件識別碼與機關名稱。 |
| 目的和意義 | 提供使用者判斷資料來源的依據、可用度等資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 請參考物件識別碼中心網站,作為提供機關物件識別碼(OID),填寫資料集提供機關物件識別碼或加填機關全銜(以半形垂直線分隔,並避免使用機關簡稱)。 |
| 建議範例 | 1. {"publisherOID":"2.16.886.101.20003.20069.20001|國家發展委員會檔案管理局"} 2. {"publisherOID":"2.16.886.101.20003.20004.20044|財政部關務署"} 3. {"publisherOID":"2.16.886.101.20003.20001.20053|內政部國土測繪中心"} 4. {"publisherOID":"2.16.886.101.20003.20069”} |
| 不建議範例 | 無 |
(十一)提供機關聯絡人姓名
| 欄位名稱 | 提供機關聯絡人姓名 |
| 英文欄位名稱 | publisherContactName |
| 定義說明 | 資料集提供機關聯絡人姓名或單位與姓名。 |
| 目的和意義 | 作為使用者諮詢相關人員之資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 填寫資料集提供機關聯絡人姓名或單位與姓名。 |
| 範例 | 1. {"publisherContactName":"資訊管理處郭大明"} 2. {"publisherContactName":"資訊室郭先生"} 3. {"publisherContactName":"大明,小明"} |
| 不建議範例 | 無 |
(十二)提供機關聯絡人電話
| 欄位名稱 | 提供機關聯絡人電話 |
| 英文欄位名稱 | publisherContactPhone |
| 定義說明 | 資料集提供機關聯絡人電話號碼。 |
| 目的和意義 | 作為使用者諮詢相關人員之資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 填寫資料集提供機關聯絡人電話。 |
| 建議範例 | {"publisherContactPhone":"02-23165300#123"} |
| 不建議範例 | 無 |
(十三)提供機關聯絡人電子郵件
| 欄位名稱 | 提供機關聯絡人電子郵件 |
| 英文欄位名稱 | publisherContactEmail |
| 定義說明 | 資料集提供機關聯絡人電子郵件。 |
| 目的和意義 | 作為使用者諮詢相關人員之資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 電子郵件,電子郵件地址格式可參考政府資料標準平臺。 |
| 填寫規則說明 | 填寫資料集提供機關聯絡人電子郵件。 |
| 建議範例 | {"publisherContactEmail":"[email protected],[email protected],[email protected]"} |
| 不建議範例 | 無 |
(十四)更新頻率
| 欄位名稱 | 更新頻率 |
| 英文欄位名稱 | updateFrequency |
| 定義說明 | 資料集之更新頻率。 |
| 目的和意義 | 提供使用者有關資料集更新之時序參考。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 1. 定義資料集更新週期,一筆資料集僅存在一個更新頻率。 2. 於 112 年 4 月 1 日起,該欄位調整填寫方式為一組單值,需填寫是否定期更新(1=是、2=否)、更新時間(正整數)、更新時間單位(年、月、日、時、分、秒)。若定期更新,需填寫更新時間及選擇更新時間單位。 3. 若為不定期更新或不更新之資料集,是否定期更新請填寫 2=否,更新時間及更新時間單位不需填寫。 |
| 建議範例 | 112 年 4 月 1 日起調整欄位規範,範例如下: updateFrequency: { regularUpdate: "1", frequency: "1", unitTime: "月" } |
| 不建議範例 | 1. "updateFrequency": { regularUpdate: "1", frequency: "每", unitTime: "月" } 2.不被建議的原因:更新時間須為正整數 |
(十五)資料品質
| 欄位名稱 | 資料品質 |
| 英文欄位名稱 | dataQuality |
| 定義說明 | 依據資料集品質檢測結果,呈現其資料集品質。 |
| 目的和意義 | 提供使用者品質良好之資料集,並逐步提升政府 資料之可用性。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 系統產生 |
| 資料型態 | 列舉 |
| 填寫規則說明 | 依據政府資料開放優質標章暨深化應用獎勵措施提供資料集標章,系統自動產出,編碼及類別為: G 金標章 S 銀標章 B 銅標章 另有無標章標示以下三種: 無(白名單) 無(未做品檢) 無(品檢未過) |
| 建議範例 | 1. {"dataQuality":"G"} 2. {"dataQuality":"S"} 3. {"dataQuality":"B"} |
| 不建議範例 | 無 |
(十六)開始收錄日期
| 欄位名稱 | 開始收錄日期 |
| 英文欄位名稱 | coverageStartedDate |
| 定義說明 | 資料集檔案內容開始收錄資料之年月日。這裡係指資料(data)之開始收錄日期。 |
| 目的和意義 | 記錄資料集收錄資料時間範圍之開始日期,提供使用者運用加值的參考依據,並可與「結束收錄日期」聯合使用。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 建議填寫 |
| 資料型態 | 日期 |
| 填寫規則說明 | 請參考 W3C XML Schema Definition,日期精準至年、月、日呈現。 |
| 建議範例 | {"coverageStartedDate":"2015-01-01"} |
| 不建議範例 | 1. {"coverageStartedDate":"2015"} 2. 不被建議的原因:日期僅為年份,精準度較低。 |
(十七)結束收錄日期
| 欄位名稱 | 結束收錄日期 |
| 英文欄位名稱 | coverageEndedDate |
| 定義說明 | 資料集檔案內容結束收錄資料之年月日。這裡係指資料(data)之結束收錄日期。 |
| 目的和意義 | 記錄資料集收錄資料時間範圍之結束日期,提供使用者運用加值的參考依據,並可與「開始收錄日期」聯合使用。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 建議填寫 |
| 資料型態 | 日期 |
| 填寫規則說明 | 請參考 W3C XML Schema Definition,日期精準至年、月、日呈現。 |
| 建議範例 | {"coverageEndedDate":"2015-01-01"} |
| 不建議範例 | 1. {"coverageEndedDate":"2015"} 2. 不被建議的原因:日期僅為年份,精準度較低。 |
(十八)上架日期
| 欄位名稱 | 上架日期 |
| 英文欄位名稱 | publishedDate |
| 定義說明 | 資料集預定上架的日期,依機關屬性自行評估是否納入送審至資料審查者通過時程。 |
| 目的和意義 | 提供使用者有關資料之時序應用參考。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 日期 |
| 填寫規則說明 | 請參考 W3C XML Schema Definition,日期精準至年、月、日呈現,新增資料集後不得修改。 |
| 建議範例 | {"publishedDate":"2015-01-01"} |
(十九)詮釋資料更新時間
| 欄位名稱 | 詮釋資料更新時間 |
| 英文欄位名稱 | modifiedDate |
| 定義說明 | 經送審資料集後,資料審查者通過後之更新時間,此欄位為系統產生,使用者不得修改。 |
| 目的和意義 | 提供使用者有關詮釋資料更新之時序參考。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 系統產生 |
| 資料型態 | 日期與時間 |
| 填寫規則說明 | 請參考 W3C XML Schema Definition,依序為年、月、日、時、分、秒呈現。 |
| 建議範例 | {"modifiedDate":"2015-01-01 23:59:59"} |
| 不建議範例 | 無 |
(二十)空間範圍
| 欄位名稱 | 空間範圍 |
| 英文欄位名稱 | spatialCoverage |
| 定義說明 | 資料資源的地理空間特徵描述。 |
| 目的和意義 | 此為額外延伸詮釋資料欄位,可依各機關之地理空間類型業務需要,可填寫如最小統計區、行政區、城市、地標、區域座標等空間特徵相關資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 建議填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 1. 填寫資料集空間特性的描述說明。 2. 建議以四極(角)坐標採用經緯度坐標填寫。 3. 可填寫最小統計區代碼。 4. 可填寫地區地名範圍。如臺灣、臺北。 5. 可填寫區域座標範圍,依各機關需求自行決定標示方式。 |
| 建議範例 | 1. {"spatialCoverage":{"LineString":{"coordinates":"121.518738,25.017538 121.603195,25.017538121.603195,25.075931 121.518738,25.075391"}}} 2. {"spatialCoverage":"A6305-0001-00"} 3. {"spatialCoverage":"臺灣"} |
| 不建議範例 | 無 |
(二十一)語系
| 欄位名稱 | 語系 |
| 英文欄位名稱 | language |
| 定義說明 | 資料集詮釋資料使用語言。 |
| 目的和意義 | 提供使用者處理詮釋資料之基礎資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 列舉 |
| 填寫規則說明 | 填寫常用代碼共計 5 個語系分類項目,編碼及類別為: zh 中文 jp 日文 en 英文 kr 韓文 else 其他 |
| 建議範例 | 1. {"language":"zh"} 2. {"language":"en"} |
| 不建議範例 | 無 |
(二十二)相關網址
| 欄位名稱 | 相關網址 |
| 英文欄位名稱 | relatedUrl |
| 定義說明 | 資料集資源的原網址(資料集來源網址)、資料集說明網址、或其他資料集相關連結。 |
| 目的和意義 | 提供資料集輔助資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 建議填寫 |
| 資料型態 | 網址 |
| 填寫規則說明 | 填寫資料集相關網址。 |
| 建議範例 | {"relatedUrl":"https://example1.gov.tw"} |
| 不建議範例 | 無 |
(二十三)關鍵字
| 欄位名稱 | 關鍵字 |
| 英文欄位名稱 | keyword |
| 定義說明 | 資料集的重要關鍵字,供檢索使用。 |
| 目的和意義 | 提供使用者檢視資料內容的依據之一,並可利用關鍵字搜尋相關資料集。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 建議填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 1. 填寫關鍵字,以簡單明確之「辭彙」為主。 2. 建議各機關可依業務需要發展關鍵字辭彙表,填寫使用辭彙表之關鍵字,避免關鍵字濫用。 |
| 建議範例 | 1. { "keyword": [ "交通", "治安"] } 2. { "keyword": [ "食品", "安全", "衛生"] } |
| 不建議範例 | 1. { "keyword": [ "100 年度 1578 條土石流潛勢溪流影響範圍圖(TWD97)", "103 年度行政院農業委員會高雄區農業改良場單位決算", "104 年度行政院農業委員會動植物防疫檢疫局及所屬會計報告"] } 2. 不被建議的原因:關鍵字過於冗長,使用者不易理解,且較無法與其他資料集有關聯性。 |
(二十四)備註
| 欄位名稱 | 備註 |
| 英文欄位名稱 | notes |
| 定義說明 | 資料集相關資訊、備註及使用說明。 |
| 目的和意義 | 此為額外延伸詮釋資料欄位、資料格式說明等,依各機關業務需要,於填寫說明資料集相關資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 選擇性填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 填寫資料集備註資訊,依各機關需求自行決定。 |
| 建議範例 | { notes: "正式出版後時有異動,請以正式出版之書 目資料為準。API 參數:year 代表年度" } |
| 不建議範例 | 無 |
(二十五)API 說明文件
| 欄位名稱 | API 說明文件 |
| 英文欄位名稱 | apiDocUrl |
| 定義說明 | 提供 API 使用手冊下載連結或說明網頁相關連結,應可瀏覽 API 操作相關內容。 |
| 目的和意義 | 提供所有 API 使用資訊說明,可以手冊下載或網頁方式呈現,介接端可瀏覽所有 API 說明相關內容。 |
| 資料提供屬性 | 僅 API 服務有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 網址 |
| 填寫規則說明 | 填寫 API 使用手冊下載或頁面連結。 |
| 建議範例 | { "apiDocUrl": "https://data.gov.tw/m2m" } |
| 不建議範例 | 無 |
(二十六)資料資源描述
| 欄位名稱 | 資料資源描述 |
| 英文欄位名稱 | resourceDescription |
| 定義說明 | 資料資源內容描述。 |
| 目的和意義 | 提供一個清晰且簡明的陳述,讓使用者了解資料資源的內容。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 建議填寫 |
| 資料型態 | 字串 |
| 填寫規則說明 | 1. 屬於資源供應資訊(Distribution)類別。 2. 說明資料資源的目的。 3. 記錄資料資源內容的關鍵環節。 4. 記錄限制訊息,如資料資源的有效性時間段或區域段。 5. 避免過於專業之術語和難以解釋的縮寫。 |
| 建議範例 | { "distribution": [ { "resourceDescription": "民國 88 年-各村(里)戶 籍人口統計月報表-CSV" } ] } |
| 不建議範例 | { distribution: [ { resourceDescription: "人口統計" } ] } 不被建議的原因:描述資訊過少,不易識別。 |
(二十七)資料資源欄位
| 欄位名稱 | 資料資源欄位 |
| 英文欄位名稱 | resourceField |
| 定義說明 | 資料資源欄位之名稱及簡要說明。 |
| 目的和意義 | 提供使用者快速了解資料資源欄位內容。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 字串或陣列 |
| 填寫規則說明 | 1. 依資料資源檔案之欄位填寫,若使用字串型態,應填入「欄位名稱(欄位名稱說明文字)」,欄位名稱之間以全形頓號分隔;可選填半形括號並於括號內描述欄位,括號內描述不可再有半形括號字元。 資料資源檔案之欄位名稱為中文者,請填入欄位之中文名稱;如為英文,請填入欄位之英文名稱。 如使用陣列型態,每 1 個欄位屬 1 個 JSON 物件,其內含 2 個欄位,一個是 name,一個是description,name 是欄位名稱,description 為欄位說明文字。name 為必填,而 description 可使用空字串代表沒有描述文字。 |
| 建議範例 | { distribution:[ { resouceField:"name(村名)、population(人口)" } ] } 或 { distribution: [ { resouceField: [ { name: "name", description: "村名" }, { name: "population", description: "人口" } ] } ] } |
| 不建議範例 | { distribution: [ { resourceField: "name" } ] } 不被建議的原因: (1)資料檔案欄位大部分為多個欄位。 |
(二十八)檔案格式
| 欄位名稱 | 檔案格式 |
| 英文欄位名稱 | resourceFormat |
| 定義說明 | 資料資源提供之檔案格式。 |
| 資料提供屬性 | 僅檔案資料有此欄位 |
| 目的和意義 | 說明資料資源之資料檔案格式資訊。 |
| 選填條件 | 必須填寫 |
| 資料型態 | 列舉 |
| 填寫規則說明 | 1. 屬於資源供應資訊(Distribution)類別。 2. 共計 30 個分類項目,類別為:CSV、JSON、XML、RDF、KML、KMZ、SHP、WMS、CAP、TXT、RSS、PDF、ODT、ODS、ODP、DOC、DOCX、XLS、XLSX、PPT、PPTX、DWG、TIFF、JPG、PNG、ZIP、GZ、RAR、7Z、GEOJSON 等檔案格式。 3. 一個檔案格式需對應一個資料下載網址(resourceDownloadUrl)。 |
| 建議範例 | { distribution: [ { resourceFormat: "CSV" } ] } |
| 不建議範例 | 無 |
(二十九)編碼格式
| 欄位名稱 | 編碼格式 |
| 英文欄位名稱 | resourceCharacterEncoding |
| 定義說明 | 資料資源的編碼格式,編碼格式分為 UTF-8、Big5以及其他。 |
| 目的和意義 | 提供使用者處理資料之基礎資訊。 |
| 資料提供屬性 | 僅檔案資料有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 列舉 |
| 填寫規則說明 | 1. 屬於資源供應資訊(Distribution)類別。 2. 依據編碼格式選填 UTF-8、Big5 以及其他。 3. 一個編碼格式需對應一個資料下載網址(resourceDownloadUrl)。 |
| 建議範例 | { distribution: [ { resourceCharacterEncoding: "UTF-8" } ] } |
| 不建議範例 | 無 |
(三十)資料資源品質檢測時間
| 欄位名稱 | 資料資源品質檢測時間 |
| 英文欄位名稱 | resourceQualityCheckTime |
| 定義說明 | 資料資源品質檢測時間為進行資料集「品質檢測」檢查資料下載網址(resourceDownloadUrl)之檢測時間。 |
| 目的和意義 | 提供使用者有關資料資源品質檢測時間之時序參考。 |
| 資料提供屬性 | 僅檔案資料有此欄位 |
| 選填條件 | 系統產生 |
| 資料型態 | 日期與時間 |
| 填寫規則說明 | 1. 屬於資源供應資訊(Distribution)類別。 2. 請參考 W3C XML Schema Definition,依序為年、月、日、時、分、秒呈現。 3. 一個資料資源品質檢測時間對應一個資料下載網址(resourceDownloadUrl)。 |
| 建議範例 | { distribution: [ { resourceQualityCheckTime : "2015-01-01 23:59:59" } ] } |
| 不建議範例 | 無 |
(三十一)資料下載網址(API 位址)
| 欄位名稱 | 資料下載網址(API 位址) |
| 英文欄位名稱 | resourceDownloadUrl |
| 定義說明 | 資料資源之檔案直接下載(download)網址,或透過API 取得資料之路徑。 |
| 目的和意義 | 提供使用者直接下載,或透過 API 路徑使用資料資源。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 網址 |
| 填寫規則說明 | 1. 屬於資源供應資訊(Distribution)類別。 2. 填寫資料下載網址或 API 路徑。 3. 支援 HTTPS 協定。詳細的 URL 規範可參考 URL Standard |
| 建議範例 | { distribution: [ { resourceDownloadURL: https://example1.gov.tw/a.csv } ] } 或 { distribution: [ { resourceDownloadURL: https://data.gov.tw/api/v2/rest/dataset/{datasetID} } ] } |
| 不建議範例 | 無 |
(三十二)資料量
| 欄位名稱 | 資料量 |
| 英文欄位名稱 | resourceAmount |
| 定義說明 | 資料資源所收錄之資料筆數。 |
| 目的和意義 | 提供使用者資料數目之參考。 |
| 資料提供屬性 | 僅檔案資料有此欄位 |
| 選填條件 | 建議填寫 |
| 資料型態 | 整數 |
| 填寫規則說明 | 以正整數填寫資料筆數。 |
| 建議範例 | { distribution: [ { resourceAmount: "12345" } ] } |
| 不建議範例 | 無 |
(三十三)資料資源備註
| 欄位名稱 | 資料資源備註 |
| 英文欄位名稱 | resourceNotes |
| 定義說明 | 資料資源相關資訊備註說明。 |
| 目的和意義 | 此為額外延伸詮釋資料欄位,依各機關之業務需要,於備註追加說明相關資料資源資訊。 |
| 資料提供屬性 | 檔案資料、API 服務皆有此欄位 |
| 選填條件 | 選擇性填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 填寫資料資源備註資訊。 |
| 建議範例 | { distribution: [ { resourceNote: "統計截止到 2014 年 12 月底" } ] } |
| 不建議範例 | 無 |
(三十四)檢測階層
| 欄位名稱 | 檢測階層 |
| 英文欄位名稱 | qcLevel |
| 定義說明 | 指定巢狀結構化檔案格式品質檢測區段 |
| 目的和意義 | 此為額外延伸資料資源指定品質檢測區段欄位,依各機關開放資料格式,於本欄位指定。 |
| 資料提供屬性 | 僅檔案資料有此欄位 |
| 選填條件 | 選擇性填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 填寫資料資源檢測的文件起始位置資訊,依各檔案結構進行填寫。 |
| 建議範例 | 資料檔案內容: <Document> <h1> This is a test document </h1> <descriptions> .... </descriptions> <definition> <description>...</description> <dataset> <row> <col1>value1-1</col1> <col2>value1-2</col2> </row> <row> <col1>value2-1</col1> <col2>value2-2</col2> </row> </dataset> <definition> </Document> 填寫範例: { distribution: [ { qcLevel: "/Document/definition/dataset" } ] } |
| 不建議範例 | 無 |
(三十五)API 請求方式
| 欄位名稱 | API 請求方式 |
| 英文欄位名稱 | resourceRequestMethod |
| 定義說明 | HTTP 協議中指定客戶端(例如網頁瀏覽器)希望對伺服器執行的操作類型 |
| 目的和意義 | 提供使用者該 API 之請求方式 |
| 資料提供屬性 | 僅 API 服務有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 列舉 |
| 填寫規則說明 | 透過 API 請求之設定方法,包含: GET POST PUT |
| 建議範例 | { distribution: [ { resourceRequestMethod: "GET", } ] } |
| 不建議範例 | 無 |
(三十六)API 機器可讀之說明文件
| 欄位名稱 | API 機器可讀之說明文件 |
| 英文欄位名稱 | resourceOasUrl |
| 定義說明 | 提供符合 OAS 規範之機器可讀說明文件直接下載(download)網址。 |
| 目的和意義 | 提供機器可讀之 API 使用文件說明,其 API 網址須符合 OAS 規範,以利機器可讀說明文件直接下載(download)網址。 |
| 資料提供屬性 | 僅 API 服務有此欄位 |
| 選填條件 | 必須填寫 |
| 資料型態 | 網址 |
| 填寫規則說明 | 1. 屬於資源供應資訊(Distribution)類別。 2. 填寫 API 說明文件下載網址。 3. 支援 HTTPS 協定。詳細的 URL 規範可參考URL Standard |
| 建議範例 | "distribution": [ { "resourceOasUrl:" https://tdx.transportdata.tw/backend/api/File/Swagger/V3/7f07d940-91a4-495d-9465-1c9df89d709c } ] } |
| 不建議範例 | 無 |
(三十七)API 參數
| 欄位名稱 | API 參數 |
| 英文欄位名稱 | resourceRequestParameters |
| 定義說明 | 提供符合 OAS 規範之機器可讀說明文件直接下載(download)網址。 |
| 目的和意義 | 提供 API 請求的查詢參數,以請求更多資源相關資訊。 |
| 資料提供屬性 | 僅 API 服務有此欄位 |
| 選填條件 | 選擇性填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 1. 屬於資源供應資訊(Distribution)類別。 2. API 參數需對應其參數名稱(name)、參數類型(type)、是否必填(requried)、預設值(default)、描述(description),為一組多值之欄位。 3. 參數名稱:文字,填寫該參數名稱。 4. 參數類型:列舉,選項包含字串(string)、整數(integer)、浮點數(float)、布林值(Boolean) 。 5. 是否必填:列舉,選項 1 必填;2 非必填。 6. 預設值:文字,若該參數為必填,則預設值需有值。 7. 描述:文字,填寫關於該參數之使用描述。 |
| 建議範例 | { distribution: [ resourceRequestParameters: [ { name: "$format", type: "string", required: 1, default: "JSON", description: "檔案格式" } ] } |
| 不建議範例 | 無 |
(三十八)API 路徑變數
| 欄位名稱 | API 路徑變數 |
| 英文欄位名稱 | resourcePathParameters |
| 定義說明 | API 請求的路徑變數。 |
| 目的和意義 | 提供 API 請求的路徑變數,完成請求所需的輸入資料或執行內容。 |
| 資料提供屬性 | 僅 API 服務有此欄位 |
| 選填條件 | 選擇性填寫 |
| 資料型態 | 文字 |
| 填寫規則說明 | 1. 屬於資源供應資訊(Distribution)類別。 2. API 路徑變數需對應其參數名稱(name)、預設值(default)、描述(description),為一組多值之欄位。 3. 參數名稱:文字,填寫該參數名稱。 4. 預設值:文字,若該參數為必填,則預設值需有值。 5. 描述:文字,填寫關於該參數之使用描述。 |
| 建議範例 | { distribution: [ resourcePathParameters: [ { name: "datasetID", default: "656 description: "資料集識別碼" } ] } |
| 不建議範例 | 無 |

