APIでの利用方法

ユーザー情報取得

編集

目次

APIでの利用方法

プレイヤー自身のユーザー情報を取得

  • 現在のユーザーの情報を取得します。
  • ユーザーがプレミアム会員かどうかも取得できます。
  • プレイしているユーザーがログインしている必要があります。ログインしてない場合にエラーを返すため、それでユーザーのログイン状態を判別することができます。
  • このAPIはAPIの呼び出し回数制限の対象です。
メソッドwindow.RPGAtsumaru.user.getSelfInformation()
引数なし
戻り値Promise<SelfInformation>

戻り値の型 SelfInformation について

戻り値で取得できる SelfInformation は以下のような型です。

interface SelfInformation {
    id: number;
    name: string;
    isPremium: boolean;
    profile: string;
    twitterId: string;
    url: string;
}

プロパティの内容は次のようになっています。

プロパティ内容
idnumberユーザーのニコニコユーザーID
namestringユーザーの名前
isPremiumbooleanユーザーがニコニコのプレミアム会員かどうか
profilestringユーザーのプロフィール文
twitterIdstringユーザーのtwitterId
urlstringユーザーのサイトURL

戻り値の例

// window.RPGAtsumaru.user.getSelfInformation().then(function(v) { console.log(v) }) を実行
{
    id: 64341294,
    name: "ゲームアツマール公式",
    profile: "やあ! 僕はアツマライオン!\nみんなでゲームを作って遊んで楽しもうよ!",
    twitterId: "nico_indiesgame",
    url: "https://game.nicovideo.jp/atsumaru/",
    isPremium: false
}

起こりうるエラーの種類

名前説明
UNAUTHORIZEDプレイヤーがログインしていない
INTERNAL_SERVER_ERRORゲームアツマールもしくはニコニ広告のサービス側で何らかの問題が発生しているか、または通信に失敗した(※ユーザーが広告ブロックしている場合も含む)
API_CALL_LIMIT_EXCEEDED短時間にアツマールAPIを利用しすぎて、一時的に利用を制限されている

ユーザーIDを指定して特定のユーザー情報を取得

メソッドwindow.RPGAtsumaru.user.getUserInformation(userId: number)
説明userId : ユーザー情報を取得したいユーザーのニコニコユーザーIDを自然数で指定します。
引数なし
戻り値Promise<UserInformation>

戻り値の型 UserInformation について

戻り値で取得できる UserInformation は以下のような型です。

interface UserInformation {
    id: number;
    name: string;
    profile: string;
    twitterId: string;
    url: string;
}

プロパティの内容は次のようになっています。

プロパティ内容
idnumberユーザーのニコニコユーザーID
namestringユーザーの名前
profilestringユーザーのプロフィール文
twitterIdstringユーザーのtwitterId
urlstringユーザーのサイトURL

戻り値の例

// window.RPGAtsumaru.user.getUserInformation(64341294).then(function(v) { console.log(v) }) を実行
{
    id: 64341294,
    name: "ゲームアツマール公式",
    profile: "やあ! 僕はアツマライオン!\nみんなでゲームを作って遊んで楽しもうよ!",
    twitterId: "nico_indiesgame",
    url: "https://game.nicovideo.jp/atsumaru/"
}

起こりうるエラーの種類

名前説明
FORBIDDENuserIdプレイヤー間通信の有効化を行っていないユーザーのIDを指定した
BAD_REQUEST引数として不正な値を指定している
INTERNAL_SERVER_ERRORゲームアツマールのサービス側で何らかの問題が発生しているか、または通信に失敗した
API_CALL_LIMIT_EXCEEDED短時間にアツマールAPIを利用しすぎて、一時的に利用を制限されている

現在のゲームを最近プレイしたユーザーの情報を取得

メソッドwindow.RPGAtsumaru.user.getRecentUsers()
引数なし
戻り値Promise<UserIdName[]>
制限このAPIはAPIの呼び出し回数制限の対象です

戻り値の型 UserIdName について

戻り値で取得できる UserIdName は以下のような型です。

interface UserIdName {
    id: number;
    name: string;
}

プロパティの内容は次のようになっています。

プロパティ内容
idnumberユーザーのニコニコユーザーID
namestringユーザーの名前

戻り値の例

// window.RPGAtsumaru.user.getRecentUsers().then(function(v) { console.log(v) }) を実行
[
        {
        id: 64341294,
        name: "ゲームアツマール公式"
        },
        {
        id: 63008093,
        name: "ツクール開発部公式"
    }
]

起こりうるエラーの種類

名前説明
INTERNAL_SERVER_ERRORゲームアツマールもしくはニコニ広告のサービス側で何らかの問題が発生しているか、または通信に失敗した(※ユーザーが広告ブロックしている場合も含む)
API_CALL_LIMIT_EXCEEDED短時間にアツマールAPIを利用しすぎて、一時的に利用を制限されている

オンライン人数を取得

  • 今から1~60分前までの間にこのゲームをプレイしたログインユーザーの人数を取得します。
  • このAPIはAPIの呼び出し回数制限の対象です。
メソッドwindow.RPGAtsumaru.user.getActiveUserCount(minutes: number)
引数minutes : 現在から何分前までのプレイ人数を取得するかを1~60までの整数で指定します。
戻り値Promise<number>

戻り値の例

// window.RPGAtsumaru.user.getActiveUserCount(1).then(function(v) { console.log(v) }) を実行
3

起こりうるエラーの種類

名前説明
BAD_REQUESTminutes に1~60までの整数以外を指定した
INTERNAL_SERVER_ERRORゲームアツマールもしくはニコニ広告のサービス側で何らかの問題が発生しているか、または通信に失敗した(※ユーザーが広告ブロックしている場合も含む)
API_CALL_LIMIT_EXCEEDED短時間にアツマールAPIを利用しすぎて、一時的に利用を制限されている

関連ドキュメント

ドキュメントリンク備考
機能解説ユーザー情報取得機能概要や全般的な解説
プラグインでの利用方法プラグインでの利用方法RPGツクールシリーズユーザー向け

最終更新日

  • 2020/02/28