アンケート設問を作成
/manage/events/:eventId/questions参加登録アンケートの設問を作成します。questionsWrite 権限が必要です。
| 認証 | 要ログイン |
|---|
パスパラメータ
eventIdstring必須イベント ID または slug。
リクエストボディ
refIdstring設問の参照 ID(テンプレート由来の識別子)
typestring必須設問タイプ(作成時は必須)。text / longText / email / url / singleSelect / multiSelect / toggle / radioButton / date / image のいずれか。
titlestring必須設問文(必須)。255 文字以内。
descriptionstring説明。500 文字以内。
languagesobject多言語の設問文・説明。
optionsobject[]選択肢(singleSelect / multiSelect / radioButton の場合)。各選択肢のラベルを指定する。
requiredboolean回答必須かどうか。
ticketIdsstring[]この設問を出すチケット ID の配列。空配列なら全チケットが対象。
ordernumber表示順。整数。デフォルト 9999。
statusstringDRAFT / PUBLISHED / PRIVATE のいずれか。
searchableboolean参加者検索の対象にするか。
showOnDashboardbooleanダッシュボードに集計を表示するか。
branchParentId / conditionOptionIds / positionstring | string[] | number条件分岐の設定。
settingsobject設問タイプ固有の設定。
オブジェクトの構造
languages
言語コードをキーに、その言語で表示する title / description を指定します。指定した言語のみ上書きされ、未指定の言語は既定のフィールドが使われます。
<lang>object言語コード(ja / en など)
<lang>.titlestringその言語で表示するタイトル。
<lang>.descriptionstringその言語で表示する説明。
{
"ja": { "title": "オープニング基調講演", "description": "..." },
"en": { "title": "Opening Keynote", "description": "..." }
}options
選択肢。singleSelect / multiSelect / radioButton の設問で使用します。回答時は選択肢の id を answer に指定します。
idstring選択肢 ID。既存の選択肢を更新する場合に指定する(新規は省略)
labelstring必須選択肢のラベル。
languagesobject言語別ラベル({ [lang]: { label } })
[
{ "id": "o1", "label": "SNS", "languages": { "en": { "label": "Social media" } } },
{ "label": "知人の紹介" }
]settings
設問タイプごとの追加設定。現在は image タイプの画像サイズ指定にのみ使用します。
widthnumber画像の幅(px)。16〜4096 の整数。
heightnumber画像の高さ(px)。16〜4096 の整数。
{
"width": 1200,
"height": 630
}curl https://api.4s.link/manage/events/EVENT_ID/questions \-X POST \-H "Authorization: Bearer 4s_at_..." \-H "Content-Type: application/json" \-d '{"type": "text","title": "参加目的を教えてください","required": true,"status": "PUBLISHED"}'
{"id": "q1a2b3c4-...","refId": "purpose","type": "text","title": "参加目的を教えてください","description": null,"required": true,"options": [],"ticketIds": [],"order": 0,"status": "PUBLISHED","searchable": false,"showOnDashboard": false}