Appearance
SC-001 日別記事結果ショートコード
概要
- 指定ホール・日付の台別データ(ランキング・末尾データ・ヒートマップ)を日別記事ページに埋め込み表示する。
- 埋め込みブロック全体のライフサイクル・状態差分・パーツ別の操作仕様は PUB-003 日別記事結果(埋め込みブロック) を参照。
- 初期 HTML はプレースホルダー中心とし、ランキング等の重い塊は API-001 に記載の
daily-article/v1の GET(エンドポイント識別子はAPI-001-*)を使用し非同期に表示する。
外部インターフェース
ショートコードタグ
- タグ名:
[CustomCode_CreateDailyArticleResult] - 入力例:
[CustomCode_CreateDailyArticleResult hall="アイランド秋葉原" date="20240101"]
属性一覧
| 属性 | 役割 | 必須 |
|---|---|---|
hall | 対象のホールを指定(HallEnum) | ○ |
date | 対象日を指定(YYYYMMDD 形式。例: 20240101) | ○ |
date は 8桁の数字(^\d{8}$)以外は不正扱いとなり、ショートコードは出力しません(下記「エラー・境界条件」も参照)。
ワイヤーフレーム
ランキング (B-0〜B-3)
末尾データ (B-5)
ヒートマップ (B-6〜B-7)
広告 (B-8)
エラー・境界条件
| 条件 | ユーザー向け挙動 | メッセージ / ログ |
|---|---|---|
hall 不正 / 未指定 | 出力なし(空文字) | — |
date 未指定 / 空 / 形式不正 | 出力なし(空文字) | — |
| ヒートマップレイアウト取得失敗 | 表示は継続、レイアウト空 | error_log(コントローラー) |
| 非同期取得失敗(JS) | プレースホルダーにエラー表示 | Messages::DAILY_ARTICLE_RESULT_ASYNC_* |
今後の更新で崩してはいけないところ(互換性契約)
公開契約(Breaking change 扱い)
- ショートコード名、変数
- ショートコード名
CustomCode_CreateDailyArticleResult、属性名hall/date(dateは必須) - 理由:既存記事がショートコードを呼び出す際に使用している値を正確に読み込むため
- ショートコード名