コンテンツ企画
コンテンツ企画の API。タイムテーブルにコンテンツを置いて動かし、ライン(担当の組)とスタッフ、登壇者とその確認、サムネイルを作る。公開を止める指摘をまとめて確かめる入口と、参加表明の画像の下書きもここにある。
この分類のあらまし
- 誰が呼べるか
そのイベントを企画できる人が、ログインして呼ぶ。
ログイン 49 件
- 件数と印
この分類の API は 49 件・ポーリング 1 件・レート制限 39 件
画面が一定の間隔で呼び直す前提の API(ポーリング)。
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
- 契約での分類の説明
コンテンツ企画(タイムテーブル・ライン・登壇者・サムネイル・コンテンツのチャット。そのイベントを企画できる人)
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API49 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- 運営 admin のブラウザ操作で active な主 Tokyo イベントの Stage A / B を登録する。同名の実ルームを再利用し、既存ステージと 4S 対応は保持するPOST作成・操作
/api/planning/{eventId}/stages/registerログイン(cookie)・レート制限 - 企画の全体(日・ステージ・ライン・全コンテンツ〔未配置と終日のブースを含む〕・登壇者の一覧・格子の設定・rev)を 1 回でGET取得
/api/planning/{eventId}ログイン・ポーリング・レート制限 - 下書きのコンテンツをステージと時刻に作る(kind は format から決まる。lineId を省くとステージの既定のライン)POST作成・操作
/api/planning/{eventId}/blocksログイン・レート制限 - コンテンツを動かす・伸ばす・ステージやラインを付け替える・題を変える(expectedRevision が違えば 409 で今の状態 = PlannerBlockConflictResponse を返す。公開中どうしが重なる置き方は 409 stage_overlap)PATCH一部を更新
/api/planning/blocks/{contentId}ログイン・レート制限 - 下書きのコンテンツを消す(一度でも公開したもの・募集が結んであるもの・出展者が属するもの・チャットのあるものは 409。ブラウザのログインだけ)DELETE削除
/api/planning/blocks/{contentId}ログイン(cookie)・レート制限 - 公開を止める指摘(同じステージの重なり・時刻やステージの不足・長さ)と注意(会期の外・刻みに乗らない・ラインなし・登壇者なし・未確定の登壇者)を返す(書込みなし)POST作成・操作
/api/planning/{eventId}/validateログイン・レート制限 - コンテンツの登壇者の全文(並び・役割・大きく見せる人)。ここに無い人は外すPUT更新
/api/planning/blocks/{contentId}/speakersログイン・レート制限 - ラインの一覧(受け持つステージ・既定のスタッフ・コンテンツの数)GET取得
/api/planning/{eventId}/linesログイン・レート制限 - ラインの既定のスタッフに選べる人(運営と、そのイベントの管理者だけ。名前と id。参加者の一覧は出さない)GET取得
/api/planning/{eventId}/staffログイン・レート制限 - ラインを作る(名前はイベントの中で一意。色は点の色の名前 = lib/tint.ts の TINTS)POST作成・操作
/api/planning/{eventId}/linesログイン・レート制限 - ラインの名前・色・並びを変えるPATCH一部を更新
/api/planning/lines/{id}ログイン・レート制限 - ラインを消す(コンテンツは残り、ラインだけ外れる。既に在るチャットとそのメンバーは変わらない)DELETE削除
/api/planning/lines/{id}ログイン・レート制限 - ラインの既定のスタッフの全文(autoJoin = コンテンツのチャットができるときに自動で入る)PUT更新
/api/planning/lines/{id}/membersログイン・レート制限 - ラインが受け持つステージの全文PUT更新
/api/planning/lines/{id}/roomsログイン・レート制限 - 登壇者の一覧(確認の段階・アカウントの有無・出るコンテンツ・生きている限定リンクの数)。主のイベントは全員、それ以外はそのイベントのコンテンツに出る人GET取得
/api/planning/{eventId}/speakersログイン・レート制限 - 運営が登壇者の写真を上げる(multipart の file。サーバで向きを当てて WebP に書き直し、メタデータを落とす。返った id を提案の photoImageId に指す。そのイベントを企画できる人)POST作成・操作
/api/planning/{eventId}/speaker-photosログイン・レート制限 - 登壇者を作る(提案の流れに入る前の draft)。contentId でコンテンツへ結べるPOST作成・操作
/api/planning/speakersログイン・レート制限 - 登壇者 1 人: 今の掲載内容・開いている提案と本人の直し・結んだアカウント・出るコンテンツ・限定リンク・今の上限GET取得
/api/planning/speakers/{id}ログイン・レート制限 - 運営の直接の修正(プロフィールは draft の人だけ。それ以外は提案を通す = 409 proposal_required)と、結ぶアカウントの変更・出るコンテンツへの追加PATCH一部を更新
/api/planning/speakers/{id}ログイン・レート制限 - 運営の提案を書く・書き直す(開いている提案を置き換える。本人の直しが入っていれば discardSpeakerEdits が要る)PUT更新
/api/planning/speakers/{id}/proposalログイン・レート制限 - 提案(+ 本人の直し)を確定して掲載内容へ写す(ブラウザのログインだけ。API トークン・MCP 不可)POST作成・操作
/api/planning/speakers/{id}/confirmログイン(cookie)・レート制限 - 登壇者の限定リンクを発行する(秘密の URL はこの応答だけ。期限はゲーム設定 speaker.previewTtlDays。ブラウザのログインだけ)POST作成・操作
/api/planning/speakers/{id}/preview-linksログイン(cookie)・レート制限 - 限定リンクを取り消す(ブラウザのログインだけ)DELETE削除
/api/planning/preview-links/{id}ログイン(cookie)・レート制限 - サムネイルのデザイン・使える形式 / テンプレート / テーマ・保存済みの PNG・絵に載る材料GET取得
/api/planning/blocks/{contentId}/thumbnailログイン・レート制限 - サムネイルのデザインを保存する(テンプレート・テーマ・手で直した改行など。expectedRev が違えば 409)PUT更新
/api/planning/blocks/{contentId}/thumbnailログイン・レート制限 - 今のデザインの PNG(その場で描く。下書きも見られる。企画できる人だけ。w を渡すとその幅へ縮めた見本、type=jpeg / webp で軽い見本〔応答は image/jpeg・image/webp〕)GET取得
/api/planning/blocks/{contentId}/thumbnail/{format}ログイン・レート制限 - 今の版の全形式を描いて保存する(公開中のコンテンツなら公開の URL が付く)POST作成・操作
/api/planning/blocks/{contentId}/thumbnail/renderログイン・レート制限 - 保存せず・描かずに、渡したデザイン(テンプレート / 自分で組んだ配置)の形式ごとの配置と検算の指摘を返す(配置を直しながら何度も呼ぶ)POST作成・操作
/api/planning/blocks/{contentId}/thumbnail/validateログイン・レート制限 - テンプレート(おまかせを含む)か取ってある配置を「自分で組む」配置へ写して返す(保存しない。白紙ではなく動く配置から始める)POST作成・操作
/api/planning/blocks/{contentId}/thumbnail/duplicateログイン・レート制限 - このイベントに取ってある配置(自分で組んだもの)と、最初から在る見本GET取得
/api/planning/{eventId}/thumbnail-templatesログイン・レート制限 - 配置に名前を付けてイベントに取っておく・上書きする・消す(layout = null で削除。見本の key は使えない)PUT更新
/api/planning/{eventId}/thumbnail-templatesログイン・レート制限 - コンテンツのチャットを作る、または既に在るものを返す(メンバー = ラインの既定のスタッフ + コンテンツのチーム + アカウントのある登壇者。ブラウザのログインだけ)POST作成・操作
/api/planning/blocks/{contentId}/chatログイン(cookie)・レート制限 - 管理するイベントの参加表明画像の下書きと版GET取得
/api/participation-visual/events/{eventId}ログイン・レート制限 - 参加表明画像の下書きだけを保存(content scope)PUT更新
/api/participation-visual/events/{eventId}ログイン・レート制限 - 人の cookie 操作で公開・有効化POST作成・操作
/api/participation-visual/events/{eventId}/publishログイン(cookie)・レート制限 - 固定の合成人物で PNG と問題を返す(実参加者は読まない)POST作成・操作
/api/participation-visual/events/{eventId}/previewログイン・レート制限 - 固定の合成人物の PNG。問題は X-Visual-IssuesPOST作成・操作
/api/participation-visual/events/{eventId}/preview-imageログイン・レート制限 - 合成見本で両用途のレイアウト・画像・フォントを検査POST作成・操作
/api/participation-visual/events/{eventId}/validateログイン・レート制限 - 本人の content_thumbnail staged upload をイベント素材へ一回だけ消費。cookie multipart file/expectedActorId も可POST作成・操作
/api/participation-visual/events/{eventId}/backgroundログイン・レート制限 - コンテンツを下書きで作る(?entry=exhibitor は出展の入口からの保存)POST作成・操作
/api/event-contentログイン - コンテンツ 1 件の編集中の内容(管理できる人だけ)GET取得
/api/event-content/{id}ログイン - コンテンツの内容・時刻・ステージ・主体を直すPATCH一部を更新
/api/event-content/{id}ログイン - コンテンツの操作(公開・非公開・チーム・共催・登壇者・限定リンク・アンケートの依頼。公開・非公開だけは publish scope の運営 admin の PAT でも可)POST作成・操作
/api/event-content/{id}ログイン - 参加者がチェックインとアンケートを主催・共催へ共有するかを決めるPOST作成・操作
/api/event-content/{id}/consentログイン - 公開中のコンテンツの共有先(主催・共催の名前と共有する内容・確認用の版)GET取得
/api/event-content/{id}/recipientsログイン - 共有を受けたチェックインの名簿とアンケートの回答(見てよい分だけ)GET取得
/api/event-content/{id}/recordsログイン - ステージのコンテンツへ登壇者を手で足す(名前・肩書き・紹介・https の写真)POST作成・操作
/api/event-content/{id}/speakersログイン - コンテンツの管理画面の内容(チーム・登壇者・限定リンク・共催・受付 QR)GET取得
/api/event-content/{id}/workspaceログイン - Tokyo の既定のコンテンツ一式を下書きで作る(既に在るものは作らない)POST作成・操作
/api/event-content/lineupログイン