GS2-Account SDK API リファレンス モデル Namespace ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ✓ ~ 1024文字 ネームスペースGRN name string ✓ ~ 128文字 ネームスペース名 description string ~ 1024文字 説明文 changePasswordIfTakeOver bool ✓ false アカウント引き継ぎ時にパスワードを変更するか differentUserIdForLoginAndDataRetention bool ✓ false ログインに使用するユーザーIDとデータの保持に使用するユーザーIDを異なるものにする createAccountScript ScriptSetting アカウント新規作成したときに実行するスクリプト authenticationScript ScriptSetting 認証したときに実行するスクリプト createTakeOverScript ScriptSetting 引き継ぎ情報登録したときに実行するスクリプト doTakeOverScript ScriptSetting 引き継ぎ実行したときに実行するスクリプト logSetting LogSetting ログの出力設定 createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) updatedAt long ✓ 現在時刻 最終更新日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
Account ゲームプレイヤーアカウント
ゲームプレイヤーを識別するID情報のエンティティです。 ゲームプレイヤーアカウントは匿名アカウントであり、ユーザーID(UUID)とパスワード(ランダムな32文字の文字列)で構成されるため、ゲームプレイヤーはメールアドレスなどの情報を入力する必要はありません。
発行されたゲームプレイヤーアカウントは、デバイスのローカルストレージに保存しておき、次回以降ログインに使用します。
型 有効化条件 必須 デフォルト 値の制限 説明 accountId string ✓ ~ 1024文字 ゲームプレイヤーアカウントGRN userId string ✓ UUID ~ 128文字 ユーザーID password string ✓ ~ 128文字 パスワード timeOffset int ✓ 0 ~ 315360000 現在時刻に対する補正値(現在時刻を起点とした秒数) banStatuses List<BanStatus> ~ 10 items アカウントBANの情報リスト banned bool ✓ false アカウントBANされているか lastAuthenticatedAt long 最終認証時刻 (UNIX時間 単位:ミリ秒) createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
TakeOver 引継ぎ情報
引継ぎ情報とは、デバイスの機種変更やプラットフォーム間のアカウントの移動・共有時に使用する情報です。 個人を識別するユニークな文字列とパスワードで構成され、その適切な組み合わせを入力することで、Account(匿名アカウント)を取得することができます。
1つの Account に対して複数の引継ぎ情報を設定できます。 複数の引継ぎ情報を設定するにはそれぞれ異なるスロットを指定する必要があります。 スロットには0~1024を指定できますので、最大1025種類の引継ぎ情報を設定可能です。
具体的な用例としては 0 には Twitter のアカウント情報を、1 には Sign-in Apple のアカウント情報を、2 には Google のアカウント情報を保存するようにする。というような使い方が想定されています。 あくまでこの引継ぎ情報はデータホルダーであり、ソーシャルアカウントとの認証の仕組みは別途用意する必要があります。
型 有効化条件 必須 デフォルト 値の制限 説明 takeOverId string ✓ ~ 1024文字 引き継ぎ設定GRN userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 引き継ぎ用ユーザーID password string ✓ ~ 128文字 パスワード createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
各種プラットフォームID
X、Instagram、facebook などの各種プラットフォームにおけるIDを保持します。 他のプレイヤーは各種プラットフォームIDを使用して、プレイヤーを検索することができます。
Instagram のフォロワーや、facebook のフレンドをゲーム内のフレンドとしてインポートする際に、GS2-Account のアカウントを特定するために使用します。
型 有効化条件 必須 デフォルト 値の制限 説明 platformId string ✓ ~ 1024文字 各種プラットフォームID GRN userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 各種プラットフォームにおけるユーザーID createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
DataOwner データオーナーはネームスペースの設定で「ログインに使用するユーザーIDとデータの保持に使用するユーザーIDを異なるものにする」を指定した際に使用されます。 ユーザーIDとは異なるデータオーナーIDを発行し、GS2-Account の認証処理を通してアクセストークンを受け取った場合に取得できるユーザーIDはデータオーナーIDになります。
型 有効化条件 必須 デフォルト 値の制限 説明 dataOwnerId string ✓ ~ 1024文字 データオーナーGRN userId string ✓ ~ 128文字 ユーザーID name string ✓ UUID ~ 36文字 データオーナーの名前 createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
TakeOverTypeModel 引き継ぎ情報モデル
引継ぎ情報を定義するモデルです。
引継ぎ情報とは、デバイスの機種変更やプラットフォーム間のアカウントの移動・共有時に使用する情報です。 個人を識別するユニークな文字列とパスワードで構成され、その適切な組み合わせを入力することで、Account(匿名アカウント)を取得することができます。
1つの Account に対して複数の引継ぎ情報を設定できます。 複数の引継ぎ情報を設定するにはそれぞれ異なるスロットを指定する必要があります。 スロットには0~1024を指定できますので、最大1025種類の引継ぎ情報を設定可能です。
具体的な用例としては 0 には Twitter のアカウント情報を、1 には Sign-in Apple のアカウント情報を、2 には Google のアカウント情報を保存するようにする。というような使い方が想定されています。 あくまでこの引継ぎ情報はデータホルダーであり、ソーシャルアカウントとの認証の仕組みは別途用意する必要があります。
型 有効化条件 必須 デフォルト 値の制限 説明 takeOverTypeModelId string ✓ ~ 1024文字 引き継ぎ情報モデルGRN type int ✓ ~ 1024 スロット番号 metadata string ~ 2048文字 メタデータ openIdConnectSetting OpenIdConnectSetting ✓ OpenID Connect の設定
TakeOverTypeModelMaster 引き継ぎ情報モデルマスター
引継ぎ情報の定義である引き継ぎ情報モデルのマスターデータです。
引継ぎ情報とは、デバイスの機種変更やプラットフォーム間のアカウントの移動・共有時に使用する情報です。 個人を識別するユニークな文字列とパスワードで構成され、その適切な組み合わせを入力することで、Account(匿名アカウント)を取得することができます。
1つの Account に対して複数の引継ぎ情報を設定できます。 複数の引継ぎ情報を設定するにはそれぞれ異なるスロットを指定する必要があります。 スロットには0~1024を指定できますので、最大1025種類の引継ぎ情報を設定可能です。
具体的な用例としては 0 には Twitter のアカウント情報を、1 には Sign-in Apple のアカウント情報を、2 には Google のアカウント情報を保存するようにする。というような使い方が想定されています。 あくまでこの引継ぎ情報はデータホルダーであり、ソーシャルアカウントとの認証の仕組みは別途用意する必要があります。
型 有効化条件 必須 デフォルト 値の制限 説明 takeOverTypeModelId string ✓ ~ 1024文字 引き継ぎ情報モデルマスターGRN type int ✓ ~ 1024 スロット番号 description string ~ 1024文字 説明文 metadata string ~ 2048文字 メタデータ openIdConnectSetting OpenIdConnectSetting ✓ OpenID Connect の設定 createdAt long ✓ 現在時刻 作成日時 (UNIX時間 単位:ミリ秒) updatedAt long ✓ 現在時刻 最終更新日時 (UNIX時間 単位:ミリ秒) revision long 0 ~ 9223372036854775805 リビジョン
CurrentModelMaster 現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
型 有効化条件 必須 デフォルト 値の制限 説明 namespaceId string ✓ ~ 1024文字 現在有効なモデル設定GRN settings string ✓ ~ 5242880文字 マスターデータ
OpenIdConnectSetting OpenID Connect の設定
型 有効化条件 必須 デフォルト 値の制限 説明 configurationPath string ✓ ~ 1024文字 Open ID Connect 設定 URL clientId string ✓ ~ 1024文字 クライアントID clientSecret string {configurationPath} != “https://appleid.apple.com/.well-known/openid-configuration” ✓ ~ 1024文字 クライアントシークレット appleTeamId string {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” ✓ ~ 1024文字 Apple Developer チームID appleKeyId string {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” ✓ ~ 1024文字 Apple に登録済みのキーID applePrivateKeyPem string {configurationPath} == “https://appleid.apple.com/.well-known/openid-configuration” ✓ ~ 10240文字 Apple から受け取った秘密鍵 doneEndpointUrl string ~ 1024文字 認証完了時に遷移するURL
各種プラットフォームにおけるユーザー情報
型 有効化条件 必須 デフォルト 値の制限 説明 type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 各種プラットフォームにおけるユーザーID userId string ✓ ~ 128文字 ユーザーID
BanStatus アカウントBANの情報
ゲームプレイヤーアカウントに適用されたBAN(アクセス禁止)状態に関する情報を表します。 この型は、BANが適用された理由、BANの名称、およびBANの解除予定日時などの詳細情報を含みます。 BAN状態は、不正行為や規約違反など、様々な理由でアカウントに適用されることがあり、この型はその状態を管理するのに役立ちます。 システムは、この情報を基にアカウントのアクセス権限を制御し、必要に応じてアクセスの制限や解除を行います。
型 有効化条件 必須 デフォルト 値の制限 説明 name string ✓ UUID ~ 36文字 BANステータス名 reason string ✓ ~ 256文字 アカウントBANされた理由 releaseTimestamp long ✓ BANが解除される日時 (UNIX時間 単位:ミリ秒)
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 タグ
ScriptSetting スクリプト設定
GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。 このモデルは、スクリプトの実行をトリガーするための設定を保持します。
スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。 同期実行は、スクリプトの実行が完了するまで処理がブロックされます。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。
一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。 しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。
非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。 Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。
型 有効化条件 必須 デフォルト 値の制限 説明 triggerScriptId string ~ 1024文字 同期実行スクリプトの GS2-Script のスクリプトGRN doneTriggerTargetType enum { “none”, “gs2_script”, “aws” } ✓ “none” ~ 128文字 非同期スクリプトの実行方法 doneTriggerScriptId string {doneTriggerTargetType} == “gs2_script” ~ 1024文字 非同期実行スクリプトの GS2-Script のスクリプトGRN doneTriggerQueueNamespaceId string {doneTriggerTargetType} == “gs2_script” ~ 1024文字 非同期実行スクリプトを実行する GS2-JobQueue ネームスペース
doneTriggerTargetType に指定する列挙型の定義 定義 説明 none なし gs2_script GS2-Script aws Amazon EventBridge
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DescribeNamespaces (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DescribeNamespacesRequest ;
import io.gs2.account.result.DescribeNamespacesResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DescribeNamespacesRequest ;
using Gs2.Gs2Account.Result.DescribeNamespacesResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DescribeNamespacesResult > asyncResult = null ;
yield return client . DescribeNamespaces (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . describeNamespaces (
new Gs2Account . 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . describe_namespaces (
account . 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 ( 'account' )
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 ( 'account' )
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文字 説明文 changePasswordIfTakeOver bool ✓ false アカウント引き継ぎ時にパスワードを変更するか differentUserIdForLoginAndDataRetention bool ✓ false ログインに使用するユーザーIDとデータの保持に使用するユーザーIDを異なるものにする createAccountScript ScriptSetting アカウント新規作成したときに実行するスクリプト authenticationScript ScriptSetting 認証したときに実行するスクリプト createTakeOverScript ScriptSetting 引き継ぎ情報登録したときに実行するスクリプト doTakeOverScript ScriptSetting 引き継ぎ実行したときに実行するスクリプト 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreateNamespace (
& account . CreateNamespaceRequest {
Name : pointy . String ( "namespace1" ),
Description : nil ,
ChangePasswordIfTakeOver : pointy . Bool ( false ),
DifferentUserIdForLoginAndDataRetention : nil ,
CreateAccountScript : nil ,
AuthenticationScript : nil ,
CreateTakeOverScript : nil ,
DoTakeOverScript : nil ,
LogSetting : & account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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 )
-> withChangePasswordIfTakeOver ( False )
-> withDifferentUserIdForLoginAndDataRetention ( null )
-> withCreateAccountScript ( null )
-> withAuthenticationScript ( null )
-> withCreateTakeOverScript ( null )
-> withDoTakeOverScript ( null )
-> withLogSetting (( new \Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreateNamespaceRequest ;
import io.gs2.account.result.CreateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreateNamespaceResult result = client . createNamespace (
new CreateNamespaceRequest ()
. withName ( "namespace1" )
. withDescription ( null )
. withChangePasswordIfTakeOver ( false )
. withDifferentUserIdForLoginAndDataRetention ( null )
. withCreateAccountScript ( null )
. withAuthenticationScript ( null )
. withCreateTakeOverScript ( null )
. withDoTakeOverScript ( null )
. withLogSetting ( new io . gs2 . account . 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreateNamespaceRequest ;
using Gs2.Gs2Account.Result.CreateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreateNamespaceResult > asyncResult = null ;
yield return client . CreateNamespace (
new Gs2 . Gs2Account . Request . CreateNamespaceRequest ()
. WithName ( "namespace1" )
. WithDescription ( null )
. WithChangePasswordIfTakeOver ( false )
. WithDifferentUserIdForLoginAndDataRetention ( null )
. WithCreateAccountScript ( null )
. WithAuthenticationScript ( null )
. WithCreateTakeOverScript ( null )
. WithDoTakeOverScript ( null )
. WithLogSetting ( new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createNamespace (
new Gs2Account . CreateNamespaceRequest ()
. withName ( "namespace1" )
. withDescription ( null )
. withChangePasswordIfTakeOver ( false )
. withDifferentUserIdForLoginAndDataRetention ( null )
. withCreateAccountScript ( null )
. withAuthenticationScript ( null )
. withCreateTakeOverScript ( null )
. withDoTakeOverScript ( null )
. withLogSetting ( new Gs2Account . 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_namespace (
account . CreateNamespaceRequest ()
. with_name ( self . hash1 )
. with_description ( None )
. with_change_password_if_take_over ( False )
. with_different_user_id_for_login_and_data_retention ( None )
. with_create_account_script ( None )
. with_authentication_script ( None )
. with_create_take_over_script ( None )
. with_do_take_over_script ( None )
. with_log_setting (
account . 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 ( 'account' )
api_result = client.create_namespace ({
name = "namespace1" ,
description = nil ,
changePasswordIfTakeOver = false ,
differentUserIdForLoginAndDataRetention = nil ,
createAccountScript = nil ,
authenticationScript = nil ,
createTakeOverScript = nil ,
doTakeOverScript = 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 ( 'account' )
api_result_handler = client.create_namespace_async ({
name = "namespace1" ,
description = nil ,
changePasswordIfTakeOver = false ,
differentUserIdForLoginAndDataRetention = nil ,
createAccountScript = nil ,
authenticationScript = nil ,
createTakeOverScript = nil ,
doTakeOverScript = 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetNamespaceStatus (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetNamespaceStatusRequest ;
import io.gs2.account.result.GetNamespaceStatusResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetNamespaceStatusRequest ;
using Gs2.Gs2Account.Result.GetNamespaceStatusResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetNamespaceStatusResult > asyncResult = null ;
yield return client . GetNamespaceStatus (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getNamespaceStatus (
new Gs2Account . GetNamespaceStatusRequest ()
. withNamespaceName ( "namespace1" )
);
const status = result . getStatus ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_namespace_status (
account . GetNamespaceStatusRequest ()
. with_namespace_name ( self . hash1 )
)
status = result . status
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
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 ( 'account' )
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetNamespace (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetNamespaceRequest ;
import io.gs2.account.result.GetNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetNamespaceRequest ;
using Gs2.Gs2Account.Result.GetNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetNamespaceResult > asyncResult = null ;
yield return client . GetNamespace (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getNamespace (
new Gs2Account . GetNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_namespace (
account . GetNamespaceRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
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 ( 'account' )
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文字 説明文 changePasswordIfTakeOver bool ✓ false アカウント引き継ぎ時にパスワードを変更するか createAccountScript ScriptSetting アカウント新規作成したときに実行するスクリプト authenticationScript ScriptSetting 認証したときに実行するスクリプト createTakeOverScript ScriptSetting 引き継ぎ情報登録したときに実行するスクリプト doTakeOverScript ScriptSetting 引き継ぎ実行したときに実行するスクリプト 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . UpdateNamespace (
& account . UpdateNamespaceRequest {
NamespaceName : pointy . String ( "namespace1" ),
Description : pointy . String ( "description1" ),
ChangePasswordIfTakeOver : pointy . Bool ( true ),
CreateAccountScript : & account . ScriptSetting {
TriggerScriptId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1001" ),
DoneTriggerScriptId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002" ),
},
AuthenticationScript : & account . ScriptSetting {
TriggerScriptId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003" ),
DoneTriggerScriptId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004" ),
},
CreateTakeOverScript : & account . ScriptSetting {
TriggerScriptId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005" ),
DoneTriggerScriptId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006" ),
},
DoTakeOverScript : & account . ScriptSetting {
TriggerScriptId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007" ),
DoneTriggerScriptId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008" ),
},
LogSetting : & account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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" )
-> withChangePasswordIfTakeOver ( True )
-> withCreateAccountScript (( new \Gs2\Account\Model\ScriptSetting ())
-> withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script: \n amespace1:script:script-1001" )
-> withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script: \n amespace1:script:script-1002" ))
-> withAuthenticationScript (( new \Gs2\Account\Model\ScriptSetting ())
-> withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script: \n amespace1:script:script-1003" )
-> withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script: \n amespace1:script:script-1004" ))
-> withCreateTakeOverScript (( new \Gs2\Account\Model\ScriptSetting ())
-> withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script: \n amespace1:script:script-1005" )
-> withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script: \n amespace1:script:script-1006" ))
-> withDoTakeOverScript (( new \Gs2\Account\Model\ScriptSetting ())
-> withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script: \n amespace1:script:script-1007" )
-> withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script: \n amespace1:script:script-1008" ))
-> withLogSetting (( new \Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.UpdateNamespaceRequest ;
import io.gs2.account.result.UpdateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
UpdateNamespaceResult result = client . updateNamespace (
new UpdateNamespaceRequest ()
. withNamespaceName ( "namespace1" )
. withDescription ( "description1" )
. withChangePasswordIfTakeOver ( true )
. withCreateAccountScript ( new io . gs2 . account . model . ScriptSetting ()
. withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1001" )
. withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002" ))
. withAuthenticationScript ( new io . gs2 . account . model . ScriptSetting ()
. withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003" )
. withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004" ))
. withCreateTakeOverScript ( new io . gs2 . account . model . ScriptSetting ()
. withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005" )
. withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006" ))
. withDoTakeOverScript ( new io . gs2 . account . model . ScriptSetting ()
. withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007" )
. withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008" ))
. withLogSetting ( new io . gs2 . account . 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.UpdateNamespaceRequest ;
using Gs2.Gs2Account.Result.UpdateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . UpdateNamespaceResult > asyncResult = null ;
yield return client . UpdateNamespace (
new Gs2 . Gs2Account . Request . UpdateNamespaceRequest ()
. WithNamespaceName ( "namespace1" )
. WithDescription ( "description1" )
. WithChangePasswordIfTakeOver ( true )
. WithCreateAccountScript ( new Gs2 . Gs2Account . Model . ScriptSetting ()
. WithTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1001" )
. WithDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002" ))
. WithAuthenticationScript ( new Gs2 . Gs2Account . Model . ScriptSetting ()
. WithTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003" )
. WithDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004" ))
. WithCreateTakeOverScript ( new Gs2 . Gs2Account . Model . ScriptSetting ()
. WithTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005" )
. WithDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006" ))
. WithDoTakeOverScript ( new Gs2 . Gs2Account . Model . ScriptSetting ()
. WithTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007" )
. WithDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008" ))
. WithLogSetting ( new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . updateNamespace (
new Gs2Account . UpdateNamespaceRequest ()
. withNamespaceName ( "namespace1" )
. withDescription ( "description1" )
. withChangePasswordIfTakeOver ( true )
. withCreateAccountScript ( new Gs2Account . model . ScriptSetting ()
. withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1001" )
. withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002" ))
. withAuthenticationScript ( new Gs2Account . model . ScriptSetting ()
. withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003" )
. withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004" ))
. withCreateTakeOverScript ( new Gs2Account . model . ScriptSetting ()
. withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005" )
. withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006" ))
. withDoTakeOverScript ( new Gs2Account . model . ScriptSetting ()
. withTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007" )
. withDoneTriggerScriptId ( "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008" ))
. withLogSetting ( new Gs2Account . 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . update_namespace (
account . UpdateNamespaceRequest ()
. with_namespace_name ( self . hash1 )
. with_description ( 'description1' )
. with_change_password_if_take_over ( True )
. with_create_account_script (
account . ScriptSetting ()
. with_trigger_script_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1001' )
. with_done_trigger_script_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002' ))
. with_authentication_script (
account . ScriptSetting ()
. with_trigger_script_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003' )
. with_done_trigger_script_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004' ))
. with_create_take_over_script (
account . ScriptSetting ()
. with_trigger_script_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005' )
. with_done_trigger_script_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006' ))
. with_do_take_over_script (
account . ScriptSetting ()
. with_trigger_script_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007' )
. with_done_trigger_script_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008' ))
. with_log_setting (
account . 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 ( 'account' )
api_result = client.update_namespace ({
namespaceName = "namespace1" ,
description = "description1" ,
changePasswordIfTakeOver = true ,
createAccountScript = {
triggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1001" ,
doneTriggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002" ,
},
authenticationScript = {
triggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003" ,
doneTriggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004" ,
},
createTakeOverScript = {
triggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005" ,
doneTriggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006" ,
},
doTakeOverScript = {
triggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007" ,
doneTriggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008" ,
},
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 ( 'account' )
api_result_handler = client.update_namespace_async ({
namespaceName = "namespace1" ,
description = "description1" ,
changePasswordIfTakeOver = true ,
createAccountScript = {
triggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1001" ,
doneTriggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002" ,
},
authenticationScript = {
triggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003" ,
doneTriggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004" ,
},
createTakeOverScript = {
triggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005" ,
doneTriggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006" ,
},
doTakeOverScript = {
triggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007" ,
doneTriggerScriptId = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008" ,
},
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeleteNamespace (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeleteNamespaceRequest ;
import io.gs2.account.result.DeleteNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeleteNamespaceRequest ;
using Gs2.Gs2Account.Result.DeleteNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeleteNamespaceResult > asyncResult = null ;
yield return client . DeleteNamespace (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deleteNamespace (
new Gs2Account . DeleteNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_namespace (
account . DeleteNamespaceRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
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 ( 'account' )
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DumpUserDataByUserId (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DumpUserDataByUserIdRequest ;
import io.gs2.account.result.DumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DumpUserDataByUserIdRequest ;
using Gs2.Gs2Account.Result.DumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DumpUserDataByUserIdResult > asyncResult = null ;
yield return client . DumpUserDataByUserId (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . dumpUserDataByUserId (
new Gs2Account . DumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . dump_user_data_by_user_id (
account . DumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
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 ( 'account' )
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CheckDumpUserDataByUserId (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CheckDumpUserDataByUserIdRequest ;
import io.gs2.account.result.CheckDumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CheckDumpUserDataByUserIdRequest ;
using Gs2.Gs2Account.Result.CheckDumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CheckDumpUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckDumpUserDataByUserId (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . checkDumpUserDataByUserId (
new Gs2Account . CheckDumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . check_dump_user_data_by_user_id (
account . CheckDumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
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 ( 'account' )
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CleanUserDataByUserId (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CleanUserDataByUserIdRequest ;
import io.gs2.account.result.CleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CleanUserDataByUserIdRequest ;
using Gs2.Gs2Account.Result.CleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CleanUserDataByUserId (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . cleanUserDataByUserId (
new Gs2Account . CleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . clean_user_data_by_user_id (
account . CleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
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 ( 'account' )
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CheckCleanUserDataByUserId (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CheckCleanUserDataByUserIdRequest ;
import io.gs2.account.result.CheckCleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CheckCleanUserDataByUserIdRequest ;
using Gs2.Gs2Account.Result.CheckCleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CheckCleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckCleanUserDataByUserId (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . checkCleanUserDataByUserId (
new Gs2Account . CheckCleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . check_clean_user_data_by_user_id (
account . CheckCleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_time_offset_token ( None )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
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 ( 'account' )
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に紐づくデータのインポートを実行
インポートに使用できるデータは GS2 によってエクスポートして取得したデータに限定され、古いデータはインポートに失敗する可能性があります。 エクスポートしたユーザーIDと異なるユーザーIDでインポートすることができますが、ユーザーデータのペイロード内にユーザーIDが含まれる場合はその限りではありません。
このAPIの戻り値で応答されたURLにエクスポートした zip ファイルをアップロードし、importUserDataByUserId を呼び出すことで実際のインポート処理を開始できます。
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . PrepareImportUserDataByUserId (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.PrepareImportUserDataByUserIdRequest ;
import io.gs2.account.result.PrepareImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.PrepareImportUserDataByUserIdRequest ;
using Gs2.Gs2Account.Result.PrepareImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . PrepareImportUserDataByUserIdResult > asyncResult = null ;
yield return client . PrepareImportUserDataByUserId (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . prepareImportUserDataByUserId (
new Gs2Account . 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . prepare_import_user_data_by_user_id (
account . 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 ( 'account' )
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 ( 'account' )
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に紐づくデータのインポートを実行
インポートに使用できるデータは GS2 によってエクスポートして取得したデータに限定され、古いデータはインポートに失敗する可能性があります。 エクスポートしたユーザーIDと異なるユーザーIDでインポートすることができますが、ユーザーデータのペイロード内にユーザーIDが含まれる場合はその限りではありません。
このAPIを呼び出す前に prepareImportUserDataByUserId を呼び出して、アップロード準備を完了させる必要があります。
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . ImportUserDataByUserId (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.ImportUserDataByUserIdRequest ;
import io.gs2.account.result.ImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.ImportUserDataByUserIdRequest ;
using Gs2.Gs2Account.Result.ImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . ImportUserDataByUserIdResult > asyncResult = null ;
yield return client . ImportUserDataByUserId (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . importUserDataByUserId (
new Gs2Account . ImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
. withTimeOffsetToken ( null )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . import_user_data_by_user_id (
account . 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 ( 'account' )
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 ( 'account' )
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CheckImportUserDataByUserId (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CheckImportUserDataByUserIdRequest ;
import io.gs2.account.result.CheckImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CheckImportUserDataByUserIdRequest ;
using Gs2.Gs2Account.Result.CheckImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CheckImportUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckImportUserDataByUserId (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . checkImportUserDataByUserId (
new Gs2Account . 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . check_import_user_data_by_user_id (
account . 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 ( 'account' )
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 ( 'account' )
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 ;
describeAccounts ゲームプレイヤーアカウントの一覧を取得
指定された名前空間に存在するすべてのゲームプレイヤーアカウントの一覧を取得します。 取得されるアカウントの情報には、アカウントID、ステータス、作成日時などが含まれます。 ページネーションをサポートしており、一度に取得できるアカウントの数を制限し、次のページのトークンを提供します。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数
Result 型 説明 items List<Account> ゲームプレイヤーアカウントのリスト 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DescribeAccounts (
& account . DescribeAccountsRequest {
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DescribeAccountsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeAccounts (
( new DescribeAccountsRequest ())
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DescribeAccountsRequest ;
import io.gs2.account.result.DescribeAccountsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DescribeAccountsResult result = client . describeAccounts (
new DescribeAccountsRequest ()
. withNamespaceName ( "namespace1" )
. withPageToken ( null )
. withLimit ( null )
);
List < Account > 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DescribeAccountsRequest ;
using Gs2.Gs2Account.Result.DescribeAccountsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DescribeAccountsResult > asyncResult = null ;
yield return client . DescribeAccounts (
new Gs2 . Gs2Account . Request . DescribeAccountsRequest ()
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . describeAccounts (
new Gs2Account . DescribeAccountsRequest ()
. 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . describe_accounts (
account . DescribeAccountsRequest ()
. 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 ( 'account' )
api_result = client.describe_accounts ({
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 ( 'account' )
api_result_handler = client.describe_accounts_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 ;
createAccount ゲームプレイヤーアカウントを新規作成
このメソッドは新しいゲームプレイヤーアカウントを作成します。 アカウントの作成にあたってユーザーID、パスワードの指定は不要です。ユーザーID、パスワードは自動的に生成されます。 作成成功時、新しく作成されたアカウントの詳細情報がレスポンスとして返されます。
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreateAccount (
& account . CreateAccountRequest {
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\CreateAccountRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createAccount (
( new CreateAccountRequest ())
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreateAccountRequest ;
import io.gs2.account.result.CreateAccountResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreateAccountResult result = client . createAccount (
new CreateAccountRequest ()
. withNamespaceName ( "namespace1" )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreateAccountRequest ;
using Gs2.Gs2Account.Result.CreateAccountResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreateAccountResult > asyncResult = null ;
yield return client . CreateAccount (
new Gs2 . Gs2Account . Request . CreateAccountRequest ()
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createAccount (
new Gs2Account . CreateAccountRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_account (
account . CreateAccountRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.create_account ({
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 ( 'account' )
api_result_handler = client.create_account_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 ;
updateTimeOffset ゲームプレイヤーアカウントの現在時刻に対する補正値を更新
特定のゲームプレイヤーアカウントの時刻補正値を更新します。 この時刻補正は、未来のイベントスケジュールを事前にテストするために活用できます。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID timeOffset int ✓ 0 ~ 315360000 現在時刻に対する補正値(現在時刻を起点とした秒数) 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . UpdateTimeOffset (
& account . UpdateTimeOffsetRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
TimeOffset : 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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\UpdateTimeOffsetRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateTimeOffset (
( new UpdateTimeOffsetRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withTimeOffset ( 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.UpdateTimeOffsetRequest ;
import io.gs2.account.result.UpdateTimeOffsetResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
UpdateTimeOffsetResult result = client . updateTimeOffset (
new UpdateTimeOffsetRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffset ( null )
. withTimeOffsetToken ( null )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.UpdateTimeOffsetRequest ;
using Gs2.Gs2Account.Result.UpdateTimeOffsetResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . UpdateTimeOffsetResult > asyncResult = null ;
yield return client . UpdateTimeOffset (
new Gs2 . Gs2Account . Request . UpdateTimeOffsetRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithTimeOffset ( 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . updateTimeOffset (
new Gs2Account . UpdateTimeOffsetRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffset ( null )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . update_time_offset (
account . UpdateTimeOffsetRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_time_offset ( None )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.update_time_offset ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
timeOffset = 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 ( 'account' )
api_result_handler = client.update_time_offset_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
timeOffset = 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 ;
updateBanned ゲームプレイヤーアカウントのアカウントBAN状況を更新
特定のゲームプレイヤーアカウントのBAN(アクセス禁止)状態を更新するために使用されます。 アカウントのBAN状態を有効または無効にすることができ、これによりアカウントのゲーム内利用を制限することができます。 アカウントIDと新しいBAN状態を指定して更新します。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID banned bool ✓ false アカウントBANされているか 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . UpdateBanned (
& account . UpdateBannedRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
Banned : pointy . Bool ( true ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\UpdateBannedRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateBanned (
( new UpdateBannedRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withBanned ( True )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.UpdateBannedRequest ;
import io.gs2.account.result.UpdateBannedResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
UpdateBannedResult result = client . updateBanned (
new UpdateBannedRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withBanned ( true )
. withTimeOffsetToken ( null )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.UpdateBannedRequest ;
using Gs2.Gs2Account.Result.UpdateBannedResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . UpdateBannedResult > asyncResult = null ;
yield return client . UpdateBanned (
new Gs2 . Gs2Account . Request . UpdateBannedRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithBanned ( true )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . updateBanned (
new Gs2Account . UpdateBannedRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withBanned ( true )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . update_banned (
account . UpdateBannedRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_banned ( True )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.update_banned ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
banned = true ,
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 ( 'account' )
api_result_handler = client.update_banned_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
banned = true ,
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 ;
addBan ゲームプレイヤーアカウントのアカウントBAN状況を更新
ゲームプレイヤーアカウントに新しいBAN状態を追加するために使用されます。 特定のアカウントに対して、一時的または永続的なアクセス禁止を設定できます。 BANを追加するには、アカウントIDとBAN状態(理由や期間を含む)を指定する必要があります。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID banStatus BanStatus ✓ BAN状態 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . AddBan (
& account . AddBanRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
BanStatus : & account . BanStatus {
Name : pointy . String ( "feature1" ),
Reason : pointy . String ( "reason" ),
ReleaseTimestamp : pointy . Int64 ( 1000000000000 ),
},
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\AddBanRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> addBan (
( new AddBanRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withBanStatus (( new BanStatus ())
-> withName ( "feature1" )
-> withReason ( "reason" )
-> withReleaseTimestamp ( 1000000000000 )
)
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.AddBanRequest ;
import io.gs2.account.result.AddBanResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
AddBanResult result = client . addBan (
new AddBanRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withBanStatus ( new BanStatus ()
. withName ( "feature1" )
. withReason ( "reason" )
. withReleaseTimestamp ( 1000000000000L )
)
. withTimeOffsetToken ( null )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.AddBanRequest ;
using Gs2.Gs2Account.Result.AddBanResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . AddBanResult > asyncResult = null ;
yield return client . AddBan (
new Gs2 . Gs2Account . Request . AddBanRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithBanStatus ( new Gs2 . Gs2Account . Model . BanStatus ()
. WithName ( "feature1" )
. WithReason ( "reason" )
. WithReleaseTimestamp ( 1000000000000L )
)
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . addBan (
new Gs2Account . AddBanRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withBanStatus ( new Gs2Account . model . BanStatus ()
. withName ( "feature1" )
. withReason ( "reason" )
. withReleaseTimestamp ( 1000000000000 )
)
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . add_ban (
account . AddBanRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_ban_status ( account . BanStatus ()
. with_name ( 'feature1' )
. with_reason ( 'reason' )
. with_release_timestamp ( 1000000000000 )
)
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.add_ban ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
banStatus = {
name = "feature1" ,
reason = "reason" ,
release_timestamp = 1000000000000 ,
},
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 ( 'account' )
api_result_handler = client.add_ban_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
banStatus = {
name = "feature1" ,
reason = "reason" ,
release_timestamp = 1000000000000 ,
},
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 ;
removeBan ゲームプレイヤーアカウントのアカウントBAN状況を削除
特定のゲームプレイヤーアカウントに適用されたBAN状態を削除します。 削除を行うには、アカウントIDと削除するBAN状態の名前を指定します。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID banStatusName string ✓ ~ 36文字 BAN状態名 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . RemoveBan (
& account . RemoveBanRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
BanStatusName : pointy . String ( "status-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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\RemoveBanRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> removeBan (
( new RemoveBanRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withBanStatusName ( "status-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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.RemoveBanRequest ;
import io.gs2.account.result.RemoveBanResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
RemoveBanResult result = client . removeBan (
new RemoveBanRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withBanStatusName ( "status-0001" )
. withTimeOffsetToken ( null )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.RemoveBanRequest ;
using Gs2.Gs2Account.Result.RemoveBanResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . RemoveBanResult > asyncResult = null ;
yield return client . RemoveBan (
new Gs2 . Gs2Account . Request . RemoveBanRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithBanStatusName ( "status-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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . removeBan (
new Gs2Account . RemoveBanRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withBanStatusName ( "status-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . remove_ban (
account . RemoveBanRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_ban_status_name ( 'status-0001' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.remove_ban ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
banStatusName = "status-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 ( 'account' )
api_result_handler = client.remove_ban_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
banStatusName = "status-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 ;
getAccount ゲームプレイヤーアカウントを取得
指定されたIDを持つ特定のゲームプレイヤーアカウントの詳細情報を取得します。 取得される情報には、アカウントの名前、ステータス、作成日時などが含まれます。 このメソッドは、アカウントの詳細情報を表示するためのものです。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ UUID ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetAccount (
& account . GetAccountRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetAccountRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getAccount (
( new GetAccountRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetAccountRequest ;
import io.gs2.account.result.GetAccountResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetAccountResult result = client . getAccount (
new GetAccountRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffsetToken ( null )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetAccountRequest ;
using Gs2.Gs2Account.Result.GetAccountResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetAccountResult > asyncResult = null ;
yield return client . GetAccount (
new Gs2 . Gs2Account . Request . GetAccountRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getAccount (
new Gs2Account . GetAccountRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_account (
account . GetAccountRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_account ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ( 'account' )
api_result_handler = client.get_account_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ;
deleteAccount ゲームプレイヤーアカウントを削除
特定のゲームプレイヤーアカウントを削除するために使用されます。 アカウントを削除すると、そのアカウントでログインできなくなりますが、GS2-Account が管理していないユーザーデータについては引き続きGS2に残り続けます。 ユーザーデータも全て削除する必要がある場合は、マネージメントコンソールからアクセスできるユーザーデータの完全削除機能を利用してください。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ UUID ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeleteAccount (
& account . DeleteAccountRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeleteAccountRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteAccount (
( new DeleteAccountRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeleteAccountRequest ;
import io.gs2.account.result.DeleteAccountResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeleteAccountResult result = client . deleteAccount (
new DeleteAccountRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffsetToken ( null )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeleteAccountRequest ;
using Gs2.Gs2Account.Result.DeleteAccountResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeleteAccountResult > asyncResult = null ;
yield return client . DeleteAccount (
new Gs2 . Gs2Account . Request . DeleteAccountRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deleteAccount (
new Gs2Account . DeleteAccountRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_account (
account . DeleteAccountRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_account ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ( 'account' )
api_result_handler = client.delete_account_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ;
authentication ゲームプレイヤーアカウントを認証
ゲームプレイヤーアカウントの認証に使用されます。 ユーザーがアカウントにログインする際に、ユーザー名とパスワードの照合を行います。 正しい認証情報が提供されると、アカウント情報とその署名が発行されます。 この情報を GS2-Auth に渡すことで、アクセストークンを得ることができ、GS2 が提供する様々なマイクロサービスにログインしたユーザーとしてアクセスすることができます。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID keyId string ✓ “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024文字 暗号鍵GRN password 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . Authentication (
& account . AuthenticationRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "user-0001" ),
KeyId : pointy . String ( "grn:gs2:ap-northeast-1:owner_id:key:namespace1:key:key-0001" ),
Password : pointy . String ( "password-0001" ),
TimeOffsetToken : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
banStatuses := result . BanStatuses
body := result . Body
signature := result . Signature
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\AuthenticationRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> authentication (
( new AuthenticationRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( "user-0001" )
-> withKeyId ( "grn:gs2:ap-northeast-1:owner_id:key: \n amespace1:key:key-0001" )
-> withPassword ( "password-0001" )
-> withTimeOffsetToken ( null )
);
$item = $result -> getItem ();
$banStatuses = $result -> getBanStatuses ();
$body = $result -> getBody ();
$signature = $result -> getSignature ();
} 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.AuthenticationRequest ;
import io.gs2.account.result.AuthenticationResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
AuthenticationResult result = client . authentication (
new AuthenticationRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "user-0001" )
. withKeyId ( "grn:gs2:ap-northeast-1:owner_id:key:namespace1:key:key-0001" )
. withPassword ( "password-0001" )
. withTimeOffsetToken ( null )
);
Account item = result . getItem ();
List < BanStatus > banStatuses = result . getBanStatuses ();
String body = result . getBody ();
String signature = result . getSignature ();
} 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.AuthenticationRequest ;
using Gs2.Gs2Account.Result.AuthenticationResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . AuthenticationResult > asyncResult = null ;
yield return client . Authentication (
new Gs2 . Gs2Account . Request . AuthenticationRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "user-0001" )
. WithKeyId ( "grn:gs2:ap-northeast-1:owner_id:key:namespace1:key:key-0001" )
. WithPassword ( "password-0001" )
. WithTimeOffsetToken ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
var banStatuses = result . BanStatuses ;
var body = result . Body ;
var signature = result . Signature ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . authentication (
new Gs2Account . AuthenticationRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "user-0001" )
. withKeyId ( "grn:gs2:ap-northeast-1:owner_id:key:namespace1:key:key-0001" )
. withPassword ( "password-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
const banStatuses = result . getBanStatuses ();
const body = result . getBody ();
const signature = result . getSignature ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . authentication (
account . AuthenticationRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( 'user-0001' )
. with_key_id ( 'grn:gs2:ap-northeast-1:owner_id:key:namespace1:key:key-0001' )
. with_password ( 'password-0001' )
. with_time_offset_token ( None )
)
item = result . item
ban_statuses = result . ban_statuses
body = result . body
signature = result . signature
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.authentication ({
namespaceName = "namespace1" ,
userId = "user-0001" ,
keyId = "grn:gs2:ap-northeast-1:owner_id:key:namespace1:key:key-0001" ,
password = "password-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 ;
banStatuses = result.banStatuses ;
body = result.body ;
signature = result.signature ;
client = gs2 ( 'account' )
api_result_handler = client.authentication_async ({
namespaceName = "namespace1" ,
userId = "user-0001" ,
keyId = "grn:gs2:ap-northeast-1:owner_id:key:namespace1:key:key-0001" ,
password = "password-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 ;
banStatuses = result.banStatuses ;
body = result.body ;
signature = result.signature ;
describeTakeOvers 引き継ぎ設定の一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数
Result 型 説明 items List<TakeOver> 引き継ぎ設定のリスト 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DescribeTakeOvers (
& account . DescribeTakeOversRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "$account1.userId" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DescribeTakeOversRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeTakeOvers (
( new DescribeTakeOversRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $account1 . userId )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DescribeTakeOversRequest ;
import io.gs2.account.result.DescribeTakeOversResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DescribeTakeOversResult result = client . describeTakeOvers (
new DescribeTakeOversRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withPageToken ( null )
. withLimit ( null )
);
List < TakeOver > 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DescribeTakeOversRequest ;
using Gs2.Gs2Account.Result.DescribeTakeOversResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DescribeTakeOversResult > asyncResult = null ;
yield return client . DescribeTakeOvers (
new Gs2 . Gs2Account . Request . DescribeTakeOversRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "$account1.userId" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . describeTakeOvers (
new Gs2Account . DescribeTakeOversRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . describe_take_overs (
account . DescribeTakeOversRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . account1 . user_id )
. 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 ( 'account' )
api_result = client.describe_take_overs ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
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 ( 'account' )
api_result_handler = client.describe_take_overs_async ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
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 ;
describeTakeOversByUserId ユーザーIDを指定して引き継ぎ設定の一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数 timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 型 説明 items List<TakeOver> 引き継ぎ設定のリスト 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DescribeTakeOversByUserId (
& account . DescribeTakeOversByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DescribeTakeOversByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeTakeOversByUserId (
( new DescribeTakeOversByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DescribeTakeOversByUserIdRequest ;
import io.gs2.account.result.DescribeTakeOversByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DescribeTakeOversByUserIdResult result = client . describeTakeOversByUserId (
new DescribeTakeOversByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
List < TakeOver > 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DescribeTakeOversByUserIdRequest ;
using Gs2.Gs2Account.Result.DescribeTakeOversByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DescribeTakeOversByUserIdResult > asyncResult = null ;
yield return client . DescribeTakeOversByUserId (
new Gs2 . Gs2Account . Request . DescribeTakeOversByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . describeTakeOversByUserId (
new Gs2Account . DescribeTakeOversByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . describe_take_overs_by_user_id (
account . DescribeTakeOversByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. 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 ( 'account' )
api_result = client.describe_take_overs_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ( 'account' )
api_result_handler = client.describe_take_overs_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ;
createTakeOver 引き継ぎ設定を新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 引き継ぎ用ユーザーID password 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreateTakeOver (
& account . CreateTakeOverRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "user-0001@gs2.io" ),
Password : pointy . String ( "password-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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\CreateTakeOverRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createTakeOver (
( new CreateTakeOverRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $account1 . userId )
-> withType ( 0 )
-> withUserIdentifier ( "user-0001@gs2.io" )
-> withPassword ( "password-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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreateTakeOverRequest ;
import io.gs2.account.result.CreateTakeOverResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreateTakeOverResult result = client . createTakeOver (
new CreateTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
. withUserIdentifier ( "user-0001@gs2.io" )
. withPassword ( "password-0001" )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreateTakeOverRequest ;
using Gs2.Gs2Account.Result.CreateTakeOverResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreateTakeOverResult > asyncResult = null ;
yield return client . CreateTakeOver (
new Gs2 . Gs2Account . Request . CreateTakeOverRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "$account1.userId" )
. WithType ( 0 )
. WithUserIdentifier ( "user-0001@gs2.io" )
. WithPassword ( "password-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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createTakeOver (
new Gs2Account . CreateTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
. withUserIdentifier ( "user-0001@gs2.io" )
. withPassword ( "password-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_take_over (
account . CreateTakeOverRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . account1 . user_id )
. with_type ( 0 )
. with_user_identifier ( 'user-0001@gs2.io' )
. with_password ( 'password-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.create_take_over ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
userIdentifier = "user-0001@gs2.io" ,
password = "password-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 ( 'account' )
api_result_handler = client.create_take_over_async ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
userIdentifier = "user-0001@gs2.io" ,
password = "password-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 ;
createTakeOverByUserId ユーザーIDを指定して引き継ぎ設定を新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 引き継ぎ用ユーザーID password 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreateTakeOverByUserId (
& account . CreateTakeOverByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "user-0001@gs2.io" ),
Password : pointy . String ( "password-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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\CreateTakeOverByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createTakeOverByUserId (
( new CreateTakeOverByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withType ( 0 )
-> withUserIdentifier ( "user-0001@gs2.io" )
-> withPassword ( "password-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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreateTakeOverByUserIdRequest ;
import io.gs2.account.result.CreateTakeOverByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreateTakeOverByUserIdResult result = client . createTakeOverByUserId (
new CreateTakeOverByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withUserIdentifier ( "user-0001@gs2.io" )
. withPassword ( "password-0001" )
. withTimeOffsetToken ( null )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreateTakeOverByUserIdRequest ;
using Gs2.Gs2Account.Result.CreateTakeOverByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreateTakeOverByUserIdResult > asyncResult = null ;
yield return client . CreateTakeOverByUserId (
new Gs2 . Gs2Account . Request . CreateTakeOverByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithType ( 0 )
. WithUserIdentifier ( "user-0001@gs2.io" )
. WithPassword ( "password-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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createTakeOverByUserId (
new Gs2Account . CreateTakeOverByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withUserIdentifier ( "user-0001@gs2.io" )
. withPassword ( "password-0001" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_take_over_by_user_id (
account . CreateTakeOverByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_type ( 0 )
. with_user_identifier ( 'user-0001@gs2.io' )
. with_password ( 'password-0001' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.create_take_over_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
userIdentifier = "user-0001@gs2.io" ,
password = "password-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 ( 'account' )
api_result_handler = client.create_take_over_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
userIdentifier = "user-0001@gs2.io" ,
password = "password-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 ;
createTakeOverOpenIdConnect 引き継ぎ設定を新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 idToken string ✓ ~ 1024文字 OpenID Connect ID Token
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreateTakeOverOpenIdConnect (
& account . CreateTakeOverOpenIdConnectRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "$account1.userId" ),
Type : nil ,
IdToken : pointy . String ( "0123456789" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\CreateTakeOverOpenIdConnectRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createTakeOverOpenIdConnect (
( new CreateTakeOverOpenIdConnectRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $account1 . userId )
-> withType ( null )
-> withIdToken ( "0123456789" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreateTakeOverOpenIdConnectRequest ;
import io.gs2.account.result.CreateTakeOverOpenIdConnectResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreateTakeOverOpenIdConnectResult result = client . createTakeOverOpenIdConnect (
new CreateTakeOverOpenIdConnectRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( null )
. withIdToken ( "0123456789" )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreateTakeOverOpenIdConnectRequest ;
using Gs2.Gs2Account.Result.CreateTakeOverOpenIdConnectResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreateTakeOverOpenIdConnectResult > asyncResult = null ;
yield return client . CreateTakeOverOpenIdConnect (
new Gs2 . Gs2Account . Request . CreateTakeOverOpenIdConnectRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "$account1.userId" )
. WithType ( null )
. WithIdToken ( "0123456789" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createTakeOverOpenIdConnect (
new Gs2Account . CreateTakeOverOpenIdConnectRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( null )
. withIdToken ( "0123456789" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_take_over_open_id_connect (
account . CreateTakeOverOpenIdConnectRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . account1 . user_id )
. with_type ( None )
. with_id_token ( '0123456789' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.create_take_over_open_id_connect ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = nil ,
idToken = "0123456789" ,
})
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 ( 'account' )
api_result_handler = client.create_take_over_open_id_connect_async ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = nil ,
idToken = "0123456789" ,
})
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 ;
createTakeOverOpenIdConnectAndByUserId ユーザーIDを指定して引き継ぎ設定を新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 idToken string ✓ ~ 1024文字 OpenID Connect ID Token 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreateTakeOverOpenIdConnectAndByUserId (
& account . CreateTakeOverOpenIdConnectAndByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
Type : nil ,
IdToken : pointy . String ( "0123456789" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\CreateTakeOverOpenIdConnectAndByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createTakeOverOpenIdConnectAndByUserId (
( new CreateTakeOverOpenIdConnectAndByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withType ( null )
-> withIdToken ( "0123456789" )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreateTakeOverOpenIdConnectAndByUserIdRequest ;
import io.gs2.account.result.CreateTakeOverOpenIdConnectAndByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreateTakeOverOpenIdConnectAndByUserIdResult result = client . createTakeOverOpenIdConnectAndByUserId (
new CreateTakeOverOpenIdConnectAndByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( null )
. withIdToken ( "0123456789" )
. withTimeOffsetToken ( null )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreateTakeOverOpenIdConnectAndByUserIdRequest ;
using Gs2.Gs2Account.Result.CreateTakeOverOpenIdConnectAndByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreateTakeOverOpenIdConnectAndByUserIdResult > asyncResult = null ;
yield return client . CreateTakeOverOpenIdConnectAndByUserId (
new Gs2 . Gs2Account . Request . CreateTakeOverOpenIdConnectAndByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithType ( null )
. WithIdToken ( "0123456789" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createTakeOverOpenIdConnectAndByUserId (
new Gs2Account . CreateTakeOverOpenIdConnectAndByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( null )
. withIdToken ( "0123456789" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_take_over_open_id_connect_and_by_user_id (
account . CreateTakeOverOpenIdConnectAndByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_type ( None )
. with_id_token ( '0123456789' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.create_take_over_open_id_connect_and_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = nil ,
idToken = "0123456789" ,
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 ( 'account' )
api_result_handler = client.create_take_over_open_id_connect_and_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = nil ,
idToken = "0123456789" ,
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 ;
getTakeOver 引き継ぎ設定を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetTakeOver (
& account . GetTakeOverRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetTakeOverRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getTakeOver (
( new GetTakeOverRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $account1 . userId )
-> withType ( 0 )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetTakeOverRequest ;
import io.gs2.account.result.GetTakeOverResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetTakeOverResult result = client . getTakeOver (
new GetTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetTakeOverRequest ;
using Gs2.Gs2Account.Result.GetTakeOverResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetTakeOverResult > asyncResult = null ;
yield return client . GetTakeOver (
new Gs2 . Gs2Account . Request . GetTakeOverRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "$account1.userId" )
. WithType ( 0 ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getTakeOver (
new Gs2Account . GetTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_take_over (
account . GetTakeOverRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . account1 . user_id )
. with_type ( 0 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_take_over ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
})
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 ( 'account' )
api_result_handler = client.get_take_over_async ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
})
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 ;
getTakeOverByUserId ユーザーIDを指定して引き継ぎ設定を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetTakeOverByUserId (
& account . GetTakeOverByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetTakeOverByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getTakeOverByUserId (
( new GetTakeOverByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withType ( 0 )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetTakeOverByUserIdRequest ;
import io.gs2.account.result.GetTakeOverByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetTakeOverByUserIdResult result = client . getTakeOverByUserId (
new GetTakeOverByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withTimeOffsetToken ( null )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetTakeOverByUserIdRequest ;
using Gs2.Gs2Account.Result.GetTakeOverByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetTakeOverByUserIdResult > asyncResult = null ;
yield return client . GetTakeOverByUserId (
new Gs2 . Gs2Account . Request . GetTakeOverByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithType ( 0 )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getTakeOverByUserId (
new Gs2Account . GetTakeOverByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_take_over_by_user_id (
account . GetTakeOverByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_type ( 0 )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_take_over_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
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 ( 'account' )
api_result_handler = client.get_take_over_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
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 ;
updateTakeOver 引き継ぎ設定を更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 oldPassword string ✓ ~ 128文字 古いパスワード password 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . UpdateTakeOver (
& account . UpdateTakeOverRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
OldPassword : pointy . String ( "password-0001" ),
Password : pointy . String ( "password-1001" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\UpdateTakeOverRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateTakeOver (
( new UpdateTakeOverRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $account1 . userId )
-> withType ( 0 )
-> withOldPassword ( "password-0001" )
-> withPassword ( "password-1001" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.UpdateTakeOverRequest ;
import io.gs2.account.result.UpdateTakeOverResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
UpdateTakeOverResult result = client . updateTakeOver (
new UpdateTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
. withOldPassword ( "password-0001" )
. withPassword ( "password-1001" )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.UpdateTakeOverRequest ;
using Gs2.Gs2Account.Result.UpdateTakeOverResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . UpdateTakeOverResult > asyncResult = null ;
yield return client . UpdateTakeOver (
new Gs2 . Gs2Account . Request . UpdateTakeOverRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "$account1.userId" )
. WithType ( 0 )
. WithOldPassword ( "password-0001" )
. WithPassword ( "password-1001" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . updateTakeOver (
new Gs2Account . UpdateTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
. withOldPassword ( "password-0001" )
. withPassword ( "password-1001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . update_take_over (
account . UpdateTakeOverRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . account1 . user_id )
. with_type ( 0 )
. with_old_password ( 'password-0001' )
. with_password ( 'password-1001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.update_take_over ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
oldPassword = "password-0001" ,
password = "password-1001" ,
})
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 ( 'account' )
api_result_handler = client.update_take_over_async ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
oldPassword = "password-0001" ,
password = "password-1001" ,
})
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 ;
updateTakeOverByUserId 引き継ぎ設定を更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 oldPassword string ✓ ~ 128文字 古いパスワード password 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . UpdateTakeOverByUserId (
& account . UpdateTakeOverByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
OldPassword : pointy . String ( "password-0001" ),
Password : pointy . String ( "password-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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\UpdateTakeOverByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateTakeOverByUserId (
( new UpdateTakeOverByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withType ( 0 )
-> withOldPassword ( "password-0001" )
-> withPassword ( "password-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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.UpdateTakeOverByUserIdRequest ;
import io.gs2.account.result.UpdateTakeOverByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
UpdateTakeOverByUserIdResult result = client . updateTakeOverByUserId (
new UpdateTakeOverByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withOldPassword ( "password-0001" )
. withPassword ( "password-0002" )
. withTimeOffsetToken ( null )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.UpdateTakeOverByUserIdRequest ;
using Gs2.Gs2Account.Result.UpdateTakeOverByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . UpdateTakeOverByUserIdResult > asyncResult = null ;
yield return client . UpdateTakeOverByUserId (
new Gs2 . Gs2Account . Request . UpdateTakeOverByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithType ( 0 )
. WithOldPassword ( "password-0001" )
. WithPassword ( "password-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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . updateTakeOverByUserId (
new Gs2Account . UpdateTakeOverByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withOldPassword ( "password-0001" )
. withPassword ( "password-0002" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . update_take_over_by_user_id (
account . UpdateTakeOverByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_type ( 0 )
. with_old_password ( 'password-0001' )
. with_password ( 'password-0002' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.update_take_over_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
oldPassword = "password-0001" ,
password = "password-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 ( 'account' )
api_result_handler = client.update_take_over_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
oldPassword = "password-0001" ,
password = "password-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 ;
deleteTakeOver 引き継ぎ設定を削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeleteTakeOver (
& account . DeleteTakeOverRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeleteTakeOverRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteTakeOver (
( new DeleteTakeOverRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $account1 . userId )
-> withType ( 0 )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeleteTakeOverRequest ;
import io.gs2.account.result.DeleteTakeOverResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeleteTakeOverResult result = client . deleteTakeOver (
new DeleteTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeleteTakeOverRequest ;
using Gs2.Gs2Account.Result.DeleteTakeOverResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeleteTakeOverResult > asyncResult = null ;
yield return client . DeleteTakeOver (
new Gs2 . Gs2Account . Request . DeleteTakeOverRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "$account1.userId" )
. WithType ( 0 ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deleteTakeOver (
new Gs2Account . DeleteTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_take_over (
account . DeleteTakeOverRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . account1 . user_id )
. with_type ( 0 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_take_over ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
})
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 ( 'account' )
api_result_handler = client.delete_take_over_async ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
})
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 ;
deleteTakeOverByUserIdentifier 引き継ぎ用ユーザーIDを指定して引き継ぎ設定を削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 1024 スロット番号 userIdentifier string ~ 1024文字 引き継ぎ用ユーザー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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeleteTakeOverByUserIdentifier (
& account . DeleteTakeOverByUserIdentifierRequest {
NamespaceName : pointy . String ( "namespace1" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "user-0001@gs2.io" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeleteTakeOverByUserIdentifierRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteTakeOverByUserIdentifier (
( new DeleteTakeOverByUserIdentifierRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withType ( 0 )
-> withUserIdentifier ( "user-0001@gs2.io" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeleteTakeOverByUserIdentifierRequest ;
import io.gs2.account.result.DeleteTakeOverByUserIdentifierResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeleteTakeOverByUserIdentifierResult result = client . deleteTakeOverByUserIdentifier (
new DeleteTakeOverByUserIdentifierRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withUserIdentifier ( "user-0001@gs2.io" )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeleteTakeOverByUserIdentifierRequest ;
using Gs2.Gs2Account.Result.DeleteTakeOverByUserIdentifierResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeleteTakeOverByUserIdentifierResult > asyncResult = null ;
yield return client . DeleteTakeOverByUserIdentifier (
new Gs2 . Gs2Account . Request . DeleteTakeOverByUserIdentifierRequest ()
. WithNamespaceName ( "namespace1" )
. WithType ( 0 )
. WithUserIdentifier ( "user-0001@gs2.io" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deleteTakeOverByUserIdentifier (
new Gs2Account . DeleteTakeOverByUserIdentifierRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withUserIdentifier ( "user-0001@gs2.io" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_take_over_by_user_identifier (
account . DeleteTakeOverByUserIdentifierRequest ()
. with_namespace_name ( self . hash1 )
. with_type ( 0 )
. with_user_identifier ( 'user-0001@gs2.io' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_take_over_by_user_identifier ({
namespaceName = "namespace1" ,
type = 0 ,
userIdentifier = "user-0001@gs2.io" ,
})
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 ( 'account' )
api_result_handler = client.delete_take_over_by_user_identifier_async ({
namespaceName = "namespace1" ,
type = 0 ,
userIdentifier = "user-0001@gs2.io" ,
})
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 ;
deleteTakeOverByUserId ユーザーIDを指定して引き継ぎ設定を削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeleteTakeOverByUserId (
& account . DeleteTakeOverByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeleteTakeOverByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteTakeOverByUserId (
( new DeleteTakeOverByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withType ( 0 )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeleteTakeOverByUserIdRequest ;
import io.gs2.account.result.DeleteTakeOverByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeleteTakeOverByUserIdResult result = client . deleteTakeOverByUserId (
new DeleteTakeOverByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withTimeOffsetToken ( null )
);
TakeOver 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeleteTakeOverByUserIdRequest ;
using Gs2.Gs2Account.Result.DeleteTakeOverByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeleteTakeOverByUserIdResult > asyncResult = null ;
yield return client . DeleteTakeOverByUserId (
new Gs2 . Gs2Account . Request . DeleteTakeOverByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithType ( 0 )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deleteTakeOverByUserId (
new Gs2Account . DeleteTakeOverByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_take_over_by_user_id (
account . DeleteTakeOverByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_type ( 0 )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_take_over_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
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 ( 'account' )
api_result_handler = client.delete_take_over_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
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 ;
doTakeOver 引き継ぎ設定を更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 引き継ぎ用ユーザーID password 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DoTakeOver (
& account . DoTakeOverRequest {
NamespaceName : pointy . String ( "namespace1" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "user-0001@gs2.io" ),
Password : pointy . String ( "password-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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DoTakeOverRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> doTakeOver (
( new DoTakeOverRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withType ( 0 )
-> withUserIdentifier ( "user-0001@gs2.io" )
-> withPassword ( "password-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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DoTakeOverRequest ;
import io.gs2.account.result.DoTakeOverResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DoTakeOverResult result = client . doTakeOver (
new DoTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withUserIdentifier ( "user-0001@gs2.io" )
. withPassword ( "password-0001" )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DoTakeOverRequest ;
using Gs2.Gs2Account.Result.DoTakeOverResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DoTakeOverResult > asyncResult = null ;
yield return client . DoTakeOver (
new Gs2 . Gs2Account . Request . DoTakeOverRequest ()
. WithNamespaceName ( "namespace1" )
. WithType ( 0 )
. WithUserIdentifier ( "user-0001@gs2.io" )
. WithPassword ( "password-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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . doTakeOver (
new Gs2Account . DoTakeOverRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withUserIdentifier ( "user-0001@gs2.io" )
. withPassword ( "password-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . do_take_over (
account . DoTakeOverRequest ()
. with_namespace_name ( self . hash1 )
. with_type ( 0 )
. with_user_identifier ( 'user-0001@gs2.io' )
. with_password ( 'password-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.do_take_over ({
namespaceName = "namespace1" ,
type = 0 ,
userIdentifier = "user-0001@gs2.io" ,
password = "password-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 ( 'account' )
api_result_handler = client.do_take_over_async ({
namespaceName = "namespace1" ,
type = 0 ,
userIdentifier = "user-0001@gs2.io" ,
password = "password-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 ;
doTakeOverOpenIdConnect 引き継ぎ設定を更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 1024 スロット番号 idToken string ✓ ~ 1024文字 OpenID Connect ID Token
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DoTakeOverOpenIdConnect (
& account . DoTakeOverOpenIdConnectRequest {
NamespaceName : pointy . String ( "namespace1" ),
Type : nil ,
IdToken : pointy . String ( "0123456789" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DoTakeOverOpenIdConnectRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> doTakeOverOpenIdConnect (
( new DoTakeOverOpenIdConnectRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withType ( null )
-> withIdToken ( "0123456789" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DoTakeOverOpenIdConnectRequest ;
import io.gs2.account.result.DoTakeOverOpenIdConnectResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DoTakeOverOpenIdConnectResult result = client . doTakeOverOpenIdConnect (
new DoTakeOverOpenIdConnectRequest ()
. withNamespaceName ( "namespace1" )
. withType ( null )
. withIdToken ( "0123456789" )
);
Account 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DoTakeOverOpenIdConnectRequest ;
using Gs2.Gs2Account.Result.DoTakeOverOpenIdConnectResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DoTakeOverOpenIdConnectResult > asyncResult = null ;
yield return client . DoTakeOverOpenIdConnect (
new Gs2 . Gs2Account . Request . DoTakeOverOpenIdConnectRequest ()
. WithNamespaceName ( "namespace1" )
. WithType ( null )
. WithIdToken ( "0123456789" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . doTakeOverOpenIdConnect (
new Gs2Account . DoTakeOverOpenIdConnectRequest ()
. withNamespaceName ( "namespace1" )
. withType ( null )
. withIdToken ( "0123456789" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . do_take_over_open_id_connect (
account . DoTakeOverOpenIdConnectRequest ()
. with_namespace_name ( self . hash1 )
. with_type ( None )
. with_id_token ( '0123456789' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.do_take_over_open_id_connect ({
namespaceName = "namespace1" ,
type = nil ,
idToken = "0123456789" ,
})
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 ( 'account' )
api_result_handler = client.do_take_over_open_id_connect_async ({
namespaceName = "namespace1" ,
type = nil ,
idToken = "0123456789" ,
})
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 ;
getAuthorizationUrl 認証URLを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号
Result 型 説明 authorizationUrl 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetAuthorizationUrl (
& account . GetAuthorizationUrlRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
}
)
if err != nil {
panic ( "error occurred" )
}
authorizationUrl := result . AuthorizationUrl
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetAuthorizationUrlRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getAuthorizationUrl (
( new GetAuthorizationUrlRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $account1 . userId )
-> withType ( 0 )
);
$authorizationUrl = $result -> getAuthorizationUrl ();
} 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetAuthorizationUrlRequest ;
import io.gs2.account.result.GetAuthorizationUrlResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetAuthorizationUrlResult result = client . getAuthorizationUrl (
new GetAuthorizationUrlRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
);
String authorizationUrl = result . getAuthorizationUrl ();
} 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetAuthorizationUrlRequest ;
using Gs2.Gs2Account.Result.GetAuthorizationUrlResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetAuthorizationUrlResult > asyncResult = null ;
yield return client . GetAuthorizationUrl (
new Gs2 . Gs2Account . Request . GetAuthorizationUrlRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "$account1.userId" )
. WithType ( 0 ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var authorizationUrl = result . AuthorizationUrl ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getAuthorizationUrl (
new Gs2Account . GetAuthorizationUrlRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withType ( 0 )
);
const authorizationUrl = result . getAuthorizationUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_authorization_url (
account . GetAuthorizationUrlRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . account1 . user_id )
. with_type ( 0 )
)
authorization_url = result . authorization_url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_authorization_url ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
authorizationUrl = result.authorizationUrl ;
client = gs2 ( 'account' )
api_result_handler = client.get_authorization_url_async ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
type = 0 ,
})
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
authorizationUrl = result.authorizationUrl ;
各種プラットフォームにおけるユーザーIDの一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数
Result 型 説明 items List<PlatformId> 各種プラットフォームにおけるユーザーIDのリスト 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DescribePlatformIds (
& account . DescribePlatformIdsRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "$account1.userId" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DescribePlatformIdsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describePlatformIds (
( new DescribePlatformIdsRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $account1 . userId )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DescribePlatformIdsRequest ;
import io.gs2.account.result.DescribePlatformIdsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DescribePlatformIdsResult result = client . describePlatformIds (
new DescribePlatformIdsRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withPageToken ( null )
. withLimit ( null )
);
List < PlatformId > 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DescribePlatformIdsRequest ;
using Gs2.Gs2Account.Result.DescribePlatformIdsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DescribePlatformIdsResult > asyncResult = null ;
yield return client . DescribePlatformIds (
new Gs2 . Gs2Account . Request . DescribePlatformIdsRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "$account1.userId" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . describePlatformIds (
new Gs2Account . DescribePlatformIdsRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "$account1.userId" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . describe_platform_ids (
account . DescribePlatformIdsRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . account1 . user_id )
. 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 ( 'account' )
api_result = client.describe_platform_ids ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
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 ( 'account' )
api_result_handler = client.describe_platform_ids_async ({
namespaceName = "namespace1" ,
accessToken = "$account1.userId" ,
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 ;
ユーザーIDを指定して各種プラットフォームにおけるユーザーIDの一覧を取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID pageToken string ~ 1024文字 データの取得を開始する位置を指定するトークン limit int ✓ 30 1 ~ 1000 データの取得件数 timeOffsetToken string ~ 1024文字 タイムオフセットトークン
Result 型 説明 items List<PlatformId> 各種プラットフォームにおけるユーザーIDのリスト 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DescribePlatformIdsByUserId (
& account . DescribePlatformIdsByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "user-0001" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DescribePlatformIdsByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describePlatformIdsByUserId (
( new DescribePlatformIdsByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( "user-0001" )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DescribePlatformIdsByUserIdRequest ;
import io.gs2.account.result.DescribePlatformIdsByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DescribePlatformIdsByUserIdResult result = client . describePlatformIdsByUserId (
new DescribePlatformIdsByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "user-0001" )
. withPageToken ( null )
. withLimit ( null )
. withTimeOffsetToken ( null )
);
List < PlatformId > 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DescribePlatformIdsByUserIdRequest ;
using Gs2.Gs2Account.Result.DescribePlatformIdsByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DescribePlatformIdsByUserIdResult > asyncResult = null ;
yield return client . DescribePlatformIdsByUserId (
new Gs2 . Gs2Account . Request . DescribePlatformIdsByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "user-0001" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . describePlatformIdsByUserId (
new Gs2Account . DescribePlatformIdsByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "user-0001" )
. 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . describe_platform_ids_by_user_id (
account . DescribePlatformIdsByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( 'user-0001' )
. 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 ( 'account' )
api_result = client.describe_platform_ids_by_user_id ({
namespaceName = "namespace1" ,
userId = "user-0001" ,
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 ( 'account' )
api_result_handler = client.describe_platform_ids_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "user-0001" ,
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 ;
各種プラットフォームにおけるユーザーIDを新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 各種プラットフォームにおけるユーザー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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreatePlatformId (
& account . CreatePlatformIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "accessToken-0001" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "123456" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\CreatePlatformIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createPlatformId (
( new CreatePlatformIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $accessToken0001 )
-> withType ( 0 )
-> withUserIdentifier ( "123456" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreatePlatformIdRequest ;
import io.gs2.account.result.CreatePlatformIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreatePlatformIdResult result = client . createPlatformId (
new CreatePlatformIdRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "accessToken-0001" )
. withType ( 0 )
. withUserIdentifier ( "123456" )
);
PlatformId 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreatePlatformIdRequest ;
using Gs2.Gs2Account.Result.CreatePlatformIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreatePlatformIdResult > asyncResult = null ;
yield return client . CreatePlatformId (
new Gs2 . Gs2Account . Request . CreatePlatformIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "accessToken-0001" )
. WithType ( 0 )
. WithUserIdentifier ( "123456" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createPlatformId (
new Gs2Account . CreatePlatformIdRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "accessToken-0001" )
. withType ( 0 )
. withUserIdentifier ( "123456" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_platform_id (
account . CreatePlatformIdRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . access_token_0001 )
. with_type ( 0 )
. with_user_identifier ( '123456' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.create_platform_id ({
namespaceName = "namespace1" ,
accessToken = "accessToken-0001" ,
type = 0 ,
userIdentifier = "123456" ,
})
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 ( 'account' )
api_result_handler = client.create_platform_id_async ({
namespaceName = "namespace1" ,
accessToken = "accessToken-0001" ,
type = 0 ,
userIdentifier = "123456" ,
})
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 ;
ユーザーIDを指定して各種プラットフォームにおけるユーザーIDを新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 各種プラットフォームにおけるユーザー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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreatePlatformIdByUserId (
& account . CreatePlatformIdByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "123456789" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\CreatePlatformIdByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createPlatformIdByUserId (
( new CreatePlatformIdByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withType ( 0 )
-> withUserIdentifier ( "123456789" )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreatePlatformIdByUserIdRequest ;
import io.gs2.account.result.CreatePlatformIdByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreatePlatformIdByUserIdResult result = client . createPlatformIdByUserId (
new CreatePlatformIdByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withUserIdentifier ( "123456789" )
. withTimeOffsetToken ( null )
);
PlatformId 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreatePlatformIdByUserIdRequest ;
using Gs2.Gs2Account.Result.CreatePlatformIdByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreatePlatformIdByUserIdResult > asyncResult = null ;
yield return client . CreatePlatformIdByUserId (
new Gs2 . Gs2Account . Request . CreatePlatformIdByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithType ( 0 )
. WithUserIdentifier ( "123456789" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createPlatformIdByUserId (
new Gs2Account . CreatePlatformIdByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withUserIdentifier ( "123456789" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_platform_id_by_user_id (
account . CreatePlatformIdByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_type ( 0 )
. with_user_identifier ( '123456789' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.create_platform_id_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
userIdentifier = "123456789" ,
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 ( 'account' )
api_result_handler = client.create_platform_id_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
userIdentifier = "123456789" ,
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 ;
各種プラットフォームにおけるユーザーIDを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetPlatformId (
& account . GetPlatformIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "accessToken-0001" ),
Type : pointy . Int32 ( 0 ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetPlatformIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getPlatformId (
( new GetPlatformIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $accessToken0001 )
-> withType ( 0 )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetPlatformIdRequest ;
import io.gs2.account.result.GetPlatformIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetPlatformIdResult result = client . getPlatformId (
new GetPlatformIdRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "accessToken-0001" )
. withType ( 0 )
);
PlatformId 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetPlatformIdRequest ;
using Gs2.Gs2Account.Result.GetPlatformIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetPlatformIdResult > asyncResult = null ;
yield return client . GetPlatformId (
new Gs2 . Gs2Account . Request . GetPlatformIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "accessToken-0001" )
. WithType ( 0 ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getPlatformId (
new Gs2Account . GetPlatformIdRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "accessToken-0001" )
. withType ( 0 )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_platform_id (
account . GetPlatformIdRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . access_token_0001 )
. with_type ( 0 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_platform_id ({
namespaceName = "namespace1" ,
accessToken = "accessToken-0001" ,
type = 0 ,
})
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 ( 'account' )
api_result_handler = client.get_platform_id_async ({
namespaceName = "namespace1" ,
accessToken = "accessToken-0001" ,
type = 0 ,
})
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 ;
ユーザーIDを指定して各種プラットフォームにおけるユーザーIDを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetPlatformIdByUserId (
& account . GetPlatformIdByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
Type : pointy . Int32 ( 0 ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetPlatformIdByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getPlatformIdByUserId (
( new GetPlatformIdByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> withType ( 0 )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetPlatformIdByUserIdRequest ;
import io.gs2.account.result.GetPlatformIdByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetPlatformIdByUserIdResult result = client . getPlatformIdByUserId (
new GetPlatformIdByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withTimeOffsetToken ( null )
);
PlatformId 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetPlatformIdByUserIdRequest ;
using Gs2.Gs2Account.Result.GetPlatformIdByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetPlatformIdByUserIdResult > asyncResult = null ;
yield return client . GetPlatformIdByUserId (
new Gs2 . Gs2Account . Request . GetPlatformIdByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. WithType ( 0 )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getPlatformIdByUserId (
new Gs2Account . GetPlatformIdByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withType ( 0 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_platform_id_by_user_id (
account . GetPlatformIdByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_type ( 0 )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_platform_id_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
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 ( 'account' )
api_result_handler = client.get_platform_id_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
type = 0 ,
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 ;
各種プラットフォームにおけるユーザーIDを指定してGS2-AccountのユーザーIDを取得
ネームスペースの設定で「ログインに使用するユーザーIDとデータの保持に使用するユーザーIDを異なるものにする」を有効にしている場合はデータオーナーIDを取得できます。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 各種プラットフォームにおけるユーザー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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . FindPlatformId (
& account . FindPlatformIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "accessToken-0001" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "123456" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\FindPlatformIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> findPlatformId (
( new FindPlatformIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $accessToken0001 )
-> withType ( 0 )
-> withUserIdentifier ( "123456" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.FindPlatformIdRequest ;
import io.gs2.account.result.FindPlatformIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
FindPlatformIdResult result = client . findPlatformId (
new FindPlatformIdRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "accessToken-0001" )
. withType ( 0 )
. withUserIdentifier ( "123456" )
);
PlatformUser 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.FindPlatformIdRequest ;
using Gs2.Gs2Account.Result.FindPlatformIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . FindPlatformIdResult > asyncResult = null ;
yield return client . FindPlatformId (
new Gs2 . Gs2Account . Request . FindPlatformIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "accessToken-0001" )
. WithType ( 0 )
. WithUserIdentifier ( "123456" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . findPlatformId (
new Gs2Account . FindPlatformIdRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "accessToken-0001" )
. withType ( 0 )
. withUserIdentifier ( "123456" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . find_platform_id (
account . FindPlatformIdRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . access_token_0001 )
. with_type ( 0 )
. with_user_identifier ( '123456' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.find_platform_id ({
namespaceName = "namespace1" ,
accessToken = "accessToken-0001" ,
type = 0 ,
userIdentifier = "123456" ,
})
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 ( 'account' )
api_result_handler = client.find_platform_id_async ({
namespaceName = "namespace1" ,
accessToken = "accessToken-0001" ,
type = 0 ,
userIdentifier = "123456" ,
})
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 ;
ユーザーIDを指定して各種プラットフォームにおけるユーザーIDを取得
ネームスペースの設定で「ログインに使用するユーザーIDとデータの保持に使用するユーザーIDを異なるものにする」を有効にしている場合はデータオーナーIDを取得できます。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ✓ ~ 1024文字 各種プラットフォームにおけるユーザー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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . FindPlatformIdByUserId (
& account . FindPlatformIdByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "user-0001" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "123456" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\FindPlatformIdByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> findPlatformIdByUserId (
( new FindPlatformIdByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( "user-0001" )
-> withType ( 0 )
-> withUserIdentifier ( "123456" )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.FindPlatformIdByUserIdRequest ;
import io.gs2.account.result.FindPlatformIdByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
FindPlatformIdByUserIdResult result = client . findPlatformIdByUserId (
new FindPlatformIdByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "user-0001" )
. withType ( 0 )
. withUserIdentifier ( "123456" )
. withTimeOffsetToken ( null )
);
PlatformUser 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.FindPlatformIdByUserIdRequest ;
using Gs2.Gs2Account.Result.FindPlatformIdByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . FindPlatformIdByUserIdResult > asyncResult = null ;
yield return client . FindPlatformIdByUserId (
new Gs2 . Gs2Account . Request . FindPlatformIdByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "user-0001" )
. WithType ( 0 )
. WithUserIdentifier ( "123456" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . findPlatformIdByUserId (
new Gs2Account . FindPlatformIdByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "user-0001" )
. withType ( 0 )
. withUserIdentifier ( "123456" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . find_platform_id_by_user_id (
account . FindPlatformIdByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( 'user-0001' )
. with_type ( 0 )
. with_user_identifier ( '123456' )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.find_platform_id_by_user_id ({
namespaceName = "namespace1" ,
userId = "user-0001" ,
type = 0 ,
userIdentifier = "123456" ,
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 ( 'account' )
api_result_handler = client.find_platform_id_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "user-0001" ,
type = 0 ,
userIdentifier = "123456" ,
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 ;
各種プラットフォームにおけるユーザーIDを削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 accessToken string ✓ ~ 128文字 ユーザーID type int ✓ ~ 1024 スロット番号 userIdentifier string ~ 1024文字 各種プラットフォームにおけるユーザー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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeletePlatformId (
& account . DeletePlatformIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
AccessToken : pointy . String ( "accessToken-0001" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "123456" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeletePlatformIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deletePlatformId (
( new DeletePlatformIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withAccessToken ( self :: $accessToken0001 )
-> withType ( 0 )
-> withUserIdentifier ( "123456" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeletePlatformIdRequest ;
import io.gs2.account.result.DeletePlatformIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeletePlatformIdResult result = client . deletePlatformId (
new DeletePlatformIdRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "accessToken-0001" )
. withType ( 0 )
. withUserIdentifier ( "123456" )
);
PlatformId 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeletePlatformIdRequest ;
using Gs2.Gs2Account.Result.DeletePlatformIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeletePlatformIdResult > asyncResult = null ;
yield return client . DeletePlatformId (
new Gs2 . Gs2Account . Request . DeletePlatformIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithAccessToken ( "accessToken-0001" )
. WithType ( 0 )
. WithUserIdentifier ( "123456" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deletePlatformId (
new Gs2Account . DeletePlatformIdRequest ()
. withNamespaceName ( "namespace1" )
. withAccessToken ( "accessToken-0001" )
. withType ( 0 )
. withUserIdentifier ( "123456" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_platform_id (
account . DeletePlatformIdRequest ()
. with_namespace_name ( self . hash1 )
. with_access_token ( self . access_token_0001 )
. with_type ( 0 )
. with_user_identifier ( '123456' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_platform_id ({
namespaceName = "namespace1" ,
accessToken = "accessToken-0001" ,
type = 0 ,
userIdentifier = "123456" ,
})
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 ( 'account' )
api_result_handler = client.delete_platform_id_async ({
namespaceName = "namespace1" ,
accessToken = "accessToken-0001" ,
type = 0 ,
userIdentifier = "123456" ,
})
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 ;
各種プラットフォームにおけるユーザーIDを指定して各種プラットフォームにおけるユーザーIDを削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 1024 スロット番号 userIdentifier string ~ 1024文字 各種プラットフォームにおけるユーザー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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeletePlatformIdByUserIdentifier (
& account . DeletePlatformIdByUserIdentifierRequest {
NamespaceName : pointy . String ( "namespace1" ),
Type : pointy . Int32 ( 0 ),
UserIdentifier : pointy . String ( "123456789" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeletePlatformIdByUserIdentifierRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deletePlatformIdByUserIdentifier (
( new DeletePlatformIdByUserIdentifierRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withType ( 0 )
-> withUserIdentifier ( "123456789" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeletePlatformIdByUserIdentifierRequest ;
import io.gs2.account.result.DeletePlatformIdByUserIdentifierResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeletePlatformIdByUserIdentifierResult result = client . deletePlatformIdByUserIdentifier (
new DeletePlatformIdByUserIdentifierRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withUserIdentifier ( "123456789" )
);
PlatformId 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeletePlatformIdByUserIdentifierRequest ;
using Gs2.Gs2Account.Result.DeletePlatformIdByUserIdentifierResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeletePlatformIdByUserIdentifierResult > asyncResult = null ;
yield return client . DeletePlatformIdByUserIdentifier (
new Gs2 . Gs2Account . Request . DeletePlatformIdByUserIdentifierRequest ()
. WithNamespaceName ( "namespace1" )
. WithType ( 0 )
. WithUserIdentifier ( "123456789" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deletePlatformIdByUserIdentifier (
new Gs2Account . DeletePlatformIdByUserIdentifierRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withUserIdentifier ( "123456789" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_platform_id_by_user_identifier (
account . DeletePlatformIdByUserIdentifierRequest ()
. with_namespace_name ( self . hash1 )
. with_type ( 0 )
. with_user_identifier ( '123456789' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_platform_id_by_user_identifier ({
namespaceName = "namespace1" ,
type = 0 ,
userIdentifier = "123456789" ,
})
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 ( 'account' )
api_result_handler = client.delete_platform_id_by_user_identifier_async ({
namespaceName = "namespace1" ,
type = 0 ,
userIdentifier = "123456789" ,
})
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 ;
ユーザーIDを指定して各種プラットフォームにおけるユーザーIDを削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ ~ 128文字 ユーザーID type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeletePlatformIdByUserId (
& account . DeletePlatformIdByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "user-0001" ),
Type : pointy . Int32 ( 0 ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeletePlatformIdByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deletePlatformIdByUserId (
( new DeletePlatformIdByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( "user-0001" )
-> withType ( 0 )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeletePlatformIdByUserIdRequest ;
import io.gs2.account.result.DeletePlatformIdByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeletePlatformIdByUserIdResult result = client . deletePlatformIdByUserId (
new DeletePlatformIdByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "user-0001" )
. withType ( 0 )
. withTimeOffsetToken ( null )
);
PlatformId 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeletePlatformIdByUserIdRequest ;
using Gs2.Gs2Account.Result.DeletePlatformIdByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeletePlatformIdByUserIdResult > asyncResult = null ;
yield return client . DeletePlatformIdByUserId (
new Gs2 . Gs2Account . Request . DeletePlatformIdByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "user-0001" )
. WithType ( 0 )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deletePlatformIdByUserId (
new Gs2Account . DeletePlatformIdByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "user-0001" )
. withType ( 0 )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_platform_id_by_user_id (
account . DeletePlatformIdByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( 'user-0001' )
. with_type ( 0 )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_platform_id_by_user_id ({
namespaceName = "namespace1" ,
userId = "user-0001" ,
type = 0 ,
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 ( 'account' )
api_result_handler = client.delete_platform_id_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "user-0001" ,
type = 0 ,
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 ;
getDataOwnerByUserId データオーナーを取得
指定されたユーザーIDに関連付けられたデータオーナーの情報を取得するために使用されます。 このアクションは、指定された名前空間内の特定のアカウントに紐づくデータオーナーの詳細情報を返します。 データオーナー情報には、データオーナーID、関連するユーザーID、およびその他の関連情報が含まれます。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ UUID ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetDataOwnerByUserId (
& account . GetDataOwnerByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetDataOwnerByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getDataOwnerByUserId (
( new GetDataOwnerByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetDataOwnerByUserIdRequest ;
import io.gs2.account.result.GetDataOwnerByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetDataOwnerByUserIdResult result = client . getDataOwnerByUserId (
new GetDataOwnerByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffsetToken ( null )
);
DataOwner 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetDataOwnerByUserIdRequest ;
using Gs2.Gs2Account.Result.GetDataOwnerByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetDataOwnerByUserIdResult > asyncResult = null ;
yield return client . GetDataOwnerByUserId (
new Gs2 . Gs2Account . Request . GetDataOwnerByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getDataOwnerByUserId (
new Gs2Account . GetDataOwnerByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_data_owner_by_user_id (
account . GetDataOwnerByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_data_owner_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ( 'account' )
api_result_handler = client.get_data_owner_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ;
deleteDataOwnerByUserId データオーナーを削除
特定のユーザーIDに関連付けられたデータオーナーの情報を削除するために使用されます。 このアクションは、指定された名前空間内のアカウントに関連するデータオーナーをシステムから完全に削除します。 ユーザーIDとデータオーナーIDの関連性が失われ、GS2 が管理するユーザーデータ内にユーザーIDが含まれない限り誰のデータかが不明な状態になります。
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 userId string ✓ UUID ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeleteDataOwnerByUserId (
& account . DeleteDataOwnerByUserIdRequest {
NamespaceName : pointy . String ( "namespace1" ),
UserId : pointy . String ( "$account1.userId" ),
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeleteDataOwnerByUserIdRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteDataOwnerByUserId (
( new DeleteDataOwnerByUserIdRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withUserId ( self :: $account1 . userId )
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeleteDataOwnerByUserIdRequest ;
import io.gs2.account.result.DeleteDataOwnerByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeleteDataOwnerByUserIdResult result = client . deleteDataOwnerByUserId (
new DeleteDataOwnerByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffsetToken ( null )
);
DataOwner 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeleteDataOwnerByUserIdRequest ;
using Gs2.Gs2Account.Result.DeleteDataOwnerByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeleteDataOwnerByUserIdResult > asyncResult = null ;
yield return client . DeleteDataOwnerByUserId (
new Gs2 . Gs2Account . Request . DeleteDataOwnerByUserIdRequest ()
. WithNamespaceName ( "namespace1" )
. WithUserId ( "$account1.userId" )
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deleteDataOwnerByUserId (
new Gs2Account . DeleteDataOwnerByUserIdRequest ()
. withNamespaceName ( "namespace1" )
. withUserId ( "$account1.userId" )
. withTimeOffsetToken ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_data_owner_by_user_id (
account . DeleteDataOwnerByUserIdRequest ()
. with_namespace_name ( self . hash1 )
. with_user_id ( self . account1 . user_id )
. with_time_offset_token ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_data_owner_by_user_id ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ( 'account' )
api_result_handler = client.delete_data_owner_by_user_id_async ({
namespaceName = "namespace1" ,
userId = "$account1.userId" ,
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 ;
describeTakeOverTypeModels 引き継ぎ情報モデルの一覧を取得
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DescribeTakeOverTypeModels (
& account . DescribeTakeOverTypeModelsRequest {
NamespaceName : pointy . String ( "namespace2" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DescribeTakeOverTypeModelsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeTakeOverTypeModels (
( new DescribeTakeOverTypeModelsRequest ())
-> withNamespaceName ( self :: namespace2 )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DescribeTakeOverTypeModelsRequest ;
import io.gs2.account.result.DescribeTakeOverTypeModelsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DescribeTakeOverTypeModelsResult result = client . describeTakeOverTypeModels (
new DescribeTakeOverTypeModelsRequest ()
. withNamespaceName ( "namespace2" )
);
List < TakeOverTypeModel > 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DescribeTakeOverTypeModelsRequest ;
using Gs2.Gs2Account.Result.DescribeTakeOverTypeModelsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DescribeTakeOverTypeModelsResult > asyncResult = null ;
yield return client . DescribeTakeOverTypeModels (
new Gs2 . Gs2Account . Request . DescribeTakeOverTypeModelsRequest ()
. WithNamespaceName ( "namespace2" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . describeTakeOverTypeModels (
new Gs2Account . DescribeTakeOverTypeModelsRequest ()
. withNamespaceName ( "namespace2" )
);
const items = result . getItems ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . describe_take_over_type_models (
account . DescribeTakeOverTypeModelsRequest ()
. with_namespace_name ( self . hash2 )
)
items = result . items
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.describe_take_over_type_models ({
namespaceName = "namespace2" ,
})
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 ( 'account' )
api_result_handler = client.describe_take_over_type_models_async ({
namespaceName = "namespace2" ,
})
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 ;
getTakeOverTypeModel 引き継ぎ情報モデルを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetTakeOverTypeModel (
& account . GetTakeOverTypeModelRequest {
NamespaceName : pointy . String ( "namespace2" ),
Type : pointy . Int32 ( 0 ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetTakeOverTypeModelRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getTakeOverTypeModel (
( new GetTakeOverTypeModelRequest ())
-> withNamespaceName ( self :: namespace2 )
-> withType ( 0 )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetTakeOverTypeModelRequest ;
import io.gs2.account.result.GetTakeOverTypeModelResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetTakeOverTypeModelResult result = client . getTakeOverTypeModel (
new GetTakeOverTypeModelRequest ()
. withNamespaceName ( "namespace2" )
. withType ( 0 )
);
TakeOverTypeModel 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetTakeOverTypeModelRequest ;
using Gs2.Gs2Account.Result.GetTakeOverTypeModelResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetTakeOverTypeModelResult > asyncResult = null ;
yield return client . GetTakeOverTypeModel (
new Gs2 . Gs2Account . Request . GetTakeOverTypeModelRequest ()
. WithNamespaceName ( "namespace2" )
. WithType ( 0 ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getTakeOverTypeModel (
new Gs2Account . GetTakeOverTypeModelRequest ()
. withNamespaceName ( "namespace2" )
. withType ( 0 )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_take_over_type_model (
account . GetTakeOverTypeModelRequest ()
. with_namespace_name ( self . hash2 )
. with_type ( 0 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_take_over_type_model ({
namespaceName = "namespace2" ,
type = 0 ,
})
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 ( 'account' )
api_result_handler = client.get_take_over_type_model_async ({
namespaceName = "namespace2" ,
type = 0 ,
})
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 ;
describeTakeOverTypeModelMasters 引き継ぎ情報モデルマスターの一覧を取得
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DescribeTakeOverTypeModelMasters (
& account . DescribeTakeOverTypeModelMastersRequest {
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DescribeTakeOverTypeModelMastersRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeTakeOverTypeModelMasters (
( new DescribeTakeOverTypeModelMastersRequest ())
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DescribeTakeOverTypeModelMastersRequest ;
import io.gs2.account.result.DescribeTakeOverTypeModelMastersResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DescribeTakeOverTypeModelMastersResult result = client . describeTakeOverTypeModelMasters (
new DescribeTakeOverTypeModelMastersRequest ()
. withNamespaceName ( "namespace1" )
. withPageToken ( null )
. withLimit ( null )
);
List < TakeOverTypeModelMaster > 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DescribeTakeOverTypeModelMastersRequest ;
using Gs2.Gs2Account.Result.DescribeTakeOverTypeModelMastersResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DescribeTakeOverTypeModelMastersResult > asyncResult = null ;
yield return client . DescribeTakeOverTypeModelMasters (
new Gs2 . Gs2Account . Request . DescribeTakeOverTypeModelMastersRequest ()
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . describeTakeOverTypeModelMasters (
new Gs2Account . DescribeTakeOverTypeModelMastersRequest ()
. 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . describe_take_over_type_model_masters (
account . DescribeTakeOverTypeModelMastersRequest ()
. 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 ( 'account' )
api_result = client.describe_take_over_type_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 ( 'account' )
api_result_handler = client.describe_take_over_type_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 ;
createTakeOverTypeModelMaster 引き継ぎ情報モデルマスターを新規作成
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 1024 スロット番号 description string ~ 1024文字 説明文 metadata string ~ 2048文字 メタデータ openIdConnectSetting OpenIdConnectSetting ✓ OpenID Connect の設定
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . CreateTakeOverTypeModelMaster (
& account . CreateTakeOverTypeModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Type : pointy . Int32 ( 0 ),
Description : nil ,
Metadata : pointy . String ( "Google" ),
OpenIdConnectSetting : & account . OpenIdConnectSetting {
ConfigurationPath : pointy . String ( "https://accounts.google.com/.well-known/openid-configuration" ),
ClientId : pointy . String ( "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com" ),
ClientSecret : pointy . String ( "secret" ),
},
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\CreateTakeOverTypeModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createTakeOverTypeModelMaster (
( new CreateTakeOverTypeModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withType ( 0 )
-> withDescription ( null )
-> withMetadata ( "Google" )
-> withOpenIdConnectSetting (( new \Gs2\Account\Model\OpenIdConnectSetting ())
-> withConfigurationPath ( "https://accounts.google.com/.well-known/openid-configuration" )
-> withClientId ( "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com" )
-> withClientSecret ( "secret" ))
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.CreateTakeOverTypeModelMasterRequest ;
import io.gs2.account.result.CreateTakeOverTypeModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
CreateTakeOverTypeModelMasterResult result = client . createTakeOverTypeModelMaster (
new CreateTakeOverTypeModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withDescription ( null )
. withMetadata ( "Google" )
. withOpenIdConnectSetting ( new io . gs2 . account . model . OpenIdConnectSetting ()
. withConfigurationPath ( "https://accounts.google.com/.well-known/openid-configuration" )
. withClientId ( "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com" )
. withClientSecret ( "secret" ))
);
TakeOverTypeModelMaster 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.CreateTakeOverTypeModelMasterRequest ;
using Gs2.Gs2Account.Result.CreateTakeOverTypeModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . CreateTakeOverTypeModelMasterResult > asyncResult = null ;
yield return client . CreateTakeOverTypeModelMaster (
new Gs2 . Gs2Account . Request . CreateTakeOverTypeModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithType ( 0 )
. WithDescription ( null )
. WithMetadata ( "Google" )
. WithOpenIdConnectSetting ( new Gs2 . Gs2Account . Model . OpenIdConnectSetting ()
. WithConfigurationPath ( "https://accounts.google.com/.well-known/openid-configuration" )
. WithClientId ( "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com" )
. WithClientSecret ( "secret" )),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . createTakeOverTypeModelMaster (
new Gs2Account . CreateTakeOverTypeModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withDescription ( null )
. withMetadata ( "Google" )
. withOpenIdConnectSetting ( new Gs2Account . model . OpenIdConnectSetting ()
. withConfigurationPath ( "https://accounts.google.com/.well-known/openid-configuration" )
. withClientId ( "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com" )
. withClientSecret ( "secret" ))
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . create_take_over_type_model_master (
account . CreateTakeOverTypeModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_type ( 0 )
. with_description ( None )
. with_metadata ( 'Google' )
. with_open_id_connect_setting (
account . OpenIdConnectSetting ()
. with_configuration_path ( 'https://accounts.google.com/.well-known/openid-configuration' )
. with_client_id ( '695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com' )
. with_client_secret ( 'secret' ))
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.create_take_over_type_model_master ({
namespaceName = "namespace1" ,
type = 0 ,
description = nil ,
metadata = "Google" ,
openIdConnectSetting = {
configurationPath = "https://accounts.google.com/.well-known/openid-configuration" ,
clientId = "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com" ,
clientSecret = "secret" ,
},
})
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 ( 'account' )
api_result_handler = client.create_take_over_type_model_master_async ({
namespaceName = "namespace1" ,
type = 0 ,
description = nil ,
metadata = "Google" ,
openIdConnectSetting = {
configurationPath = "https://accounts.google.com/.well-known/openid-configuration" ,
clientId = "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com" ,
clientSecret = "secret" ,
},
})
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 ;
getTakeOverTypeModelMaster 引き継ぎ情報モデルマスターを取得
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetTakeOverTypeModelMaster (
& account . GetTakeOverTypeModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Type : pointy . Int32 ( 0 ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetTakeOverTypeModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getTakeOverTypeModelMaster (
( new GetTakeOverTypeModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withType ( 0 )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetTakeOverTypeModelMasterRequest ;
import io.gs2.account.result.GetTakeOverTypeModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetTakeOverTypeModelMasterResult result = client . getTakeOverTypeModelMaster (
new GetTakeOverTypeModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
);
TakeOverTypeModelMaster 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetTakeOverTypeModelMasterRequest ;
using Gs2.Gs2Account.Result.GetTakeOverTypeModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetTakeOverTypeModelMasterResult > asyncResult = null ;
yield return client . GetTakeOverTypeModelMaster (
new Gs2 . Gs2Account . Request . GetTakeOverTypeModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithType ( 0 ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getTakeOverTypeModelMaster (
new Gs2Account . GetTakeOverTypeModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_take_over_type_model_master (
account . GetTakeOverTypeModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_type ( 0 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_take_over_type_model_master ({
namespaceName = "namespace1" ,
type = 0 ,
})
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 ( 'account' )
api_result_handler = client.get_take_over_type_model_master_async ({
namespaceName = "namespace1" ,
type = 0 ,
})
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 ;
updateTakeOverTypeModelMaster 引き継ぎ情報モデルマスターを更新
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 1024 スロット番号 description string ~ 1024文字 説明文 metadata string ~ 2048文字 メタデータ openIdConnectSetting OpenIdConnectSetting ✓ OpenID Connect の設定
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . UpdateTakeOverTypeModelMaster (
& account . UpdateTakeOverTypeModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Type : pointy . Int32 ( 0 ),
Description : pointy . String ( "description1" ),
Metadata : pointy . String ( "Microsoft" ),
OpenIdConnectSetting : & account . OpenIdConnectSetting {
ConfigurationPath : pointy . String ( "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration" ),
ClientId : pointy . String ( "io.gs2.sample.auth" ),
ClientSecret : pointy . String ( "secret" ),
},
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\UpdateTakeOverTypeModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateTakeOverTypeModelMaster (
( new UpdateTakeOverTypeModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withType ( 0 )
-> withDescription ( "description1" )
-> withMetadata ( "Microsoft" )
-> withOpenIdConnectSetting (( new \Gs2\Account\Model\OpenIdConnectSetting ())
-> withConfigurationPath ( "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration" )
-> withClientId ( "io.gs2.sample.auth" )
-> withClientSecret ( "secret" ))
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.UpdateTakeOverTypeModelMasterRequest ;
import io.gs2.account.result.UpdateTakeOverTypeModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
UpdateTakeOverTypeModelMasterResult result = client . updateTakeOverTypeModelMaster (
new UpdateTakeOverTypeModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withDescription ( "description1" )
. withMetadata ( "Microsoft" )
. withOpenIdConnectSetting ( new io . gs2 . account . model . OpenIdConnectSetting ()
. withConfigurationPath ( "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration" )
. withClientId ( "io.gs2.sample.auth" )
. withClientSecret ( "secret" ))
);
TakeOverTypeModelMaster 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.UpdateTakeOverTypeModelMasterRequest ;
using Gs2.Gs2Account.Result.UpdateTakeOverTypeModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . UpdateTakeOverTypeModelMasterResult > asyncResult = null ;
yield return client . UpdateTakeOverTypeModelMaster (
new Gs2 . Gs2Account . Request . UpdateTakeOverTypeModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithType ( 0 )
. WithDescription ( "description1" )
. WithMetadata ( "Microsoft" )
. WithOpenIdConnectSetting ( new Gs2 . Gs2Account . Model . OpenIdConnectSetting ()
. WithConfigurationPath ( "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration" )
. WithClientId ( "io.gs2.sample.auth" )
. WithClientSecret ( "secret" )),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . updateTakeOverTypeModelMaster (
new Gs2Account . UpdateTakeOverTypeModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
. withDescription ( "description1" )
. withMetadata ( "Microsoft" )
. withOpenIdConnectSetting ( new Gs2Account . model . OpenIdConnectSetting ()
. withConfigurationPath ( "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration" )
. withClientId ( "io.gs2.sample.auth" )
. withClientSecret ( "secret" ))
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . update_take_over_type_model_master (
account . UpdateTakeOverTypeModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_type ( 0 )
. with_description ( 'description1' )
. with_metadata ( 'Microsoft' )
. with_open_id_connect_setting (
account . OpenIdConnectSetting ()
. with_configuration_path ( 'https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration' )
. with_client_id ( 'io.gs2.sample.auth' )
. with_client_secret ( 'secret' ))
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.update_take_over_type_model_master ({
namespaceName = "namespace1" ,
type = 0 ,
description = "description1" ,
metadata = "Microsoft" ,
openIdConnectSetting = {
configurationPath = "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration" ,
clientId = "io.gs2.sample.auth" ,
clientSecret = "secret" ,
},
})
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 ( 'account' )
api_result_handler = client.update_take_over_type_model_master_async ({
namespaceName = "namespace1" ,
type = 0 ,
description = "description1" ,
metadata = "Microsoft" ,
openIdConnectSetting = {
configurationPath = "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration" ,
clientId = "io.gs2.sample.auth" ,
clientSecret = "secret" ,
},
})
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 ;
deleteTakeOverTypeModelMaster 引き継ぎ情報モデルマスターを削除
Request 型 有効化条件 必須 デフォルト 値の制限 説明 namespaceName string ✓ ~ 128文字 ネームスペース名 type int ✓ ~ 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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . DeleteTakeOverTypeModelMaster (
& account . DeleteTakeOverTypeModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Type : pointy . Int32 ( 0 ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\DeleteTakeOverTypeModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> deleteTakeOverTypeModelMaster (
( new DeleteTakeOverTypeModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withType ( 0 )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.DeleteTakeOverTypeModelMasterRequest ;
import io.gs2.account.result.DeleteTakeOverTypeModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
DeleteTakeOverTypeModelMasterResult result = client . deleteTakeOverTypeModelMaster (
new DeleteTakeOverTypeModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
);
TakeOverTypeModelMaster 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.DeleteTakeOverTypeModelMasterRequest ;
using Gs2.Gs2Account.Result.DeleteTakeOverTypeModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . DeleteTakeOverTypeModelMasterResult > asyncResult = null ;
yield return client . DeleteTakeOverTypeModelMaster (
new Gs2 . Gs2Account . Request . DeleteTakeOverTypeModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithType ( 0 ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . deleteTakeOverTypeModelMaster (
new Gs2Account . DeleteTakeOverTypeModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withType ( 0 )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . delete_take_over_type_model_master (
account . DeleteTakeOverTypeModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_type ( 0 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.delete_take_over_type_model_master ({
namespaceName = "namespace1" ,
type = 0 ,
})
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 ( 'account' )
api_result_handler = client.delete_take_over_type_model_master_async ({
namespaceName = "namespace1" ,
type = 0 ,
})
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 ;
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . ExportMaster (
& account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.ExportMasterRequest ;
import io.gs2.account.result.ExportMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
ExportMasterResult result = client . exportMaster (
new ExportMasterRequest ()
. withNamespaceName ( "namespace1" )
);
CurrentModelMaster 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.ExportMasterRequest ;
using Gs2.Gs2Account.Result.ExportMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . ExportMasterResult > asyncResult = null ;
yield return client . ExportMaster (
new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . exportMaster (
new Gs2Account . ExportMasterRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . export_master (
account . ExportMasterRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
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 ( 'account' )
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 ;
getCurrentModelMaster 現在有効なエントリー設定を取得
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . GetCurrentModelMaster (
& account . GetCurrentModelMasterRequest {
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\GetCurrentModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getCurrentModelMaster (
( new GetCurrentModelMasterRequest ())
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.GetCurrentModelMasterRequest ;
import io.gs2.account.result.GetCurrentModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
GetCurrentModelMasterResult result = client . getCurrentModelMaster (
new GetCurrentModelMasterRequest ()
. withNamespaceName ( "namespace1" )
);
CurrentModelMaster 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.GetCurrentModelMasterRequest ;
using Gs2.Gs2Account.Result.GetCurrentModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . GetCurrentModelMasterResult > asyncResult = null ;
yield return client . GetCurrentModelMaster (
new Gs2 . Gs2Account . Request . GetCurrentModelMasterRequest ()
. 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . getCurrentModelMaster (
new Gs2Account . GetCurrentModelMasterRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . get_current_model_master (
account . GetCurrentModelMasterRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.get_current_model_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 ( 'account' )
api_result_handler = client.get_current_model_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 ;
updateCurrentModelMaster 現在有効なエントリー設定を更新
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . UpdateCurrentModelMaster (
& account . UpdateCurrentModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Settings : pointy . String ( "{\"version\": \"2024-07-30\", \"takeOverTypeModels\": [{\"type\": 0, \"metadata\": \"Google\", \"openIdConnectSetting\": {\"configurationPath\": \"https://accounts.google.com/.well-known/openid-configuration\", \"clientId\": \"695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com\", \"clientSecret\": \"secret\"}}, {\"type\": 1, \"metadata\": \"Apple\", \"openIdConnectSetting\": {\"configurationPath\": \"https://appleid.apple.com/.well-known/openid-configuration\", \"clientId\": \"io.gs2.sample.auth\", \"appleTeamId\": \"9LX9LA85H8\", \"appleKeyId\": \"P937MLY6Z7\", \"applePrivateKeyPem\": \"-----BEGIN PRIVATE KEY-----\\\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\\n-----END PRIVATE KEY-----\"}}]}" ),
}
)
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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\UpdateCurrentModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateCurrentModelMaster (
( new UpdateCurrentModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withSettings ( "{ \" version \" : \" 2024-07-30 \" , \" takeOverTypeModels \" : [{ \" type \" : 0, \" metadata \" : \" Google \" , \" openIdConnectSetting \" : { \" configurationPath \" : \" https://accounts.google.com/.well-known/openid-configuration \" , \" clientId \" : \" 695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com \" , \" clientSecret \" : \" secret \" }}, { \" type \" : 1, \" metadata \" : \" Apple \" , \" openIdConnectSetting \" : { \" configurationPath \" : \" https://appleid.apple.com/.well-known/openid-configuration \" , \" clientId \" : \" io.gs2.sample.auth \" , \" appleTeamId \" : \" 9LX9LA85H8 \" , \" appleKeyId \" : \" P937MLY6Z7 \" , \" applePrivateKeyPem \" : \" -----BEGIN PRIVATE KEY----- \\\\ nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA \\\\ n-----END PRIVATE KEY----- \" }}]}" )
);
$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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.UpdateCurrentModelMasterRequest ;
import io.gs2.account.result.UpdateCurrentModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
UpdateCurrentModelMasterResult result = client . updateCurrentModelMaster (
new UpdateCurrentModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withSettings ( "{\"version\": \"2024-07-30\", \"takeOverTypeModels\": [{\"type\": 0, \"metadata\": \"Google\", \"openIdConnectSetting\": {\"configurationPath\": \"https://accounts.google.com/.well-known/openid-configuration\", \"clientId\": \"695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com\", \"clientSecret\": \"secret\"}}, {\"type\": 1, \"metadata\": \"Apple\", \"openIdConnectSetting\": {\"configurationPath\": \"https://appleid.apple.com/.well-known/openid-configuration\", \"clientId\": \"io.gs2.sample.auth\", \"appleTeamId\": \"9LX9LA85H8\", \"appleKeyId\": \"P937MLY6Z7\", \"applePrivateKeyPem\": \"-----BEGIN PRIVATE KEY-----\\\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\\n-----END PRIVATE KEY-----\"}}]}" )
);
CurrentModelMaster 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.UpdateCurrentModelMasterRequest ;
using Gs2.Gs2Account.Result.UpdateCurrentModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . UpdateCurrentModelMasterResult > asyncResult = null ;
yield return client . UpdateCurrentModelMaster (
new Gs2 . Gs2Account . Request . UpdateCurrentModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithSettings ( "{\"version\": \"2024-07-30\", \"takeOverTypeModels\": [{\"type\": 0, \"metadata\": \"Google\", \"openIdConnectSetting\": {\"configurationPath\": \"https://accounts.google.com/.well-known/openid-configuration\", \"clientId\": \"695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com\", \"clientSecret\": \"secret\"}}, {\"type\": 1, \"metadata\": \"Apple\", \"openIdConnectSetting\": {\"configurationPath\": \"https://appleid.apple.com/.well-known/openid-configuration\", \"clientId\": \"io.gs2.sample.auth\", \"appleTeamId\": \"9LX9LA85H8\", \"appleKeyId\": \"P937MLY6Z7\", \"applePrivateKeyPem\": \"-----BEGIN PRIVATE KEY-----\\\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\\n-----END PRIVATE KEY-----\"}}]}" ),
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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . updateCurrentModelMaster (
new Gs2Account . UpdateCurrentModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withSettings ( "{\"version\": \"2024-07-30\", \"takeOverTypeModels\": [{\"type\": 0, \"metadata\": \"Google\", \"openIdConnectSetting\": {\"configurationPath\": \"https://accounts.google.com/.well-known/openid-configuration\", \"clientId\": \"695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com\", \"clientSecret\": \"secret\"}}, {\"type\": 1, \"metadata\": \"Apple\", \"openIdConnectSetting\": {\"configurationPath\": \"https://appleid.apple.com/.well-known/openid-configuration\", \"clientId\": \"io.gs2.sample.auth\", \"appleTeamId\": \"9LX9LA85H8\", \"appleKeyId\": \"P937MLY6Z7\", \"applePrivateKeyPem\": \"-----BEGIN PRIVATE KEY-----\\\\nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\\n-----END PRIVATE KEY-----\"}}]}" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . update_current_model_master (
account . UpdateCurrentModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_settings ( '{"version": "2024-07-30", "takeOverTypeModels": [{"type": 0, "metadata": "Google", "openIdConnectSetting": {"configurationPath": "https://accounts.google.com/.well-known/openid-configuration", "clientId": "695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com", "clientSecret": "secret"}}, {"type": 1, "metadata": "Apple", "openIdConnectSetting": {"configurationPath": "https://appleid.apple.com/.well-known/openid-configuration", "clientId": "io.gs2.sample.auth", "appleTeamId": "9LX9LA85H8", "appleKeyId": "P937MLY6Z7", "applePrivateKeyPem": "-----BEGIN PRIVATE KEY----- \\\\ nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA \\\\ n-----END PRIVATE KEY-----"}}]}' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'account' )
api_result = client.update_current_model_master ({
namespaceName = "namespace1" ,
settings = "{ \" version \" : \" 2024-07-30 \" , \" takeOverTypeModels \" : [{ \" type \" : 0, \" metadata \" : \" Google \" , \" openIdConnectSetting \" : { \" configurationPath \" : \" https://accounts.google.com/.well-known/openid-configuration \" , \" clientId \" : \" 695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com \" , \" clientSecret \" : \" secret \" }}, { \" type \" : 1, \" metadata \" : \" Apple \" , \" openIdConnectSetting \" : { \" configurationPath \" : \" https://appleid.apple.com/.well-known/openid-configuration \" , \" clientId \" : \" io.gs2.sample.auth \" , \" appleTeamId \" : \" 9LX9LA85H8 \" , \" appleKeyId \" : \" P937MLY6Z7 \" , \" applePrivateKeyPem \" : \" -----BEGIN PRIVATE KEY----- \\ nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA \\ n-----END PRIVATE KEY----- \" }}]}" ,
})
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 ( 'account' )
api_result_handler = client.update_current_model_master_async ({
namespaceName = "namespace1" ,
settings = "{ \" version \" : \" 2024-07-30 \" , \" takeOverTypeModels \" : [{ \" type \" : 0, \" metadata \" : \" Google \" , \" openIdConnectSetting \" : { \" configurationPath \" : \" https://accounts.google.com/.well-known/openid-configuration \" , \" clientId \" : \" 695893071400-qelt0dsu8tkotl13psnq5d1ko7kki4sl.apps.googleusercontent.com \" , \" clientSecret \" : \" secret \" }}, { \" type \" : 1, \" metadata \" : \" Apple \" , \" openIdConnectSetting \" : { \" configurationPath \" : \" https://appleid.apple.com/.well-known/openid-configuration \" , \" clientId \" : \" io.gs2.sample.auth \" , \" appleTeamId \" : \" 9LX9LA85H8 \" , \" appleKeyId \" : \" P937MLY6Z7 \" , \" applePrivateKeyPem \" : \" -----BEGIN PRIVATE KEY----- \\ nAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA \\ n-----END PRIVATE KEY----- \" }}]}" ,
})
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 ;
updateCurrentModelMasterFromGitHub 現在有効なエントリー設定を更新
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/account"
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 := account . Gs2AccountRestClient {
Session : & session ,
}
result , err := client . UpdateCurrentModelMasterFromGitHub (
& account . UpdateCurrentModelMasterFromGitHubRequest {
NamespaceName : pointy . String ( "namespace1" ),
CheckoutSetting : & account . 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\Account\Gs2AccountRestClient ;
use Gs2\Account\Request\UpdateCurrentModelMasterFromGitHubRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateCurrentModelMasterFromGitHub (
( new UpdateCurrentModelMasterFromGitHubRequest ())
-> 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.account.rest.Gs2AccountRestClient ;
import io.gs2.account.request.UpdateCurrentModelMasterFromGitHubRequest ;
import io.gs2.account.result.UpdateCurrentModelMasterFromGitHubResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2AccountRestClient client = new Gs2AccountRestClient ( session );
try {
UpdateCurrentModelMasterFromGitHubResult result = client . updateCurrentModelMasterFromGitHub (
new UpdateCurrentModelMasterFromGitHubRequest ()
. withNamespaceName ( "namespace1" )
. withCheckoutSetting ( new GitHubCheckoutSetting ()
. withApiKeyId ( "$gitHubApiKey1.apiKeyId" )
. withRepositoryName ( "gs2io/master-data" )
. withSourcePath ( "path/to/file.json" )
. withReferenceType ( "branch" )
. withBranchName ( "develop" )
)
);
CurrentModelMaster 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.Gs2Account.Gs2AccountRestClient ;
using Gs2.Gs2Account.Request.UpdateCurrentModelMasterFromGitHubRequest ;
using Gs2.Gs2Account.Result.UpdateCurrentModelMasterFromGitHubResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2AccountRestClient ( session );
AsyncResult < Gs2 . Gs2Account . Result . UpdateCurrentModelMasterFromGitHubResult > asyncResult = null ;
yield return client . UpdateCurrentModelMasterFromGitHub (
new Gs2 . Gs2Account . Request . UpdateCurrentModelMasterFromGitHubRequest ()
. WithNamespaceName ( "namespace1" )
. WithCheckoutSetting ( new Gs2 . Gs2Account . 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 Gs2Account from '@/gs2/account' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Account . Gs2AccountRestClient ( session );
try {
const result = await client . updateCurrentModelMasterFromGitHub (
new Gs2Account . UpdateCurrentModelMasterFromGitHubRequest ()
. withNamespaceName ( "namespace1" )
. withCheckoutSetting ( new Gs2Account . 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 account
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = account . Gs2AccountRestClient ( session )
try :
result = client . update_current_model_master_from_git_hub (
account . UpdateCurrentModelMasterFromGitHubRequest ()
. with_namespace_name ( self . hash1 )
. with_checkout_setting ( account . 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 ( 'account' )
api_result = client.update_current_model_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 ( 'account' )
api_result_handler = client.update_current_model_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 ;