コンテンツにスキップ
Game Market Copilot Docs
日本語
English日本語
Esc
↑↓navigate↵open⌘Jpreview
このページの内容

APIエンドポイント

GMC REST APIのエンドポイント分類と、正確なパラメーターやフィールドを確認するための正本OpenAPI契約へのリンクです。

このページは/api/v1以下で利用できるエンドポイント分類の見取り図です。何が 存在し、どこを見ればよいかを示すガイドであり、パラメーターのリファレンスで はありません。正確なリクエストパラメーター、フィールドの形、enum値について は、各セクションの末尾および/api/overviewにある契約のソ ースを参照してください。

以下のすべてのエンドポイントは、/api/overviewで説明して いるレスポンスエンベロープ、エラーコード、クレジット・レート制限の挙動を共 有しています。

ゲームとSteamカタログ

Steamカタログの検索、件数の取得、グループ化された集計、IDによる単一タイトル の取得、名前によるタイトル解決、タイトル単位のレビュー・マーケティング分析 の取得ができます。

  • カタログの検索・件数取得・集計(発売年、価格帯、タグなどで件数やレビュー 中央値をグループ化した指標を算出)。
  • タイトル単位の詳細取得、複数タイトルの一括取得、名前からIDへの解決。
  • タイトル単位のレビュートピック、レビュー主張、より深い分析セクション、 サクセスレポートの要約。

検索・件数取得・集計はtagsフィルターを受け付けます。未知のタグスラッグを 指定するとINVALID_TAGが返るため、事前にタグカタログでタグを解決してくだ さい。タイトル単位の分析とサクセスレポートの呼び出しは、1タイトル分のレビ ューとマーケティングデータを統合するため、/api/overview で説明している上位のコストクラスに該当します。カタログの検索・件数取得・詳 細取得はベースラインかその近辺です。

ショーケース

ショーケースカタログを検索し、あるタイトルが今後のショーケースの募集期間に どれだけ合致するかを、締切を踏まえたフィルタリングで確認できます。

ゲームリスト

ワークスペースのゲームリストを作成・取得・更新・削除し、リスト内のゲームを 管理できます。後のコホート分析や比較のために保存しておきたいタイトル集合を 構築するために使われ、ダッシュボードとエージェントのどちらからも操作できま す。

保存済みフィルター

カタログ検索の条件(タグ、レビュー・評価・価格の範囲、並び順)を名前付きフィ ルターとして保存・再利用できます。これにより、呼び出しのたびに検索条件を組 み立て直す必要がなくなります。

タグ

タグタクソノミーを参照できます。既知のタグを一覧取得するか、自由入力の語句 で検索します。タグでフィルタリングするすべてのエンドポイントが有効なスラッ グの解決をこれに依存しているため、課金対象外で、有料プランがなくても利用で きます。

アカウント・ステータス・利用状況

ワークスペースのステータスとエンタイトルメントを確認し、APIキーとCLI認証情 報の利用状況(呼び出しごとのクレジット消費の推移を含む)を確認できます。大量 の呼び出しをまとめて実行する前に、これらのエンドポイント(または/cli にある同等のCLIコマンド)を使って、有効なプランと月間クレジット枠の残量を確 認してください。

ヘルスチェックとスキーマ

  • ヘルスチェック: 認証不要の最小限のliveness確認エンドポイントです。
  • スキーマ: 現在のAPI・CLIの機能を機械可読な形でまとめたカタログで、エージ ェントがコマンド一覧をハードコードせずに何を呼び出せるかを把握するのに役 立ちます。

このページの対象外

Copilotチャット、チャート生成、エクスポートはブラウザセッションの機能であ り、このベアラートークンAPI契約には含まれないため、上記には記載していませ ん。ベアラートークンのエンドポイントとブラウザセッション専用の機能の違いに ついては/api/overviewを参照してください。

契約のソース

これらの分類に対応するCLIコマンドについては/cliを、生のHTTPでは なくMCP経由でエージェントからアクセスする方法については /agents/mcpを参照してください。

このページは役に立ちましたか？