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
起こりうるエラーの種類
ギフト自己ポイント取得
メソッド | window.RPGAtsumaru.gift.getMyPoints() |
---|
説明 | このゲームに対して、プレイヤー本人が各ギフトごとに合計何ポイントギフトしたかを取得できます |
引数 | なし |
戻り値 | Promise<GiftMyPoints> |
制限 | このAPIはAPIの呼び出し回数制限の対象です |
戻り値の型 GiftMyPoints について
戻り値で取得できる GiftMyPoints
は以下のような型です。
interface GiftMyPoints {
[itemCode: string]: number;
}
プロパティの内容は次のようになっています。
プロパティ | 型 | 内容 |
---|
[itemCode: string] | number | itemCode の種類のギフトに対して自分が合計何ポイントギフトしたか |
戻り値の例
// window.RPGAtsumaru.gift.getMyPoints().then(function(v) { console.log(v) }) を実行
{
"_og-flower": 3000,
"_og-cake": 10000
}
起こりうるエラーの種類
ギフト履歴取得
メソッド | 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 | ギフト履歴 |
length | number | 今回取得したギフト履歴の件数 |
[n].sceneName | string | n+1番目のギフトのシーン名(※コメントに準じます) |
[n].context | string | n+1番目のギフトのコンテキスト(※コメントに準じます) |
[n].userName | string | n+1番目のギフトのユーザー名 |
[n].point | number | n+1番目のギフトのポイント |
[n].command | string | n+1番目のギフトに添えられたコメントのコマンド |
[n].comment | string | n+1番目のギフトに添えられたコメントの内容 |
[n].reply | string | n+1番目のギフトへの作者からの返信 |
[n].thanks | boolean | n+1番目のギフトに作者からの感謝(ハートマーク)が送られているか |
[n].createdAt | number | n+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: "RPGアツマール開発チーム",
point: 10000,
command: "",
comment: "",
reply: "",
thanks: false,
createdAt: 1534517890,
}
]
起こりうるエラーの種類
ギフトランキング取得
メソッド | window.RPGAtsumaru.gift.getRanking() |
---|
説明 | このゲームに対してのギフトランキングを、最大5件まで取得します。 |
引数 | なし |
戻り値 | Promise<GiftRanking> |
制限 | このAPIはAPIの呼び出し回数制限の対象です |
戻り値の型 GiftRanking について
戻り値で取得できる GiftRanking
は以下のような型です。
type GiftRanking = {
userName: string;
point: number;
}[]
プロパティの内容は次のようになっています。
プロパティ | 型 | 内容 |
---|
(this) | array | ギフトランキング |
length | number | ギフトランキングの件数(※必ず5件まで。同着の場合5位までは入り切らないことも) |
[n].userName | string | n+1番目のランキングのユーザー名 |
[n].point | number | n+1番目のランキングのポイント |
戻り値の例
// window.RPGAtsumaru.gift.getRanking().then(function(v) { console.log(v) }) を実行
[
{
userName: "RPGアツマール開発チーム",
point: 30000
},
{
userName: "アツマライオン",
point: 3000
}
]
起こりうるエラーの種類
表示ギフト取得
画面上にギフトが流れたときにそのギフトの情報を取得するには、コメントAPIの表示コメント取得をご利用ください。
投稿ギフト取得
ゲームをプレイしているユーザー本人がギフトを投稿したときにそのギフトの情報を取得するには、コメントAPIの投稿コメント取得をご利用ください。
関連ドキュメント
最終更新日