サポートお知らせの照会

Prev Next

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

サポート画面のお知らせの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /v2/story/{boardId}/{storyId}

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://dashboard-api.gamepot.ntruss.com/v2/story/cs_notice/e5d72544-****-****-****-b9cbbfd0859b' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
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のレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "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
}