API リファレンス

API はすべて https://gamerush.jp/api/ の下にあります。本文は JSON で送り、応答も JSON で返ります。成功はすべて 200 です。

認証は、Studio の API トークン で発行したトークンを Authorization: Bearer に載せるだけです。発行のしかた・権限の選び方・置き場所の注意は SDK ガイドの API トークン にあります。

export GRUSH_TOKEN="grush_pat_..."
curl "https://gamerush.jp/api/games" \
  -H "Authorization: Bearer $GRUSH_TOKEN"

トークンをゲームのビルドへ入れないでください。ここにある API は、作者の手元・CI・エディタ拡張から呼ぶためのものです。

• トークンで呼べるのは、このページに載っている API だけです。アカウントの操作・コメント・フォローなどは、トークンでは 401 になります。
• トークンから新しいトークンは発行できません。
• 運営の管理権限はトークンには乗りません。管理者が発行したトークンでも、触れるのは本人がオーナーか共同編集者のゲームだけです。

GET の応答は { games: [...] } / { game } です。各ゲームには id・title・visibility・review_status・requested_visibility・streaming_policy・thumb_url・play_count などと、最新ビルドの latestBuild が入ります。

サムネイルは2段で上げます。まず POST /api/games か PATCH /api/games/:id にファイルの名前と大きさだけを送り、返ってきた mediaUploads の url へ画像そのものを PUT します。確定の呼び出しはありません。

SIZE=$(wc -c < thumb.png)
curl -X PATCH "https://gamerush.jp/api/games/$GAME_ID" \
  -H "Authorization: Bearer $GRUSH_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"thumbnail\":{\"fileName\":\"thumb.png\",\"size\":$SIZE,\"contentType\":\"image/png\"}}" \
  > patch.json

UPLOAD_URL=$(jq -r '.mediaUploads[] | select(.kind == "thumbnail") | .url' patch.json)
curl -X PUT "$UPLOAD_URL" --data-binary @thumb.png

• 各フィールドは { fileName, size, contentType } です。形式は fileName の拡張子で決まります。
• url の期限は 1 時間です。切れたら同じ PATCH をやり直して新しい url を取ります。
• ゲームのサムネイルの URL は PATCH の時点で新しいものへ切り替わります。PUT を終えるまでは画像が出ないので、続けて上げてください。

ビルドは3段で上げます。権限はどれも builds:write です。Unity なら Editor 拡張 が同じ手順を持っているので、自分で書く必要はありません。

{
  "engine": "godot",
  "files": [
    { "path": "index.html", "size": 5120 },
    { "path": "index.js", "size": 301224 },
    { "path": "index.wasm", "size": 35651584 },
    { "path": "index.pck", "size": 2097152 }
  ]
}

curl -X POST "https://gamerush.jp/api/games/$GAME_ID/builds" \
  -H "Authorization: Bearer $GRUSH_TOKEN" \
  -H "Content-Type: application/json" \
  -d @manifest.json > build.json

jq -c '.uploadUrls[]' build.json | while read -r ticket; do
  path=$(echo "$ticket" | jq -r '.path')
  url=$(echo "$ticket" | jq -r '.url')
  curl -X PUT "$url" -H "If-None-Match: *" --data-binary @"build/$path"
done

BUILD_ID=$(jq -r '.build.id' build.json)
curl -X POST "https://gamerush.jp/api/builds/$BUILD_ID/complete" \
  -H "Authorization: Bearer $GRUSH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

ゲームから投稿するランキングの枠を宣言します。ゲーム側からの投稿と取得は SDK の役目で、ここにあるのは作者の手元から枠を管理する API です（SDK ガイドのランキング）。

1ゲームあたり 20 枠までです。投稿が1件でもある枠では sort / valueType / aggregation / period を変えられません（409）。コマンドの例と注意は SDK ガイドの API トークン にあります。

GET /api/analytics/games/:id で、Studio のアナリティクス画面と同じ数字をゲーム1本ぶん取れます。権限は analytics:read です。

curl "https://gamerush.jp/api/analytics/games/$GAME_ID?period=7d" \
  -H "Authorization: Bearer $GRUSH_TOKEN"

period は 24h / 7d / 28d（既定）/ 90d / all です。

有効プレイは、遊び始めてから 10 秒を超えたプレイだけを数えます。ロード時間の数字は ゲームの最適化ガイド の効き目を確かめるのに使えます。

作者に Studio でトークンを発行して貼ってもらう代わりに、ブラウザで承認してもらって自分のツールがトークンを受け取る形も取れます（RFC 8252 のループバック + PKCE）。Unity の Editor 拡張はこの形です。

• ツールが手元で http://127.0.0.1:<port> の HTTP サーバを立て、code_verifier（43〜128 文字のランダムな文字列）を作る
• ブラウザで下の URL を開く。作者がログインして内容を確かめ、承認ボタンを押す
• ブラウザが redirect_uri?code=…&state=… へ戻ってくる。state が送ったものと同じか確かめる
• exchange に code と code_verifier を送り、トークンを受け取る

https://gamerush.jp/studio/authorize
  ?redirect_uri=http://127.0.0.1:53682
  &code_challenge=<base64url(sha256(code_verifier))>
  &code_challenge_method=S256
  &client_name=My%20Build%20Tool
  &scopes=games:read,builds:write
  &state=<ランダムな値>

curl -X POST "https://gamerush.jp/api/api-token-authorizations/exchange" \
  -H "Content-Type: application/json" \
  -d '{"code":"<戻ってきた code>","codeVerifier":"<code_verifier>","redirectUri":"http://127.0.0.1:53682"}'

• redirect_uri は http://127.0.0.1:<port> / http://localhost:<port> / http://[::1]:<port> だけです。クエリもフラグメントも付けられません。
• code_challenge_method は S256 だけです。
• scopes はカンマ区切りです。game_ids にゲーム ID をカンマ区切りで渡すと、トークンの対象をそのゲームに絞れます。games:create とは一緒に使えません。
• code はワンタイムで 5 分です。code_verifier を間違えたときは承認からやり直してください。
• 応答は { token, secret } で、secret がトークンの本体です。有効期限は 90 日です。有効なトークンが 20 本あると 409 になります。
• client_name は承認画面と Studio のトークン一覧に出ます。