APIでの利用方法

ニコニ広告情報取得

編集

目次

APIでの利用方法

ニコニ広告ポイント取得

メソッドwindow.RPGAtsumaru.nicoad.getPoints()
説明このゲームに対して、合計何ポイント広告されたかを取得できます
引数なし
戻り値Promise<NicoadPoints>
制限このAPIはAPIの呼び出し回数制限の対象です

戻り値の型 NicoadPoints について

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

interface NicoadPoints {
    activePoint: number;
    totalPoint: number;
}

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

プロパティ型内容
activePointnumberアクティブポイント：広告期間以内の広告の合計ポイント
totalPointnumberトータルポイント：広告期間が終了したものも含めたすべての広告の合計ポイント

戻り値の例

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

// window.RPGAtsumaru.nicoad.getPoints().then(function(v) { console.log(v) }) を実行
{
    activePoint: 3000,
    totalPoint: 10000
}

起こりうるエラーの種類

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

ニコニ広告履歴取得

メソッドwindow.RPGAtsumaru.nicoad.getHistories()
説明このゲームに対してのニコニ広告の履歴を、最新のものから順に最大30件まで取得します
引数なし
戻り値Promise<NicoadHistories>
制限このAPIはAPIの呼び出し回数制限の対象です

戻り値の型 NicoadHistories について

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

interface NicoadHistories {
    activePoint: number;
    remainingCount: number;
    serverTime: number;
    histories: {
        advertiserName: string;
        nicoadId: number;
        adPoint: number;
        contribution: number;
        startedAt: number;
        endedAt: number;
    }[];
}

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

プロパティ型内容
remainingCountnumber今回取得した広告履歴の他に、あと何件広告されたか
serverTimenumberサーバー時刻
historiesarray広告履歴
histories.lengthnumber今回取得した広告履歴の件数
histories[n].advertiserNamestringn+1番目の広告の広告者名
histories[n].nicoadIdnumbern+1番目の広告の広告ID
histories[n].adPointnumbern+1番目の広告のポイント
histories[n].contributionnumbern+1番目の広告の貢献度
histories[n].startedAtnumbern+1番目の広告の掲載開始時間
histories[n].endedAtnumbern+1番目の広告の掲載終了時間

戻り値の例

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

// window.RPGAtsumaru.nicoad.getHistories().then(function(v) { console.log(v) }) を実行
{
    remainingCount: 0,
    serverTime: 1534570000,
    histories: [
        {
        advertiserName: "アツマライオン",
        nicoadId: 1234567,
        adPoint: 1000,
        contribution: 3000,
        startedAt: 1534567890,
        endedAt: 1534654290,
    },
    {
        advertiserName: "ゲームアツマール開発チーム",
        nicoadId: 1234560,
        adPoint: 10000,
        contribution: 30000,
        startedAt: 1534517890,
        endedAt: 1534604290,
    }
    ]
}

起こりうるエラーの種類

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

ニコニ広告貢献度ランキング取得

メソッドwindow.RPGAtsumaru.nicoad.getRanking()
説明このゲームに対してのニコニ広告の貢献度ランキングを、最大30位まで取得します
引数なし
戻り値Promise<NicoadRanking>
制限このAPIはAPIの呼び出し回数制限の対象です

戻り値の型 NicoadRanking について

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

type NicoadRanking = {
    advertiserName: string;
    totalContribution: number;
    rank: number;
    }[]

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

プロパティ型内容
(this)array広告貢献度ランキング
lengthnumber広告貢献度ランキングの件数（※同着の場合両方含まれるため、31件以上の可能性あり）
[n].advertiserNamestringn+1番目のランキングの広告者名
[n].totalContributionnumbern+1番目のランキングの貢献度
[n].ranknumbern+1番目のランキングの順位

戻り値の例

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

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

起こりうるエラーの種類

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

関連ドキュメント

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

最終更新日

  • 2020/09/15