サポートお知らせリストの照会

Prev Next

Classic/VPC環境で利用できます。

サポート画面のお知らせリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /v2/stories/{boardId}

リクエストヘッダ

GAMEPOT 3.0 APIで共通して使用されるヘッダの詳細は、GAMEPOT 3.0のリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
boardId String Required ボード ID
  • cs_notice (有効値)

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
filter String Required 絞り込みの条件
  • レスポンスボディの一部のフィールドで絞り込み
  • 完全一致する値のみ絞り込み
  • 条件がない場合、空の値{}を入力
  • <例> {"author_id":"{作成者 ID}"}、{"id":"{お知らせ ID}"}、{"required":false}
sort String Optional ソートの基準
  • {基準:方式}形式で入力
    • 基準: レスポンスボディの Stringタイプフィールド
    • 方式: -1 | 1
      • -1: 降順
      • 1: 昇順
  • <例> {"createdAt":"-1"}: 作成日時基準の降順
option String Optional 追加オプション: Option
  • <例> {"offset":0,"per_page":20}: 最初の項目から20個表示

Option

Optionの説明は次の通りです。

フィールド タイプ 必須の有無 説明
offset Integer Optional 照会開始オフセット
  • 0~N
per_page Integer Optional ページごとの項目数
  • 1~100

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://dashboard-api.gamepot.ntruss.com/v2/stories/cs_notice?filter=%7B%22required%22%3Afalse%7D&sort=%7B%22createdAt%22%3A%20%22-1%22%7D&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
totalCount Integer - レスポンス総数
stories Array - お知らせリスト: stories

stories

storiesの説明は次の通りです。

フィールド タイプ 必須の有無 説明
required Boolean - 必須かどうか
  • true | false
    • true: 必須
    • false: 必須ではない
hit Integer - 閲覧数
_id String - オブジェクト ID
title Array - お知らせの件名: title
category_id String - ボード ID
status Integer - お知らせを使用中か
  • 1 | 0
    • 1: 使用中
    • 0: 使用しない
text Array - お知らせ内容: text
project_id String - プロジェクト ID
author_id String - 作成者 ID
id String - お知らせ ID
createdAt String - お知らせ作成日時
  • ISO 8601形式
updatedAt String - お知らせ更新日時
  • ISO 8601形式
__v Integer - バージョンキー
参考

_id、__vは、レスポンス結果に表示される場合がありますが、サービス使用に影響を与えないフィールドです。

title

titleの説明は次の通りです。

フィールド タイプ 必須の有無 説明
lang String - 言語コード
value String - お知らせの件名
default Boolean - デフォルト言語かどうか
  • true | false
    • true: デフォルト言語
    • false: デフォルト言語ではない

text

textの説明は次の通りです。

フィールド タイプ 必須の有無 説明
lang String - 言語コード
value String - お知らせ内容
default Boolean - デフォルト言語かどうか
  • true | false
    • true: デフォルト言語
    • false: デフォルト言語ではない

レスポンスステータスコード

GAMEPOT 3.0 APIで共通して使用されるレスポンスステータスコードの詳細は、GAMEPOT 3.0のレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "totalCount": 2,
  "stories": [
    {
      "required": false,
      "hit": 0,
      "_id": "68d5d78991f09a68dbbf908a",
      "title": [
        {
          "lang": "ko",
          "value": "[テストのお知らせ] サポートページのお知らせ機能の確認",
          "default": true
        }
      ],
      "category_id": "cs_notice",
      "status": 1,
      "text": [
        {
          "lang": "ko",
          "value": "<p data-start=\"141\" data-end=\"239\"><span style=\"color: rgb(185, 106, 217);\">この記事は、<strong data-start=\"146\" data-end=\"159\">内部 QAテスト</strong>のために登録された投稿です。</span><br data-start=\"175\" data-end=\"178\"><span style=\"color: rgb(185, 106, 217);\">実際のサービスのお知らせとは無関係で、お知らせの登録&middot;照会&middot;削除機能が正常に動作しているか確認することを目的とします。</span></p>\n<p data-start=\"241\" data-end=\"249\"><span style=\"color: rgb(185, 106, 217);\">よろしくお願いします。</span></p>",
          "default": true
        }
      ],
      "project_id": "fccec9bc-****-****-****-d2df78e0d987",
      "author_id": "b2dfa23b-****-****-****-0f392a4175fb",
      "id": "a5500dbf-****-****-****-eb2329918aa5",
      "createdAt": "2025-09-26T00:00:09.954Z",
      "updatedAt": "2025-09-26T00:00:09.954Z",
      "__v": 0
    },
    {
      "required": false,
      "hit": 0,
      "_id": "68d096fdc9abf71dd89dacac",
      "title": [
        {
          "lang": "ko",
          "value": "Announcement",
          "default": true
        },
        {
          "lang": "en",
          "value": "Announcement",
          "default": false
        }
      ],
      "category_id": "cs_notice",
      "status": 1,
      "text": [
        {
          "lang": "ko",
          "value": "<p>Dear users,</p>\n<p>&nbsp;</p>\n<p>Hi. This is the announcement.</p>\n<p>&nbsp;</p>\n<p>Thank you.</p>",
          "default": true
        },
        {
          "lang": "en",
          "value": "<p>Dear User,</p>\n<p>&nbsp;</p>\n<p>Hello. This article is about the announcement.</p>\n<p>&nbsp;</p>\n<p>Thank you.</p>",
          "default": false
        }
      ],
      "project_id": "fccec9bc-****-****-****-d2df78e0d987",
      "author_id": "b2dfa23b-****-****-****-0f392a4175fb",
      "id": "e5d72544-****-****-****-b9cbbfd0859b",
      "createdAt": "2025-09-22T00:23:25.230Z",
      "updatedAt": "2025-09-26T00:05:32.708Z",
      "__v": 0
    }
  ]
}