NaraForm Docs
收集回覆

外部 Metadata

用隱藏題目從公開表單 URL 收集外部上下文

外部網站、文件站或產品頁可以把公開表單嵌入 iframe,或直接連到公開表單 URL。若需要把頁面上下文一起保存,請在表單中建立一般題目,並在題目編輯區勾選「隱藏」。

隱藏題目仍然是表單 schema 的一部分:題目的 key 是 URL query / metadata payload key,題目的標題是後台顯示名稱。它不會出現在受訪者問卷畫面,也不會寫入 answers。

設定方式

  1. 在 Builder 新增一題,例如短答題。
  2. 設定題目標題,例如「來源頁面」。
  3. 設定題目 key,例如 source_page
  4. 在題目編輯區勾選「隱藏」。
  5. 發布表單。

只有被設定為隱藏題目的 key 會被保存。未在表單 schema 中設定為 hidden 的 query params 會被忽略;filter API 則會對未設定的 metadata key 回傳 422

URL 範例

https://forms.example.com/s/feedback?source_page=guide

受訪者只會看到可見題目。送出後,回覆會保存 metadata:

{
  "source_page": "guide"
}

若 hidden 題目的 key 是 url 或以 _url 結尾,值必須是 httphttps URL。Nested object、array 與超長值會被 submit API 拒絕。

後台查看與篩選

在 Dashboard 的回覆列表中,metadata 會以獨立區塊顯示;它不會混入答案欄位。回覆列表與分析摘要可用下列 query shape 篩選:

GET /api/forms/:id/responses?metadata[source_page]=guide
GET /api/forms/:id/analytics/summary?metadata[source_page]=guide

CSV 匯出

CSV 預設維持既有欄位。若要加入 hidden metadata columns,使用:

GET /api/forms/:id/responses/export?includeMetadata=1

啟用後會在題目欄位前加入該表單 hidden 題目的欄位,例如:

metadata.source_page