お知らせリストの照会

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

お知らせリストを照会します。

リクエスト

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

メソッド	URI
GET	/v2/notices

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`filter`	String	Required	絞り込みの条件レスポンスボディの一部のフィールドで絞り込み完全一致する値のみ絞り込み条件がない場合、空の値`{}`を入力 <例> `{"country":"{国コード}"}`、`{"type":"{タスクのタイプ}"}`、`{"enable":true}`
`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/notices?filter=%7B%22enable%22%3Atrue%7D&sort=%7B%22createdAt%22%3A%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	-	レスポンス総数
`notices`	Array	-	お知らせリスト: notices

`notices`

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

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

レスポンス例

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

{
  "totalCount": 1,
  "notices": [
    {
      "country": "",
      "image": [
        {
          "lang": "ko",
          "value": "/notices/fcf67443-****-****-****-2f10a3bf9021.png",
          "default": true
        }
      ],
      "urlArr": [
        {
          "lang": "ko",
          "default": true
        }
      ],
      "schemeArr": null,
      "_id": "68cb9b7e**********4cefd5",
      "enable": true,
      "type": "url",
      "startDate": "2025-09-18T15:00:00.000Z",
      "endDate": "2025-09-19T14:59:00.000Z",
      "sort": 758174078100,
      "url": null,
      "scheme": null,
      "project_id": "fccec9bc-****-****-****-d2df78e0d987",
      "store_id": "",
      "id": "df1e517d-****-****-****-d93ee4cfd453",
      "createdAt": "2025-09-18T05:41:18.120Z",
      "updatedAt": "2025-09-22T05:25:02.723Z",
      "__v": 0
    }
  ]
}