プッシュ通知の送信

Prev Next

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

指定したスケジュールに従って、希望するユーザーに多言語プッシュ通知メッセージを送信します。即時送信と予約送信を両方サポートします。

リクエスト

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

メソッド URI
POST /v2/notifications/push

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
scheduleCode String Required スケジュールコード
scheduleDesc String Required スケジュールの説明
scheduleTimeZone String Required スケジュールのタイムゾーン
scheduleTime String Required 送信日時
  • <例> 2025-09-24T00:00:00.170Z
startDate String Optional スケジュール開始日時
  • yyyy-MM-dd HH:mm形式
endDate String Optional スケジュール終了日時
  • yyyy-MM-dd HH:mm形式
messageType String Required メッセージタイプ
  • AD (有効値)
title Object Required プッシュ通知タイトル情報
title.content String Required 基本タイトル
title.i18n Object Required 多言語タイトル情報
title.i18n.default Object Required デフォルト言語タイトル情報
title.i18n.default.content String Required デフォルト言語タイトル
title.i18n.[language] Object Optional 多言語タイトル情報
  • 対応言語: en | ja | zh-Hans | zh-Hant | ko
title.i18n.[language].content String Optional 多言語タイトル
message Object Required プッシュメッセージ情報
message.content String Required 基本メッセージ
message.custom Object Optional ユーザー定義データ
  • "key": "value"形式
message.option Object Optional メッセージオプション
message.i18n Object Required 多言語メッセージ情報
message.i18n.default Object Required デフォルト言語メッセージ情報
message.i18n.default.content String Required デフォルト言語メッセージ
message.i18n.[language] Object Optional 多言語メッセージ情報
  • 対応言語: en | ja | zh-Hans | zh-Hant | ko
message.i18n.[language].content String Optional 多言語メッセージ
dayOfWeeks Array Required スケジュール曜日リスト
deviceType String Required デバイスタイプ
  • ALL | USER
    • ALL: すべて
    • USER: 特定のユーザー
to Array Optional 受信者 IDリスト
  • 各受信者 IDは、GAMEPOT 3.0ダッシュボードの ユーザー > リスト を参照
type String Required プッシュ通知受信対象
  • ALL | USER
    • ALL: すべて
    • USER: 特定のユーザー
country Array Optional 国コードリスト

リクエスト例

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

curl --location --request POST 'https://dashboard-api.gamepot.ntruss.com/v2/notifications/push' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "scheduleCode": "code1234",
    "scheduleDesc": "description",
    "scheduleTimeZone": "Asia/Seoul",
    "scheduleTime": "2025-09-24T00:00:00.170Z",
    "messageType": "AD",
    "title": {
      "content": "件名",
      "i18n": {
        "default": {
          "content": "件名"
        },
        "en": {
          "content": "Title"
        },
        "ko": {
          "content": "제목"
        }
      }
    },
    "message": {
      "content": "メッセージ",
      "custom": {},
      "option": {},
      "i18n": {
        "default": {
          "content": "メッセージ"
        },
        "en": {
          "content": "message"
        },
        "ko": {
          "content": "메시지"
        }
      }
    },
    "dayOfWeeks": [],
    "deviceType": "ALL",
    "to": [],
    "type": "ALL",
    "country": []
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
status Integer - レスポンスコード
message Object - プッシュ通知送信情報
message.status Boolean - プッシュ通知送信は成功したか
  • true | false
    • true: 成功
    • false: 失敗
message.id String - プッシュ通知送信リクエスト ID

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

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

レスポンス例

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

{
  "status": 1,
  "message": {
    "status": true,
    "id": "521f5bcc-****-****-****-ff89474822ed"
  }
}