GS2-Ranking SDK API リファレンス モデル Namespace ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ✓ ~ 1024文字 ネームスペースGRN name string ✓ ~ 128文字 ネームスペース名 description string ~ 1024文字 説明文 lastCalculatedAts List<CalculatedAt> [] ~ 1000 items 最終集計日時リスト logSetting LogSetting ログの出力設定 createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) updatedAt long ✓ 現在時刻 最終更新日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
CategoryModel カテゴリーモデル
カテゴリ毎に異なるランキングを作成できます。
カテゴリには登録できるスコアの最小値・最大値を設定でき、その範囲外のスコアは破棄されます。 ランキングを集計する際にスコアを小さいものを上位(昇順)にするか、大きいものを上位(降順)にするかを設定できます。
ランキングの種類として グローバル
と スコープ
を選択できます。 グローバルは全プレイヤーが同じ結果を参照するもので、スコープはフレンド内ランキングや、ギルド内ランキングのようなゲームプレイヤー毎に結果の異なるランキングです。
グローバルランキングはカテゴリごとにランキングの集計間隔を15分~24時間で設定できます。 スコープランキングはリアルタイムで集計結果が反映されます。
ランキングデータには世代という設定があり、世代を変更することで登録されたスコアをリセットすることができます。
型 有効化条件 必須 デフォルト 値の制限 説明 categoryModelId string ✓ ~ 1024文字 カテゴリGRN name string ✓ ~ 128文字 カテゴリ名 metadata string ~ 1024文字 メタデータ minimumValue long ~ 9223372036854775805 スコアの最小値 maximumValue long ~ 9223372036854775805 スコアの最大値 sum bool ✓ false 登録を受け付けたスコアを合算し、合計値を競う orderDirection enum { “asc”, “desc” } ✓ ~ 128文字 スコアのソート方向 scope enum { “global”, “scoped” } ✓ ~ 128文字 ランキングの種類 globalRankingSetting GlobalRankingSetting {scope} == “global” ✓ グローバルランキング設定 entryPeriodEventId string ~ 1024文字 スコアの登録可能期間 GS2-Schedule イベントGRN accessPeriodEventId string ~ 1024文字 ランキングデータへのアクセス可能期間 GS2-Schedule イベントGRN
orderDirection に指定する列挙型の定義 scope に指定する列挙型の定義 定義 説明 global グローバル scoped スコープ
CategoryModelMaster カテゴリーモデル
カテゴリ毎に異なるランキングを作成できます。
カテゴリには登録できるスコアの最小値・最大値を設定でき、その範囲外のスコアは破棄されます。 ランキングを集計する際にスコアを小さいものを上位(昇順)にするか、大きいものを上位(降順)にするかを設定できます。
ランキングの種類として グローバル
と スコープ
を選択できます。 グローバルは全プレイヤーが同じ結果を参照するもので、スコープはフレンド内ランキングや、ギルド内ランキングのようなゲームプレイヤー毎に結果の異なるランキングです。
グローバルランキングはカテゴリごとにランキングの集計間隔を15分~24時間で設定できます。 スコープランキングはリアルタイムで集計結果が反映されます。
ランキングデータには世代という設定があり、世代を変更することで登録されたスコアをリセットすることができます。
型 有効化条件 必須 デフォルト 値の制限 説明 categoryModelId string ✓ ~ 1024文字 カテゴリマスターGRN name string ✓ ~ 128文字 カテゴリモデル名 description string ~ 1024文字 説明文 metadata string ~ 1024文字 メタデータ minimumValue long ~ 9223372036854775805 スコアの最小値 maximumValue long ~ 9223372036854775805 スコアの最大値 sum bool ✓ false 登録を受け付けたスコアを合算し、合計値を競う orderDirection enum { “asc”, “desc” } ✓ ~ 128文字 スコアのソート方向 scope enum { “global”, “scoped” } ✓ ~ 128文字 ランキングの種類 globalRankingSetting GlobalRankingSetting {scope} == “global” ✓ グローバルランキング設定 entryPeriodEventId string ~ 1024文字 スコアの登録可能期間 GS2-Schedule イベントGRN accessPeriodEventId string ~ 1024文字 ランキングデータへのアクセス可能期間 GS2-Schedule イベントGRN createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) updatedAt long ✓ 現在時刻 最終更新日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
orderDirection に指定する列挙型の定義 scope に指定する列挙型の定義 定義 説明 global グローバル scoped スコープ
Subscribe 購読
スコープランキングでスコアの変化を購読している状況を保持するエンティティです。
型 有効化条件 必須 デフォルト 値の制限 説明 subscribeId string ✓ ~ 1024文字 購読GRN categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID targetUserIds List<string> [] ~ 10000 items 購読しているユーザIDリスト subscribedUserIds List<string> [] ~ 10000 items 購読されているユーザIDリスト createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
Score スコア
ゲームプレイヤー毎×カテゴリ毎の登録されたスコアを保持するエンティティです。
型 有効化条件 必須 デフォルト 値の制限 説明 scoreId string ✓ ~ 1024文字 スコアGRN categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID uniqueId string ✓ UUID ~ 36文字 スコアのユニークID scorerUserId string ✓ ~ 128文字 ユーザーID score long ✓ ~ 9223372036854775805 スコア metadata string ~ 512文字 メタデータ createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
Ranking ランキング
ランキングには「参加者全員が同じボード上で競い合う」 グローバルランキング と、「購読したプレイヤーのスコアと競い合う」 スコープランキング があります。
型 有効化条件 必須 デフォルト 値の制限 説明 rank long ✓ 1 ~ 9223372036854775805 順位 index long ✓ ~ 9223372036854775805 1位からのインデックス categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID score long ✓ ~ 9223372036854775805 スコア metadata string ~ 512文字 メタデータ createdAt long ✓ 作成日時 (UNIX時間 単位:ミリ秒)
CurrentRankingMaster 現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ✓ ~ 1024文字 現在有効なランキングマスターGRN settings string ✓ ~ 5242880文字 マスターデータ
Scope 集計スコープ
グローバルランキングモードで使用可能。 通常グローバルランキングは登録されたスコア全てを対象にランキングの集計が行われます。
型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 スコープ名 targetDays long ✓ 1 ~ 365 集計対象日数
GlobalRankingSetting グローバルランキング設定
グローバルは全プレイヤーが同じ結果を参照するものです。 ランキングの集計間隔を15分~24時間で設定できます。
ランキングデータには世代という設定があり、世代を変更することで登録されたスコアをリセットすることができます。
型 有効化条件 必須 デフォルト 値の制限 説明 uniqueByUserId bool ✓ true ユーザID毎にスコアを1つしか登録されないようにする calculateIntervalMinutes int ✓ 15 ~ 1440 スコアの集計間隔(分) calculateFixedTiming FixedTiming スコアの固定集計開始時刻 additionalScopes List<Scope> ~ 10 items スコープリスト ignoreUserIds List<string> ~ 10000 items ランキングに反映しないユーザーIDリスト generation string ~ 256文字 ランキングの世代
FixedTiming 集計時刻固定設定
グローバルランキングの集計タイミングを固定するための設定です。
型 有効化条件 必須 デフォルト 値の制限 説明 hour int ~ 23 スコアの固定集計開始時刻(時) minute int ~ 59 スコアの固定集計開始時刻(分)
CalculatedAt 最終集計日時
型 有効化条件 必須 デフォルト 値の制限 説明 categoryName string ✓ ~ 128文字 カテゴリ名 calculatedAt long ✓ 集計日時 (UNIX時間 単位:ミリ秒)
SubscribeUser 購読しているユーザーのユーザーID
型 有効化条件 必須 デフォルト 値の制限 説明 subscribeUserId string ✓ ~ 1024文字 購読対象GRN categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID targetUserId string ✓ ~ 128文字 購読する対象のユーザーID
GitHubCheckoutSetting GitHubからマスターデータをチェックアウトする設定
型 有効化条件 必須 デフォルト 値の制限 説明 apiKeyId string ✓ ~ 1024文字 GitHub のAPIキーGRN repositoryName string ✓ ~ 1024文字 リポジトリ名 sourcePath string ✓ ~ 1024文字 ソースコードのファイルパス referenceType enum { “commit_hash”, “branch”, “tag” } ✓ ~ 128文字 コードの取得元 commitHash string {referenceType} == “commit_hash” ✓ ~ 1024文字 コミットハッシュ branchName string {referenceType} == “branch” ✓ ~ 1024文字 ブランチ名 tagName string {referenceType} == “tag” ✓ ~ 1024文字 タグ名
referenceType に指定する列挙型の定義 定義 説明 commit_hash コミットハッシュ branch ブランチ tag タグ
LogSetting ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子(Namespace ID)を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
型 有効化条件 必須 デフォルト 値の制限 説明 loggingNamespaceId string ✓ ~ 1024文字 ネームスペースGRN
メソッド describeNamespaces ネームスペースの一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeNamespaces (
& ranking . DescribeNamespacesRequest {
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeNamespacesRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeNamespaces (
( new DescribeNamespacesRequest ())
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeNamespacesRequest ;
import io.gs2.ranking.result.DescribeNamespacesResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeNamespacesResult result = client . describeNamespaces (
new DescribeNamespacesRequest ()
. withPageToken ( null )
. withLimit ( null )
);
List < Namespace > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeNamespacesRequest ;
using Gs2.Gs2Ranking.Result.DescribeNamespacesResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeNamespacesResult > asyncResult = null ;
yield return client . DescribeNamespaces (
new Gs2 . Gs2Ranking . Request . DescribeNamespacesRequest ()
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeNamespaces (
new Gs2Ranking . DescribeNamespacesRequest ()
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_namespaces (
ranking . DescribeNamespacesRequest ()
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_namespaces ({
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_namespaces_async ({
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
createNamespace ネームスペースを新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ ~ 128文字 ネームスペース名 description string ~ 1024文字 説明文 logSetting LogSetting ログの出力設定
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . CreateNamespace (
& ranking . CreateNamespaceRequest {
Name : pointy . String ( "namespace1" ),
Description : nil ,
LogSetting : & ranking . LogSetting {
LoggingNamespaceId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ),
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\CreateNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createNamespace (
( new CreateNamespaceRequest ())
-> withName ( self :: namespace1 )
-> withDescription ( null )
-> withLogSetting (( new \Gs2\Ranking\Model\LogSetting ())
-> withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log: \n amespace1" ))
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.CreateNamespaceRequest ;
import io.gs2.ranking.result.CreateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
CreateNamespaceResult result = client . createNamespace (
new CreateNamespaceRequest ()
. withName ( "namespace1" )
. withDescription ( null )
. withLogSetting ( new io . gs2 . ranking . model . LogSetting ()
. withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ))
);
Namespace item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.CreateNamespaceRequest ;
using Gs2.Gs2Ranking.Result.CreateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . CreateNamespaceResult > asyncResult = null ;
yield return client . CreateNamespace (
new Gs2 . Gs2Ranking . Request . CreateNamespaceRequest ()
. WithName ( "namespace1" )
. WithDescription ( null )
. WithLogSetting ( new Gs2 . Gs2Ranking . Model . LogSetting ()
. WithLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" )),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . createNamespace (
new Gs2Ranking . CreateNamespaceRequest ()
. withName ( "namespace1" )
. withDescription ( null )
. withLogSetting ( new Gs2Ranking . model . LogSetting ()
. withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ))
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . create_namespace (
ranking . CreateNamespaceRequest ()
. with_name ( self . hash1 )
. with_description ( None )
. with_log_setting (
ranking . LogSetting ()
. with_logging_namespace_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1' ))
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.create_namespace ({
name = "namespace1" ,
description = nil ,
logSetting = {
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ,
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.create_namespace_async ({
name = "namespace1" ,
description = nil ,
logSetting = {
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ,
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
getNamespaceStatus ネームスペースの状態を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetNamespaceStatus (
& ranking . GetNamespaceStatusRequest {
NamespaceName : pointy . String ( "namespace1" ),
}
)
if err != nil {
panic ( "error occurred" )
}
status := result . Status
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetNamespaceStatusRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getNamespaceStatus (
( new GetNamespaceStatusRequest ())
-> withNamespaceName ( self :: namespace1 )
);
$status = $result -> getStatus ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetNamespaceStatusRequest ;
import io.gs2.ranking.result.GetNamespaceStatusResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetNamespaceStatusResult result = client . getNamespaceStatus (
new GetNamespaceStatusRequest ()
. withNamespaceName ( "namespace1" )
);
String status = result . getStatus ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetNamespaceStatusRequest ;
using Gs2.Gs2Ranking.Result.GetNamespaceStatusResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetNamespaceStatusResult > asyncResult = null ;
yield return client . GetNamespaceStatus (
new Gs2 . Gs2Ranking . Request . GetNamespaceStatusRequest ()
. WithNamespaceName ( "namespace1" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var status = result . Status ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getNamespaceStatus (
new Gs2Ranking . GetNamespaceStatusRequest ()
. withNamespaceName ( "namespace1" )
);
const status = result . getStatus ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_namespace_status (
ranking . GetNamespaceStatusRequest ()
. with_namespace_name ( self . hash1 )
)
status = result . status
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_namespace_status ({
namespaceName = "namespace1" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
status = result.status ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_namespace_status_async ({
namespaceName = "namespace1" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
status = result.status ;
getNamespace ネームスペースを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetNamespace (
& ranking . GetNamespaceRequest {
NamespaceName : pointy . String ( "namespace1" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getNamespace (
( new GetNamespaceRequest ())
-> withNamespaceName ( self :: namespace1 )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetNamespaceRequest ;
import io.gs2.ranking.result.GetNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetNamespaceResult result = client . getNamespace (
new GetNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
Namespace item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetNamespaceRequest ;
using Gs2.Gs2Ranking.Result.GetNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetNamespaceResult > asyncResult = null ;
yield return client . GetNamespace (
new Gs2 . Gs2Ranking . Request . GetNamespaceRequest ()
. WithNamespaceName ( "namespace1" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getNamespace (
new Gs2Ranking . GetNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_namespace (
ranking . GetNamespaceRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_namespace ({
namespaceName = "namespace1" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_namespace_async ({
namespaceName = "namespace1" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
updateNamespace ネームスペースを更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 description string ~ 1024文字 説明文 logSetting LogSetting ログの出力設定
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . UpdateNamespace (
& ranking . UpdateNamespaceRequest {
NamespaceName : pointy . String ( "namespace1" ),
Description : pointy . String ( "description1" ),
LogSetting : & ranking . LogSetting {
LoggingNamespaceId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ),
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\UpdateNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateNamespace (
( new UpdateNamespaceRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withDescription ( "description1" )
-> withLogSetting (( new \Gs2\Ranking\Model\LogSetting ())
-> withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log: \n amespace1" ))
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.UpdateNamespaceRequest ;
import io.gs2.ranking.result.UpdateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
UpdateNamespaceResult result = client . updateNamespace (
new UpdateNamespaceRequest ()
. withNamespaceName ( "namespace1" )
. withDescription ( "description1" )
. withLogSetting ( new io . gs2 . ranking . model . LogSetting ()
. withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ))
);
Namespace item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.UpdateNamespaceRequest ;
using Gs2.Gs2Ranking.Result.UpdateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . UpdateNamespaceResult > asyncResult = null ;
yield return client . UpdateNamespace (
new Gs2 . Gs2Ranking . Request . UpdateNamespaceRequest ()
. WithNamespaceName ( "namespace1" )
. WithDescription ( "description1" )
. WithLogSetting ( new Gs2 . Gs2Ranking . Model . LogSetting ()
. WithLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" )),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . updateNamespace (
new Gs2Ranking . UpdateNamespaceRequest ()
. withNamespaceName ( "namespace1" )
. withDescription ( "description1" )
. withLogSetting ( new Gs2Ranking . model . LogSetting ()
. withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ))
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . update_namespace (
ranking . UpdateNamespaceRequest ()
. with_namespace_name ( self . hash1 )
. with_description ( 'description1' )
. with_log_setting (
ranking . LogSetting ()
. with_logging_namespace_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1' ))
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.update_namespace ({
namespaceName = "namespace1" ,
description = "description1" ,
logSetting = {
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ,
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.update_namespace_async ({
namespaceName = "namespace1" ,
description = "description1" ,
logSetting = {
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1" ,
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
deleteNamespace ネームスペースを削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DeleteNamespace (
& ranking . DeleteNamespaceRequest {
NamespaceName : pointy . String ( "namespace1" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DeleteNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteNamespace (
( new DeleteNamespaceRequest ())
-> withNamespaceName ( self :: namespace1 )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DeleteNamespaceRequest ;
import io.gs2.ranking.result.DeleteNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DeleteNamespaceResult result = client . deleteNamespace (
new DeleteNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
Namespace item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DeleteNamespaceRequest ;
using Gs2.Gs2Ranking.Result.DeleteNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DeleteNamespaceResult > asyncResult = null ;
yield return client . DeleteNamespace (
new Gs2 . Gs2Ranking . Request . DeleteNamespaceRequest ()
. WithNamespaceName ( "namespace1" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . deleteNamespace (
new Gs2Ranking . DeleteNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . delete_namespace (
ranking . DeleteNamespaceRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.delete_namespace ({
namespaceName = "namespace1" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.delete_namespace_async ({
namespaceName = "namespace1" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
dumpUserDataByUserId 指定したユーザーIDに紐づくデータのダンプを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DumpUserDataByUserId (
& ranking . DumpUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DumpUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> dumpUserDataByUserId (
( new DumpUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DumpUserDataByUserIdRequest ;
import io.gs2.ranking.result.DumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DumpUserDataByUserIdResult result = client . dumpUserDataByUserId (
new DumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DumpUserDataByUserIdRequest ;
using Gs2.Gs2Ranking.Result.DumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DumpUserDataByUserIdResult > asyncResult = null ;
yield return client . DumpUserDataByUserId (
new Gs2 . Gs2Ranking . Request . DumpUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . dumpUserDataByUserId (
new Gs2Ranking . DumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . dump_user_data_by_user_id (
ranking . DumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.dump_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
client = gs2 ( 'ranking' )
api_result_handler = client.dump_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
checkDumpUserDataByUserId 指定したユーザーIDに紐づくデータのダンプが完了しているか確認
Request 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . CheckDumpUserDataByUserId (
& ranking . CheckDumpUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
url := result . Url
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\CheckDumpUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> checkDumpUserDataByUserId (
( new CheckDumpUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
$url = $result -> getUrl ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.CheckDumpUserDataByUserIdRequest ;
import io.gs2.ranking.result.CheckDumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
CheckDumpUserDataByUserIdResult result = client . checkDumpUserDataByUserId (
new CheckDumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
String url = result . getUrl ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.CheckDumpUserDataByUserIdRequest ;
using Gs2.Gs2Ranking.Result.CheckDumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . CheckDumpUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckDumpUserDataByUserId (
new Gs2 . Gs2Ranking . Request . CheckDumpUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var url = result . Url ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . checkDumpUserDataByUserId (
new Gs2Ranking . CheckDumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . check_dump_user_data_by_user_id (
ranking . CheckDumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.check_dump_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
url = result.url ;
client = gs2 ( 'ranking' )
api_result_handler = client.check_dump_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
url = result.url ;
cleanUserDataByUserId 指定したユーザーIDに紐づくデータのダンプを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . CleanUserDataByUserId (
& ranking . CleanUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\CleanUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> cleanUserDataByUserId (
( new CleanUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.CleanUserDataByUserIdRequest ;
import io.gs2.ranking.result.CleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
CleanUserDataByUserIdResult result = client . cleanUserDataByUserId (
new CleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.CleanUserDataByUserIdRequest ;
using Gs2.Gs2Ranking.Result.CleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . CleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CleanUserDataByUserId (
new Gs2 . Gs2Ranking . Request . CleanUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . cleanUserDataByUserId (
new Gs2Ranking . CleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . clean_user_data_by_user_id (
ranking . CleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.clean_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
client = gs2 ( 'ranking' )
api_result_handler = client.clean_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
checkCleanUserDataByUserId 指定したユーザーIDに紐づくデータのダンプが完了しているか確認
Request 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . CheckCleanUserDataByUserId (
& ranking . CheckCleanUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\CheckCleanUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> checkCleanUserDataByUserId (
( new CheckCleanUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.CheckCleanUserDataByUserIdRequest ;
import io.gs2.ranking.result.CheckCleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
CheckCleanUserDataByUserIdResult result = client . checkCleanUserDataByUserId (
new CheckCleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.CheckCleanUserDataByUserIdRequest ;
using Gs2.Gs2Ranking.Result.CheckCleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . CheckCleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckCleanUserDataByUserId (
new Gs2 . Gs2Ranking . Request . CheckCleanUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . checkCleanUserDataByUserId (
new Gs2Ranking . CheckCleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . check_clean_user_data_by_user_id (
ranking . CheckCleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.check_clean_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
client = gs2 ( 'ranking' )
api_result_handler = client.check_clean_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
prepareImportUserDataByUserId 指定したユーザーIDに紐づくデータのインポートを開始
Request 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 型 説明 uploadToken string アップロード後に結果を反映する際に使用するトークン uploadUrl string ユーザーデータアップロード処理の実行に使用するURL
実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . PrepareImportUserDataByUserId (
& ranking . PrepareImportUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
uploadToken := result . UploadToken
uploadUrl := result . UploadUrl
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\PrepareImportUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> prepareImportUserDataByUserId (
( new PrepareImportUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
$uploadToken = $result -> getUploadToken ();
$uploadUrl = $result -> getUploadUrl ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.PrepareImportUserDataByUserIdRequest ;
import io.gs2.ranking.result.PrepareImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
PrepareImportUserDataByUserIdResult result = client . prepareImportUserDataByUserId (
new PrepareImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
String uploadToken = result . getUploadToken ();
String uploadUrl = result . getUploadUrl ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.PrepareImportUserDataByUserIdRequest ;
using Gs2.Gs2Ranking.Result.PrepareImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . PrepareImportUserDataByUserIdResult > asyncResult = null ;
yield return client . PrepareImportUserDataByUserId (
new Gs2 . Gs2Ranking . Request . PrepareImportUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var uploadToken = result . UploadToken ;
var uploadUrl = result . UploadUrl ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . prepareImportUserDataByUserId (
new Gs2Ranking . PrepareImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
const uploadToken = result . getUploadToken ();
const uploadUrl = result . getUploadUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . prepare_import_user_data_by_user_id (
ranking . PrepareImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
upload_token = result . upload_token
upload_url = result . upload_url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.prepare_import_user_data_by_user_id ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
uploadToken = result.uploadToken ;
uploadUrl = result.uploadUrl ;
client = gs2 ( 'ranking' )
api_result_handler = client.prepare_import_user_data_by_user_id_async ({
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
uploadToken = result.uploadToken ;
uploadUrl = result.uploadUrl ;
importUserDataByUserId 指定したユーザーIDに紐づくデータのインポートを開始
Request 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID uploadToken string ✓ ~ 1024文字 アップロード準備で受け取ったトークン timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . ImportUserDataByUserId (
& ranking . ImportUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
UploadToken : pointy . String ( "upload-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\ImportUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> importUserDataByUserId (
( new ImportUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withUploadToken ( "upload-0001" )
-> withTimeOffsetToken ( null )
);
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.ImportUserDataByUserIdRequest ;
import io.gs2.ranking.result.ImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
ImportUserDataByUserIdResult result = client . importUserDataByUserId (
new ImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.ImportUserDataByUserIdRequest ;
using Gs2.Gs2Ranking.Result.ImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . ImportUserDataByUserIdResult > asyncResult = null ;
yield return client . ImportUserDataByUserId (
new Gs2 . Gs2Ranking . Request . ImportUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithUploadToken ( "upload-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . importUserDataByUserId (
new Gs2Ranking . ImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . import_user_data_by_user_id (
ranking . ImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_upload_token ( 'upload-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.import_user_data_by_user_id ({
userId = "user-0001" ,
uploadToken = "upload-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
client = gs2 ( 'ranking' )
api_result_handler = client.import_user_data_by_user_id_async ({
userId = "user-0001" ,
uploadToken = "upload-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
checkImportUserDataByUserId 指定したユーザーIDに紐づくデータのインポートが完了しているか確認
Request 型 有効化条件 必須 デフォルト 値の制限 説明 userId string ✓ ~ 128文字 ユーザーID uploadToken string ✓ ~ 1024文字 アップロード準備で受け取ったトークン timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . CheckImportUserDataByUserId (
& ranking . CheckImportUserDataByUserIdRequest {
UserId : pointy . String ( "user-0001" ),
UploadToken : pointy . String ( "upload-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
url := result . Url
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\CheckImportUserDataByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> checkImportUserDataByUserId (
( new CheckImportUserDataByUserIdRequest ())
-> withUserId ( "user-0001" )
-> withUploadToken ( "upload-0001" )
-> withTimeOffsetToken ( null )
);
$url = $result -> getUrl ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.CheckImportUserDataByUserIdRequest ;
import io.gs2.ranking.result.CheckImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
CheckImportUserDataByUserIdResult result = client . checkImportUserDataByUserId (
new CheckImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
String url = result . getUrl ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.CheckImportUserDataByUserIdRequest ;
using Gs2.Gs2Ranking.Result.CheckImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . CheckImportUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckImportUserDataByUserId (
new Gs2 . Gs2Ranking . Request . CheckImportUserDataByUserIdRequest ()
. WithUserId ( "user-0001" )
. WithUploadToken ( "upload-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var url = result . Url ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . checkImportUserDataByUserId (
new Gs2Ranking . CheckImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . check_import_user_data_by_user_id (
ranking . CheckImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_upload_token ( 'upload-0001' )
. with_time_offset_token ( None )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.check_import_user_data_by_user_id ({
userId = "user-0001" ,
uploadToken = "upload-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
url = result.url ;
client = gs2 ( 'ranking' )
api_result_handler = client.check_import_user_data_by_user_id_async ({
userId = "user-0001" ,
uploadToken = "upload-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
url = result.url ;
describeCategoryModels カテゴリモデルの一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeCategoryModels (
& ranking . DescribeCategoryModelsRequest {
NamespaceName : pointy . String ( "namespace1" ),
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeCategoryModelsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeCategoryModels (
( new DescribeCategoryModelsRequest ())
-> withNamespaceName ( self :: namespace1 )
);
$items = $result -> getItems ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeCategoryModelsRequest ;
import io.gs2.ranking.result.DescribeCategoryModelsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeCategoryModelsResult result = client . describeCategoryModels (
new DescribeCategoryModelsRequest ()
. withNamespaceName ( "namespace1" )
);
List < CategoryModel > items = result . getItems ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeCategoryModelsRequest ;
using Gs2.Gs2Ranking.Result.DescribeCategoryModelsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeCategoryModelsResult > asyncResult = null ;
yield return client . DescribeCategoryModels (
new Gs2 . Gs2Ranking . Request . DescribeCategoryModelsRequest ()
. WithNamespaceName ( "namespace1" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeCategoryModels (
new Gs2Ranking . DescribeCategoryModelsRequest ()
. withNamespaceName ( "namespace1" )
);
const items = result . getItems ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_category_models (
ranking . DescribeCategoryModelsRequest ()
. with_namespace_name ( self . hash1 )
)
items = result . items
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_category_models ({
namespaceName = "namespace1" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_category_models_async ({
namespaceName = "namespace1" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
getCategoryModel カテゴリモデルを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetCategoryModel (
& ranking . GetCategoryModelRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetCategoryModelRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getCategoryModel (
( new GetCategoryModelRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetCategoryModelRequest ;
import io.gs2.ranking.result.GetCategoryModelResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetCategoryModelResult result = client . getCategoryModel (
new GetCategoryModelRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
);
CategoryModel item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetCategoryModelRequest ;
using Gs2.Gs2Ranking.Result.GetCategoryModelResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetCategoryModelResult > asyncResult = null ;
yield return client . GetCategoryModel (
new Gs2 . Gs2Ranking . Request . GetCategoryModelRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getCategoryModel (
new Gs2Ranking . GetCategoryModelRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_category_model (
ranking . GetCategoryModelRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_category_model ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_category_model_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
describeCategoryModelMasters カテゴリモデルマスターの一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeCategoryModelMasters (
& ranking . DescribeCategoryModelMastersRequest {
NamespaceName : pointy . String ( "namespace1" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeCategoryModelMastersRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeCategoryModelMasters (
( new DescribeCategoryModelMastersRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeCategoryModelMastersRequest ;
import io.gs2.ranking.result.DescribeCategoryModelMastersResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeCategoryModelMastersResult result = client . describeCategoryModelMasters (
new DescribeCategoryModelMastersRequest ()
. withNamespaceName ( "namespace1" )
. withPageToken ( null )
. withLimit ( null )
);
List < CategoryModelMaster > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeCategoryModelMastersRequest ;
using Gs2.Gs2Ranking.Result.DescribeCategoryModelMastersResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeCategoryModelMastersResult > asyncResult = null ;
yield return client . DescribeCategoryModelMasters (
new Gs2 . Gs2Ranking . Request . DescribeCategoryModelMastersRequest ()
. WithNamespaceName ( "namespace1" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeCategoryModelMasters (
new Gs2Ranking . DescribeCategoryModelMastersRequest ()
. withNamespaceName ( "namespace1" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_category_model_masters (
ranking . DescribeCategoryModelMastersRequest ()
. with_namespace_name ( self . hash1 )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_category_model_masters ({
namespaceName = "namespace1" ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_category_model_masters_async ({
namespaceName = "namespace1" ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
createCategoryModelMaster カテゴリモデルマスターを新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 name string ✓ ~ 128文字 カテゴリモデル名 description string ~ 1024文字 説明文 metadata string ~ 1024文字 メタデータ minimumValue long ~ 9223372036854775805 スコアの最小値 maximumValue long ~ 9223372036854775805 スコアの最大値 orderDirection enum { “asc”, “desc” } ✓ ~ 128文字 スコアのソート方向 scope enum { “global”, “scoped” } ✓ ~ 128文字 ランキングの種類 globalRankingSetting GlobalRankingSetting {scope} == “global” ✓ グローバルランキング設定 entryPeriodEventId string ~ 1024文字 スコアの登録可能期間 GS2-Schedule イベントGRN accessPeriodEventId string ~ 1024文字 ランキングデータへのアクセス可能期間 GS2-Schedule イベントGRN uniqueByUserId bool {scope} == “global” ✓ ユーザID毎にスコアを1つしか登録されないようにする sum bool ✓ false 登録を受け付けたスコアを合算し、合計値を競う calculateFixedTimingHour int {scope} == “global” ~ 23 スコアの固定集計開始時刻(時) calculateFixedTimingMinute int {scope} == “global” ~ 59 スコアの固定集計開始時刻(分) calculateIntervalMinutes int {scope} == “global” ✓ 15 ~ 1440 スコアの集計間隔(分) additionalScopes List<Scope> {scope} == “global” ~ 10 items スコープリスト ignoreUserIds List<string> ~ 10000 items ランキングに反映しないユーザーIDリスト generation string ~ 256文字 ランキングの世代
orderDirection に指定する列挙型の定義 scope に指定する列挙型の定義 定義 説明 global グローバル scoped スコープ
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . CreateCategoryModelMaster (
& ranking . CreateCategoryModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Name : pointy . String ( "category-0001" ),
Description : nil ,
Metadata : nil ,
MinimumValue : nil ,
MaximumValue : nil ,
OrderDirection : pointy . String ( "asc" ),
Scope : pointy . String ( "global" ),
GlobalRankingSetting : & ranking . GlobalRankingSetting {
CalculateIntervalMinutes : pointy . Int32 ( 15 ),
UniqueByUserId : pointy . Bool ( false ),
AdditionalScopes : [] ranking . Scope {
ranking . Scope {
Name : pointy . String ( "daily" ),
TargetDays : pointy . Int64 ( 1 ),
},
ranking . Scope {
Name : pointy . String ( "weekly" ),
TargetDays : pointy . Int64 ( 7 ),
},
},
},
EntryPeriodEventId : nil ,
AccessPeriodEventId : nil ,
Sum : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\CreateCategoryModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createCategoryModelMaster (
( new CreateCategoryModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withName ( "category-0001" )
-> withDescription ( null )
-> withMetadata ( null )
-> withMinimumValue ( null )
-> withMaximumValue ( null )
-> withOrderDirection ( "asc" )
-> withScope ( "global" )
-> withGlobalRankingSetting (( new \Gs2\Ranking\Model\GlobalRankingSetting ())
-> withCalculateIntervalMinutes ( 15 )
-> withUniqueByUserId ( False )
-> withAdditionalScopes ([
( new \Gs2\Ranking\Model\Scope ())
-> withName ( "daily" )
-> withTargetDays ( 1 ),
( new \Gs2\Ranking\Model\Scope ())
-> withName ( "weekly" )
-> withTargetDays ( 7 ),
]))
-> withEntryPeriodEventId ( null )
-> withAccessPeriodEventId ( null )
-> withSum ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.CreateCategoryModelMasterRequest ;
import io.gs2.ranking.result.CreateCategoryModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
CreateCategoryModelMasterResult result = client . createCategoryModelMaster (
new CreateCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withName ( "category-0001" )
. withDescription ( null )
. withMetadata ( null )
. withMinimumValue ( null )
. withMaximumValue ( null )
. withOrderDirection ( "asc" )
. withScope ( "global" )
. withGlobalRankingSetting ( new io . gs2 . ranking . model . GlobalRankingSetting ()
. withCalculateIntervalMinutes ( 15 )
. withUniqueByUserId ( false )
. withAdditionalScopes ( Arrays . asList (
new io . gs2 . ranking . model . Scope ()
. withName ( "daily" )
. withTargetDays ( 1L ),
new io . gs2 . ranking . model . Scope ()
. withName ( "weekly" )
. withTargetDays ( 7L )
)))
. withEntryPeriodEventId ( null )
. withAccessPeriodEventId ( null )
. withSum ( null )
);
CategoryModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.CreateCategoryModelMasterRequest ;
using Gs2.Gs2Ranking.Result.CreateCategoryModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . CreateCategoryModelMasterResult > asyncResult = null ;
yield return client . CreateCategoryModelMaster (
new Gs2 . Gs2Ranking . Request . CreateCategoryModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithName ( "category-0001" )
. WithDescription ( null )
. WithMetadata ( null )
. WithMinimumValue ( null )
. WithMaximumValue ( null )
. WithOrderDirection ( "asc" )
. WithScope ( "global" )
. WithGlobalRankingSetting ( new Gs2 . Gs2Ranking . Model . GlobalRankingSetting ()
. WithCalculateIntervalMinutes ( 15 )
. WithUniqueByUserId ( false )
. WithAdditionalScopes ( new Gs2 . Gs2Ranking . Model . Scope [] {
new Gs2 . Gs2Ranking . Model . Scope ()
. WithName ( "daily" )
. WithTargetDays ( 1L ),
new Gs2 . Gs2Ranking . Model . Scope ()
. WithName ( "weekly" )
. WithTargetDays ( 7L ),
}))
. WithEntryPeriodEventId ( null )
. WithAccessPeriodEventId ( null )
. WithSum ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . createCategoryModelMaster (
new Gs2Ranking . CreateCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withName ( "category-0001" )
. withDescription ( null )
. withMetadata ( null )
. withMinimumValue ( null )
. withMaximumValue ( null )
. withOrderDirection ( "asc" )
. withScope ( "global" )
. withGlobalRankingSetting ( new Gs2Ranking . model . GlobalRankingSetting ()
. withCalculateIntervalMinutes ( 15 )
. withUniqueByUserId ( false )
. withAdditionalScopes ([
new Gs2Ranking . model . Scope ()
. withName ( "daily" )
. withTargetDays ( 1 ),
new Gs2Ranking . model . Scope ()
. withName ( "weekly" )
. withTargetDays ( 7 ),
]))
. withEntryPeriodEventId ( null )
. withAccessPeriodEventId ( null )
. withSum ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . create_category_model_master (
ranking . CreateCategoryModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_name ( 'category-0001' )
. with_description ( None )
. with_metadata ( None )
. with_minimum_value ( None )
. with_maximum_value ( None )
. with_order_direction ( 'asc' )
. with_scope ( 'global' )
. with_global_ranking_setting (
ranking . GlobalRankingSetting ()
. with_calculate_interval_minutes ( 15 )
. with_unique_by_user_id ( False )
. with_additional_scopes ([
ranking . Scope ()
. with_name ( 'daily' )
. with_target_days ( 1 ),
ranking . Scope ()
. with_name ( 'weekly' )
. with_target_days ( 7 ),
]))
. with_entry_period_event_id ( None )
. with_access_period_event_id ( None )
. with_sum ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.create_category_model_master ({
namespaceName = "namespace1" ,
name = "category-0001" ,
description = nil ,
metadata = nil ,
minimumValue = nil ,
maximumValue = nil ,
orderDirection = "asc" ,
scope = "global" ,
globalRankingSetting = {
calculateIntervalMinutes = 15 ,
uniqueByUserId = false ,
additionalScopes = {
{
name = "daily" ,
targetDays = 1 ,
},
{
name = "weekly" ,
targetDays = 7 ,
}
},
},
entryPeriodEventId = nil ,
accessPeriodEventId = nil ,
sum = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.create_category_model_master_async ({
namespaceName = "namespace1" ,
name = "category-0001" ,
description = nil ,
metadata = nil ,
minimumValue = nil ,
maximumValue = nil ,
orderDirection = "asc" ,
scope = "global" ,
globalRankingSetting = {
calculateIntervalMinutes = 15 ,
uniqueByUserId = false ,
additionalScopes = {
{
name = "daily" ,
targetDays = 1 ,
},
{
name = "weekly" ,
targetDays = 7 ,
}
},
},
entryPeriodEventId = nil ,
accessPeriodEventId = nil ,
sum = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
getCategoryModelMaster カテゴリモデルマスターを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリモデル名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetCategoryModelMaster (
& ranking . GetCategoryModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetCategoryModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getCategoryModelMaster (
( new GetCategoryModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetCategoryModelMasterRequest ;
import io.gs2.ranking.result.GetCategoryModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetCategoryModelMasterResult result = client . getCategoryModelMaster (
new GetCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
);
CategoryModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetCategoryModelMasterRequest ;
using Gs2.Gs2Ranking.Result.GetCategoryModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetCategoryModelMasterResult > asyncResult = null ;
yield return client . GetCategoryModelMaster (
new Gs2 . Gs2Ranking . Request . GetCategoryModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getCategoryModelMaster (
new Gs2Ranking . GetCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_category_model_master (
ranking . GetCategoryModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_category_model_master ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_category_model_master_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
updateCategoryModelMaster カテゴリモデルマスターを更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリモデル名 description string ~ 1024文字 説明文 metadata string ~ 1024文字 メタデータ minimumValue long ~ 9223372036854775805 スコアの最小値 maximumValue long ~ 9223372036854775805 スコアの最大値 orderDirection enum { “asc”, “desc” } ✓ ~ 128文字 スコアのソート方向 scope enum { “global”, “scoped” } ✓ ~ 128文字 ランキングの種類 globalRankingSetting GlobalRankingSetting {scope} == “global” ✓ グローバルランキング設定 entryPeriodEventId string ~ 1024文字 スコアの登録可能期間 GS2-Schedule イベントGRN accessPeriodEventId string ~ 1024文字 ランキングデータへのアクセス可能期間 GS2-Schedule イベントGRN uniqueByUserId bool {scope} == “global” ✓ ユーザID毎にスコアを1つしか登録されないようにする sum bool ✓ false 登録を受け付けたスコアを合算し、合計値を競う calculateFixedTimingHour int {scope} == “global” ~ 23 スコアの固定集計開始時刻(時) calculateFixedTimingMinute int {scope} == “global” ~ 59 スコアの固定集計開始時刻(分) calculateIntervalMinutes int {scope} == “global” ✓ 15 ~ 1440 スコアの集計間隔(分) additionalScopes List<Scope> {scope} == “global” ~ 10 items スコープリスト ignoreUserIds List<string> ~ 10000 items ランキングに反映しないユーザーIDリスト generation string ~ 256文字 ランキングの世代
orderDirection に指定する列挙型の定義 scope に指定する列挙型の定義 定義 説明 global グローバル scoped スコープ
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . UpdateCategoryModelMaster (
& ranking . UpdateCategoryModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
Description : pointy . String ( "description1" ),
Metadata : pointy . String ( "CATEGORY_0001" ),
MinimumValue : pointy . Int64 ( 100 ),
MaximumValue : pointy . Int64 ( 10000 ),
OrderDirection : pointy . String ( "desc" ),
Scope : pointy . String ( "global" ),
GlobalRankingSetting : & ranking . GlobalRankingSetting {
CalculateIntervalMinutes : pointy . Int32 ( 15 ),
UniqueByUserId : pointy . Bool ( true ),
AdditionalScopes : [] ranking . Scope {
ranking . Scope {
Name : pointy . String ( "weekly" ),
TargetDays : pointy . Int64 ( 7 ),
},
ranking . Scope {
Name : pointy . String ( "monthly" ),
TargetDays : pointy . Int64 ( 30 ),
},
},
},
EntryPeriodEventId : nil ,
AccessPeriodEventId : nil ,
Sum : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\UpdateCategoryModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateCategoryModelMaster (
( new UpdateCategoryModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withDescription ( "description1" )
-> withMetadata ( "CATEGORY_0001" )
-> withMinimumValue ( 100 )
-> withMaximumValue ( 10000 )
-> withOrderDirection ( "desc" )
-> withScope ( "global" )
-> withGlobalRankingSetting (( new \Gs2\Ranking\Model\GlobalRankingSetting ())
-> withCalculateIntervalMinutes ( 15 )
-> withUniqueByUserId ( True )
-> withAdditionalScopes ([
( new \Gs2\Ranking\Model\Scope ())
-> withName ( "weekly" )
-> withTargetDays ( 7 ),
( new \Gs2\Ranking\Model\Scope ())
-> withName ( "monthly" )
-> withTargetDays ( 30 ),
]))
-> withEntryPeriodEventId ( null )
-> withAccessPeriodEventId ( null )
-> withSum ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.UpdateCategoryModelMasterRequest ;
import io.gs2.ranking.result.UpdateCategoryModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
UpdateCategoryModelMasterResult result = client . updateCategoryModelMaster (
new UpdateCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withDescription ( "description1" )
. withMetadata ( "CATEGORY_0001" )
. withMinimumValue ( 100L )
. withMaximumValue ( 10000L )
. withOrderDirection ( "desc" )
. withScope ( "global" )
. withGlobalRankingSetting ( new io . gs2 . ranking . model . GlobalRankingSetting ()
. withCalculateIntervalMinutes ( 15 )
. withUniqueByUserId ( true )
. withAdditionalScopes ( Arrays . asList (
new io . gs2 . ranking . model . Scope ()
. withName ( "weekly" )
. withTargetDays ( 7L ),
new io . gs2 . ranking . model . Scope ()
. withName ( "monthly" )
. withTargetDays ( 30L )
)))
. withEntryPeriodEventId ( null )
. withAccessPeriodEventId ( null )
. withSum ( null )
);
CategoryModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.UpdateCategoryModelMasterRequest ;
using Gs2.Gs2Ranking.Result.UpdateCategoryModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . UpdateCategoryModelMasterResult > asyncResult = null ;
yield return client . UpdateCategoryModelMaster (
new Gs2 . Gs2Ranking . Request . UpdateCategoryModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithDescription ( "description1" )
. WithMetadata ( "CATEGORY_0001" )
. WithMinimumValue ( 100L )
. WithMaximumValue ( 10000L )
. WithOrderDirection ( "desc" )
. WithScope ( "global" )
. WithGlobalRankingSetting ( new Gs2 . Gs2Ranking . Model . GlobalRankingSetting ()
. WithCalculateIntervalMinutes ( 15 )
. WithUniqueByUserId ( true )
. WithAdditionalScopes ( new Gs2 . Gs2Ranking . Model . Scope [] {
new Gs2 . Gs2Ranking . Model . Scope ()
. WithName ( "weekly" )
. WithTargetDays ( 7L ),
new Gs2 . Gs2Ranking . Model . Scope ()
. WithName ( "monthly" )
. WithTargetDays ( 30L ),
}))
. WithEntryPeriodEventId ( null )
. WithAccessPeriodEventId ( null )
. WithSum ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . updateCategoryModelMaster (
new Gs2Ranking . UpdateCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withDescription ( "description1" )
. withMetadata ( "CATEGORY_0001" )
. withMinimumValue ( 100 )
. withMaximumValue ( 10000 )
. withOrderDirection ( "desc" )
. withScope ( "global" )
. withGlobalRankingSetting ( new Gs2Ranking . model . GlobalRankingSetting ()
. withCalculateIntervalMinutes ( 15 )
. withUniqueByUserId ( true )
. withAdditionalScopes ([
new Gs2Ranking . model . Scope ()
. withName ( "weekly" )
. withTargetDays ( 7 ),
new Gs2Ranking . model . Scope ()
. withName ( "monthly" )
. withTargetDays ( 30 ),
]))
. withEntryPeriodEventId ( null )
. withAccessPeriodEventId ( null )
. withSum ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . update_category_model_master (
ranking . UpdateCategoryModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_description ( 'description1' )
. with_metadata ( 'CATEGORY_0001' )
. with_minimum_value ( 100 )
. with_maximum_value ( 10000 )
. with_order_direction ( 'desc' )
. with_scope ( 'global' )
. with_global_ranking_setting (
ranking . GlobalRankingSetting ()
. with_calculate_interval_minutes ( 15 )
. with_unique_by_user_id ( True )
. with_additional_scopes ([
ranking . Scope ()
. with_name ( 'weekly' )
. with_target_days ( 7 ),
ranking . Scope ()
. with_name ( 'monthly' )
. with_target_days ( 30 ),
]))
. with_entry_period_event_id ( None )
. with_access_period_event_id ( None )
. with_sum ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.update_category_model_master ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
description = "description1" ,
metadata = "CATEGORY_0001" ,
minimumValue = 100 ,
maximumValue = 10000 ,
orderDirection = "desc" ,
scope = "global" ,
globalRankingSetting = {
calculateIntervalMinutes = 15 ,
uniqueByUserId = true ,
additionalScopes = {
{
name = "weekly" ,
targetDays = 7 ,
},
{
name = "monthly" ,
targetDays = 30 ,
}
},
},
entryPeriodEventId = nil ,
accessPeriodEventId = nil ,
sum = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.update_category_model_master_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
description = "description1" ,
metadata = "CATEGORY_0001" ,
minimumValue = 100 ,
maximumValue = 10000 ,
orderDirection = "desc" ,
scope = "global" ,
globalRankingSetting = {
calculateIntervalMinutes = 15 ,
uniqueByUserId = true ,
additionalScopes = {
{
name = "weekly" ,
targetDays = 7 ,
},
{
name = "monthly" ,
targetDays = 30 ,
}
},
},
entryPeriodEventId = nil ,
accessPeriodEventId = nil ,
sum = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
deleteCategoryModelMaster カテゴリモデルマスターを削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリモデル名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DeleteCategoryModelMaster (
& ranking . DeleteCategoryModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DeleteCategoryModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteCategoryModelMaster (
( new DeleteCategoryModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DeleteCategoryModelMasterRequest ;
import io.gs2.ranking.result.DeleteCategoryModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DeleteCategoryModelMasterResult result = client . deleteCategoryModelMaster (
new DeleteCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
);
CategoryModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DeleteCategoryModelMasterRequest ;
using Gs2.Gs2Ranking.Result.DeleteCategoryModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DeleteCategoryModelMasterResult > asyncResult = null ;
yield return client . DeleteCategoryModelMaster (
new Gs2 . Gs2Ranking . Request . DeleteCategoryModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . deleteCategoryModelMaster (
new Gs2Ranking . DeleteCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . delete_category_model_master (
ranking . DeleteCategoryModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.delete_category_model_master ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.delete_category_model_master_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
subscribe 対象ユーザーを購読
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ✓ ~ 128文字 ユーザーID targetUserId string ✓ ~ 128文字 購読するユーザーID
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . Subscribe (
& ranking . SubscribeRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
TargetUserId : pointy . String ( "user-0002" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\SubscribeRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> subscribe (
( new SubscribeRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
-> withTargetUserId ( "user-0002" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.SubscribeRequest ;
import io.gs2.ranking.result.SubscribeResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
SubscribeResult result = client . subscribe (
new SubscribeRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withTargetUserId ( "user-0002" )
);
SubscribeUser item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.SubscribeRequest ;
using Gs2.Gs2Ranking.Result.SubscribeResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . SubscribeResult > asyncResult = null ;
yield return client . Subscribe (
new Gs2 . Gs2Ranking . Request . SubscribeRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithTargetUserId ( "user-0002" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . subscribe (
new Gs2Ranking . SubscribeRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withTargetUserId ( "user-0002" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . subscribe (
ranking . SubscribeRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
. with_target_user_id ( 'user-0002' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.subscribe ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
targetUserId = "user-0002" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.subscribe_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
targetUserId = "user-0002" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
subscribeByUserId ユーザーIDを指定して対象のユーザーを購読
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID targetUserId string ✓ ~ 128文字 購読するユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . SubscribeByUserId (
& ranking . SubscribeByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
TargetUserId : pointy . String ( "user-0002" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\SubscribeByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> subscribeByUserId (
( new SubscribeByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withTargetUserId ( "user-0002" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.SubscribeByUserIdRequest ;
import io.gs2.ranking.result.SubscribeByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
SubscribeByUserIdResult result = client . subscribeByUserId (
new SubscribeByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withTargetUserId ( "user-0002" )
. withTimeOffsetToken ( null )
);
SubscribeUser item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.SubscribeByUserIdRequest ;
using Gs2.Gs2Ranking.Result.SubscribeByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . SubscribeByUserIdResult > asyncResult = null ;
yield return client . SubscribeByUserId (
new Gs2 . Gs2Ranking . Request . SubscribeByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithTargetUserId ( "user-0002" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . subscribeByUserId (
new Gs2Ranking . SubscribeByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withTargetUserId ( "user-0002" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . subscribe_by_user_id (
ranking . SubscribeByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_target_user_id ( 'user-0002' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.subscribe_by_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
targetUserId = "user-0002" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.subscribe_by_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
targetUserId = "user-0002" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
describeScores スコアの一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ✓ ~ 128文字 ユーザーID scorerUserId string ✓ ~ 128文字 ユーザーID pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数
Result 型 説明 items List<Score> スコアのリスト nextPageToken string リストの続きを取得するためのページトークン
実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeScores (
& ranking . DescribeScoresRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
ScorerUserId : pointy . String ( "user-0002" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeScoresRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeScores (
( new DescribeScoresRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
-> withScorerUserId ( "user-0002" )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeScoresRequest ;
import io.gs2.ranking.result.DescribeScoresResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeScoresResult result = client . describeScores (
new DescribeScoresRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withScorerUserId ( "user-0002" )
. withPageToken ( null )
. withLimit ( null )
);
List < Score > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeScoresRequest ;
using Gs2.Gs2Ranking.Result.DescribeScoresResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeScoresResult > asyncResult = null ;
yield return client . DescribeScores (
new Gs2 . Gs2Ranking . Request . DescribeScoresRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithScorerUserId ( "user-0002" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeScores (
new Gs2Ranking . DescribeScoresRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withScorerUserId ( "user-0002" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_scores (
ranking . DescribeScoresRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
. with_scorer_user_id ( 'user-0002' )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_scores ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
scorerUserId = "user-0002" ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_scores_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
scorerUserId = "user-0002" ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
describeScoresByUserId ユーザーIDを指定してスコアの一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID scorerUserId string ✓ ~ 128文字 ユーザーID pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数 timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 型 説明 items List<Score> スコアのリスト nextPageToken string リストの続きを取得するためのページトークン
実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeScoresByUserId (
& ranking . DescribeScoresByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
ScorerUserId : pointy . String ( "user-0002" ),
PageToken : nil ,
Limit : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeScoresByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeScoresByUserId (
( new DescribeScoresByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withScorerUserId ( "user-0002" )
-> withPageToken ( null )
-> withLimit ( null )
-> withTimeOffsetToken ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeScoresByUserIdRequest ;
import io.gs2.ranking.result.DescribeScoresByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeScoresByUserIdResult result = client . describeScoresByUserId (
new DescribeScoresByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withScorerUserId ( "user-0002" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
List < Score > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeScoresByUserIdRequest ;
using Gs2.Gs2Ranking.Result.DescribeScoresByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeScoresByUserIdResult > asyncResult = null ;
yield return client . DescribeScoresByUserId (
new Gs2 . Gs2Ranking . Request . DescribeScoresByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithScorerUserId ( "user-0002" )
. WithPageToken ( null )
. WithLimit ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeScoresByUserId (
new Gs2Ranking . DescribeScoresByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withScorerUserId ( "user-0002" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_scores_by_user_id (
ranking . DescribeScoresByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_scorer_user_id ( 'user-0002' )
. with_page_token ( None )
. with_limit ( None )
. with_time_offset_token ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_scores_by_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
scorerUserId = "user-0002" ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_scores_by_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
scorerUserId = "user-0002" ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
getScore スコアを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ✓ ~ 128文字 ユーザーID scorerUserId string ✓ ~ 128文字 ユーザーID uniqueId string ✓ “0” ~ 36文字 スコアのユニークID
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetScore (
& ranking . GetScoreRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
ScorerUserId : pointy . String ( "user-0002" ),
UniqueId : pointy . String ( "unique-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetScoreRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getScore (
( new GetScoreRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
-> withScorerUserId ( "user-0002" )
-> withUniqueId ( "unique-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetScoreRequest ;
import io.gs2.ranking.result.GetScoreResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetScoreResult result = client . getScore (
new GetScoreRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withScorerUserId ( "user-0002" )
. withUniqueId ( "unique-0001" )
);
Score item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetScoreRequest ;
using Gs2.Gs2Ranking.Result.GetScoreResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetScoreResult > asyncResult = null ;
yield return client . GetScore (
new Gs2 . Gs2Ranking . Request . GetScoreRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithScorerUserId ( "user-0002" )
. WithUniqueId ( "unique-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getScore (
new Gs2Ranking . GetScoreRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withScorerUserId ( "user-0002" )
. withUniqueId ( "unique-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_score (
ranking . GetScoreRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
. with_scorer_user_id ( 'user-0002' )
. with_unique_id ( 'unique-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_score ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
scorerUserId = "user-0002" ,
uniqueId = "unique-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_score_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
scorerUserId = "user-0002" ,
uniqueId = "unique-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
getScoreByUserId ユーザーIDを指定してスコアを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID scorerUserId string ✓ ~ 128文字 ユーザーID uniqueId string ✓ “0” ~ 36文字 スコアのユニークID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetScoreByUserId (
& ranking . GetScoreByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
ScorerUserId : pointy . String ( "user-0002" ),
UniqueId : pointy . String ( "unique-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetScoreByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getScoreByUserId (
( new GetScoreByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withScorerUserId ( "user-0002" )
-> withUniqueId ( "unique-0001" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetScoreByUserIdRequest ;
import io.gs2.ranking.result.GetScoreByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetScoreByUserIdResult result = client . getScoreByUserId (
new GetScoreByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withScorerUserId ( "user-0002" )
. withUniqueId ( "unique-0001" )
. withTimeOffsetToken ( null )
);
Score item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetScoreByUserIdRequest ;
using Gs2.Gs2Ranking.Result.GetScoreByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetScoreByUserIdResult > asyncResult = null ;
yield return client . GetScoreByUserId (
new Gs2 . Gs2Ranking . Request . GetScoreByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithScorerUserId ( "user-0002" )
. WithUniqueId ( "unique-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getScoreByUserId (
new Gs2Ranking . GetScoreByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withScorerUserId ( "user-0002" )
. withUniqueId ( "unique-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_score_by_user_id (
ranking . GetScoreByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_scorer_user_id ( 'user-0002' )
. with_unique_id ( 'unique-0001' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_score_by_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
scorerUserId = "user-0002" ,
uniqueId = "unique-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_score_by_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
scorerUserId = "user-0002" ,
uniqueId = "unique-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
describeRankings ランキングを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ~ 128文字 ユーザーID additionalScopeName string ~ 128文字 スコープ名 startIndex long ~ 9223372036854775805 ランキングの取得を開始するインデックス pageToken string ~ 4096文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数
Result 型 説明 items List<Ranking> ランキングのリスト nextPageToken string リストの続きを取得するためのページトークン
実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeRankings (
& ranking . DescribeRankingsRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
AdditionalScopeName : nil ,
StartIndex : pointy . Int64 ( 0 ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeRankingsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeRankings (
( new DescribeRankingsRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
-> withAdditionalScopeName ( null )
-> withStartIndex ( 0 )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeRankingsRequest ;
import io.gs2.ranking.result.DescribeRankingsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeRankingsResult result = client . describeRankings (
new DescribeRankingsRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withAdditionalScopeName ( null )
. withStartIndex ( 0L )
. withPageToken ( null )
. withLimit ( null )
);
List < Ranking > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeRankingsRequest ;
using Gs2.Gs2Ranking.Result.DescribeRankingsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeRankingsResult > asyncResult = null ;
yield return client . DescribeRankings (
new Gs2 . Gs2Ranking . Request . DescribeRankingsRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithAdditionalScopeName ( null )
. WithStartIndex ( 0L )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeRankings (
new Gs2Ranking . DescribeRankingsRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withAdditionalScopeName ( null )
. withStartIndex ( 0 )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_rankings (
ranking . DescribeRankingsRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
. with_additional_scope_name ( None )
. with_start_index ( 0 )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_rankings ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
additionalScopeName = nil ,
startIndex = 0 ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_rankings_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
additionalScopeName = nil ,
startIndex = 0 ,
pageToken = nil ,
limit = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
describeRankingssByUserId ユーザIDを指定してランキングを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ~ 128文字 ユーザーID additionalScopeName string ~ 128文字 スコープ名 startIndex long ~ 9223372036854775805 ランキングの取得を開始するインデックス pageToken string ~ 4096文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数 timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 型 説明 items List<Ranking> ランキングのリスト nextPageToken string リストの続きを取得するためのページトークン
実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeRankingssByUserId (
& ranking . DescribeRankingssByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
AdditionalScopeName : nil ,
StartIndex : pointy . Int64 ( 0 ),
PageToken : nil ,
Limit : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeRankingssByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeRankingssByUserId (
( new DescribeRankingssByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withAdditionalScopeName ( null )
-> withStartIndex ( 0 )
-> withPageToken ( null )
-> withLimit ( null )
-> withTimeOffsetToken ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeRankingssByUserIdRequest ;
import io.gs2.ranking.result.DescribeRankingssByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeRankingssByUserIdResult result = client . describeRankingssByUserId (
new DescribeRankingssByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withAdditionalScopeName ( null )
. withStartIndex ( 0L )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
List < Ranking > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeRankingssByUserIdRequest ;
using Gs2.Gs2Ranking.Result.DescribeRankingssByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeRankingssByUserIdResult > asyncResult = null ;
yield return client . DescribeRankingssByUserId (
new Gs2 . Gs2Ranking . Request . DescribeRankingssByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithAdditionalScopeName ( null )
. WithStartIndex ( 0L )
. WithPageToken ( null )
. WithLimit ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeRankingssByUserId (
new Gs2Ranking . DescribeRankingssByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withAdditionalScopeName ( null )
. withStartIndex ( 0 )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_rankingss_by_user_id (
ranking . DescribeRankingssByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_additional_scope_name ( None )
. with_start_index ( 0 )
. with_page_token ( None )
. with_limit ( None )
. with_time_offset_token ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_rankingss_by_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
additionalScopeName = nil ,
startIndex = 0 ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_rankingss_by_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
additionalScopeName = nil ,
startIndex = 0 ,
pageToken = nil ,
limit = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
describeNearRankings 指定したスコア付近のランキングを取得
このAPIはグローバルランキングのときのみ使用できます
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 additionalScopeName string ~ 128文字 スコープ名 score long ✓ ~ 9223372036854775805 スコア
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeNearRankings (
& ranking . DescribeNearRankingsRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AdditionalScopeName : nil ,
Score : pointy . Int64 ( 1000 ),
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeNearRankingsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeNearRankings (
( new DescribeNearRankingsRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAdditionalScopeName ( null )
-> withScore ( 1000 )
);
$items = $result -> getItems ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeNearRankingsRequest ;
import io.gs2.ranking.result.DescribeNearRankingsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeNearRankingsResult result = client . describeNearRankings (
new DescribeNearRankingsRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAdditionalScopeName ( null )
. withScore ( 1000L )
);
List < Ranking > items = result . getItems ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeNearRankingsRequest ;
using Gs2.Gs2Ranking.Result.DescribeNearRankingsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeNearRankingsResult > asyncResult = null ;
yield return client . DescribeNearRankings (
new Gs2 . Gs2Ranking . Request . DescribeNearRankingsRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAdditionalScopeName ( null )
. WithScore ( 1000L ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeNearRankings (
new Gs2Ranking . DescribeNearRankingsRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAdditionalScopeName ( null )
. withScore ( 1000 )
);
const items = result . getItems ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_near_rankings (
ranking . DescribeNearRankingsRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_additional_scope_name ( None )
. with_score ( 1000 )
)
items = result . items
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_near_rankings ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
additionalScopeName = nil ,
score = 1000 ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_near_rankings_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
additionalScopeName = nil ,
score = 1000 ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
getRanking ランキングを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ✓ ~ 128文字 ランキングを取得するユーザーID(GS2-Schedule の期間判定に使用されます。) scorerUserId string ✓ ~ 128文字 スコアを獲得したユーザーのユーザーID uniqueId string ✓ “0” ~ 36文字 スコアのユニークID additionalScopeName string ~ 128文字 スコープ名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetRanking (
& ranking . GetRankingRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
ScorerUserId : pointy . String ( "user-0001" ),
UniqueId : pointy . String ( "unique-id" ),
AdditionalScopeName : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetRankingRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getRanking (
( new GetRankingRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
-> withScorerUserId ( "user-0001" )
-> withUniqueId ( "unique-id" )
-> withAdditionalScopeName ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetRankingRequest ;
import io.gs2.ranking.result.GetRankingResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetRankingResult result = client . getRanking (
new GetRankingRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withScorerUserId ( "user-0001" )
. withUniqueId ( "unique-id" )
. withAdditionalScopeName ( null )
);
Ranking item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetRankingRequest ;
using Gs2.Gs2Ranking.Result.GetRankingResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetRankingResult > asyncResult = null ;
yield return client . GetRanking (
new Gs2 . Gs2Ranking . Request . GetRankingRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithScorerUserId ( "user-0001" )
. WithUniqueId ( "unique-id" )
. WithAdditionalScopeName ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getRanking (
new Gs2Ranking . GetRankingRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withScorerUserId ( "user-0001" )
. withUniqueId ( "unique-id" )
. withAdditionalScopeName ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_ranking (
ranking . GetRankingRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
. with_scorer_user_id ( 'user-0001' )
. with_unique_id ( 'unique-id' )
. with_additional_scope_name ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_ranking ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
scorerUserId = "user-0001" ,
uniqueId = "unique-id" ,
additionalScopeName = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_ranking_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
scorerUserId = "user-0001" ,
uniqueId = "unique-id" ,
additionalScopeName = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
getRankingByUserId ユーザーIDを指定してランキングを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ランキングを取得するユーザーID(GS2-Schedule の期間判定に使用されます。) scorerUserId string ✓ ~ 128文字 スコアを獲得したユーザーのユーザーID uniqueId string ✓ “0” ~ 36文字 スコアのユニークID additionalScopeName string ~ 128文字 スコープ名 timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetRankingByUserId (
& ranking . GetRankingByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
ScorerUserId : pointy . String ( "user-0001" ),
UniqueId : pointy . String ( "unique-id" ),
AdditionalScopeName : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetRankingByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getRankingByUserId (
( new GetRankingByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withScorerUserId ( "user-0001" )
-> withUniqueId ( "unique-id" )
-> withAdditionalScopeName ( null )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetRankingByUserIdRequest ;
import io.gs2.ranking.result.GetRankingByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetRankingByUserIdResult result = client . getRankingByUserId (
new GetRankingByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withScorerUserId ( "user-0001" )
. withUniqueId ( "unique-id" )
. withAdditionalScopeName ( null )
. withTimeOffsetToken ( null )
);
Ranking item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetRankingByUserIdRequest ;
using Gs2.Gs2Ranking.Result.GetRankingByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetRankingByUserIdResult > asyncResult = null ;
yield return client . GetRankingByUserId (
new Gs2 . Gs2Ranking . Request . GetRankingByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithScorerUserId ( "user-0001" )
. WithUniqueId ( "unique-id" )
. WithAdditionalScopeName ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getRankingByUserId (
new Gs2Ranking . GetRankingByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withScorerUserId ( "user-0001" )
. withUniqueId ( "unique-id" )
. withAdditionalScopeName ( null )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_ranking_by_user_id (
ranking . GetRankingByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_scorer_user_id ( 'user-0001' )
. with_unique_id ( 'unique-id' )
. with_additional_scope_name ( None )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_ranking_by_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
scorerUserId = "user-0001" ,
uniqueId = "unique-id" ,
additionalScopeName = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_ranking_by_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
scorerUserId = "user-0001" ,
uniqueId = "unique-id" ,
additionalScopeName = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
putScore スコアを登録
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ✓ ~ 128文字 ユーザーID score long ✓ ~ 9223372036854775805 スコア metadata string ~ 512文字 メタデータ
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . PutScore (
& ranking . PutScoreRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
Score : pointy . Int64 ( 1000 ),
Metadata : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\PutScoreRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> putScore (
( new PutScoreRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
-> withScore ( 1000 )
-> withMetadata ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.PutScoreRequest ;
import io.gs2.ranking.result.PutScoreResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
PutScoreResult result = client . putScore (
new PutScoreRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withScore ( 1000L )
. withMetadata ( null )
);
Score item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.PutScoreRequest ;
using Gs2.Gs2Ranking.Result.PutScoreResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . PutScoreResult > asyncResult = null ;
yield return client . PutScore (
new Gs2 . Gs2Ranking . Request . PutScoreRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithScore ( 1000L )
. WithMetadata ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . putScore (
new Gs2Ranking . PutScoreRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withScore ( 1000 )
. withMetadata ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . put_score (
ranking . PutScoreRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
. with_score ( 1000 )
. with_metadata ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.put_score ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
score = 1000 ,
metadata = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.put_score_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
score = 1000 ,
metadata = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
putScoreByUserId ユーザーIDを指定してスコアを登録
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID score long ✓ ~ 9223372036854775805 スコア metadata string ~ 512文字 メタデータ timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . PutScoreByUserId (
& ranking . PutScoreByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
Score : pointy . Int64 ( 1000 ),
Metadata : nil ,
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\PutScoreByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> putScoreByUserId (
( new PutScoreByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withScore ( 1000 )
-> withMetadata ( null )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.PutScoreByUserIdRequest ;
import io.gs2.ranking.result.PutScoreByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
PutScoreByUserIdResult result = client . putScoreByUserId (
new PutScoreByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withScore ( 1000L )
. withMetadata ( null )
. withTimeOffsetToken ( null )
);
Score item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.PutScoreByUserIdRequest ;
using Gs2.Gs2Ranking.Result.PutScoreByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . PutScoreByUserIdResult > asyncResult = null ;
yield return client . PutScoreByUserId (
new Gs2 . Gs2Ranking . Request . PutScoreByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithScore ( 1000L )
. WithMetadata ( null )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . putScoreByUserId (
new Gs2Ranking . PutScoreByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withScore ( 1000 )
. withMetadata ( null )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . put_score_by_user_id (
ranking . PutScoreByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_score ( 1000 )
. with_metadata ( None )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.put_score_by_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
score = 1000 ,
metadata = nil ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.put_score_by_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
score = 1000 ,
metadata = nil ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
calcRanking ランキングの計算処理の強制実行
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 additionalScopeName string ~ 128文字 追加のスコープ
Result 型 説明 processing bool 非同期処理で集計処理が継続中か
実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . CalcRanking (
& ranking . CalcRankingRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AdditionalScopeName : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
processing := result . Processing
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\CalcRankingRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> calcRanking (
( new CalcRankingRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAdditionalScopeName ( null )
);
$processing = $result -> getProcessing ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.CalcRankingRequest ;
import io.gs2.ranking.result.CalcRankingResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
CalcRankingResult result = client . calcRanking (
new CalcRankingRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAdditionalScopeName ( null )
);
boolean processing = result . getProcessing ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.CalcRankingRequest ;
using Gs2.Gs2Ranking.Result.CalcRankingResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . CalcRankingResult > asyncResult = null ;
yield return client . CalcRanking (
new Gs2 . Gs2Ranking . Request . CalcRankingRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAdditionalScopeName ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var processing = result . Processing ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . calcRanking (
new Gs2Ranking . CalcRankingRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAdditionalScopeName ( null )
);
const processing = result . getProcessing ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . calc_ranking (
ranking . CalcRankingRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_additional_scope_name ( None )
)
processing = result . processing
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.calc_ranking ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
additionalScopeName = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
processing = result.processing ;
client = gs2 ( 'ranking' )
api_result_handler = client.calc_ranking_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
additionalScopeName = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
processing = result.processing ;
exportMaster 現在有効なランキング設定のマスターデータをエクスポート
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . ExportMaster (
& ranking . ExportMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\ExportMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> exportMaster (
( new ExportMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.ExportMasterRequest ;
import io.gs2.ranking.result.ExportMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
ExportMasterResult result = client . exportMaster (
new ExportMasterRequest ()
. withNamespaceName ( "namespace1" )
);
CurrentRankingMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.ExportMasterRequest ;
using Gs2.Gs2Ranking.Result.ExportMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . ExportMasterResult > asyncResult = null ;
yield return client . ExportMaster (
new Gs2 . Gs2Ranking . Request . ExportMasterRequest ()
. WithNamespaceName ( "namespace1" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . exportMaster (
new Gs2Ranking . ExportMasterRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . export_master (
ranking . ExportMasterRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.export_master ({
namespaceName = "namespace1" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.export_master_async ({
namespaceName = "namespace1" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
getCurrentRankingMaster 現在有効なランキング設定を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetCurrentRankingMaster (
& ranking . GetCurrentRankingMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetCurrentRankingMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getCurrentRankingMaster (
( new GetCurrentRankingMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetCurrentRankingMasterRequest ;
import io.gs2.ranking.result.GetCurrentRankingMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetCurrentRankingMasterResult result = client . getCurrentRankingMaster (
new GetCurrentRankingMasterRequest ()
. withNamespaceName ( "namespace1" )
);
CurrentRankingMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetCurrentRankingMasterRequest ;
using Gs2.Gs2Ranking.Result.GetCurrentRankingMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetCurrentRankingMasterResult > asyncResult = null ;
yield return client . GetCurrentRankingMaster (
new Gs2 . Gs2Ranking . Request . GetCurrentRankingMasterRequest ()
. WithNamespaceName ( "namespace1" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getCurrentRankingMaster (
new Gs2Ranking . GetCurrentRankingMasterRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_current_ranking_master (
ranking . GetCurrentRankingMasterRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_current_ranking_master ({
namespaceName = "namespace1" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_current_ranking_master_async ({
namespaceName = "namespace1" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
updateCurrentRankingMaster 現在有効なランキング設定を更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 settings string ✓ ~ 5242880文字 マスターデータ
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . UpdateCurrentRankingMaster (
& ranking . UpdateCurrentRankingMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Settings : pointy . String ( "{\n \"version\": \"2019-09-17\",\n \"categoryModels\": [\n {\n \"name\": \"category-0001\",\n \"orderDirection\": \"asc\",\n \"scope\": \"global\",\n \"uniqueByUserId\": false,\n \"sum\": false,\n \"calculateFixedTimingHour\": -1,\n \"calculateFixedTimingMinute\": 0,\n \"calculateIntervalMinutes\": 15,\n \"additionalScopes\": [\n {\n \"name\": \"daily\",\n \"targetDays\": 1\n },\n {\n \"name\": \"weekly\",\n \"targetDays\": 7\n }\n ],\n \"ignoreUserIds\": []\n },\n {\n \"name\": \"category-0002\",\n \"metadata\": \"CATEGORY_0002\",\n \"minimumValue\": 1000,\n \"maximumValue\": 100000,\n \"orderDirection\": \"asc\",\n \"scope\": \"scoped\",\n \"uniqueByUserId\": true,\n \"sum\": false,\n \"calculateFixedTimingHour\": -1,\n \"calculateFixedTimingMinute\": 0,\n \"calculateIntervalMinutes\": 60,\n \"additionalScopes\": [],\n \"ignoreUserIds\": []\n }\n ]\n}" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\UpdateCurrentRankingMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateCurrentRankingMaster (
( new UpdateCurrentRankingMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withSettings ( "{ \n \" version \" : \" 2019-09-17 \" , \n \" categoryModels \" : [ \n { \n \" name \" : \" category-0001 \" , \n \" orderDirection \" : \" asc \" , \n \" scope \" : \" global \" , \n \" uniqueByUserId \" : false, \n \" sum \" : false, \n \" calculateFixedTimingHour \" : -1, \n \" calculateFixedTimingMinute \" : 0, \n \" calculateIntervalMinutes \" : 15, \n \" additionalScopes \" : [ \n { \n \" name \" : \" daily \" , \n \" targetDays \" : 1 \n }, \n { \n \" name \" : \" weekly \" , \n \" targetDays \" : 7 \n } \n ], \n \" ignoreUserIds \" : [] \n }, \n { \n \" name \" : \" category-0002 \" , \n \" metadata \" : \" CATEGORY_0002 \" , \n \" minimumValue \" : 1000, \n \" maximumValue \" : 100000, \n \" orderDirection \" : \" asc \" , \n \" scope \" : \" scoped \" , \n \" uniqueByUserId \" : true, \n \" sum \" : false, \n \" calculateFixedTimingHour \" : -1, \n \" calculateFixedTimingMinute \" : 0, \n \" calculateIntervalMinutes \" : 60, \n \" additionalScopes \" : [], \n \" ignoreUserIds \" : [] \n } \n ] \n }" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.UpdateCurrentRankingMasterRequest ;
import io.gs2.ranking.result.UpdateCurrentRankingMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
UpdateCurrentRankingMasterResult result = client . updateCurrentRankingMaster (
new UpdateCurrentRankingMasterRequest ()
. withNamespaceName ( "namespace1" )
. withSettings ( "{\n \"version\": \"2019-09-17\",\n \"categoryModels\": [\n {\n \"name\": \"category-0001\",\n \"orderDirection\": \"asc\",\n \"scope\": \"global\",\n \"uniqueByUserId\": false,\n \"sum\": false,\n \"calculateFixedTimingHour\": -1,\n \"calculateFixedTimingMinute\": 0,\n \"calculateIntervalMinutes\": 15,\n \"additionalScopes\": [\n {\n \"name\": \"daily\",\n \"targetDays\": 1\n },\n {\n \"name\": \"weekly\",\n \"targetDays\": 7\n }\n ],\n \"ignoreUserIds\": []\n },\n {\n \"name\": \"category-0002\",\n \"metadata\": \"CATEGORY_0002\",\n \"minimumValue\": 1000,\n \"maximumValue\": 100000,\n \"orderDirection\": \"asc\",\n \"scope\": \"scoped\",\n \"uniqueByUserId\": true,\n \"sum\": false,\n \"calculateFixedTimingHour\": -1,\n \"calculateFixedTimingMinute\": 0,\n \"calculateIntervalMinutes\": 60,\n \"additionalScopes\": [],\n \"ignoreUserIds\": []\n }\n ]\n}" )
);
CurrentRankingMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.UpdateCurrentRankingMasterRequest ;
using Gs2.Gs2Ranking.Result.UpdateCurrentRankingMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . UpdateCurrentRankingMasterResult > asyncResult = null ;
yield return client . UpdateCurrentRankingMaster (
new Gs2 . Gs2Ranking . Request . UpdateCurrentRankingMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithSettings ( "{\n \"version\": \"2019-09-17\",\n \"categoryModels\": [\n {\n \"name\": \"category-0001\",\n \"orderDirection\": \"asc\",\n \"scope\": \"global\",\n \"uniqueByUserId\": false,\n \"sum\": false,\n \"calculateFixedTimingHour\": -1,\n \"calculateFixedTimingMinute\": 0,\n \"calculateIntervalMinutes\": 15,\n \"additionalScopes\": [\n {\n \"name\": \"daily\",\n \"targetDays\": 1\n },\n {\n \"name\": \"weekly\",\n \"targetDays\": 7\n }\n ],\n \"ignoreUserIds\": []\n },\n {\n \"name\": \"category-0002\",\n \"metadata\": \"CATEGORY_0002\",\n \"minimumValue\": 1000,\n \"maximumValue\": 100000,\n \"orderDirection\": \"asc\",\n \"scope\": \"scoped\",\n \"uniqueByUserId\": true,\n \"sum\": false,\n \"calculateFixedTimingHour\": -1,\n \"calculateFixedTimingMinute\": 0,\n \"calculateIntervalMinutes\": 60,\n \"additionalScopes\": [],\n \"ignoreUserIds\": []\n }\n ]\n}" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . updateCurrentRankingMaster (
new Gs2Ranking . UpdateCurrentRankingMasterRequest ()
. withNamespaceName ( "namespace1" )
. withSettings ( "{\n \"version\": \"2019-09-17\",\n \"categoryModels\": [\n {\n \"name\": \"category-0001\",\n \"orderDirection\": \"asc\",\n \"scope\": \"global\",\n \"uniqueByUserId\": false,\n \"sum\": false,\n \"calculateFixedTimingHour\": -1,\n \"calculateFixedTimingMinute\": 0,\n \"calculateIntervalMinutes\": 15,\n \"additionalScopes\": [\n {\n \"name\": \"daily\",\n \"targetDays\": 1\n },\n {\n \"name\": \"weekly\",\n \"targetDays\": 7\n }\n ],\n \"ignoreUserIds\": []\n },\n {\n \"name\": \"category-0002\",\n \"metadata\": \"CATEGORY_0002\",\n \"minimumValue\": 1000,\n \"maximumValue\": 100000,\n \"orderDirection\": \"asc\",\n \"scope\": \"scoped\",\n \"uniqueByUserId\": true,\n \"sum\": false,\n \"calculateFixedTimingHour\": -1,\n \"calculateFixedTimingMinute\": 0,\n \"calculateIntervalMinutes\": 60,\n \"additionalScopes\": [],\n \"ignoreUserIds\": []\n }\n ]\n}" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . update_current_ranking_master (
ranking . UpdateCurrentRankingMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_settings ( '{ \n "version": "2019-09-17", \n "categoryModels": [ \n { \n "name": "category-0001", \n "orderDirection": "asc", \n "scope": "global", \n "uniqueByUserId": false, \n "sum": false, \n "calculateFixedTimingHour": -1, \n "calculateFixedTimingMinute": 0, \n "calculateIntervalMinutes": 15, \n "additionalScopes": [ \n { \n "name": "daily", \n "targetDays": 1 \n }, \n { \n "name": "weekly", \n "targetDays": 7 \n } \n ], \n "ignoreUserIds": [] \n }, \n { \n "name": "category-0002", \n "metadata": "CATEGORY_0002", \n "minimumValue": 1000, \n "maximumValue": 100000, \n "orderDirection": "asc", \n "scope": "scoped", \n "uniqueByUserId": true, \n "sum": false, \n "calculateFixedTimingHour": -1, \n "calculateFixedTimingMinute": 0, \n "calculateIntervalMinutes": 60, \n "additionalScopes": [], \n "ignoreUserIds": [] \n } \n ] \n }' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.update_current_ranking_master ({
namespaceName = "namespace1" ,
settings = "{ \n " version ": " 2019 - 09 - 17 ", \n " categoryModels ": [ \n { \n " name ": " category - 0001 ", \n " orderDirection ": " asc ", \n " scope ": " global ", \n " uniqueByUserId ": false, \n " sum ": false, \n " calculateFixedTimingHour ": -1, \n " calculateFixedTimingMinute ": 0, \n " calculateIntervalMinutes ": 15, \n " additionalScopes ": [ \n { \n " name ": " daily ", \n " targetDays ": 1 \n }, \n { \n " name ": " weekly ", \n " targetDays ": 7 \n } \n ], \n " ignoreUserIds ": [] \n }, \n { \n " name ": " category - 0002 ", \n " metadata ": " CATEGORY_0002 ", \n " minimumValue ": 1000, \n " maximumValue ": 100000, \n " orderDirection ": " asc ", \n " scope ": " scoped ", \n " uniqueByUserId ": true, \n " sum ": false, \n " calculateFixedTimingHour ": -1, \n " calculateFixedTimingMinute ": 0, \n " calculateIntervalMinutes ": 60, \n " additionalScopes ": [], \n " ignoreUserIds ": [] \n } \n ] \n }" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.update_current_ranking_master_async ({
namespaceName = "namespace1" ,
settings = "{ \n " version ": " 2019 - 09 - 17 ", \n " categoryModels ": [ \n { \n " name ": " category - 0001 ", \n " orderDirection ": " asc ", \n " scope ": " global ", \n " uniqueByUserId ": false, \n " sum ": false, \n " calculateFixedTimingHour ": -1, \n " calculateFixedTimingMinute ": 0, \n " calculateIntervalMinutes ": 15, \n " additionalScopes ": [ \n { \n " name ": " daily ", \n " targetDays ": 1 \n }, \n { \n " name ": " weekly ", \n " targetDays ": 7 \n } \n ], \n " ignoreUserIds ": [] \n }, \n { \n " name ": " category - 0002 ", \n " metadata ": " CATEGORY_0002 ", \n " minimumValue ": 1000, \n " maximumValue ": 100000, \n " orderDirection ": " asc ", \n " scope ": " scoped ", \n " uniqueByUserId ": true, \n " sum ": false, \n " calculateFixedTimingHour ": -1, \n " calculateFixedTimingMinute ": 0, \n " calculateIntervalMinutes ": 60, \n " additionalScopes ": [], \n " ignoreUserIds ": [] \n } \n ] \n }" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
updateCurrentRankingMasterFromGitHub 現在有効なランキング設定を更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 checkoutSetting GitHubCheckoutSetting ✓ GitHubからマスターデータをチェックアウトしてくる設定
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . UpdateCurrentRankingMasterFromGitHub (
& ranking . UpdateCurrentRankingMasterFromGitHubRequest {
NamespaceName : pointy . String ( "namespace1" ),
CheckoutSetting : & ranking . GitHubCheckoutSetting {
ApiKeyId : pointy . String ( "$gitHubApiKey1.apiKeyId" ),
RepositoryName : pointy . String ( "gs2io/master-data" ),
SourcePath : pointy . String ( "path/to/file.json" ),
ReferenceType : pointy . String ( "branch" ),
BranchName : pointy . String ( "develop" ),
},
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\UpdateCurrentRankingMasterFromGitHubRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateCurrentRankingMasterFromGitHub (
( new UpdateCurrentRankingMasterFromGitHubRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCheckoutSetting (( new GitHubCheckoutSetting ())
-> withApiKeyId ( self :: $gitHubApiKey1 . apiKeyId )
-> withRepositoryName ( "gs2io/master-data" )
-> withSourcePath ( "path/to/file.json" )
-> withReferenceType ( "branch" )
-> withBranchName ( "develop" )
)
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.UpdateCurrentRankingMasterFromGitHubRequest ;
import io.gs2.ranking.result.UpdateCurrentRankingMasterFromGitHubResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
UpdateCurrentRankingMasterFromGitHubResult result = client . updateCurrentRankingMasterFromGitHub (
new UpdateCurrentRankingMasterFromGitHubRequest ()
. withNamespaceName ( "namespace1" )
. withCheckoutSetting ( new GitHubCheckoutSetting ()
. withApiKeyId ( "$gitHubApiKey1.apiKeyId" )
. withRepositoryName ( "gs2io/master-data" )
. withSourcePath ( "path/to/file.json" )
. withReferenceType ( "branch" )
. withBranchName ( "develop" )
)
);
CurrentRankingMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.UpdateCurrentRankingMasterFromGitHubRequest ;
using Gs2.Gs2Ranking.Result.UpdateCurrentRankingMasterFromGitHubResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . UpdateCurrentRankingMasterFromGitHubResult > asyncResult = null ;
yield return client . UpdateCurrentRankingMasterFromGitHub (
new Gs2 . Gs2Ranking . Request . UpdateCurrentRankingMasterFromGitHubRequest ()
. WithNamespaceName ( "namespace1" )
. WithCheckoutSetting ( new Gs2 . Gs2Ranking . Model . GitHubCheckoutSetting ()
. WithApiKeyId ( "$gitHubApiKey1.apiKeyId" )
. WithRepositoryName ( "gs2io/master-data" )
. WithSourcePath ( "path/to/file.json" )
. WithReferenceType ( "branch" )
. WithBranchName ( "develop" )
),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . updateCurrentRankingMasterFromGitHub (
new Gs2Ranking . UpdateCurrentRankingMasterFromGitHubRequest ()
. withNamespaceName ( "namespace1" )
. withCheckoutSetting ( new Gs2Ranking . model . GitHubCheckoutSetting ()
. withApiKeyId ( "$gitHubApiKey1.apiKeyId" )
. withRepositoryName ( "gs2io/master-data" )
. withSourcePath ( "path/to/file.json" )
. withReferenceType ( "branch" )
. withBranchName ( "develop" )
)
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . update_current_ranking_master_from_git_hub (
ranking . UpdateCurrentRankingMasterFromGitHubRequest ()
. with_namespace_name ( self . hash1 )
. with_checkout_setting ( ranking . GitHubCheckoutSetting ()
. with_api_key_id ( self . git_hub_api_key1 . api_key_id )
. with_repository_name ( 'gs2io/master-data' )
. with_source_path ( 'path/to/file.json' )
. with_reference_type ( 'branch' )
. with_branch_name ( 'develop' )
)
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.update_current_ranking_master_from_git_hub ({
namespaceName = "namespace1" ,
checkoutSetting = {
api_key_id = "$gitHubApiKey1.apiKeyId" ,
repository_name = "gs2io/master-data" ,
source_path = "path/to/file.json" ,
reference_type = "branch" ,
branch_name = "develop" ,
},
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.update_current_ranking_master_from_git_hub_async ({
namespaceName = "namespace1" ,
checkoutSetting = {
api_key_id = "$gitHubApiKey1.apiKeyId" ,
repository_name = "gs2io/master-data" ,
source_path = "path/to/file.json" ,
reference_type = "branch" ,
branch_name = "develop" ,
},
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
getSubscribe 購読を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ✓ ~ 128文字 ユーザーID targetUserId string ✓ ~ 128文字 ユーザーID
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetSubscribe (
& ranking . GetSubscribeRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
TargetUserId : pointy . String ( "user-0002" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetSubscribeRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getSubscribe (
( new GetSubscribeRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
-> withTargetUserId ( "user-0002" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetSubscribeRequest ;
import io.gs2.ranking.result.GetSubscribeResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetSubscribeResult result = client . getSubscribe (
new GetSubscribeRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withTargetUserId ( "user-0002" )
);
SubscribeUser item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetSubscribeRequest ;
using Gs2.Gs2Ranking.Result.GetSubscribeResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetSubscribeResult > asyncResult = null ;
yield return client . GetSubscribe (
new Gs2 . Gs2Ranking . Request . GetSubscribeRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithTargetUserId ( "user-0002" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getSubscribe (
new Gs2Ranking . GetSubscribeRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withTargetUserId ( "user-0002" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_subscribe (
ranking . GetSubscribeRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
. with_target_user_id ( 'user-0002' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_subscribe ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
targetUserId = "user-0002" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_subscribe_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
targetUserId = "user-0002" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
getSubscribeByUserId ユーザIDを指定して購読を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID targetUserId string ✓ ~ 128文字 ユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . GetSubscribeByUserId (
& ranking . GetSubscribeByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
TargetUserId : pointy . String ( "user-0002" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\GetSubscribeByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getSubscribeByUserId (
( new GetSubscribeByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withTargetUserId ( "user-0002" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.GetSubscribeByUserIdRequest ;
import io.gs2.ranking.result.GetSubscribeByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
GetSubscribeByUserIdResult result = client . getSubscribeByUserId (
new GetSubscribeByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withTargetUserId ( "user-0002" )
. withTimeOffsetToken ( null )
);
SubscribeUser item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.GetSubscribeByUserIdRequest ;
using Gs2.Gs2Ranking.Result.GetSubscribeByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . GetSubscribeByUserIdResult > asyncResult = null ;
yield return client . GetSubscribeByUserId (
new Gs2 . Gs2Ranking . Request . GetSubscribeByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithTargetUserId ( "user-0002" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . getSubscribeByUserId (
new Gs2Ranking . GetSubscribeByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withTargetUserId ( "user-0002" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . get_subscribe_by_user_id (
ranking . GetSubscribeByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_target_user_id ( 'user-0002' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.get_subscribe_by_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
targetUserId = "user-0002" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.get_subscribe_by_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
targetUserId = "user-0002" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
unsubscribe 購読を解除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ✓ ~ 128文字 ユーザーID targetUserId string ✓ ~ 128文字 購読解除するユーザーID
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . Unsubscribe (
& ranking . UnsubscribeRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
TargetUserId : pointy . String ( "user-0002" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\UnsubscribeRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> unsubscribe (
( new UnsubscribeRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
-> withTargetUserId ( "user-0002" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.UnsubscribeRequest ;
import io.gs2.ranking.result.UnsubscribeResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
UnsubscribeResult result = client . unsubscribe (
new UnsubscribeRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withTargetUserId ( "user-0002" )
);
SubscribeUser item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.UnsubscribeRequest ;
using Gs2.Gs2Ranking.Result.UnsubscribeResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . UnsubscribeResult > asyncResult = null ;
yield return client . Unsubscribe (
new Gs2 . Gs2Ranking . Request . UnsubscribeRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" )
. WithTargetUserId ( "user-0002" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . unsubscribe (
new Gs2Ranking . UnsubscribeRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
. withTargetUserId ( "user-0002" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . unsubscribe (
ranking . UnsubscribeRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
. with_target_user_id ( 'user-0002' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.unsubscribe ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
targetUserId = "user-0002" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.unsubscribe_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
targetUserId = "user-0002" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
unsubscribeByUserId ユーザIDを指定して購読を解除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID targetUserId string ✓ ~ 128文字 購読解除するユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . UnsubscribeByUserId (
& ranking . UnsubscribeByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
TargetUserId : pointy . String ( "user-0002" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\UnsubscribeByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> unsubscribeByUserId (
( new UnsubscribeByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withTargetUserId ( "user-0002" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.UnsubscribeByUserIdRequest ;
import io.gs2.ranking.result.UnsubscribeByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
UnsubscribeByUserIdResult result = client . unsubscribeByUserId (
new UnsubscribeByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withTargetUserId ( "user-0002" )
. withTimeOffsetToken ( null )
);
SubscribeUser item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.UnsubscribeByUserIdRequest ;
using Gs2.Gs2Ranking.Result.UnsubscribeByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . UnsubscribeByUserIdResult > asyncResult = null ;
yield return client . UnsubscribeByUserId (
new Gs2 . Gs2Ranking . Request . UnsubscribeByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithTargetUserId ( "user-0002" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . unsubscribeByUserId (
new Gs2Ranking . UnsubscribeByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withTargetUserId ( "user-0002" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . unsubscribe_by_user_id (
ranking . UnsubscribeByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_target_user_id ( 'user-0002' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.unsubscribe_by_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
targetUserId = "user-0002" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
client = gs2 ( 'ranking' )
api_result_handler = client.unsubscribe_by_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
targetUserId = "user-0002" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
describeSubscribesByCategoryName 購読しているユーザーのユーザーIDの一覧取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 accessToken string ✓ ~ 128文字 ユーザーID
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeSubscribesByCategoryName (
& ranking . DescribeSubscribesByCategoryNameRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
AccessToken : pointy . String ( "accessToken-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeSubscribesByCategoryNameRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeSubscribesByCategoryName (
( new DescribeSubscribesByCategoryNameRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withAccessToken ( self :: $accessToken0001 )
);
$items = $result -> getItems ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeSubscribesByCategoryNameRequest ;
import io.gs2.ranking.result.DescribeSubscribesByCategoryNameResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeSubscribesByCategoryNameResult result = client . describeSubscribesByCategoryName (
new DescribeSubscribesByCategoryNameRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
);
List < SubscribeUser > items = result . getItems ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeSubscribesByCategoryNameRequest ;
using Gs2.Gs2Ranking.Result.DescribeSubscribesByCategoryNameResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeSubscribesByCategoryNameResult > asyncResult = null ;
yield return client . DescribeSubscribesByCategoryName (
new Gs2 . Gs2Ranking . Request . DescribeSubscribesByCategoryNameRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithAccessToken ( "accessToken-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeSubscribesByCategoryName (
new Gs2Ranking . DescribeSubscribesByCategoryNameRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withAccessToken ( "accessToken-0001" )
);
const items = result . getItems ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_subscribes_by_category_name (
ranking . DescribeSubscribesByCategoryNameRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_access_token ( self . access_token_0001 )
)
items = result . items
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_subscribes_by_category_name ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_subscribes_by_category_name_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
accessToken = "accessToken-0001" ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
describeSubscribesByCategoryNameAndUserId ユーザーIDを指定してそのユーザーが購読しているユーザーの一覧取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 categoryName string ✓ ~ 128文字 カテゴリ名 userId string ✓ ~ 128文字 ユーザーID timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 実装例
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script
GS2-Script(Async) import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ranking"
import "github.com/openlyinc/pointy"
session := core . Gs2RestSession {
Credential : & core . BasicGs2Credential {
ClientId : "your client id" ,
ClientSecret : "your client secret" ,
},
Region : core . ApNortheast1 ,
}
if err := session . Connect (); err != nil {
panic ( "error occurred" )
}
client := ranking . Gs2RankingRestClient {
Session : & session ,
}
result , err := client . DescribeSubscribesByCategoryNameAndUserId (
& ranking . DescribeSubscribesByCategoryNameAndUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-0001" ),
UserId : pointy . String ( "user-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Ranking\Gs2RankingRestClient ;
use Gs2\Ranking\Request\DescribeSubscribesByCategoryNameAndUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeSubscribesByCategoryNameAndUserId (
( new DescribeSubscribesByCategoryNameAndUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-0001" )
-> withUserId ( "user-0001" )
-> withTimeOffsetToken ( null )
);
$items = $result -> getItems ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.ranking.rest.Gs2RankingRestClient ;
import io.gs2.ranking.request.DescribeSubscribesByCategoryNameAndUserIdRequest ;
import io.gs2.ranking.result.DescribeSubscribesByCategoryNameAndUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2RankingRestClient client = new Gs2RankingRestClient ( session );
try {
DescribeSubscribesByCategoryNameAndUserIdResult result = client . describeSubscribesByCategoryNameAndUserId (
new DescribeSubscribesByCategoryNameAndUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
List < SubscribeUser > items = result . getItems ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Ranking.Gs2RankingRestClient ;
using Gs2.Gs2Ranking.Request.DescribeSubscribesByCategoryNameAndUserIdRequest ;
using Gs2.Gs2Ranking.Result.DescribeSubscribesByCategoryNameAndUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2RankingRestClient ( session );
AsyncResult < Gs2 . Gs2Ranking . Result . DescribeSubscribesByCategoryNameAndUserIdResult > asyncResult = null ;
yield return client . DescribeSubscribesByCategoryNameAndUserId (
new Gs2 . Gs2Ranking . Request . DescribeSubscribesByCategoryNameAndUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-0001" )
. WithUserId ( "user-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Ranking from '@/gs2/ranking' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Ranking . Gs2RankingRestClient ( session );
try {
const result = await client . describeSubscribesByCategoryNameAndUserId (
new Gs2Ranking . DescribeSubscribesByCategoryNameAndUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-0001" )
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
const items = result . getItems ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import ranking
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = ranking . Gs2RankingRestClient ( session )
try :
result = client . describe_subscribes_by_category_name_and_user_id (
ranking . DescribeSubscribesByCategoryNameAndUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-0001' )
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
items = result . items
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'ranking' )
api_result = client.describe_subscribes_by_category_name_and_user_id ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
timeOffsetToken = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
client = gs2 ( 'ranking' )
api_result_handler = client.describe_subscribes_by_category_name_and_user_id_async ({
namespaceName = "namespace1" ,
categoryName = "category-0001" ,
userId = "user-0001" ,
timeOffsetToken = nil ,
})
api_result = api_result_handler () -- Call the handler to get the result
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;