リーダーボード機能の使い方
はじめに
リーダーボード機能とは、獲得スコア、クリアタイム、プレイ回数等を競い合う為のスコアランキング機能です。アプリケーション管理の「アプリケーション詳細」より「モバイル」タブ、「PC」タブ、「SPWeb」タブ、「Android」タブ、「iOS」タブのいずれかを登録することで、下図左下のようなリーダーボード設定へのリンクが表示されますので、こちらをクリックします。
リーダーボードの設定
リーダーボードを使用するためには、一つ以上のリーダーボードを設定しなければなりません。リーダーボードは1アプリケーションにつき、5つまで設定できます。「リーダーボードの追加」ボタンをクリックして、リーダーボードを追加します。
リーダーボード設定画面では、下図のような画面が表示されます。
各項目について設定していきます。
- アイコン(オプション)
- 320x320pxの画像ファイルをアップロードできます。アップロードできる画像ファイルの形式は、JPG, PNG, GIF です。アップロードした画像のURLはリーダーボード API から取得することができます。API で取得した画像の掲載場所、利用方法は任意となります。
- 識別子(必須)
- リーダーボードを特定する識別子です。リーダーボード API に渡す LeaderboardId として使用します。この識別子は一度設定すると変更することはできませんのでご注意ください。
- タイトル(必須)
- 全角 128 文字以内で入力してください。リーダーボード API で取得することができます。
- デフォルトスコア(オプション)
- スコア値を指定しないでユーザーのスコアを追加/更新した場合のデフォルト値を指定します。
- 負の数、小数も入力することができます。指数表記も使用できますが、小文字の「e」を使用して下さい。
- フォーマット(必須)
- 使用するフォーマット形式を指定します。リーダーボード API では指定された形式に合わせた数値形式で取得することができます。
- フォーマット桁数(オプション)
- 上記フォーマットにおける小数点以下の桁数を設定できます。フォーマットに「0を含む自然数」が指定された場合には、この設定は無視されます。
- スコア上書き設定(オプション)
- ハイスコアで無い場合でもスコアを上書きするかのオプションです。
- 「常に上書きする」にチェックを入れた場合には、既存のスコアよりもハイスコアで無い場合でも上書きします。
- 「常に上書きする」にチェックを入れない場合には、既存のスコアよりもハイスコアだった場合のみ上書きします。
- ハイスコアで無い場合でもスコアを上書きするかのオプションです。
- ソート設定
- スコア値の降順/昇順が指定できます。デフォルトは降順です。
- 同点順位設定
- スコアが同点だった時の順位を同じ順位とするかどうかを設定します。
- 「同スコアを同じ順位として扱う」にチェックをいれると同スコアのユーザー全てが同じ順位となります。
- 「同スコアを同じ順位として扱う」にチェックをいれない場合には、同スコアの場合においても、異なる順位付けがされるようになります。
- デフォルトはチェックが入った状態です。
- スコアが同点だった時の順位を同じ順位とするかどうかを設定します。
- 負のスコア設定
- スコアの値が負の値になることを許可・制限することができます。
- 「負のスコアを許可する」にチェックを入れた場合には、スコアの更新が負のスコアまで更新可能になります。
- 「負のスコアを許可する」にチェックを入れない場合には、負のスコアでの更新が制限されます。
- 負のスコアでの更新が制限されている場合に、負のスコアでの更新を行おうとすると 409 conflict が返却されます。また、decrement で減算を行う場合に 0 を超えて負のスコアになってしまう場合は、負のスコアにはならずに 0 となります。
- デフォルトはチェックが入った状態です。
上記の項目を設定後、識別子を leaderboardId としたリーダーボード API が使用可能になります。
- スコアの値が負の値になることを許可・制限することができます。
リーダーボード設定が終了すると、リーダーボード API が Sandbox 環境で使用可能になります。リーダーボード API には Client API と RESTful API があります。リーダーボード API は以下の機能を実現します。
- リーダーボード情報の取得
- 複数のリーダーボード情報の取得
- 全てのリーダーボード情報の取得
- トップスコアリストの取得
- フレンドスコアリストの取得
- 指定ユーザーのスコアの取得
- カレントユーザーのスコアの追加/更新
- カレントユーザーのスコアの削除
詳しくは参考資料にあるAPIリファレンスを参照してください。
本番環境でリーダーボードを使用するには
本番環境で、リーダーボードを使用するためには、以下の図のリーダーボード一覧の「サービス」列が「有効」になっている必要があります。「サービス」列を「有効」の状態にするためには「識別子」列の対象のリーダーボードをクリックします。

クリックすると、以下の画面の最下部に「サービス環境で有効にする」ボタンがありますので、クリックすることで「有効」にできます。

参考資料
-
RESTful API に関しまして、こちらをご参照下さい。
-
Native / Unity SDK の Client API の詳細につきましては、SDK に同梱されている API ガイドをご確認下さい。( /android/docs/javadoc , /ios/docs/headerdoc )
更新履歴
- 2012/09/26
- 同点順位設定と負のスコア設定の説明を追記
- 2012/07/06
- Native / Unity SDK の参考資料を追記
- 2012/05/28
- 「本番環境でリーダーボードを使用するには」を追記
- 2012/04/09
- 新規作成