APIでの利用方法

ギフト

編集

目次

APIでの利用方法

ギフト投稿画面表示

メソッドwindow.RPGAtsumaru.gift.displayCatalogModal()
説明ギフトの一覧を表示し、投稿を促す画面を表示できます。プレイヤー本人がギフトボタン（プレゼントボックスのアイコン）を押したときと同じ動作をします。
引数なし
戻り値なし

ギフト累計ポイント取得

メソッドwindow.RPGAtsumaru.gift.getTotalPoints()
説明このゲームに対して、すべてのユーザーが合計何ポイントギフトしたかを取得できます
引数なし
戻り値Promise<number>
制限このAPIはAPIの呼び出し回数制限の対象です

戻り値の例

// window.RPGAtsumaru.gift.getTotalPoints().then(function(v) { console.log(v) }) を実行
100000

起こりうるエラーの種類

名前説明
INTERNAL_SERVER_ERRORゲームアツマールのサービス側で何らかの問題が発生しているか、または通信に失敗した
API_CALL_LIMIT_EXCEEDED短時間にアツマールAPIを利用しすぎて、一時的に利用を制限されている

ギフト自己ポイント取得

メソッドwindow.RPGAtsumaru.gift.getMyPoints()
説明このゲームに対して、プレイヤー本人が各ギフトごとに合計何ポイントギフトしたかを取得できます
引数なし
戻り値Promise<GiftMyPoints>
制限このAPIはAPIの呼び出し回数制限の対象です

戻り値の型 GiftMyPoints について

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

interface GiftMyPoints {
    [itemCode: string]: number;
}

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

プロパティ型内容
[itemCode: string]numberitemCode の種類のギフトに対して自分が合計何ポイントギフトしたか

戻り値の例

// window.RPGAtsumaru.gift.getMyPoints().then(function(v) { console.log(v) }) を実行
{
    "_og-flower": 3000,
    "_og-cake": 10000
}

起こりうるエラーの種類

名前説明
UNAUTHORIZEDプレイヤーがログインしていない
INTERNAL_SERVER_ERRORゲームアツマールのサービス側で何らかの問題が発生しているか、または通信に失敗した
API_CALL_LIMIT_EXCEEDED短時間にアツマールAPIを利用しすぎて、一時的に利用を制限されている

ギフト履歴取得

メソッドwindow.RPGAtsumaru.gift.getHistories()
説明このゲームに対しての有料ギフトの履歴を、最新のものから順に最大30件まで取得します。無料ギフトは含まれません
引数なし
戻り値Promise<GiftHistories>
制限このAPIはAPIの呼び出し回数制限の対象です

戻り値の型 GiftHistories について

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

type GiftHistories = {
    sceneName: string;
    context: string;
    userName: string;
    point: number;
    command: string;
    comment: string;
    reply: string;
    thanks: boolean;
    createdAt: number;
}[]

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

プロパティ型内容
(this)arrayギフト履歴
lengthnumber今回取得したギフト履歴の件数
[n].sceneNamestringn+1番目のギフトのシーン名（※コメントに準じます）
[n].contextstringn+1番目のギフトのコンテキスト（※コメントに準じます）
[n].userNamestringn+1番目のギフトのユーザー名
[n].pointnumbern+1番目のギフトのポイント
[n].commandstringn+1番目のギフトに添えられたコメントのコマンド
[n].commentstringn+1番目のギフトに添えられたコメントの内容
[n].replystringn+1番目のギフトへの作者からの返信
[n].thanksbooleann+1番目のギフトに作者からの感謝（ハートマーク）が送られているか
[n].createdAtnumbern+1番目のギフトの投稿時刻（unix time sec）

戻り値の例

// window.RPGAtsumaru.gift.getHistories().then(function(v) { console.log(v) }) を実行
[
    {
        sceneName: "__title",
        context: "v2/",
        userName: "アツマライオン",
        point: 1000,
        command: "red shita big",
        comment: "ゲーム開発、がんばライオン！",
        reply: "ありがライオン！！！！！",
        thanks: true,
        createdAt: 1534567890,
    },
    {
        sceneName: "map1",
        context: "v2/MapEvent1/page1/%E3%81%93%E3%81%AF",
        userName: "ゲームアツマール開発チーム",
        point: 10000,
        command: "",
        comment: "",
        reply: "",
        thanks: false,
        createdAt: 1534517890,
    }
]

起こりうるエラーの種類

名前説明
INTERNAL_SERVER_ERRORゲームアツマールのサービス側で何らかの問題が発生しているか、または通信に失敗した
API_CALL_LIMIT_EXCEEDED短時間にアツマールAPIを利用しすぎて、一時的に利用を制限されている

ギフトランキング取得

メソッドwindow.RPGAtsumaru.gift.getRanking()
説明このゲームに対してのギフトランキングを、最大5件まで取得します。
引数なし
戻り値Promise<GiftRanking>
制限このAPIはAPIの呼び出し回数制限の対象です

戻り値の型 GiftRanking について

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

type GiftRanking = {
    userName: string;
    point: number;
}[]

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

プロパティ型内容
(this)arrayギフトランキング
lengthnumberギフトランキングの件数（※必ず5件まで。同着の場合5位までは入り切らないことも）
[n].userNamestringn+1番目のランキングのユーザー名
[n].pointnumbern+1番目のランキングのポイント

戻り値の例

// window.RPGAtsumaru.gift.getRanking().then(function(v) { console.log(v) }) を実行
[
    {
        userName: "ゲームアツマール開発チーム",
        point: 30000
    },
    {
        userName: "アツマライオン",
        point: 3000
    }
]

起こりうるエラーの種類

名前説明
INTERNAL_SERVER_ERRORゲームアツマールのサービス側で何らかの問題が発生しているか、または通信に失敗した
API_CALL_LIMIT_EXCEEDED短時間にアツマールAPIを利用しすぎて、一時的に利用を制限されている

表示ギフト取得

画面上にギフトが流れたときにそのギフトの情報を取得するには、コメントAPIの表示コメント取得をご利用ください。

投稿ギフト取得

ゲームをプレイしているユーザー本人がギフトを投稿したときにそのギフトの情報を取得するには、コメントAPIの投稿コメント取得をご利用ください。

関連ドキュメント

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

最終更新日

  • 2020/11/25