コンテンツにスキップ

メンション

この機能を使用すると、チャンネルメッセージ内で特定のユーザーに言及し、通知を送信することができます。

「メンション」機能の操作は以下の通りです:

  • メンション機能専用の独立したAPIは存在せず、代わりにメンション情報は既存のAPIのレスポンスデータに含まれています。
  • メンションされたユーザーには別のプッシュ通知(リモートプッシュ、SDKが必要)が送信されます。

メンション情報を含むAPIレスポンス

このセクションでは、チャンネルメッセージ履歴APIの応答に含まれるメンション情報について説明します。

レスポンスボディ > データ > コンテンツ > プラグインデータ

チャネルメッセージにメンション情報が含まれている場合、mentionsフィールドは**data > content > pluginData**に含まれます。チャネルメッセージ履歴APIレスポンスボディの中に。

フィールド 説明 タイプ
mentions メンション情報 オブジェクト配列

レスポンスボディ > データ > コンテンツ > プラグインデータ > メンション

フィールド 説明 タイプ
playerId 言及されたユーザーのプレイヤーID long

レスポンスサンプル

{
  // ...omitted
        "content": [
            {
                "gameIndex": 1374,
                "from": 1,
                "messageId": "ggJ5Csh15J-mI3i5",
                "extraData": "",
                "pluginData": {
                    "mentions": [
                        {
                            "playerId": 101
                        }
                    ]
                },
                "to": "public:10",
                "message": "aaa",
                "langCode": "ko",
                "timestamp": "2025-07-17T00:56:17.156Z",
                "timestampMillis": 1752713777156
            }
        ]
  // ...omitted
}