GS2-Enchant SDK API リファレンス
モデル
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN | ||
name | string | ✓ | ~ 32文字 | ネームスペース名 | ||
description | string | ~ 1024文字 | 説明文 | |||
transactionSetting | TransactionSetting | ✓ | トランザクション設定 | |||
logSetting | LogSetting | ログの出力設定 | ||||
createdAt | long | ✓ | 作成日時 | |||
updatedAt | long | ✓ | 最終更新日時 | |||
revision | long | 0 | ~ 9223372036854775805 | リビジョン |
BalanceParameterModel
バランスパラメーターモデル
バランスパラメーターの抽選条件を定義します。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
balanceParameterModelId | string | ✓ | ~ 1024文字 | バランスパラメーターモデルGRN | ||
name | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
totalValue | long | ✓ | ~ 9223372036854775805 | 合計値 | ||
initialValueStrategy | enum [‘average’, ’lottery’] | ✓ | “average” | ~ 128文字 | 初期値の設定方針 | |
parameters | List<BalanceParameterValueModel> | ✓ | バランスパラメーター値モデルのリスト |
BalanceParameterModelMaster
バランスパラメーターモデルマスター
バランスパラメーターの抽選条件を定義します。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
balanceParameterModelId | string | ✓ | ~ 1024文字 | バランスパラメーターモデルGRN | ||
name | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 | ||
description | string | ~ 1024文字 | 説明文 | |||
metadata | string | ~ 2048文字 | メタデータ | |||
totalValue | long | ✓ | ~ 9223372036854775805 | 合計値 | ||
initialValueStrategy | enum [‘average’, ’lottery’] | ✓ | “average” | ~ 128文字 | 初期値の設定方針 | |
parameters | List<BalanceParameterValueModel> | ✓ | バランスパラメーター値モデルのリスト | |||
createdAt | long | ✓ | 作成日時 | |||
updatedAt | long | ✓ | 最終更新日時 | |||
revision | long | 0 | ~ 9223372036854775805 | リビジョン |
RarityParameterModel
レアリティパラメーターモデル
レアリティパラメーターの抽選条件を定義します。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
rarityParameterModelId | string | ✓ | ~ 1024文字 | レアリティパラメーターモデルGRN | ||
name | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 | ||
metadata | string | ~ 2048文字 | メタデータ | |||
maximumParameterCount | int | ✓ | 1 ~ 10 | 付与するパラメーターの最大数 | ||
parameterCounts | List<RarityParameterCountModel> | ✓ | レアリティパラメーターの付与数モデルのリスト | |||
parameters | List<RarityParameterValueModel> | ✓ | レアリティパラメーター値モデルのリスト |
RarityParameterModelMaster
レアリティパラメーターモデルマスター
レアリティパラメーターの抽選条件を定義します。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
rarityParameterModelId | string | ✓ | ~ 1024文字 | レアリティパラメーターモデルGRN | ||
name | string | ✓ | ~ 128文字 | レアリティパラメーターモデル名 | ||
description | string | ~ 1024文字 | 説明文 | |||
metadata | string | ~ 2048文字 | メタデータ | |||
maximumParameterCount | int | ✓ | 1 ~ 10 | 付与するパラメーターの最大数 | ||
parameterCounts | List<RarityParameterCountModel> | ✓ | レアリティパラメーターの付与数モデルのリスト | |||
parameters | List<RarityParameterValueModel> | ✓ | レアリティパラメーター値モデルのリスト | |||
createdAt | long | ✓ | 作成日時 | |||
updatedAt | long | ✓ | 最終更新日時 | |||
revision | long | 0 | ~ 9223372036854775805 | リビジョン |
CurrentParameterMaster
現在有効な強化レートマスター
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceId | string | ✓ | ~ 1024文字 | 現在有効なパラメーター設定GRN | ||
settings | string | ✓ | ~ 5242880文字 | マスターデータ |
BalanceParameterStatus
バランスパラメーターの状態
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
balanceParameterStatusId | string | ✓ | ~ 1024文字 | バランスパラメーターGRN | ||
userId | string | ✓ | ~ 128文字 | ユーザーID | ||
parameterName | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 | ||
propertyId | string | ✓ | ~ 1024文字 | パラメーターの保有元リソースのプロパティID | ||
parameterValues | List<BalanceParameterValue> | ✓ | バランスパラメーターの値リスト | |||
createdAt | long | ✓ | 作成日時 | |||
updatedAt | long | ✓ | 最終更新日時 | |||
revision | long | 0 | ~ 9223372036854775805 | リビジョン |
RarityParameterStatus
レアリティパラメーターの状態
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
rarityParameterStatusId | string | ✓ | ~ 1024文字 | レアリティパラメーターGRN | ||
userId | string | ✓ | ~ 128文字 | ユーザーID | ||
parameterName | string | ✓ | ~ 128文字 | レアリティパラメーターモデル名 | ||
propertyId | string | ✓ | ~ 1024文字 | パラメーターの保有元リソースのプロパティID | ||
parameterValues | List<RarityParameterValue> | レアリティパラメーターの値リスト | ||||
createdAt | long | ✓ | 作成日時 | |||
updatedAt | long | ✓ | 最終更新日時 | |||
revision | long | 0 | ~ 9223372036854775805 | リビジョン |
BalanceParameterValueModel
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 64文字 | 名前 | ||
metadata | string | ~ 512文字 | メタデータ |
RarityParameterCountModel
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
count | int | ✓ | ~ 10 | 値 | ||
weight | int | ✓ | 1 ~ 2147483646 | 排出重み |
RarityParameterValueModel
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 64文字 | 名前 | ||
metadata | string | ~ 512文字 | メタデータ | |||
resourceName | string | ✓ | ~ 64文字 | ゲーム内で使用するパラメーターリソースの種類を表す名前(GS2の動作のためには使用しません) | ||
resourceValue | long | ✓ | ~ 9223372036854775805 | ゲーム内で使用するパラメーターリソースの値(GS2の動作のためには使用しません) | ||
weight | int | ✓ | 1 ~ 2147483646 | 排出重み |
BalanceParameterValue
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 64文字 | 名前 | ||
value | long | ✓ | ~ 9223372036854775805 | 値 |
RarityParameterValue
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 64文字 | 名前 | ||
resourceName | string | ✓ | ~ 64文字 | リソースの名前 | ||
resourceValue | long | ✓ | ~ 9223372036854775805 | リソースの値 |
Config
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
key | string | ✓ | ~ 64文字 | 名前 | ||
value | string | ~ 51200文字 | 値 |
GitHubCheckoutSetting
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
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文字 | タグ名 |
ScriptSetting
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
triggerScriptId | string | ~ 1024文字 | スクリプトGRN | |||
doneTriggerTargetType | enum [’none’, ‘gs2_script’, ‘aws’] | ✓ | “none” | ~ 128文字 | 完了通知の通知先 | |
doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | スクリプトGRN | ||
doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | ネームスペースGRN |
LogSetting
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
TransactionSetting
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
enableAutoRun | bool | ✓ | false | 発行したスタンプシートをサーバーサイドで自動的に実行するか | ||
distributorNamespaceId | string | {enableAutoRun} | ✓ | ~ 1024文字 | スタンプシートの実行に使用する GS2-Distributor ネームスペース | |
keyId | string | !{enableAutoRun} | ✓ | ~ 1024文字 | スタンプシートの署名に使用する GS2-Key の暗号鍵 | |
queueNamespaceId | string | ~ 1024文字 | スタンプシートの実行に使用する GS2-JobQueue のネームスペース |
メソッド
describeNamespaces
ネームスペースの一覧を取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
pageToken | string | ~ 1024文字 | データの取得を開始する位置を指定するトークン | |||
limit | int | ✓ | 30 | 1 ~ 1000 | データの取得件数 |
Result
型 | 説明 | |
---|---|---|
items | List<Namespace> | ネームスペースのリスト |
nextPageToken | string | リストの続きを取得するためのページトークン |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.DescribeNamespaces(
&enchant.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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.DescribeNamespacesRequest;
import io.gs2.enchant.result.DescribeNamespacesResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.DescribeNamespacesRequest;
using Gs2.Gs2Enchant.Result.DescribeNamespacesResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.DescribeNamespacesResult> asyncResult = null;
yield return client.DescribeNamespaces(
new Gs2.Gs2Enchant.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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.describeNamespaces(
new Gs2Enchant.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 enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.describe_namespaces(
enchant.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('enchant')
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;
createNamespace
ネームスペースを新規作成
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | ||
description | string | ~ 1024文字 | 説明文 | |||
transactionSetting | TransactionSetting | ✓ | トランザクション設定 | |||
logSetting | LogSetting | ログの出力設定 |
Result
型 | 説明 | |
---|---|---|
item | Namespace | 作成したネームスペース |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.CreateNamespace(
&enchant.CreateNamespaceRequest {
Name: pointy.String("namespace1"),
Description: nil,
TransactionSetting: &enchant.TransactionSetting{
EnableAutoRun: pointy.Bool(false),
QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
KeyId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001"),
},
LogSetting: &enchant.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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\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)
->withTransactionSetting((new \Gs2\Enchant\Model\TransactionSetting())
->withEnableAutoRun(False)
->withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
->withKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:\namespace1:key:key-0001"))
->withLogSetting((new \Gs2\Enchant\Model\LogSetting())
->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:\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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.CreateNamespaceRequest;
import io.gs2.enchant.result.CreateNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
CreateNamespaceResult result = client.createNamespace(
new CreateNamespaceRequest()
.withName("namespace1")
.withDescription(null)
.withTransactionSetting(new io.gs2.enchant.model.TransactionSetting()
.withEnableAutoRun(false)
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
.withKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001"))
.withLogSetting(new io.gs2.enchant.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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.CreateNamespaceRequest;
using Gs2.Gs2Enchant.Result.CreateNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.CreateNamespaceResult> asyncResult = null;
yield return client.CreateNamespace(
new Gs2.Gs2Enchant.Request.CreateNamespaceRequest()
.WithName("namespace1")
.WithDescription(null)
.WithTransactionSetting(new Gs2.Gs2Enchant.Model.TransactionSetting()
.WithEnableAutoRun(false)
.WithQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
.WithKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001"))
.WithLogSetting(new Gs2.Gs2Enchant.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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.createNamespace(
new Gs2Enchant.CreateNamespaceRequest()
.withName("namespace1")
.withDescription(null)
.withTransactionSetting(new Gs2Enchant.model.TransactionSetting()
.withEnableAutoRun(false)
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
.withKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001"))
.withLogSetting(new Gs2Enchant.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 enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.create_namespace(
enchant.CreateNamespaceRequest()
.with_name(self.hash1)
.with_description(None)
.with_transaction_setting(
enchant.TransactionSetting()
.with_enable_auto_run(False)
.with_queue_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001')
.with_key_id('grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001'))
.with_log_setting(
enchant.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('enchant')
api_result = client.create_namespace({
name='namespace1',
description=nil,
transactionSetting={
enableAutoRun=false,
queueNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
keyId='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001',
},
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;
getNamespaceStatus
ネームスペースの状態を取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 |
Result
型 | 説明 | |
---|---|---|
status | string |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.GetNamespaceStatus(
&enchant.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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.GetNamespaceStatusRequest;
import io.gs2.enchant.result.GetNamespaceStatusResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.GetNamespaceStatusRequest;
using Gs2.Gs2Enchant.Result.GetNamespaceStatusResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.GetNamespaceStatusResult> asyncResult = null;
yield return client.GetNamespaceStatus(
new Gs2.Gs2Enchant.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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.getNamespaceStatus(
new Gs2Enchant.GetNamespaceStatusRequest()
.withNamespaceName("namespace1")
);
const status = result.getStatus();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.get_namespace_status(
enchant.GetNamespaceStatusRequest()
.with_namespace_name(self.hash1)
)
status = result.status
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
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;
getNamespace
ネームスペースを取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 |
Result
型 | 説明 | |
---|---|---|
item | Namespace | ネームスペース |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.GetNamespace(
&enchant.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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.GetNamespaceRequest;
import io.gs2.enchant.result.GetNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.GetNamespaceRequest;
using Gs2.Gs2Enchant.Result.GetNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.GetNamespaceResult> asyncResult = null;
yield return client.GetNamespace(
new Gs2.Gs2Enchant.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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.getNamespace(
new Gs2Enchant.GetNamespaceRequest()
.withNamespaceName("namespace1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.get_namespace(
enchant.GetNamespaceRequest()
.with_namespace_name(self.hash1)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
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;
updateNamespace
ネームスペースを更新
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
description | string | ~ 1024文字 | 説明文 | |||
transactionSetting | TransactionSetting | ✓ | トランザクション設定 | |||
logSetting | LogSetting | ログの出力設定 |
Result
型 | 説明 | |
---|---|---|
item | Namespace | 更新したネームスペース |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.UpdateNamespace(
&enchant.UpdateNamespaceRequest {
NamespaceName: pointy.String("namespace1"),
Description: pointy.String("description1"),
TransactionSetting: &enchant.TransactionSetting{
EnableAutoRun: pointy.Bool(false),
QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
KeyId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001"),
},
LogSetting: &enchant.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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\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")
->withTransactionSetting((new \Gs2\Enchant\Model\TransactionSetting())
->withEnableAutoRun(False)
->withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
->withKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:\namespace1:key:key-0001"))
->withLogSetting((new \Gs2\Enchant\Model\LogSetting())
->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:\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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.UpdateNamespaceRequest;
import io.gs2.enchant.result.UpdateNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
UpdateNamespaceResult result = client.updateNamespace(
new UpdateNamespaceRequest()
.withNamespaceName("namespace1")
.withDescription("description1")
.withTransactionSetting(new io.gs2.enchant.model.TransactionSetting()
.withEnableAutoRun(false)
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
.withKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001"))
.withLogSetting(new io.gs2.enchant.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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.UpdateNamespaceRequest;
using Gs2.Gs2Enchant.Result.UpdateNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.UpdateNamespaceResult> asyncResult = null;
yield return client.UpdateNamespace(
new Gs2.Gs2Enchant.Request.UpdateNamespaceRequest()
.WithNamespaceName("namespace1")
.WithDescription("description1")
.WithTransactionSetting(new Gs2.Gs2Enchant.Model.TransactionSetting()
.WithEnableAutoRun(false)
.WithQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
.WithKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001"))
.WithLogSetting(new Gs2.Gs2Enchant.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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.updateNamespace(
new Gs2Enchant.UpdateNamespaceRequest()
.withNamespaceName("namespace1")
.withDescription("description1")
.withTransactionSetting(new Gs2Enchant.model.TransactionSetting()
.withEnableAutoRun(false)
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
.withKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001"))
.withLogSetting(new Gs2Enchant.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 enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.update_namespace(
enchant.UpdateNamespaceRequest()
.with_namespace_name(self.hash1)
.with_description('description1')
.with_transaction_setting(
enchant.TransactionSetting()
.with_enable_auto_run(False)
.with_queue_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001')
.with_key_id('grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001'))
.with_log_setting(
enchant.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('enchant')
api_result = client.update_namespace({
namespaceName='namespace1',
description='description1',
transactionSetting={
enableAutoRun=false,
queueNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
keyId='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001',
},
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;
deleteNamespace
ネームスペースを削除
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 |
Result
型 | 説明 | |
---|---|---|
item | Namespace | 削除したネームスペース |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.DeleteNamespace(
&enchant.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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.DeleteNamespaceRequest;
import io.gs2.enchant.result.DeleteNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.DeleteNamespaceRequest;
using Gs2.Gs2Enchant.Result.DeleteNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.DeleteNamespaceResult> asyncResult = null;
yield return client.DeleteNamespace(
new Gs2.Gs2Enchant.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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.deleteNamespace(
new Gs2Enchant.DeleteNamespaceRequest()
.withNamespaceName("namespace1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.delete_namespace(
enchant.DeleteNamespaceRequest()
.with_namespace_name(self.hash1)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
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;
describeBalanceParameterModels
バランスパラメーターモデルの一覧を取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 |
Result
型 | 説明 | |
---|---|---|
items | List<BalanceParameterModel> | バランスパラメーターモデルのリスト |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.DescribeBalanceParameterModels(
&enchant.DescribeBalanceParameterModelsRequest {
NamespaceName: pointy.String("namespace1"),
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\DescribeBalanceParameterModelsRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeBalanceParameterModels(
(new DescribeBalanceParameterModelsRequest())
->withNamespaceName(self::namespace1)
);
$items = $result->getItems();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.DescribeBalanceParameterModelsRequest;
import io.gs2.enchant.result.DescribeBalanceParameterModelsResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
DescribeBalanceParameterModelsResult result = client.describeBalanceParameterModels(
new DescribeBalanceParameterModelsRequest()
.withNamespaceName("namespace1")
);
List<BalanceParameterModel> 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.DescribeBalanceParameterModelsRequest;
using Gs2.Gs2Enchant.Result.DescribeBalanceParameterModelsResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.DescribeBalanceParameterModelsResult> asyncResult = null;
yield return client.DescribeBalanceParameterModels(
new Gs2.Gs2Enchant.Request.DescribeBalanceParameterModelsRequest()
.WithNamespaceName("namespace1"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
import Gs2Core from '@/gs2/core';
import * as Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.describeBalanceParameterModels(
new Gs2Enchant.DescribeBalanceParameterModelsRequest()
.withNamespaceName("namespace1")
);
const items = result.getItems();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.describe_balance_parameter_models(
enchant.DescribeBalanceParameterModelsRequest()
.with_namespace_name(self.hash1)
)
items = result.items
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
api_result = client.describe_balance_parameter_models({
namespaceName='namespace1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
getBalanceParameterModel
バランスパラメーターモデルを取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
parameterName | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 |
Result
型 | 説明 | |
---|---|---|
item | BalanceParameterModel | バランスパラメーターモデル |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.GetBalanceParameterModel(
&enchant.GetBalanceParameterModelRequest {
NamespaceName: pointy.String("namespace1"),
ParameterName: pointy.String("balance-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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\GetBalanceParameterModelRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getBalanceParameterModel(
(new GetBalanceParameterModelRequest())
->withNamespaceName(self::namespace1)
->withParameterName("balance-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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.GetBalanceParameterModelRequest;
import io.gs2.enchant.result.GetBalanceParameterModelResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
GetBalanceParameterModelResult result = client.getBalanceParameterModel(
new GetBalanceParameterModelRequest()
.withNamespaceName("namespace1")
.withParameterName("balance-0001")
);
BalanceParameterModel 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.GetBalanceParameterModelRequest;
using Gs2.Gs2Enchant.Result.GetBalanceParameterModelResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.GetBalanceParameterModelResult> asyncResult = null;
yield return client.GetBalanceParameterModel(
new Gs2.Gs2Enchant.Request.GetBalanceParameterModelRequest()
.WithNamespaceName("namespace1")
.WithParameterName("balance-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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.getBalanceParameterModel(
new Gs2Enchant.GetBalanceParameterModelRequest()
.withNamespaceName("namespace1")
.withParameterName("balance-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.get_balance_parameter_model(
enchant.GetBalanceParameterModelRequest()
.with_namespace_name(self.hash1)
.with_parameter_name('balance-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
api_result = client.get_balance_parameter_model({
namespaceName='namespace1',
parameterName='balance-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
describeBalanceParameterModelMasters
バランスパラメーターモデルマスターの一覧を取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
pageToken | string | ~ 1024文字 | データの取得を開始する位置を指定するトークン | |||
limit | int | ✓ | 30 | 1 ~ 1000 | データの取得件数 |
Result
型 | 説明 | |
---|---|---|
items | List<BalanceParameterModelMaster> | バランスパラメーターモデルマスターのリスト |
nextPageToken | string | リストの続きを取得するためのページトークン |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.DescribeBalanceParameterModelMasters(
&enchant.DescribeBalanceParameterModelMastersRequest {
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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\DescribeBalanceParameterModelMastersRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeBalanceParameterModelMasters(
(new DescribeBalanceParameterModelMastersRequest())
->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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.DescribeBalanceParameterModelMastersRequest;
import io.gs2.enchant.result.DescribeBalanceParameterModelMastersResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
DescribeBalanceParameterModelMastersResult result = client.describeBalanceParameterModelMasters(
new DescribeBalanceParameterModelMastersRequest()
.withNamespaceName("namespace1")
.withPageToken(null)
.withLimit(null)
);
List<BalanceParameterModelMaster> 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.DescribeBalanceParameterModelMastersRequest;
using Gs2.Gs2Enchant.Result.DescribeBalanceParameterModelMastersResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.DescribeBalanceParameterModelMastersResult> asyncResult = null;
yield return client.DescribeBalanceParameterModelMasters(
new Gs2.Gs2Enchant.Request.DescribeBalanceParameterModelMastersRequest()
.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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.describeBalanceParameterModelMasters(
new Gs2Enchant.DescribeBalanceParameterModelMastersRequest()
.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 enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.describe_balance_parameter_model_masters(
enchant.DescribeBalanceParameterModelMastersRequest()
.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('enchant')
api_result = client.describe_balance_parameter_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;
createBalanceParameterModelMaster
バランスパラメーターモデルマスターを新規作成
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
name | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 | ||
description | string | ~ 1024文字 | 説明文 | |||
metadata | string | ~ 2048文字 | メタデータ | |||
totalValue | long | ✓ | ~ 9223372036854775805 | 合計値 | ||
initialValueStrategy | enum [‘average’, ’lottery’] | ✓ | “average” | ~ 128文字 | 初期値の設定方針 | |
parameters | List<BalanceParameterValueModel> | ✓ | バランスパラメーター値モデルのリスト |
Result
型 | 説明 | |
---|---|---|
item | BalanceParameterModelMaster | 作成したバランスパラメーターモデルマスター |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.CreateBalanceParameterModelMaster(
&enchant.CreateBalanceParameterModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
Name: pointy.String("balance-0001"),
Description: nil,
Metadata: nil,
TotalValue: pointy.Int64(100),
InitialValueStrategy: pointy.String("average"),
Parameters: []enchant.BalanceParameterValueModel{
enchant.BalanceParameterValueModel{
Name: pointy.String("parameter-0001"),
},
enchant.BalanceParameterValueModel{
Name: pointy.String("parameter-0002"),
},
enchant.BalanceParameterValueModel{
Name: pointy.String("parameter-0003"),
},
},
}
)
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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\CreateBalanceParameterModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->createBalanceParameterModelMaster(
(new CreateBalanceParameterModelMasterRequest())
->withNamespaceName(self::namespace1)
->withName("balance-0001")
->withDescription(null)
->withMetadata(null)
->withTotalValue(100)
->withInitialValueStrategy("average")
->withParameters([ (new \Gs2\Enchant\Model\BalanceParameterValueModel())
->withName("parameter-0001"),
(new \Gs2\Enchant\Model\BalanceParameterValueModel())
->withName("parameter-0002"),
(new \Gs2\Enchant\Model\BalanceParameterValueModel())
->withName("parameter-0003"),
])
);
$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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.CreateBalanceParameterModelMasterRequest;
import io.gs2.enchant.result.CreateBalanceParameterModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
CreateBalanceParameterModelMasterResult result = client.createBalanceParameterModelMaster(
new CreateBalanceParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withName("balance-0001")
.withDescription(null)
.withMetadata(null)
.withTotalValue(100L)
.withInitialValueStrategy("average")
.withParameters(Arrays.asList(
new io.gs2.enchant.model.BalanceParameterValueModel()
.withName("parameter-0001"),
new io.gs2.enchant.model.BalanceParameterValueModel()
.withName("parameter-0002"),
new io.gs2.enchant.model.BalanceParameterValueModel()
.withName("parameter-0003")
))
);
BalanceParameterModelMaster 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.CreateBalanceParameterModelMasterRequest;
using Gs2.Gs2Enchant.Result.CreateBalanceParameterModelMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.CreateBalanceParameterModelMasterResult> asyncResult = null;
yield return client.CreateBalanceParameterModelMaster(
new Gs2.Gs2Enchant.Request.CreateBalanceParameterModelMasterRequest()
.WithNamespaceName("namespace1")
.WithName("balance-0001")
.WithDescription(null)
.WithMetadata(null)
.WithTotalValue(100L)
.WithInitialValueStrategy("average")
.WithParameters(new Gs2.Gs2Enchant.Model.BalanceParameterValueModel[] {
new Gs2.Gs2Enchant.Model.BalanceParameterValueModel()
.WithName("parameter-0001"),
new Gs2.Gs2Enchant.Model.BalanceParameterValueModel()
.WithName("parameter-0002"),
new Gs2.Gs2Enchant.Model.BalanceParameterValueModel()
.WithName("parameter-0003")
}),
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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.createBalanceParameterModelMaster(
new Gs2Enchant.CreateBalanceParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withName("balance-0001")
.withDescription(null)
.withMetadata(null)
.withTotalValue(100)
.withInitialValueStrategy("average")
.withParameters([
new Gs2Enchant.model.BalanceParameterValueModel()
.withName("parameter-0001"),
new Gs2Enchant.model.BalanceParameterValueModel()
.withName("parameter-0002"),
new Gs2Enchant.model.BalanceParameterValueModel()
.withName("parameter-0003")
])
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.create_balance_parameter_model_master(
enchant.CreateBalanceParameterModelMasterRequest()
.with_namespace_name(self.hash1)
.with_name('balance-0001')
.with_description(None)
.with_metadata(None)
.with_total_value(100)
.with_initial_value_strategy('average')
.with_parameters([ enchant.BalanceParameterValueModel()
.with_name('parameter-0001'),
enchant.BalanceParameterValueModel()
.with_name('parameter-0002'),
enchant.BalanceParameterValueModel()
.with_name('parameter-0003'),
])
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
api_result = client.create_balance_parameter_model_master({
namespaceName='namespace1',
name='balance-0001',
description=nil,
metadata=nil,
totalValue=100,
initialValueStrategy='average',
parameters={
{
name='parameter-0001',
},
{
name='parameter-0002',
},
{
name='parameter-0003',
}
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getBalanceParameterModelMaster
バランスパラメーターモデルマスターを取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
parameterName | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 |
Result
型 | 説明 | |
---|---|---|
item | BalanceParameterModelMaster | バランスパラメーターモデルマスター |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.GetBalanceParameterModelMaster(
&enchant.GetBalanceParameterModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
ParameterName: pointy.String("balance-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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\GetBalanceParameterModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getBalanceParameterModelMaster(
(new GetBalanceParameterModelMasterRequest())
->withNamespaceName(self::namespace1)
->withParameterName("balance-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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.GetBalanceParameterModelMasterRequest;
import io.gs2.enchant.result.GetBalanceParameterModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
GetBalanceParameterModelMasterResult result = client.getBalanceParameterModelMaster(
new GetBalanceParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withParameterName("balance-0001")
);
BalanceParameterModelMaster 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.GetBalanceParameterModelMasterRequest;
using Gs2.Gs2Enchant.Result.GetBalanceParameterModelMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.GetBalanceParameterModelMasterResult> asyncResult = null;
yield return client.GetBalanceParameterModelMaster(
new Gs2.Gs2Enchant.Request.GetBalanceParameterModelMasterRequest()
.WithNamespaceName("namespace1")
.WithParameterName("balance-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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.getBalanceParameterModelMaster(
new Gs2Enchant.GetBalanceParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withParameterName("balance-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.get_balance_parameter_model_master(
enchant.GetBalanceParameterModelMasterRequest()
.with_namespace_name(self.hash1)
.with_parameter_name('balance-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
api_result = client.get_balance_parameter_model_master({
namespaceName='namespace1',
parameterName='balance-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
updateBalanceParameterModelMaster
バランスパラメーターモデルマスターを更新
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
parameterName | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 | ||
description | string | ~ 1024文字 | 説明文 | |||
metadata | string | ~ 2048文字 | メタデータ | |||
totalValue | long | ✓ | ~ 9223372036854775805 | 合計値 | ||
initialValueStrategy | enum [‘average’, ’lottery’] | ✓ | “average” | ~ 128文字 | 初期値の設定方針 | |
parameters | List<BalanceParameterValueModel> | ✓ | バランスパラメーター値モデルのリスト |
Result
型 | 説明 | |
---|---|---|
item | BalanceParameterModelMaster | 更新したバランスパラメーターモデルマスター |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.UpdateBalanceParameterModelMaster(
&enchant.UpdateBalanceParameterModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
ParameterName: pointy.String("balance-0001"),
Description: pointy.String("description1"),
Metadata: pointy.String("BALANCE_0001"),
TotalValue: pointy.Int64(200),
InitialValueStrategy: pointy.String("lottery"),
Parameters: []enchant.BalanceParameterValueModel{
enchant.BalanceParameterValueModel{
Name: pointy.String("parameter-1001"),
},
enchant.BalanceParameterValueModel{
Name: pointy.String("parameter-1002"),
},
enchant.BalanceParameterValueModel{
Name: pointy.String("parameter-1003"),
},
enchant.BalanceParameterValueModel{
Name: pointy.String("parameter-1004"),
},
},
}
)
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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\UpdateBalanceParameterModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->updateBalanceParameterModelMaster(
(new UpdateBalanceParameterModelMasterRequest())
->withNamespaceName(self::namespace1)
->withParameterName("balance-0001")
->withDescription("description1")
->withMetadata("BALANCE_0001")
->withTotalValue(200)
->withInitialValueStrategy("lottery")
->withParameters([ (new \Gs2\Enchant\Model\BalanceParameterValueModel())
->withName("parameter-1001"),
(new \Gs2\Enchant\Model\BalanceParameterValueModel())
->withName("parameter-1002"),
(new \Gs2\Enchant\Model\BalanceParameterValueModel())
->withName("parameter-1003"),
(new \Gs2\Enchant\Model\BalanceParameterValueModel())
->withName("parameter-1004"),
])
);
$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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.UpdateBalanceParameterModelMasterRequest;
import io.gs2.enchant.result.UpdateBalanceParameterModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
UpdateBalanceParameterModelMasterResult result = client.updateBalanceParameterModelMaster(
new UpdateBalanceParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withParameterName("balance-0001")
.withDescription("description1")
.withMetadata("BALANCE_0001")
.withTotalValue(200L)
.withInitialValueStrategy("lottery")
.withParameters(Arrays.asList(
new io.gs2.enchant.model.BalanceParameterValueModel()
.withName("parameter-1001"),
new io.gs2.enchant.model.BalanceParameterValueModel()
.withName("parameter-1002"),
new io.gs2.enchant.model.BalanceParameterValueModel()
.withName("parameter-1003"),
new io.gs2.enchant.model.BalanceParameterValueModel()
.withName("parameter-1004")
))
);
BalanceParameterModelMaster 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.UpdateBalanceParameterModelMasterRequest;
using Gs2.Gs2Enchant.Result.UpdateBalanceParameterModelMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.UpdateBalanceParameterModelMasterResult> asyncResult = null;
yield return client.UpdateBalanceParameterModelMaster(
new Gs2.Gs2Enchant.Request.UpdateBalanceParameterModelMasterRequest()
.WithNamespaceName("namespace1")
.WithParameterName("balance-0001")
.WithDescription("description1")
.WithMetadata("BALANCE_0001")
.WithTotalValue(200L)
.WithInitialValueStrategy("lottery")
.WithParameters(new Gs2.Gs2Enchant.Model.BalanceParameterValueModel[] {
new Gs2.Gs2Enchant.Model.BalanceParameterValueModel()
.WithName("parameter-1001"),
new Gs2.Gs2Enchant.Model.BalanceParameterValueModel()
.WithName("parameter-1002"),
new Gs2.Gs2Enchant.Model.BalanceParameterValueModel()
.WithName("parameter-1003"),
new Gs2.Gs2Enchant.Model.BalanceParameterValueModel()
.WithName("parameter-1004")
}),
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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.updateBalanceParameterModelMaster(
new Gs2Enchant.UpdateBalanceParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withParameterName("balance-0001")
.withDescription("description1")
.withMetadata("BALANCE_0001")
.withTotalValue(200)
.withInitialValueStrategy("lottery")
.withParameters([
new Gs2Enchant.model.BalanceParameterValueModel()
.withName("parameter-1001"),
new Gs2Enchant.model.BalanceParameterValueModel()
.withName("parameter-1002"),
new Gs2Enchant.model.BalanceParameterValueModel()
.withName("parameter-1003"),
new Gs2Enchant.model.BalanceParameterValueModel()
.withName("parameter-1004")
])
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.update_balance_parameter_model_master(
enchant.UpdateBalanceParameterModelMasterRequest()
.with_namespace_name(self.hash1)
.with_parameter_name('balance-0001')
.with_description('description1')
.with_metadata('BALANCE_0001')
.with_total_value(200)
.with_initial_value_strategy('lottery')
.with_parameters([ enchant.BalanceParameterValueModel()
.with_name('parameter-1001'),
enchant.BalanceParameterValueModel()
.with_name('parameter-1002'),
enchant.BalanceParameterValueModel()
.with_name('parameter-1003'),
enchant.BalanceParameterValueModel()
.with_name('parameter-1004'),
])
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
api_result = client.update_balance_parameter_model_master({
namespaceName='namespace1',
parameterName='balance-0001',
description='description1',
metadata='BALANCE_0001',
totalValue=200,
initialValueStrategy='lottery',
parameters={
{
name='parameter-1001',
},
{
name='parameter-1002',
},
{
name='parameter-1003',
},
{
name='parameter-1004',
}
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
deleteBalanceParameterModelMaster
バランスパラメーターモデルマスターを削除
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
parameterName | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 |
Result
型 | 説明 | |
---|---|---|
item | BalanceParameterModelMaster | 削除したバランスパラメーターモデルマスター |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.DeleteBalanceParameterModelMaster(
&enchant.DeleteBalanceParameterModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
ParameterName: pointy.String("balance-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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\DeleteBalanceParameterModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->deleteBalanceParameterModelMaster(
(new DeleteBalanceParameterModelMasterRequest())
->withNamespaceName(self::namespace1)
->withParameterName("balance-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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.DeleteBalanceParameterModelMasterRequest;
import io.gs2.enchant.result.DeleteBalanceParameterModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
DeleteBalanceParameterModelMasterResult result = client.deleteBalanceParameterModelMaster(
new DeleteBalanceParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withParameterName("balance-0001")
);
BalanceParameterModelMaster 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.DeleteBalanceParameterModelMasterRequest;
using Gs2.Gs2Enchant.Result.DeleteBalanceParameterModelMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.DeleteBalanceParameterModelMasterResult> asyncResult = null;
yield return client.DeleteBalanceParameterModelMaster(
new Gs2.Gs2Enchant.Request.DeleteBalanceParameterModelMasterRequest()
.WithNamespaceName("namespace1")
.WithParameterName("balance-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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.deleteBalanceParameterModelMaster(
new Gs2Enchant.DeleteBalanceParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withParameterName("balance-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.delete_balance_parameter_model_master(
enchant.DeleteBalanceParameterModelMasterRequest()
.with_namespace_name(self.hash1)
.with_parameter_name('balance-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
api_result = client.delete_balance_parameter_model_master({
namespaceName='namespace1',
parameterName='balance-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
describeRarityParameterModels
レアリティパラメーターモデルの一覧を取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 |
Result
型 | 説明 | |
---|---|---|
items | List<RarityParameterModel> | レアリティパラメーターモデルのリスト |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.DescribeRarityParameterModels(
&enchant.DescribeRarityParameterModelsRequest {
NamespaceName: pointy.String("namespace1"),
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\DescribeRarityParameterModelsRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeRarityParameterModels(
(new DescribeRarityParameterModelsRequest())
->withNamespaceName(self::namespace1)
);
$items = $result->getItems();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.DescribeRarityParameterModelsRequest;
import io.gs2.enchant.result.DescribeRarityParameterModelsResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
DescribeRarityParameterModelsResult result = client.describeRarityParameterModels(
new DescribeRarityParameterModelsRequest()
.withNamespaceName("namespace1")
);
List<RarityParameterModel> 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.DescribeRarityParameterModelsRequest;
using Gs2.Gs2Enchant.Result.DescribeRarityParameterModelsResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.DescribeRarityParameterModelsResult> asyncResult = null;
yield return client.DescribeRarityParameterModels(
new Gs2.Gs2Enchant.Request.DescribeRarityParameterModelsRequest()
.WithNamespaceName("namespace1"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
import Gs2Core from '@/gs2/core';
import * as Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.describeRarityParameterModels(
new Gs2Enchant.DescribeRarityParameterModelsRequest()
.withNamespaceName("namespace1")
);
const items = result.getItems();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.describe_rarity_parameter_models(
enchant.DescribeRarityParameterModelsRequest()
.with_namespace_name(self.hash1)
)
items = result.items
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
api_result = client.describe_rarity_parameter_models({
namespaceName='namespace1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
getRarityParameterModel
レアリティパラメーターモデルを取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
parameterName | string | ✓ | ~ 128文字 | バランスパラメーターモデル名 |
Result
型 | 説明 | |
---|---|---|
item | RarityParameterModel | レアリティパラメーターモデル |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.GetRarityParameterModel(
&enchant.GetRarityParameterModelRequest {
NamespaceName: pointy.String("namespace1"),
ParameterName: pointy.String("rarity-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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\GetRarityParameterModelRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getRarityParameterModel(
(new GetRarityParameterModelRequest())
->withNamespaceName(self::namespace1)
->withParameterName("rarity-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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.GetRarityParameterModelRequest;
import io.gs2.enchant.result.GetRarityParameterModelResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
GetRarityParameterModelResult result = client.getRarityParameterModel(
new GetRarityParameterModelRequest()
.withNamespaceName("namespace1")
.withParameterName("rarity-0001")
);
RarityParameterModel 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.GetRarityParameterModelRequest;
using Gs2.Gs2Enchant.Result.GetRarityParameterModelResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.GetRarityParameterModelResult> asyncResult = null;
yield return client.GetRarityParameterModel(
new Gs2.Gs2Enchant.Request.GetRarityParameterModelRequest()
.WithNamespaceName("namespace1")
.WithParameterName("rarity-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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.getRarityParameterModel(
new Gs2Enchant.GetRarityParameterModelRequest()
.withNamespaceName("namespace1")
.withParameterName("rarity-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.get_rarity_parameter_model(
enchant.GetRarityParameterModelRequest()
.with_namespace_name(self.hash1)
.with_parameter_name('rarity-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('enchant')
api_result = client.get_rarity_parameter_model({
namespaceName='namespace1',
parameterName='rarity-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
describeRarityParameterModelMasters
レアリティパラメーターモデルマスターの一覧を取得
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
pageToken | string | ~ 1024文字 | データの取得を開始する位置を指定するトークン | |||
limit | int | ✓ | 30 | 1 ~ 1000 | データの取得件数 |
Result
型 | 説明 | |
---|---|---|
items | List<RarityParameterModelMaster> | レアリティパラメーターモデルマスターのリスト |
nextPageToken | string | リストの続きを取得するためのページトークン |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.DescribeRarityParameterModelMasters(
&enchant.DescribeRarityParameterModelMastersRequest {
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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\DescribeRarityParameterModelMastersRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeRarityParameterModelMasters(
(new DescribeRarityParameterModelMastersRequest())
->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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.DescribeRarityParameterModelMastersRequest;
import io.gs2.enchant.result.DescribeRarityParameterModelMastersResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
DescribeRarityParameterModelMastersResult result = client.describeRarityParameterModelMasters(
new DescribeRarityParameterModelMastersRequest()
.withNamespaceName("namespace1")
.withPageToken(null)
.withLimit(null)
);
List<RarityParameterModelMaster> 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.Gs2Enchant.Gs2EnchantRestClient;
using Gs2.Gs2Enchant.Request.DescribeRarityParameterModelMastersRequest;
using Gs2.Gs2Enchant.Result.DescribeRarityParameterModelMastersResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2EnchantRestClient(session);
AsyncResult<Gs2.Gs2Enchant.Result.DescribeRarityParameterModelMastersResult> asyncResult = null;
yield return client.DescribeRarityParameterModelMasters(
new Gs2.Gs2Enchant.Request.DescribeRarityParameterModelMastersRequest()
.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 Gs2Enchant from '@/gs2/enchant';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Enchant.Gs2EnchantRestClient(session);
try {
const result = await client.describeRarityParameterModelMasters(
new Gs2Enchant.DescribeRarityParameterModelMastersRequest()
.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 enchant
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = enchant.Gs2EnchantRestClient(session)
try:
result = client.describe_rarity_parameter_model_masters(
enchant.DescribeRarityParameterModelMastersRequest()
.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('enchant')
api_result = client.describe_rarity_parameter_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;
createRarityParameterModelMaster
レアリティパラメーターモデルマスターを新規作成
Request
型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | ||
name | string | ✓ | ~ 128文字 | レアリティパラメーターモデル名 | ||
description | string | ~ 1024文字 | 説明文 | |||
metadata | string | ~ 2048文字 | メタデータ | |||
maximumParameterCount | int | ✓ | 1 ~ 10 | 付与するパラメーターの最大数 | ||
parameterCounts | List<RarityParameterCountModel> | ✓ | レアリティパラメーターの付与数モデルのリスト | |||
parameters | List<RarityParameterValueModel> | ✓ | レアリティパラメーター値モデルのリスト |
Result
型 | 説明 | |
---|---|---|
item | RarityParameterModelMaster | 作成したレアリティパラメーターモデルマスター |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enchant"
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 := enchant.Gs2EnchantRestClient{
Session: &session,
}
result, err := client.CreateRarityParameterModelMaster(
&enchant.CreateRarityParameterModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
Name: pointy.String("rarity-0001"),
Description: nil,
Metadata: nil,
MaximumParameterCount: pointy.Int32(5),
ParameterCounts: []enchant.RarityParameterCountModel{
enchant.RarityParameterCountModel{
Count: pointy.Int32(0),
Weight: pointy.Int32(1),
},
enchant.RarityParameterCountModel{
Count: pointy.Int32(1),
Weight: pointy.Int32(2),
},
enchant.RarityParameterCountModel{
Count: pointy.Int32(2),
Weight: pointy.Int32(3),
},
},
Parameters: []enchant.RarityParameterValueModel{
enchant.RarityParameterValueModel{
Name: pointy.String("parameter-0001"),
ResourceName: pointy.String("resource-0001"),
ResourceValue: pointy.Int64(100),
Weight: pointy.Int32(1),
},
enchant.RarityParameterValueModel{
Name: pointy.String("parameter-0002"),
ResourceName: pointy.String("resource-0002"),
ResourceValue: pointy.Int64(200),
Weight: pointy.Int32(2),
},
enchant.RarityParameterValueModel{
Name: pointy.String("parameter-0003"),
ResourceName: pointy.String("resource-0003"),
ResourceValue: pointy.Int64(300),
Weight: pointy.Int32(3),
},
},
}
)
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\Enchant\Gs2EnchantRestClient;
use Gs2\Enchant\Request\CreateRarityParameterModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->createRarityParameterModelMaster(
(new CreateRarityParameterModelMasterRequest())
->withNamespaceName(self::namespace1)
->withName("rarity-0001")
->withDescription(null)
->withMetadata(null)
->withMaximumParameterCount(5)
->withParameterCounts([ (new \Gs2\Enchant\Model\RarityParameterCountModel())
->withCount(0)
->withWeight(1),
(new \Gs2\Enchant\Model\RarityParameterCountModel())
->withCount(1)
->withWeight(2),
(new \Gs2\Enchant\Model\RarityParameterCountModel())
->withCount(2)
->withWeight(3),
])
->withParameters([ (new \Gs2\Enchant\Model\RarityParameterValueModel())
->withName("parameter-0001")
->withResourceName("resource-0001")
->withResourceValue(100)
->withWeight(1),
(new \Gs2\Enchant\Model\RarityParameterValueModel())
->withName("parameter-0002")
->withResourceName("resource-0002")
->withResourceValue(200)
->withWeight(2),
(new \Gs2\Enchant\Model\RarityParameterValueModel())
->withName("parameter-0003")
->withResourceName("resource-0003")
->withResourceValue(300)
->withWeight(3),
])
);
$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.enchant.rest.Gs2EnchantRestClient;
import io.gs2.enchant.request.CreateRarityParameterModelMasterRequest;
import io.gs2.enchant.result.CreateRarityParameterModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2EnchantRestClient client = new Gs2EnchantRestClient(session);
try {
CreateRarityParameterModelMasterResult result = client.createRarityParameterModelMaster(
new CreateRarityParameterModelMasterRequest()
.withNamespaceName("namespace1")
.withName("rarity-0001")
.withDescription(null)
.withMetadata(null)