シングルプッシュ

前提条件¶

Single Push APIと同期するには、認証トークン（API KEY）を発行する必要があります。すでにキーを持っている場合は、追加の権限をリクエストしてください。認証トークンのリクエストと発行方法については、Hive Server API > Notification > Push v4 > Authenticationを参照してください。

環境別のアクセスURL¶

基本情報とリクエストパラメータ¶

お知らせアラートワークフロー¶

お知らせアラートは、それを受け取ることに同意したゲームアプリのユーザーにのみ送信されます。お知らせアラートが21:00~08:00の間に送信される場合、夜間アラートの追加の同意が必要です。

通知アラートワークフローの詳細は以下の通りです:

• ユーザーが通知アラートを受け取ることに同意しない場合、通知として設定されたすべてのメッセージは送信されません。
• 通知アラートを受け取ることに同意したユーザーのみが、夜間アラートの同意を与えることができます。

識別子の構造¶

識別子の例¶

    [
        {
            "playerId":51234,
            "did":1234
        }
    ]

メッセージ構造¶

オプション情報¶

ActionPayload¶

ActionPayloadは、シングルプッシュAPIの追加機能であるプッシュアクションボタンを使用する際に配信されるデータ形式です。

プッシュアクションボタンは、SDKで利用可能な通知機能であり、プッシュ通知を長押しするとシステムボタンとして表示されます。

プッシュアクションボタンの詳細については、以下のガイドを参照してください。

• SDK開発ガイド > プッシュアクションボタン
• Apple > プッシュ通知のユーザーアクション設定ガイド
• Android > FCMアクションボタンガイド

ActionPayload データ構造¶

シングルプッシュAPIをリクエストする際、ActionPayloadに含まれるデータは次のとおりです。

アクション¶

アクションは、ActionPayload内の各システムボタンのデータです。アクションに含まれるパラメータは以下の通りです。

出力 > 応答パラメータ構造¶

応答ステータスコード¶

例のコード¶

• リクエスト ("enableLocale":false)

    POST /push/send HTTP/1.1
      Host: sandbox-notification.qpyou.cn
      Content-Type: application/json
      Authorization: Bearer {API KEY}
      Content-Length: [自動計算]
  
  
    {
        "notice": false,
        "identifiers": [
            {
                "playerId": 200001358,
                "did": 300010915
            }
        ],
        "game": {
            "gameid": "com.com2us.hivesdk",
            "appids": [
                "com.com2us.hivesdk.normal.freefull.google.global.android.common",
                "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal"
            ]
        },
        "enableLocale": false,
        "payload": {
            "single": {
                "android": {
                    "title": "android title",
                    "message": "android message",
                    "messageExpanded": "",
                    "imageUrl": "",
                    "ticker": "",
                    "summaryText": ""
                },
                "ios": {
                    "title": "ios title",
                    "message": "ios message",
                    "mediaUrl": ""
                }
            },
            "option": {
                "badge": "1",
                "overwrite": false,
                "collapseKey": "",
                "engagement": "",
                "groupKey": "",
                "android": {
                    "icon": "",
                    "sound": "",
                    "priority": "normal"
                },
                "ios": {
                    "sound": ""
                }
            }
        },
        "actionInfo": {
            "android": {
                "actions": [
                    {
                        "titles": {
                            "default": "OK"
                        },
                        "actionType": "CURL",
                        "action": "https://examplecurl.com"
                    },
                    {
                        "titles": {
                            "default": "Cancel"
                        },
                        "actionType": "CLOSE",
                        "action": ""
                    }
                ]
            },
            "ios": {
                "category": "CONFIRM_CATEGORY",
                "actions": [
                    {
                        "actionId": "CONFIRM_ID",
                        "actionType": "CURL",
                        "action": "https://examplecurl.com"
                    },
                    {
                        "actionId": "CLOSE_ID",
                        "actionType": "CLOSE",
                        "action": ""
                    }
                ]
            }
        }
    }
  

• リクエスト ("enableLocale":true)

  POST /push/send HTTP/1.1
  Host: sandbox-notification.qpyou.cn
  Content-Type: application/json
  Authorization: Bearer {API KEY}
  Content-Length: [auto calculated]
  
  {
      "notice": false,
      "identifiers": [
          {
              "playerId": 200001358,
              "did": 300010915
          }
      ],
      "game": {
          "gameid": "com.com2us.hivesdk",
          "appids": [
              "com.com2us.hivesdk.normal.freefull.google.global.android.common",
              "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal"
          ]
      },
      "enableLocale": true,
      "payload": {
          "defaultLanguage": "en",
          "locale": {
              "ko": {
                  "android": {
                      "title": "テスト_韓国語のタイトル",
                      "message": "テスト_韓国語のメッセージ"
                  },
                  "ios": {
                      "title": "テスト_韓国語のタイトル",
                      "message": "テスト_韓国語のメッセージ"
                  }
              },
              "en": {
                  "android": {
                      "title": "test_English title",
                      "message": "test_English message"
                  },
                  "ios": {
                      "title": "test_English title",
                      "message": "test_English message"
                  }
              }
          },
          "option": {
              "badge": 1,
              "overwrite": true,
              "collapseKey": "99",
              "groupKey": "",
              "android": {
                  "icon": "GoogleIcon",
                  "sound": "GoogleSound",
                  "priority": "normal"
              },
              "ios": {
                  "sound": "AppleSound"
              }
          }
      },
      "actionInfo": {
          "android": {
              "actions": [
                  {
                      "titles": {
                          "default": "OK",
                          "en": "OK",
                          "ko": "확인"
                      },
                      "actionType": "CURL",
                      "action": "https://examplecurl.com"
                  },
                  {
                      "titles": {
                          "default": "Cancel",
                          "en": "Cancel",
                          "ko": "취소"
                      },
                      "actionType": "CLOSE",
                      "action": ""
                  }
              ]
          },
          "ios": {
              "category": "CONFIRM_CATEGORY",
              "actions": [
                  {
                      "actionId": "CONFIRM_ID",
                      "actionType": "CURL",
                      "action": "https://examplecurl.com"
                  },
                  {
                      "actionId": "CLOSE_ID",
                      "actionType": "CLOSE",
                      "action": ""
                  }
              ]
          }
      }
  }
  

• 応答

  HTTP/1.1 200 OK
  Content-length: 0
  Content-Type: application/json
  UUID: 3bc6b414-e2df-40d6-8006-9d2308a6edf9