お知らせの照会

Prev Next

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

お知らせの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /v2/notice/{noticeId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
noticeId String Required お知らせ ID

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
country String - 国コード
image Array - お知らせ画像リスト: image
urlArr Array - URLリスト: urlArr
schemeArr Array - スキームリスト: schemeArr
_id String - オブジェクト ID
enable Boolean - 使用するかどうか
  • true | false
    • true: 掲載可能または掲載中
    • false: 掲載不可
type String - タスクのタイプ
  • url | scheme
    • url: URL移動
    • scheme: スキーム実行
startDate String - お知らせ開始日時
  • ISO 8601形式(UTCを使用)
endDate String - お知らせ終了日時
  • ISO 8601形式(UTCを使用)
sort Integer - お知らせソート基準
url String - URL情報
scheme String - スキーム情報
project_id String - プロジェクト ID
store_id String - ストア ID
  • google | one | apple | galaxy | huawei | amazon | nowgg | pc | steam
  • 空の値の場合、すべてのストアに適用
id String - お知らせ ID
createdAt String - お知らせ作成日時
  • ISO 8601形式(UTCを使用)
updatedAt String - お知らせ更新日時
  • ISO 8601形式(UTCを使用)
__v Integer - バージョンキー
参考

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

image

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

フィールド タイプ 必須の有無 説明
lang String - 言語コード
value String - リソースアドレス(Base URL以下)
default Boolean - デフォルト言語かどうか
  • true | false
    • true: デフォルト言語
    • false: デフォルト言語ではない

urlArr

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

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

schemeArr

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

フィールド タイプ 必須の有無 説明
lang String - 言語コード
value String - スキーム情報
default Boolean - デフォルト言語かどうか
  • true | false
    • true: デフォルト言語
    • false: デフォルト言語ではない

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

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

レスポンス例

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

{
  "country": "",
  "image": [
    {
      "lang": "ko",
      "value": "/notices/fcf67443-****-****-****-2f10a3bf9021.png",
      "default": true
    }
  ],
  "urlArr": [
    {
      "lang": "ko",
      "value": "https://www.naver.com",
      "default": true
    }
  ],
  "schemeArr": null,
  "_id": "68cb9b************4cefd5",
  "enable": true,
  "type": "url",
  "startDate": "2025-09-23T15:00:00.000Z",
  "endDate": "2025-09-30T14:59:00.000Z",
  "sort": 758174077900,
  "url": null,
  "scheme": null,
  "project_id": "fccec9bc-****-****-****-d2df78e0d987",
  "store_id": "pc",
  "id": "df1e517d-****-****-****-d93ee4cfd453",
  "createdAt": "2025-09-18T05:41:18.120Z",
  "updatedAt": "2025-09-22T07:27:51.800Z",
  "__v": 0
}