Gs2RankingClient (Game Server Services GS2-Ranking SDK for Java 0.1.0 API)

java.lang.Object
- io.gs2.AbstractGs2Client<Gs2RankingClient>
- - io.gs2.ranking.Gs2RankingClient

public class Gs2RankingClient
extends AbstractGs2Client<Gs2RankingClient>

GS2-Ranking API クライアント

Author:: Game Server Services, Inc.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT
- Fields inherited from class io.gs2.AbstractGs2Client
  credential, region

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT`

Constructor Summary

Constructors
Constructor and Description

Gs2RankingClient(IGs2Credential credential)
コンストラクタ。

Constructors
Constructor and Description
`Gs2RankingClient(IGs2Credential credential)` コンストラクタ。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateGameModeResult`	`createGameMode(CreateGameModeRequest request)` ゲームモードを作成。ゲームモードを作成すると、ゲームモードの設定としてランキングが昇順なのか、降順なのかを設定できます。レースゲームのようなタイムの値が小さいほど上位のランキングの場合は昇順を、アクションゲームなどで、スコアの値が大きいほど上位のランキングの場合は降順を選択します。他に、集計間隔を15分以上、24時間以下で分単位で設定できます。ランキングを更新したい間隔に合わせて設定することになります。集計処理毎に費用が発生するため、高頻度であればあるほど利用料金は高くなります。
`CreateRankingTableResult`	`createRankingTable(CreateRankingTableRequest request)` ランキングテーブルを作成。 GS2-Ranking を利用するには、まずランキングテーブルを作成する必要があります。 1つのランキングテーブルには複数のゲームモードのランキングを格納することができます。
`void`	`deleteGameMode(DeleteGameModeRequest request)` ゲームモードを削除。
`void`	`deleteRankingTable(DeleteRankingTableRequest request)` ランキングテーブルを削除。
`DescribeGameModeResult`	`describeGameMode(DescribeGameModeRequest request)` ゲームモード一覧を取得。
`DescribeRankingTableResult`	`describeRankingTable(DescribeRankingTableRequest request)` ランキングテーブル一覧を取得。
`GetEstimateRankResult`	`getEstimateRank(GetEstimateRankRequest request)` スコアを指定しておおよその順位を取得。指定したスコアを取ったと仮定して何位ぐらいになれるのか、といった指標を計算する際に利用します。原則1000位単位でおおよその順位を応答します。上位プレイヤーに対しては1000位単位の解像度では情報が不足している場合があると思いますので、応答が上位プレイヤーだった場合は、更に `getRanking(GetRankingRequest)` で上位のスコアを取得してさらに詳細な順位に絞り込んで情報提供する。というのもユーザ体験をよく出来ると思います。
`GetGameModeResult`	`getGameMode(GetGameModeRequest request)` ゲームモードを取得。
`GetMyRankResult`	`getMyRank(GetMyRankRequest request)` 自分の順位を取得。自分の順位を取得できます、応答される値は集計時点での正確な値となります。 accessToken には `Gs2AuthClient.login(io.gs2.auth.control.LoginRequest)` でログインして取得したアクセストークンを指定してください。
`GetRankingResult`	`getRanking(GetRankingRequest request)` ランキングを取得。ランキングを取得します。ランキングにはユーザID、スコア、メタデータといった基本情報のほかに、インデックスと順位が付加されています。インデックスは先頭を1とした位置情報で、順位は同一スコアのユーザを同一順位として計算された値です。ランキングの性質上、同一スコアでも別順位として扱いたい場合は順位の代わりにインデックスを利用することで実現できます。ランキングデータはランダムアクセスができますので、`getMyRank(GetMyRankRequest)` で自分の順位を取得して、その前後のランキンデータを取得する。というような処理も実現できます。
`GetRankingTableResult`	`getRankingTable(GetRankingTableRequest request)` ランキングテーブルを取得。
`PutScoreResult`	`putScore(PutScoreRequest request)` スコアを登録。スコアの登録は一時的にバッファリングされ、定期的にランキングデータとして書き込まれます。そのため、スコア登録直後にランキング集計が開始された場合は、集計結果に含まれない可能性があります。 accessToken には `Gs2AuthClient.login(io.gs2.auth.control.LoginRequest)` でログインして取得したアクセストークンを指定してください。
`UpdateGameModeResult`	`updateGameMode(UpdateGameModeRequest request)` ゲームモードを更新。
`UpdateRankingTableResult`	`updateRankingTable(UpdateRankingTableRequest request)` ランキングテーブルを更新。

Methods inherited from class io.gs2.AbstractGs2Client
createHttpDelete, createHttpGet, createHttpPost, createHttpPut, doRequest, getRegion, setRegion, withRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENDPOINT
```
public static String ENDPOINT
```
- Constructor Detail
  - Gs2RankingClient
```
public Gs2RankingClient(IGs2Credential credential)
```
    コンストラクタ。
    
    Parameters:
    
    credential - 認証情報
- Method Detail
  - createRankingTable
```
public CreateRankingTableResult createRankingTable(CreateRankingTableRequest request)
```
    ランキングテーブルを作成。
    
    GS2-Ranking を利用するには、まずランキングテーブルを作成する必要があります。
    1つのランキングテーブルには複数のゲームモードのランキングを格納することができます。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    作成結果
  - describeRankingTable
```
public DescribeRankingTableResult describeRankingTable(DescribeRankingTableRequest request)
```
    ランキングテーブル一覧を取得。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    ランキングテーブル一覧
  - getRankingTable
```
public GetRankingTableResult getRankingTable(GetRankingTableRequest request)
```
    ランキングテーブルを取得。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    ランキングテーブル
  - updateRankingTable
```
public UpdateRankingTableResult updateRankingTable(UpdateRankingTableRequest request)
```
    ランキングテーブルを更新。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    更新結果
  - deleteRankingTable
```
public void deleteRankingTable(DeleteRankingTableRequest request)
```
    ランキングテーブルを削除。
    
    Parameters:
    
    request - リクエストパラメータ
  - createGameMode
```
public CreateGameModeResult createGameMode(CreateGameModeRequest request)
```
    ゲームモードを作成。
    
    ゲームモードを作成すると、ゲームモードの設定としてランキングが昇順なのか、降順なのかを設定できます。
    レースゲームのようなタイムの値が小さいほど上位のランキングの場合は昇順を、
    アクションゲームなどで、スコアの値が大きいほど上位のランキングの場合は降順を選択します。
    
    他に、集計間隔を15分以上、24時間以下で分単位で設定できます。
    ランキングを更新したい間隔に合わせて設定することになります。
    集計処理毎に費用が発生するため、高頻度であればあるほど利用料金は高くなります。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    作成結果
  - describeGameMode
```
public DescribeGameModeResult describeGameMode(DescribeGameModeRequest request)
```
    ゲームモード一覧を取得。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    ゲームモード一覧
  - getGameMode
```
public GetGameModeResult getGameMode(GetGameModeRequest request)
```
    ゲームモードを取得。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    ゲームモード
  - updateGameMode
```
public UpdateGameModeResult updateGameMode(UpdateGameModeRequest request)
```
    ゲームモードを更新。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    更新結果
  - deleteGameMode
```
public void deleteGameMode(DeleteGameModeRequest request)
```
    ゲームモードを削除。
    
    Parameters:
    
    request - リクエストパラメータ
  - getRanking
```
public GetRankingResult getRanking(GetRankingRequest request)
```
    ランキングを取得。
    
    ランキングを取得します。
    ランキングにはユーザID、スコア、メタデータといった基本情報のほかに、インデックスと順位が付加されています。
    インデックスは先頭を1とした位置情報で、順位は同一スコアのユーザを同一順位として計算された値です。
    ランキングの性質上、同一スコアでも別順位として扱いたい場合は順位の代わりにインデックスを利用することで実現できます。
    
    ランキングデータはランダムアクセスができますので、getMyRank(GetMyRankRequest) で自分の順位を取得して、
    その前後のランキンデータを取得する。というような処理も実現できます。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    取得結果
  - putScore
```
public PutScoreResult putScore(PutScoreRequest request)
```
    スコアを登録。
    
    スコアの登録は一時的にバッファリングされ、定期的にランキングデータとして書き込まれます。
    そのため、スコア登録直後にランキング集計が開始された場合は、集計結果に含まれない可能性があります。
    
    accessToken には Gs2AuthClient.login(io.gs2.auth.control.LoginRequest) でログインして取得したアクセストークンを指定してください。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    登録結果
  - getMyRank
```
public GetMyRankResult getMyRank(GetMyRankRequest request)
```
    自分の順位を取得。
    
    自分の順位を取得できます、応答される値は集計時点での正確な値となります。
    
    accessToken には Gs2AuthClient.login(io.gs2.auth.control.LoginRequest) でログインして取得したアクセストークンを指定してください。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    取得結果
  - getEstimateRank
```
public GetEstimateRankResult getEstimateRank(GetEstimateRankRequest request)
```
    スコアを指定しておおよその順位を取得。
    
    指定したスコアを取ったと仮定して何位ぐらいになれるのか、といった指標を計算する際に利用します。
    原則1000位単位でおおよその順位を応答します。
    
    上位プレイヤーに対しては1000位単位の解像度では情報が不足している場合があると思いますので、
    応答が上位プレイヤーだった場合は、更に getRanking(GetRankingRequest) で上位のスコアを取得して
    さらに詳細な順位に絞り込んで情報提供する。というのもユーザ体験をよく出来ると思います。
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    取得結果

Class Gs2RankingClient

Field Summary

Fields inherited from class io.gs2.AbstractGs2Client

Constructor Summary

Method Summary

Methods inherited from class io.gs2.AbstractGs2Client

Methods inherited from class java.lang.Object

Field Detail

ENDPOINT

Constructor Detail

Gs2RankingClient

Method Detail

createRankingTable

describeRankingTable

getRankingTable

updateRankingTable

deleteRankingTable

createGameMode

describeGameMode

getGameMode

updateGameMode

deleteGameMode

getRanking

putScore

getMyRank

getEstimateRank