API Reference of GS2-Experience SDK
Model
Namespace
Namespace
Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.
Therefore, it is necessary to create a namespace before starting to use each service.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceId | string | ✓ | ~ 1024 chars | Namespace GRN | ||
name | string | ✓ | ~ 32 chars | Namespace name | ||
description | string | ~ 1024 chars | description of Namespace | |||
transactionSetting | TransactionSetting | Transaction settings | ||||
rankCapScriptId | string | ~ 1024 chars | Script to dynamically determine rank caps | |||
changeExperienceScript | ScriptSetting | Script to be executed when experience changes | ||||
changeRankScript | ScriptSetting | Script to be executed when rank changes | ||||
changeRankCapScript | ScriptSetting | Script to be executed when the rank cap changes | ||||
overflowExperienceScript | string | ~ 1024 chars | Script to run when experience overflows | |||
logSetting | LogSetting | Log output settings | ||||
createdAt | long | ✓ | Datetime of creation | |||
updatedAt | long | ✓ | Datetime of last update | |||
revision | long | 0 | ~ 9223372036854775805 | Revision |
ExperienceModelMaster
Experience Model Master
An experience model is an entity that sets the threshold of experience required for rank advancement and for each default and maximum rank cap.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
experienceModelId | string | ✓ | ~ 1024 chars | Experience Model Master GRN | ||
name | string | ✓ | ~ 128 chars | Experience Model Name | ||
description | string | ~ 1024 chars | description of Namespace | |||
metadata | string | ~ 2048 chars | metadata | |||
defaultExperience | long | ✓ | 0 | ~ 9223372036854775805 | Initial Experience Value | |
defaultRankCap | long | ✓ | ~ 9223372036854775805 | Initial value of rank cap | ||
maxRankCap | long | ✓ | ~ 9223372036854775805 | Maximum rank cap | ||
rankThresholdName | string | ✓ | ~ 128 chars | rank-up threshold | ||
acquireActionRates | List<AcquireActionRate> | ~ 100 items | List of Remuneration addition table | |||
createdAt | long | ✓ | Datetime of creation | |||
updatedAt | long | ✓ | Datetime of last update | |||
revision | long | 0 | ~ 9223372036854775805 | Revision |
ExperienceModel
Experience Model
An experience model is an entity that sets the threshold of experience required for rank advancement and for each default and maximum rank cap.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
experienceModelId | string | ✓ | ~ 1024 chars | Experience Model GRN | ||
name | string | ✓ | ~ 128 chars | Experience Model Name | ||
metadata | string | ~ 2048 chars | metadata | |||
defaultExperience | long | ✓ | 0 | ~ 9223372036854775805 | Initial Experience Value | |
defaultRankCap | long | ✓ | ~ 9223372036854775805 | Initial value of rank cap | ||
maxRankCap | long | ✓ | ~ 9223372036854775805 | Maximum rank cap | ||
rankThreshold | Threshold | ✓ | rank-up threshold | |||
acquireActionRates | List<AcquireActionRate> | ~ 100 items | List of Remuneration addition table |
ThresholdMaster
Rank Up Threshold Master
The rank-up threshold is a sequence of numbers needed to determine rank (level) from experience. If the value [10, 20] is set, experience values between 1 and 9 are rank 1, experience values between 10 and 19 are rank 2, experience values at 20 are rank 3, and no more experience values can be obtained.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
thresholdId | string | ✓ | ~ 1024 chars | Rank Up Threshold Master GRN | ||
name | string | ✓ | ~ 128 chars | Rank Up Threshold Name | ||
description | string | ~ 1024 chars | description of Namespace | |||
metadata | string | ~ 2048 chars | metadata | |||
values | List<long> | ✓ | 1 ~ 1024 items | List of Rank Up Experience Threshold | ||
createdAt | long | ✓ | Datetime of creation | |||
updatedAt | long | ✓ | Datetime of last update | |||
revision | long | 0 | ~ 9223372036854775805 | Revision |
Threshold
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
metadata | string | ~ 2048 chars | metadata | |||
values | List<long> | ✓ | 1 ~ 1024 items | List of Rank Up Experience Threshold |
AcquireActionRate
Remuneration addition table master
You can adjust the amount of rewards according to the rank.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 128 chars | Remuneration addition table name | ||
mode | enum [‘double’, ‘big’] | ✓ | “double” | ~ 128 chars | Remuneration addition table type | |
rates | List<double> | {mode} == “double” | ✓ | 1 ~ 1000 items | Amount added per rank (multiplier) | |
bigRates | List<string> | {mode} == “big” | ✓ | 1 ~ 1000 items | Amount added per rank (multiplier) |
CurrentExperienceMaster
Currently available master data
GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.
We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.
Please refer to the documentation for the format of the JSON file.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceId | string | ✓ | ~ 1024 chars | Namespace GRN | ||
settings | string | ✓ | ~ 5242880 chars | Master data |
Status
Status
Status is an entity that exists for each property ID. Holds the current experience and rank cap values.
Property ID is a status-specific ID and can be set to any value by the developer. In GS2, the itemset GRN of a GS2-Inventory or entry GRN of a GS2-Dictionary that has an experience value is followed by a It is recommended that the property ID be the value to which the suffix that serves as the experience value model is added.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
statusId | string | ✓ | ~ 1024 chars | Status GRN | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
experienceValue | long | ✓ | 0 | ~ 9223372036854775805 | Cumulative experience gained | |
rankValue | long | ✓ | 0 | ~ 9223372036854775805 | Current Rank | |
rankCapValue | long | ✓ | ~ 9223372036854775805 | Current Rank Cap | ||
nextRankUpExperienceValue | long | ✓ | 0 | ~ 9223372036854775805 | Total amount of experience for the next rank up | |
createdAt | long | ✓ | Datetime of creation | |||
updatedAt | long | ✓ | Datetime of last update | |||
revision | long | 0 | ~ 9223372036854775805 | Revision |
AcquireAction
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum [] | ✓ | ~ 128 chars | Types of actions to be performed in the stamp sheet | ||
request | string | ✓ | ~ 1048576 chars | JSON of request |
GitHubCheckoutSetting
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
apiKeyId | string | ✓ | ~ 1024 chars | GitHub API key GRN | ||
repositoryName | string | ✓ | ~ 1024 chars | Repository Name | ||
sourcePath | string | ✓ | ~ 1024 chars | Source code file path | ||
referenceType | enum [‘commit_hash’, ‘branch’, ’tag’] | ✓ | ~ 128 chars | Source of code | ||
commitHash | string | {referenceType} == “commit_hash” | ✓ | ~ 1024 chars | Commit hash | |
branchName | string | {referenceType} == “branch” | ✓ | ~ 1024 chars | Branch Name | |
tagName | string | {referenceType} == “tag” | ✓ | ~ 1024 chars | Tag Name |
ScriptSetting
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
triggerScriptId | string | ~ 1024 chars | Script GRN | |||
doneTriggerTargetType | enum [’none’, ‘gs2_script’, ‘aws’] | ✓ | “none” | ~ 128 chars | Notification of Completion | |
doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN | ||
doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Namespace GRN |
LogSetting
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
loggingNamespaceId | string | ✓ | ~ 1024 chars | Namespace GRN |
TransactionSetting
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
enableAutoRun | bool | ✓ | false | Automatically run issued stamp sheets on the server side, or | ||
distributorNamespaceId | string | {enableAutoRun} | ✓ | ~ 1024 chars | GS2-Distributor namespace used for stamp sheet execution | |
keyId | string | !{enableAutoRun} | ✓ | ~ 1024 chars | GS2-Key encryption key used to sign the stamp sheet | |
queueNamespaceId | string | ~ 1024 chars | Namespace in GS2-JobQueue used to run the stamp sheet |
Methods
describeNamespaces
Get list of namespaces
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
pageToken | string | ~ 1024 chars | Token specifying the position from which to start acquiring data | |||
limit | int | ✓ | 30 | 1 ~ 1000 | Number of data acquired |
Result
Type | Description | |
---|---|---|
items | List<Namespace> | List of Namespace |
nextPageToken | string | Page token to retrieve the rest of the listing |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DescribeNamespaces(
&experience.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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DescribeNamespacesRequest;
import io.gs2.experience.result.DescribeNamespacesResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DescribeNamespacesRequest;
using Gs2.Gs2Experience.Result.DescribeNamespacesResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DescribeNamespacesResult> asyncResult = null;
yield return client.DescribeNamespaces(
new Gs2.Gs2Experience.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.describeNamespaces(
new Gs2Experience.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 experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.describe_namespaces(
experience.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('experience')
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
Create a new namespace
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
name | string | ✓ | ~ 32 chars | Namespace name | ||
description | string | ~ 1024 chars | description of Namespace | |||
transactionSetting | TransactionSetting | Transaction settings | ||||
rankCapScriptId | string | ~ 1024 chars | Script to dynamically determine rank caps | |||
changeExperienceScript | ScriptSetting | Script to be executed when experience changes | ||||
changeRankScript | ScriptSetting | Script to be executed when rank changes | ||||
changeRankCapScript | ScriptSetting | Script to be executed when the rank cap changes | ||||
overflowExperienceScript | string | ~ 1024 chars | Script to run when experience overflows | |||
logSetting | LogSetting | Log output settings |
Result
Type | Description | |
---|---|---|
item | Namespace | Namespace created |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.CreateNamespace(
&experience.CreateNamespaceRequest {
Name: pointy.String("namespace1"),
Description: nil,
TransactionSetting: nil,
RankCapScriptId: nil,
ChangeExperienceScript: nil,
ChangeRankScript: nil,
ChangeRankCapScript: nil,
OverflowExperienceScript: nil,
LogSetting: &experience.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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\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(null)
->withRankCapScriptId(null)
->withChangeExperienceScript(null)
->withChangeRankScript(null)
->withChangeRankCapScript(null)
->withOverflowExperienceScript(null)
->withLogSetting((new \Gs2\Experience\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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.CreateNamespaceRequest;
import io.gs2.experience.result.CreateNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
CreateNamespaceResult result = client.createNamespace(
new CreateNamespaceRequest()
.withName("namespace1")
.withDescription(null)
.withTransactionSetting(null)
.withRankCapScriptId(null)
.withChangeExperienceScript(null)
.withChangeRankScript(null)
.withChangeRankCapScript(null)
.withOverflowExperienceScript(null)
.withLogSetting(new io.gs2.experience.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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.CreateNamespaceRequest;
using Gs2.Gs2Experience.Result.CreateNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.CreateNamespaceResult> asyncResult = null;
yield return client.CreateNamespace(
new Gs2.Gs2Experience.Request.CreateNamespaceRequest()
.WithName("namespace1")
.WithDescription(null)
.WithTransactionSetting(null)
.WithRankCapScriptId(null)
.WithChangeExperienceScript(null)
.WithChangeRankScript(null)
.WithChangeRankCapScript(null)
.WithOverflowExperienceScript(null)
.WithLogSetting(new Gs2.Gs2Experience.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.createNamespace(
new Gs2Experience.CreateNamespaceRequest()
.withName("namespace1")
.withDescription(null)
.withTransactionSetting(null)
.withRankCapScriptId(null)
.withChangeExperienceScript(null)
.withChangeRankScript(null)
.withChangeRankCapScript(null)
.withOverflowExperienceScript(null)
.withLogSetting(new Gs2Experience.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 experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.create_namespace(
experience.CreateNamespaceRequest()
.with_name(self.hash1)
.with_description(None)
.with_transaction_setting(None)
.with_rank_cap_script_id(None)
.with_change_experience_script(None)
.with_change_rank_script(None)
.with_change_rank_cap_script(None)
.with_overflow_experience_script(None)
.with_log_setting(
experience.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('experience')
api_result = client.create_namespace({
name='namespace1',
description=nil,
transactionSetting=nil,
rankCapScriptId=nil,
changeExperienceScript=nil,
changeRankScript=nil,
changeRankCapScript=nil,
overflowExperienceScript=nil,
logSetting={
loggingNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1',
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getNamespaceStatus
Get namespace status
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name |
Result
Type | Description | |
---|---|---|
status | string |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetNamespaceStatus(
&experience.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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetNamespaceStatusRequest;
import io.gs2.experience.result.GetNamespaceStatusResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetNamespaceStatusRequest;
using Gs2.Gs2Experience.Result.GetNamespaceStatusResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetNamespaceStatusResult> asyncResult = null;
yield return client.GetNamespaceStatus(
new Gs2.Gs2Experience.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getNamespaceStatus(
new Gs2Experience.GetNamespaceStatusRequest()
.withNamespaceName("namespace1")
);
const status = result.getStatus();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_namespace_status(
experience.GetNamespaceStatusRequest()
.with_namespace_name(self.hash1)
)
status = result.status
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
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
Get namespace
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name |
Result
Type | Description | |
---|---|---|
item | Namespace | Namespace |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetNamespace(
&experience.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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetNamespaceRequest;
import io.gs2.experience.result.GetNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetNamespaceRequest;
using Gs2.Gs2Experience.Result.GetNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetNamespaceResult> asyncResult = null;
yield return client.GetNamespace(
new Gs2.Gs2Experience.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getNamespace(
new Gs2Experience.GetNamespaceRequest()
.withNamespaceName("namespace1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_namespace(
experience.GetNamespaceRequest()
.with_namespace_name(self.hash1)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
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
Update namespace
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
description | string | ~ 1024 chars | description of Namespace | |||
transactionSetting | TransactionSetting | Transaction settings | ||||
rankCapScriptId | string | ~ 1024 chars | Script to dynamically determine rank caps | |||
changeExperienceScript | ScriptSetting | Script to be executed when experience changes | ||||
changeRankScript | ScriptSetting | Script to be executed when rank changes | ||||
changeRankCapScript | ScriptSetting | Script to be executed when the rank cap changes | ||||
overflowExperienceScript | string | ~ 1024 chars | Script to run when experience overflows | |||
logSetting | LogSetting | Log output settings |
Result
Type | Description | |
---|---|---|
item | Namespace | Updated namespace |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.UpdateNamespace(
&experience.UpdateNamespaceRequest {
NamespaceName: pointy.String("namespace1"),
Description: pointy.String("description1"),
TransactionSetting: nil,
RankCapScriptId: nil,
ChangeExperienceScript: &experience.ScriptSetting{
TriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002"),
DoneTriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003"),
},
ChangeRankScript: &experience.ScriptSetting{
TriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004"),
DoneTriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005"),
},
ChangeRankCapScript: &experience.ScriptSetting{
TriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006"),
DoneTriggerScriptId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007"),
},
OverflowExperienceScript: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008"),
LogSetting: &experience.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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\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(null)
->withRankCapScriptId(null)
->withChangeExperienceScript((new \Gs2\Experience\Model\ScriptSetting())
->withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:\namespace1:script:script-1002")
->withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:\namespace1:script:script-1003"))
->withChangeRankScript((new \Gs2\Experience\Model\ScriptSetting())
->withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:\namespace1:script:script-1004")
->withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:\namespace1:script:script-1005"))
->withChangeRankCapScript((new \Gs2\Experience\Model\ScriptSetting())
->withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:\namespace1:script:script-1006")
->withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:\namespace1:script:script-1007"))
->withOverflowExperienceScript("grn:gs2:ap-northeast-1:YourOwnerId:script:\namespace1:script:script-1008")
->withLogSetting((new \Gs2\Experience\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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.UpdateNamespaceRequest;
import io.gs2.experience.result.UpdateNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
UpdateNamespaceResult result = client.updateNamespace(
new UpdateNamespaceRequest()
.withNamespaceName("namespace1")
.withDescription("description1")
.withTransactionSetting(null)
.withRankCapScriptId(null)
.withChangeExperienceScript(new io.gs2.experience.model.ScriptSetting()
.withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002")
.withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003"))
.withChangeRankScript(new io.gs2.experience.model.ScriptSetting()
.withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004")
.withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005"))
.withChangeRankCapScript(new io.gs2.experience.model.ScriptSetting()
.withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006")
.withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007"))
.withOverflowExperienceScript("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008")
.withLogSetting(new io.gs2.experience.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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.UpdateNamespaceRequest;
using Gs2.Gs2Experience.Result.UpdateNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.UpdateNamespaceResult> asyncResult = null;
yield return client.UpdateNamespace(
new Gs2.Gs2Experience.Request.UpdateNamespaceRequest()
.WithNamespaceName("namespace1")
.WithDescription("description1")
.WithTransactionSetting(null)
.WithRankCapScriptId(null)
.WithChangeExperienceScript(new Gs2.Gs2Experience.Model.ScriptSetting()
.WithTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002")
.WithDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003"))
.WithChangeRankScript(new Gs2.Gs2Experience.Model.ScriptSetting()
.WithTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004")
.WithDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005"))
.WithChangeRankCapScript(new Gs2.Gs2Experience.Model.ScriptSetting()
.WithTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006")
.WithDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007"))
.WithOverflowExperienceScript("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008")
.WithLogSetting(new Gs2.Gs2Experience.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.updateNamespace(
new Gs2Experience.UpdateNamespaceRequest()
.withNamespaceName("namespace1")
.withDescription("description1")
.withTransactionSetting(null)
.withRankCapScriptId(null)
.withChangeExperienceScript(new Gs2Experience.model.ScriptSetting()
.withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002")
.withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003"))
.withChangeRankScript(new Gs2Experience.model.ScriptSetting()
.withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004")
.withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005"))
.withChangeRankCapScript(new Gs2Experience.model.ScriptSetting()
.withTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006")
.withDoneTriggerScriptId("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007"))
.withOverflowExperienceScript("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008")
.withLogSetting(new Gs2Experience.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 experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.update_namespace(
experience.UpdateNamespaceRequest()
.with_namespace_name(self.hash1)
.with_description('description1')
.with_transaction_setting(None)
.with_rank_cap_script_id(None)
.with_change_experience_script(
experience.ScriptSetting()
.with_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002')
.with_done_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003'))
.with_change_rank_script(
experience.ScriptSetting()
.with_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004')
.with_done_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005'))
.with_change_rank_cap_script(
experience.ScriptSetting()
.with_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006')
.with_done_trigger_script_id('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007'))
.with_overflow_experience_script('grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008')
.with_log_setting(
experience.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('experience')
api_result = client.update_namespace({
namespaceName='namespace1',
description='description1',
transactionSetting=nil,
rankCapScriptId=nil,
changeExperienceScript={
triggerScriptId='grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1002',
doneTriggerScriptId='grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1003',
},
changeRankScript={
triggerScriptId='grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1004',
doneTriggerScriptId='grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1005',
},
changeRankCapScript={
triggerScriptId='grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1006',
doneTriggerScriptId='grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1007',
},
overflowExperienceScript='grn:gs2:ap-northeast-1:YourOwnerId:script:namespace1:script:script-1008',
logSetting={
loggingNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1',
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
deleteNamespace
Delete namespace
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name |
Result
Type | Description | |
---|---|---|
item | Namespace | Deleted namespace |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DeleteNamespace(
&experience.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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DeleteNamespaceRequest;
import io.gs2.experience.result.DeleteNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DeleteNamespaceRequest;
using Gs2.Gs2Experience.Result.DeleteNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DeleteNamespaceResult> asyncResult = null;
yield return client.DeleteNamespace(
new Gs2.Gs2Experience.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.deleteNamespace(
new Gs2Experience.DeleteNamespaceRequest()
.withNamespaceName("namespace1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.delete_namespace(
experience.DeleteNamespaceRequest()
.with_namespace_name(self.hash1)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
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;
dumpUserDataByUserId
Get dump data of the data associated with the specified user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id |
Result
Type | Description |
---|
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DumpUserDataByUserId(
&experience.DumpUserDataByUserIdRequest {
UserId: pointy.String("user-0001"),
}
)
if err != nil {
panic("error occurred")
}
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DumpUserDataByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->dumpUserDataByUserId(
(new DumpUserDataByUserIdRequest())
->withUserId("user-0001")
);
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DumpUserDataByUserIdRequest;
import io.gs2.experience.result.DumpUserDataByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DumpUserDataByUserIdResult result = client.dumpUserDataByUserId(
new DumpUserDataByUserIdRequest()
.withUserId("user-0001")
);
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DumpUserDataByUserIdRequest;
using Gs2.Gs2Experience.Result.DumpUserDataByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DumpUserDataByUserIdResult> asyncResult = null;
yield return client.DumpUserDataByUserId(
new Gs2.Gs2Experience.Request.DumpUserDataByUserIdRequest()
.WithUserId("user-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.dumpUserDataByUserId(
new Gs2Experience.DumpUserDataByUserIdRequest()
.withUserId("user-0001")
);
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.dump_user_data_by_user_id(
experience.DumpUserDataByUserIdRequest()
.with_user_id('user-0001')
)
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.dump_user_data_by_user_id({
userId='user-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
checkDumpUserDataByUserId
Check if the dump of the data associated with the specified user ID is complete
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id |
Result
Type | Description | |
---|---|---|
url | string | URL of output data |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.CheckDumpUserDataByUserId(
&experience.CheckDumpUserDataByUserIdRequest {
UserId: pointy.String("user-0001"),
}
)
if err != nil {
panic("error occurred")
}
url := result.Url
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\CheckDumpUserDataByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->checkDumpUserDataByUserId(
(new CheckDumpUserDataByUserIdRequest())
->withUserId("user-0001")
);
$url = $result->getUrl();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.CheckDumpUserDataByUserIdRequest;
import io.gs2.experience.result.CheckDumpUserDataByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
CheckDumpUserDataByUserIdResult result = client.checkDumpUserDataByUserId(
new CheckDumpUserDataByUserIdRequest()
.withUserId("user-0001")
);
String url = result.getUrl();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.CheckDumpUserDataByUserIdRequest;
using Gs2.Gs2Experience.Result.CheckDumpUserDataByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.CheckDumpUserDataByUserIdResult> asyncResult = null;
yield return client.CheckDumpUserDataByUserId(
new Gs2.Gs2Experience.Request.CheckDumpUserDataByUserIdRequest()
.WithUserId("user-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var url = result.Url;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.checkDumpUserDataByUserId(
new Gs2Experience.CheckDumpUserDataByUserIdRequest()
.withUserId("user-0001")
);
const url = result.getUrl();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.check_dump_user_data_by_user_id(
experience.CheckDumpUserDataByUserIdRequest()
.with_user_id('user-0001')
)
url = result.url
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.check_dump_user_data_by_user_id({
userId='user-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
url = result.url;
cleanUserDataByUserId
Get clean data of the data associated with the specified user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id |
Result
Type | Description |
---|
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.CleanUserDataByUserId(
&experience.CleanUserDataByUserIdRequest {
UserId: pointy.String("user-0001"),
}
)
if err != nil {
panic("error occurred")
}
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\CleanUserDataByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->cleanUserDataByUserId(
(new CleanUserDataByUserIdRequest())
->withUserId("user-0001")
);
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.CleanUserDataByUserIdRequest;
import io.gs2.experience.result.CleanUserDataByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
CleanUserDataByUserIdResult result = client.cleanUserDataByUserId(
new CleanUserDataByUserIdRequest()
.withUserId("user-0001")
);
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.CleanUserDataByUserIdRequest;
using Gs2.Gs2Experience.Result.CleanUserDataByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.CleanUserDataByUserIdResult> asyncResult = null;
yield return client.CleanUserDataByUserId(
new Gs2.Gs2Experience.Request.CleanUserDataByUserIdRequest()
.WithUserId("user-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.cleanUserDataByUserId(
new Gs2Experience.CleanUserDataByUserIdRequest()
.withUserId("user-0001")
);
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.clean_user_data_by_user_id(
experience.CleanUserDataByUserIdRequest()
.with_user_id('user-0001')
)
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.clean_user_data_by_user_id({
userId='user-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
checkCleanUserDataByUserId
Check if the clean of the data associated with the specified user ID is complete
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id |
Result
Type | Description |
---|
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.CheckCleanUserDataByUserId(
&experience.CheckCleanUserDataByUserIdRequest {
UserId: pointy.String("user-0001"),
}
)
if err != nil {
panic("error occurred")
}
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\CheckCleanUserDataByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->checkCleanUserDataByUserId(
(new CheckCleanUserDataByUserIdRequest())
->withUserId("user-0001")
);
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.CheckCleanUserDataByUserIdRequest;
import io.gs2.experience.result.CheckCleanUserDataByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
CheckCleanUserDataByUserIdResult result = client.checkCleanUserDataByUserId(
new CheckCleanUserDataByUserIdRequest()
.withUserId("user-0001")
);
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.CheckCleanUserDataByUserIdRequest;
using Gs2.Gs2Experience.Result.CheckCleanUserDataByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.CheckCleanUserDataByUserIdResult> asyncResult = null;
yield return client.CheckCleanUserDataByUserId(
new Gs2.Gs2Experience.Request.CheckCleanUserDataByUserIdRequest()
.WithUserId("user-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.checkCleanUserDataByUserId(
new Gs2Experience.CheckCleanUserDataByUserIdRequest()
.withUserId("user-0001")
);
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.check_clean_user_data_by_user_id(
experience.CheckCleanUserDataByUserIdRequest()
.with_user_id('user-0001')
)
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.check_clean_user_data_by_user_id({
userId='user-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
prepareImportUserDataByUserId
Start importing data associated with the specified user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id |
Result
Type | Description | |
---|---|---|
uploadToken | string | Token used to reflect results after upload |
uploadUrl | string | URL used to upload user data |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.PrepareImportUserDataByUserId(
&experience.PrepareImportUserDataByUserIdRequest {
UserId: pointy.String("user-0001"),
}
)
if err != nil {
panic("error occurred")
}
uploadToken := result.UploadToken
uploadUrl := result.UploadUrl
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\PrepareImportUserDataByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->prepareImportUserDataByUserId(
(new PrepareImportUserDataByUserIdRequest())
->withUserId("user-0001")
);
$uploadToken = $result->getUploadToken();
$uploadUrl = $result->getUploadUrl();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.PrepareImportUserDataByUserIdRequest;
import io.gs2.experience.result.PrepareImportUserDataByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
PrepareImportUserDataByUserIdResult result = client.prepareImportUserDataByUserId(
new PrepareImportUserDataByUserIdRequest()
.withUserId("user-0001")
);
String uploadToken = result.getUploadToken();
String uploadUrl = result.getUploadUrl();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.PrepareImportUserDataByUserIdRequest;
using Gs2.Gs2Experience.Result.PrepareImportUserDataByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.PrepareImportUserDataByUserIdResult> asyncResult = null;
yield return client.PrepareImportUserDataByUserId(
new Gs2.Gs2Experience.Request.PrepareImportUserDataByUserIdRequest()
.WithUserId("user-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var uploadToken = result.UploadToken;
var uploadUrl = result.UploadUrl;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.prepareImportUserDataByUserId(
new Gs2Experience.PrepareImportUserDataByUserIdRequest()
.withUserId("user-0001")
);
const uploadToken = result.getUploadToken();
const uploadUrl = result.getUploadUrl();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.prepare_import_user_data_by_user_id(
experience.PrepareImportUserDataByUserIdRequest()
.with_user_id('user-0001')
)
upload_token = result.upload_token
upload_url = result.upload_url
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.prepare_import_user_data_by_user_id({
userId='user-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
uploadToken = result.uploadToken;
uploadUrl = result.uploadUrl;
importUserDataByUserId
Start importing data associated with the specified user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id | ||
uploadToken | string | ✓ | ~ 1024 chars | Token received in preparation for upload |
Result
Type | Description |
---|
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.ImportUserDataByUserId(
&experience.ImportUserDataByUserIdRequest {
UserId: pointy.String("user-0001"),
UploadToken: pointy.String("upload-0001"),
}
)
if err != nil {
panic("error occurred")
}
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\ImportUserDataByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->importUserDataByUserId(
(new ImportUserDataByUserIdRequest())
->withUserId("user-0001")
->withUploadToken("upload-0001")
);
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.ImportUserDataByUserIdRequest;
import io.gs2.experience.result.ImportUserDataByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
ImportUserDataByUserIdResult result = client.importUserDataByUserId(
new ImportUserDataByUserIdRequest()
.withUserId("user-0001")
.withUploadToken("upload-0001")
);
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.ImportUserDataByUserIdRequest;
using Gs2.Gs2Experience.Result.ImportUserDataByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.ImportUserDataByUserIdResult> asyncResult = null;
yield return client.ImportUserDataByUserId(
new Gs2.Gs2Experience.Request.ImportUserDataByUserIdRequest()
.WithUserId("user-0001")
.WithUploadToken("upload-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.importUserDataByUserId(
new Gs2Experience.ImportUserDataByUserIdRequest()
.withUserId("user-0001")
.withUploadToken("upload-0001")
);
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.import_user_data_by_user_id(
experience.ImportUserDataByUserIdRequest()
.with_user_id('user-0001')
.with_upload_token('upload-0001')
)
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.import_user_data_by_user_id({
userId='user-0001',
uploadToken='upload-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
checkImportUserDataByUserId
Check if the import of the data associated with the specified user ID is complete
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
userId | string | ✓ | ~ 128 chars | User Id | ||
uploadToken | string | ✓ | ~ 1024 chars | Token received in preparation for upload |
Result
Type | Description | |
---|---|---|
url | string | URL of log data |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.CheckImportUserDataByUserId(
&experience.CheckImportUserDataByUserIdRequest {
UserId: pointy.String("user-0001"),
UploadToken: pointy.String("upload-0001"),
}
)
if err != nil {
panic("error occurred")
}
url := result.Url
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\CheckImportUserDataByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->checkImportUserDataByUserId(
(new CheckImportUserDataByUserIdRequest())
->withUserId("user-0001")
->withUploadToken("upload-0001")
);
$url = $result->getUrl();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.CheckImportUserDataByUserIdRequest;
import io.gs2.experience.result.CheckImportUserDataByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
CheckImportUserDataByUserIdResult result = client.checkImportUserDataByUserId(
new CheckImportUserDataByUserIdRequest()
.withUserId("user-0001")
.withUploadToken("upload-0001")
);
String url = result.getUrl();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.CheckImportUserDataByUserIdRequest;
using Gs2.Gs2Experience.Result.CheckImportUserDataByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.CheckImportUserDataByUserIdResult> asyncResult = null;
yield return client.CheckImportUserDataByUserId(
new Gs2.Gs2Experience.Request.CheckImportUserDataByUserIdRequest()
.WithUserId("user-0001")
.WithUploadToken("upload-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var url = result.Url;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.checkImportUserDataByUserId(
new Gs2Experience.CheckImportUserDataByUserIdRequest()
.withUserId("user-0001")
.withUploadToken("upload-0001")
);
const url = result.getUrl();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.check_import_user_data_by_user_id(
experience.CheckImportUserDataByUserIdRequest()
.with_user_id('user-0001')
.with_upload_token('upload-0001')
)
url = result.url
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.check_import_user_data_by_user_id({
userId='user-0001',
uploadToken='upload-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
url = result.url;
describeExperienceModelMasters
Get list of experience model masters
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
pageToken | string | ~ 1024 chars | Token specifying the position from which to start acquiring data | |||
limit | int | ✓ | 30 | 1 ~ 1000 | Number of data acquired |
Result
Type | Description | |
---|---|---|
items | List<ExperienceModelMaster> | List of Experience Model Masters |
nextPageToken | string | Page token to retrieve the rest of the listing |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DescribeExperienceModelMasters(
&experience.DescribeExperienceModelMastersRequest {
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DescribeExperienceModelMastersRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeExperienceModelMasters(
(new DescribeExperienceModelMastersRequest())
->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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DescribeExperienceModelMastersRequest;
import io.gs2.experience.result.DescribeExperienceModelMastersResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DescribeExperienceModelMastersResult result = client.describeExperienceModelMasters(
new DescribeExperienceModelMastersRequest()
.withNamespaceName("namespace1")
.withPageToken(null)
.withLimit(null)
);
List<ExperienceModelMaster> 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DescribeExperienceModelMastersRequest;
using Gs2.Gs2Experience.Result.DescribeExperienceModelMastersResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DescribeExperienceModelMastersResult> asyncResult = null;
yield return client.DescribeExperienceModelMasters(
new Gs2.Gs2Experience.Request.DescribeExperienceModelMastersRequest()
.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.describeExperienceModelMasters(
new Gs2Experience.DescribeExperienceModelMastersRequest()
.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 experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.describe_experience_model_masters(
experience.DescribeExperienceModelMastersRequest()
.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('experience')
api_result = client.describe_experience_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;
createExperienceModelMaster
Create new experience model master
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
name | string | ✓ | ~ 128 chars | Experience Model Name | ||
description | string | ~ 1024 chars | description of Namespace | |||
metadata | string | ~ 2048 chars | metadata | |||
defaultExperience | long | ✓ | 0 | ~ 9223372036854775805 | Initial Experience Value | |
defaultRankCap | long | ✓ | ~ 9223372036854775805 | Initial value of rank cap | ||
maxRankCap | long | ✓ | ~ 9223372036854775805 | Maximum rank cap | ||
rankThresholdName | string | ✓ | ~ 128 chars | rank-up threshold | ||
acquireActionRates | List<AcquireActionRate> | ~ 100 items | List of Remuneration addition table |
Result
Type | Description | |
---|---|---|
item | ExperienceModelMaster | Created Experience Model Master |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.CreateExperienceModelMaster(
&experience.CreateExperienceModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
Name: pointy.String("experience-model-0001"),
Description: nil,
Metadata: nil,
DefaultExperience: nil,
DefaultRankCap: pointy.Int64(50),
MaxRankCap: pointy.Int64(50),
RankThresholdName: pointy.String("$threshold1.name"),
AcquireActionRates: []experience.AcquireActionRate{
experience.AcquireActionRate{
Name: pointy.String("rate-0001"),
Rates: []*float64{
pointy.Float64(1.0),
pointy.Float64(1.5),
pointy.Float64(2.0),
},
},
experience.AcquireActionRate{
Name: pointy.String("rate-0002"),
Rates: []*float64{
pointy.Float64(10.0),
pointy.Float64(15.5),
pointy.Float64(20.0),
},
},
},
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\CreateExperienceModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->createExperienceModelMaster(
(new CreateExperienceModelMasterRequest())
->withNamespaceName(self::namespace1)
->withName("experience-model-0001")
->withDescription(null)
->withMetadata(null)
->withDefaultExperience(null)
->withDefaultRankCap(50)
->withMaxRankCap(50)
->withRankThresholdName(self::$threshold1.name)
->withAcquireActionRates([ (new \Gs2\Experience\Model\AcquireActionRate())
->withName("rate-0001")
->withRates([ 1.0,
1.5,
2.0,
]),
(new \Gs2\Experience\Model\AcquireActionRate())
->withName("rate-0002")
->withRates([ 10.0,
15.5,
20.0,
]),
])
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.CreateExperienceModelMasterRequest;
import io.gs2.experience.result.CreateExperienceModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
CreateExperienceModelMasterResult result = client.createExperienceModelMaster(
new CreateExperienceModelMasterRequest()
.withNamespaceName("namespace1")
.withName("experience-model-0001")
.withDescription(null)
.withMetadata(null)
.withDefaultExperience(null)
.withDefaultRankCap(50L)
.withMaxRankCap(50L)
.withRankThresholdName("$threshold1.name")
.withAcquireActionRates(Arrays.asList(
new io.gs2.experience.model.AcquireActionRate()
.withName("rate-0001")
.withRates(Arrays.asList(
1.0,
1.5,
2.0
)),
new io.gs2.experience.model.AcquireActionRate()
.withName("rate-0002")
.withRates(Arrays.asList(
10.0,
15.5,
20.0
))
))
);
ExperienceModelMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.CreateExperienceModelMasterRequest;
using Gs2.Gs2Experience.Result.CreateExperienceModelMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.CreateExperienceModelMasterResult> asyncResult = null;
yield return client.CreateExperienceModelMaster(
new Gs2.Gs2Experience.Request.CreateExperienceModelMasterRequest()
.WithNamespaceName("namespace1")
.WithName("experience-model-0001")
.WithDescription(null)
.WithMetadata(null)
.WithDefaultExperience(null)
.WithDefaultRankCap(50L)
.WithMaxRankCap(50L)
.WithRankThresholdName("$threshold1.name")
.WithAcquireActionRates(new Gs2.Gs2Experience.Model.AcquireActionRate[] {
new Gs2.Gs2Experience.Model.AcquireActionRate()
.WithName("rate-0001")
.WithRates(new double[] {
1.0,
1.5,
2.0
}),
new Gs2.Gs2Experience.Model.AcquireActionRate()
.WithName("rate-0002")
.WithRates(new double[] {
10.0,
15.5,
20.0
})
}),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.createExperienceModelMaster(
new Gs2Experience.CreateExperienceModelMasterRequest()
.withNamespaceName("namespace1")
.withName("experience-model-0001")
.withDescription(null)
.withMetadata(null)
.withDefaultExperience(null)
.withDefaultRankCap(50)
.withMaxRankCap(50)
.withRankThresholdName("$threshold1.name")
.withAcquireActionRates([
new Gs2Experience.model.AcquireActionRate()
.withName("rate-0001")
.withRates([
1.0,
1.5,
2.0
]),
new Gs2Experience.model.AcquireActionRate()
.withName("rate-0002")
.withRates([
10.0,
15.5,
20.0
])
])
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.create_experience_model_master(
experience.CreateExperienceModelMasterRequest()
.with_namespace_name(self.hash1)
.with_name('experience-model-0001')
.with_description(None)
.with_metadata(None)
.with_default_experience(None)
.with_default_rank_cap(50)
.with_max_rank_cap(50)
.with_rank_threshold_name(self.threshold1.name)
.with_acquire_action_rates([ experience.AcquireActionRate()
.with_name('rate-0001')
.with_rates([ 1.0,
1.5,
2.0,
]),
experience.AcquireActionRate()
.with_name('rate-0002')
.with_rates([ 10.0,
15.5,
20.0,
]),
])
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.create_experience_model_master({
namespaceName='namespace1',
name='experience-model-0001',
description=nil,
metadata=nil,
defaultExperience=nil,
defaultRankCap=50,
maxRankCap=50,
rankThresholdName='$threshold1.name',
acquireActionRates={
{
name='rate-0001',
rates={
1.0,
1.5,
2.0
},
},
{
name='rate-0002',
rates={
10.0,
15.5,
20.0
},
}
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getExperienceModelMaster
Get Experience model master
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name |
Result
Type | Description | |
---|---|---|
item | ExperienceModelMaster | Experience Model Master |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetExperienceModelMaster(
&experience.GetExperienceModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
ExperienceName: pointy.String("experience-model-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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\GetExperienceModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getExperienceModelMaster(
(new GetExperienceModelMasterRequest())
->withNamespaceName(self::namespace1)
->withExperienceName("experience-model-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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetExperienceModelMasterRequest;
import io.gs2.experience.result.GetExperienceModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
GetExperienceModelMasterResult result = client.getExperienceModelMaster(
new GetExperienceModelMasterRequest()
.withNamespaceName("namespace1")
.withExperienceName("experience-model-0001")
);
ExperienceModelMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetExperienceModelMasterRequest;
using Gs2.Gs2Experience.Result.GetExperienceModelMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetExperienceModelMasterResult> asyncResult = null;
yield return client.GetExperienceModelMaster(
new Gs2.Gs2Experience.Request.GetExperienceModelMasterRequest()
.WithNamespaceName("namespace1")
.WithExperienceName("experience-model-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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getExperienceModelMaster(
new Gs2Experience.GetExperienceModelMasterRequest()
.withNamespaceName("namespace1")
.withExperienceName("experience-model-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_experience_model_master(
experience.GetExperienceModelMasterRequest()
.with_namespace_name(self.hash1)
.with_experience_name('experience-model-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.get_experience_model_master({
namespaceName='namespace1',
experienceName='experience-model-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
updateExperienceModelMaster
Update Experience Model Master
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
description | string | ~ 1024 chars | description of Namespace | |||
metadata | string | ~ 2048 chars | metadata | |||
defaultExperience | long | ✓ | 0 | ~ 9223372036854775805 | Initial Experience Value | |
defaultRankCap | long | ✓ | ~ 9223372036854775805 | Initial value of rank cap | ||
maxRankCap | long | ✓ | ~ 9223372036854775805 | Maximum rank cap | ||
rankThresholdName | string | ✓ | ~ 128 chars | rank-up threshold | ||
acquireActionRates | List<AcquireActionRate> | ~ 100 items | List of Remuneration addition table |
Result
Type | Description | |
---|---|---|
item | ExperienceModelMaster | Updated Experience Model Master |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.UpdateExperienceModelMaster(
&experience.UpdateExperienceModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
ExperienceName: pointy.String("experience-model-0001"),
Description: pointy.String("description1"),
Metadata: pointy.String("{\"hoge\": \"fuga\"}"),
DefaultExperience: pointy.Int64(100),
DefaultRankCap: pointy.Int64(60),
MaxRankCap: pointy.Int64(80),
RankThresholdName: pointy.String("$threshold2.name"),
AcquireActionRates: []experience.AcquireActionRate{
experience.AcquireActionRate{
Name: pointy.String("rate-0001"),
Mode: pointy.String("big"),
BigRates: []*string{
pointy.String("100000000000000"),
pointy.String("10000000000000000000000000000"),
pointy.String("1000000000000000000000000000000000000000000"),
},
},
experience.AcquireActionRate{
Name: pointy.String("rate-0002"),
Mode: pointy.String("big"),
BigRates: []*string{
pointy.String("100000000000000"),
pointy.String("10000000000000000000000000000"),
pointy.String("1000000000000000000000000000000000000000000"),
},
},
},
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\UpdateExperienceModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->updateExperienceModelMaster(
(new UpdateExperienceModelMasterRequest())
->withNamespaceName(self::namespace1)
->withExperienceName("experience-model-0001")
->withDescription("description1")
->withMetadata("{\"hoge\": \"fuga\"}")
->withDefaultExperience(100)
->withDefaultRankCap(60)
->withMaxRankCap(80)
->withRankThresholdName(self::$threshold2.name)
->withAcquireActionRates([ (new \Gs2\Experience\Model\AcquireActionRate())
->withName("rate-0001")
->withMode("big")
->withBigRates([ "100000000000000",
"10000000000000000000000000000",
"1000000000000000000000000000000000000000000",
]),
(new \Gs2\Experience\Model\AcquireActionRate())
->withName("rate-0002")
->withMode("big")
->withBigRates([ "100000000000000",
"10000000000000000000000000000",
"1000000000000000000000000000000000000000000",
]),
])
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.UpdateExperienceModelMasterRequest;
import io.gs2.experience.result.UpdateExperienceModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
UpdateExperienceModelMasterResult result = client.updateExperienceModelMaster(
new UpdateExperienceModelMasterRequest()
.withNamespaceName("namespace1")
.withExperienceName("experience-model-0001")
.withDescription("description1")
.withMetadata("{\"hoge\": \"fuga\"}")
.withDefaultExperience(100L)
.withDefaultRankCap(60L)
.withMaxRankCap(80L)
.withRankThresholdName("$threshold2.name")
.withAcquireActionRates(Arrays.asList(
new io.gs2.experience.model.AcquireActionRate()
.withName("rate-0001")
.withMode("big")
.withBigRates(Arrays.asList(
"100000000000000",
"10000000000000000000000000000",
"1000000000000000000000000000000000000000000"
)),
new io.gs2.experience.model.AcquireActionRate()
.withName("rate-0002")
.withMode("big")
.withBigRates(Arrays.asList(
"100000000000000",
"10000000000000000000000000000",
"1000000000000000000000000000000000000000000"
))
))
);
ExperienceModelMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.UpdateExperienceModelMasterRequest;
using Gs2.Gs2Experience.Result.UpdateExperienceModelMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.UpdateExperienceModelMasterResult> asyncResult = null;
yield return client.UpdateExperienceModelMaster(
new Gs2.Gs2Experience.Request.UpdateExperienceModelMasterRequest()
.WithNamespaceName("namespace1")
.WithExperienceName("experience-model-0001")
.WithDescription("description1")
.WithMetadata("{\"hoge\": \"fuga\"}")
.WithDefaultExperience(100L)
.WithDefaultRankCap(60L)
.WithMaxRankCap(80L)
.WithRankThresholdName("$threshold2.name")
.WithAcquireActionRates(new Gs2.Gs2Experience.Model.AcquireActionRate[] {
new Gs2.Gs2Experience.Model.AcquireActionRate()
.WithName("rate-0001")
.WithMode("big")
.WithBigRates(new string[] {
"100000000000000",
"10000000000000000000000000000",
"1000000000000000000000000000000000000000000"
}),
new Gs2.Gs2Experience.Model.AcquireActionRate()
.WithName("rate-0002")
.WithMode("big")
.WithBigRates(new string[] {
"100000000000000",
"10000000000000000000000000000",
"1000000000000000000000000000000000000000000"
})
}),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.updateExperienceModelMaster(
new Gs2Experience.UpdateExperienceModelMasterRequest()
.withNamespaceName("namespace1")
.withExperienceName("experience-model-0001")
.withDescription("description1")
.withMetadata("{\"hoge\": \"fuga\"}")
.withDefaultExperience(100)
.withDefaultRankCap(60)
.withMaxRankCap(80)
.withRankThresholdName("$threshold2.name")
.withAcquireActionRates([
new Gs2Experience.model.AcquireActionRate()
.withName("rate-0001")
.withMode("big")
.withBigRates([
"100000000000000",
"10000000000000000000000000000",
"1000000000000000000000000000000000000000000"
]),
new Gs2Experience.model.AcquireActionRate()
.withName("rate-0002")
.withMode("big")
.withBigRates([
"100000000000000",
"10000000000000000000000000000",
"1000000000000000000000000000000000000000000"
])
])
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.update_experience_model_master(
experience.UpdateExperienceModelMasterRequest()
.with_namespace_name(self.hash1)
.with_experience_name('experience-model-0001')
.with_description('description1')
.with_metadata('{"hoge": "fuga"}')
.with_default_experience(100)
.with_default_rank_cap(60)
.with_max_rank_cap(80)
.with_rank_threshold_name(self.threshold2.name)
.with_acquire_action_rates([ experience.AcquireActionRate()
.with_name('rate-0001')
.with_mode('big')
.with_big_rates([ '100000000000000',
'10000000000000000000000000000',
'1000000000000000000000000000000000000000000',
]),
experience.AcquireActionRate()
.with_name('rate-0002')
.with_mode('big')
.with_big_rates([ '100000000000000',
'10000000000000000000000000000',
'1000000000000000000000000000000000000000000',
]),
])
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.update_experience_model_master({
namespaceName='namespace1',
experienceName='experience-model-0001',
description='description1',
metadata='{"hoge": "fuga"}',
defaultExperience=100,
defaultRankCap=60,
maxRankCap=80,
rankThresholdName='$threshold2.name',
acquireActionRates={
{
name='rate-0001',
mode='big',
bigRates={
'100000000000000',
'10000000000000000000000000000',
'1000000000000000000000000000000000000000000'
},
},
{
name='rate-0002',
mode='big',
bigRates={
'100000000000000',
'10000000000000000000000000000',
'1000000000000000000000000000000000000000000'
},
}
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
deleteExperienceModelMaster
Delete Experience Model Master
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name |
Result
Type | Description | |
---|---|---|
item | ExperienceModelMaster | Deleted Experience Model Master |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DeleteExperienceModelMaster(
&experience.DeleteExperienceModelMasterRequest {
NamespaceName: pointy.String("namespace1"),
ExperienceName: pointy.String("experience-model-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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DeleteExperienceModelMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->deleteExperienceModelMaster(
(new DeleteExperienceModelMasterRequest())
->withNamespaceName(self::namespace1)
->withExperienceName("experience-model-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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DeleteExperienceModelMasterRequest;
import io.gs2.experience.result.DeleteExperienceModelMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DeleteExperienceModelMasterResult result = client.deleteExperienceModelMaster(
new DeleteExperienceModelMasterRequest()
.withNamespaceName("namespace1")
.withExperienceName("experience-model-0001")
);
ExperienceModelMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DeleteExperienceModelMasterRequest;
using Gs2.Gs2Experience.Result.DeleteExperienceModelMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DeleteExperienceModelMasterResult> asyncResult = null;
yield return client.DeleteExperienceModelMaster(
new Gs2.Gs2Experience.Request.DeleteExperienceModelMasterRequest()
.WithNamespaceName("namespace1")
.WithExperienceName("experience-model-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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.deleteExperienceModelMaster(
new Gs2Experience.DeleteExperienceModelMasterRequest()
.withNamespaceName("namespace1")
.withExperienceName("experience-model-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.delete_experience_model_master(
experience.DeleteExperienceModelMasterRequest()
.with_namespace_name(self.hash1)
.with_experience_name('experience-model-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.delete_experience_model_master({
namespaceName='namespace1',
experienceName='experience-model-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
describeExperienceModels
Get list of experience and rank-up threshold models
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name |
Result
Type | Description | |
---|---|---|
items | List<ExperienceModel> | List of Experience Model |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DescribeExperienceModels(
&experience.DescribeExperienceModelsRequest {
NamespaceName: pointy.String("namespace2"),
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DescribeExperienceModelsRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeExperienceModels(
(new DescribeExperienceModelsRequest())
->withNamespaceName(self::namespace2)
);
$items = $result->getItems();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DescribeExperienceModelsRequest;
import io.gs2.experience.result.DescribeExperienceModelsResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DescribeExperienceModelsResult result = client.describeExperienceModels(
new DescribeExperienceModelsRequest()
.withNamespaceName("namespace2")
);
List<ExperienceModel> 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DescribeExperienceModelsRequest;
using Gs2.Gs2Experience.Result.DescribeExperienceModelsResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DescribeExperienceModelsResult> asyncResult = null;
yield return client.DescribeExperienceModels(
new Gs2.Gs2Experience.Request.DescribeExperienceModelsRequest()
.WithNamespaceName("namespace2"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.describeExperienceModels(
new Gs2Experience.DescribeExperienceModelsRequest()
.withNamespaceName("namespace2")
);
const items = result.getItems();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.describe_experience_models(
experience.DescribeExperienceModelsRequest()
.with_namespace_name(self.hash2)
)
items = result.items
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.describe_experience_models({
namespaceName='namespace2',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
getExperienceModel
Get Experience Model
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name |
Result
Type | Description | |
---|---|---|
item | ExperienceModel | Experience Model |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetExperienceModel(
&experience.GetExperienceModelRequest {
NamespaceName: pointy.String("namespace2"),
ExperienceName: pointy.String("experience-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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\GetExperienceModelRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getExperienceModel(
(new GetExperienceModelRequest())
->withNamespaceName(self::namespace2)
->withExperienceName("experience-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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetExperienceModelRequest;
import io.gs2.experience.result.GetExperienceModelResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
GetExperienceModelResult result = client.getExperienceModel(
new GetExperienceModelRequest()
.withNamespaceName("namespace2")
.withExperienceName("experience-0001")
);
ExperienceModel 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetExperienceModelRequest;
using Gs2.Gs2Experience.Result.GetExperienceModelResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetExperienceModelResult> asyncResult = null;
yield return client.GetExperienceModel(
new Gs2.Gs2Experience.Request.GetExperienceModelRequest()
.WithNamespaceName("namespace2")
.WithExperienceName("experience-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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getExperienceModel(
new Gs2Experience.GetExperienceModelRequest()
.withNamespaceName("namespace2")
.withExperienceName("experience-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_experience_model(
experience.GetExperienceModelRequest()
.with_namespace_name(self.hash2)
.with_experience_name('experience-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.get_experience_model({
namespaceName='namespace2',
experienceName='experience-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
describeThresholdMasters
Get list of rank-up threshold masters
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
pageToken | string | ~ 1024 chars | Token specifying the position from which to start acquiring data | |||
limit | int | ✓ | 30 | 1 ~ 1000 | Number of data acquired |
Result
Type | Description | |
---|---|---|
items | List<ThresholdMaster> | List of Rank Up Threshold Master |
nextPageToken | string | Page token to retrieve the rest of the listing |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DescribeThresholdMasters(
&experience.DescribeThresholdMastersRequest {
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DescribeThresholdMastersRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeThresholdMasters(
(new DescribeThresholdMastersRequest())
->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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DescribeThresholdMastersRequest;
import io.gs2.experience.result.DescribeThresholdMastersResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DescribeThresholdMastersResult result = client.describeThresholdMasters(
new DescribeThresholdMastersRequest()
.withNamespaceName("namespace1")
.withPageToken(null)
.withLimit(null)
);
List<ThresholdMaster> 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DescribeThresholdMastersRequest;
using Gs2.Gs2Experience.Result.DescribeThresholdMastersResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DescribeThresholdMastersResult> asyncResult = null;
yield return client.DescribeThresholdMasters(
new Gs2.Gs2Experience.Request.DescribeThresholdMastersRequest()
.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.describeThresholdMasters(
new Gs2Experience.DescribeThresholdMastersRequest()
.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 experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.describe_threshold_masters(
experience.DescribeThresholdMastersRequest()
.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('experience')
api_result = client.describe_threshold_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;
createThresholdMaster
Create new rank-up threshold master
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
name | string | ✓ | ~ 128 chars | Rank Up Threshold Name | ||
description | string | ~ 1024 chars | description of Namespace | |||
metadata | string | ~ 2048 chars | metadata | |||
values | List<long> | ✓ | 1 ~ 1024 items | List of Rank Up Experience Threshold |
Result
Type | Description | |
---|---|---|
item | ThresholdMaster | Created rank-up threshold master |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.CreateThresholdMaster(
&experience.CreateThresholdMasterRequest {
NamespaceName: pointy.String("namespace1"),
Name: pointy.String("threshold-0001"),
Description: nil,
Metadata: nil,
Values: []*int64{
pointy.Int64(100),
pointy.Int64(200),
pointy.Int64(300),
},
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\CreateThresholdMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->createThresholdMaster(
(new CreateThresholdMasterRequest())
->withNamespaceName(self::namespace1)
->withName("threshold-0001")
->withDescription(null)
->withMetadata(null)
->withValues([ 100,
200,
300,
])
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.CreateThresholdMasterRequest;
import io.gs2.experience.result.CreateThresholdMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
CreateThresholdMasterResult result = client.createThresholdMaster(
new CreateThresholdMasterRequest()
.withNamespaceName("namespace1")
.withName("threshold-0001")
.withDescription(null)
.withMetadata(null)
.withValues(Arrays.asList(
100L,
200L,
300L
))
);
ThresholdMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.CreateThresholdMasterRequest;
using Gs2.Gs2Experience.Result.CreateThresholdMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.CreateThresholdMasterResult> asyncResult = null;
yield return client.CreateThresholdMaster(
new Gs2.Gs2Experience.Request.CreateThresholdMasterRequest()
.WithNamespaceName("namespace1")
.WithName("threshold-0001")
.WithDescription(null)
.WithMetadata(null)
.WithValues(new long[] {
100L,
200L,
300L
}),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.createThresholdMaster(
new Gs2Experience.CreateThresholdMasterRequest()
.withNamespaceName("namespace1")
.withName("threshold-0001")
.withDescription(null)
.withMetadata(null)
.withValues([
100,
200,
300
])
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.create_threshold_master(
experience.CreateThresholdMasterRequest()
.with_namespace_name(self.hash1)
.with_name('threshold-0001')
.with_description(None)
.with_metadata(None)
.with_values([ 100,
200,
300,
])
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.create_threshold_master({
namespaceName='namespace1',
name='threshold-0001',
description=nil,
metadata=nil,
values={
100,
200,
300
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getThresholdMaster
Obtain rank-up threshold master
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
thresholdName | string | ✓ | ~ 128 chars | Rank Up Threshold Name |
Result
Type | Description | |
---|---|---|
item | ThresholdMaster | Rank Up Threshold Master |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetThresholdMaster(
&experience.GetThresholdMasterRequest {
NamespaceName: pointy.String("namespace1"),
ThresholdName: pointy.String("threshold-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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\GetThresholdMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getThresholdMaster(
(new GetThresholdMasterRequest())
->withNamespaceName(self::namespace1)
->withThresholdName("threshold-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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetThresholdMasterRequest;
import io.gs2.experience.result.GetThresholdMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
GetThresholdMasterResult result = client.getThresholdMaster(
new GetThresholdMasterRequest()
.withNamespaceName("namespace1")
.withThresholdName("threshold-0001")
);
ThresholdMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetThresholdMasterRequest;
using Gs2.Gs2Experience.Result.GetThresholdMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetThresholdMasterResult> asyncResult = null;
yield return client.GetThresholdMaster(
new Gs2.Gs2Experience.Request.GetThresholdMasterRequest()
.WithNamespaceName("namespace1")
.WithThresholdName("threshold-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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getThresholdMaster(
new Gs2Experience.GetThresholdMasterRequest()
.withNamespaceName("namespace1")
.withThresholdName("threshold-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_threshold_master(
experience.GetThresholdMasterRequest()
.with_namespace_name(self.hash1)
.with_threshold_name('threshold-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.get_threshold_master({
namespaceName='namespace1',
thresholdName='threshold-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
updateThresholdMaster
Update rank-up threshold master
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
thresholdName | string | ✓ | ~ 128 chars | Rank Up Threshold Name | ||
description | string | ~ 1024 chars | description of Namespace | |||
metadata | string | ~ 2048 chars | metadata | |||
values | List<long> | ✓ | 1 ~ 1024 items | List of Rank Up Experience Threshold |
Result
Type | Description | |
---|---|---|
item | ThresholdMaster | Updated rank-up threshold master |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.UpdateThresholdMaster(
&experience.UpdateThresholdMasterRequest {
NamespaceName: pointy.String("namespace1"),
ThresholdName: pointy.String("threshold-0001"),
Description: pointy.String("description1"),
Metadata: pointy.String("{\"fuga\": \"piyo\"}"),
Values: []*int64{
pointy.Int64(1100),
pointy.Int64(1200),
pointy.Int64(1300),
},
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\UpdateThresholdMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->updateThresholdMaster(
(new UpdateThresholdMasterRequest())
->withNamespaceName(self::namespace1)
->withThresholdName("threshold-0001")
->withDescription("description1")
->withMetadata("{\"fuga\": \"piyo\"}")
->withValues([ 1100,
1200,
1300,
])
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.UpdateThresholdMasterRequest;
import io.gs2.experience.result.UpdateThresholdMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
UpdateThresholdMasterResult result = client.updateThresholdMaster(
new UpdateThresholdMasterRequest()
.withNamespaceName("namespace1")
.withThresholdName("threshold-0001")
.withDescription("description1")
.withMetadata("{\"fuga\": \"piyo\"}")
.withValues(Arrays.asList(
1100L,
1200L,
1300L
))
);
ThresholdMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.UpdateThresholdMasterRequest;
using Gs2.Gs2Experience.Result.UpdateThresholdMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.UpdateThresholdMasterResult> asyncResult = null;
yield return client.UpdateThresholdMaster(
new Gs2.Gs2Experience.Request.UpdateThresholdMasterRequest()
.WithNamespaceName("namespace1")
.WithThresholdName("threshold-0001")
.WithDescription("description1")
.WithMetadata("{\"fuga\": \"piyo\"}")
.WithValues(new long[] {
1100L,
1200L,
1300L
}),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.updateThresholdMaster(
new Gs2Experience.UpdateThresholdMasterRequest()
.withNamespaceName("namespace1")
.withThresholdName("threshold-0001")
.withDescription("description1")
.withMetadata("{\"fuga\": \"piyo\"}")
.withValues([
1100,
1200,
1300
])
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.update_threshold_master(
experience.UpdateThresholdMasterRequest()
.with_namespace_name(self.hash1)
.with_threshold_name('threshold-0001')
.with_description('description1')
.with_metadata('{"fuga": "piyo"}')
.with_values([ 1100,
1200,
1300,
])
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.update_threshold_master({
namespaceName='namespace1',
thresholdName='threshold-0001',
description='description1',
metadata='{"fuga": "piyo"}',
values={
1100,
1200,
1300
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
deleteThresholdMaster
Delete rank-up threshold master
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
thresholdName | string | ✓ | ~ 128 chars | Rank Up Threshold Name |
Result
Type | Description | |
---|---|---|
item | ThresholdMaster | Deleted rank-up threshold master |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DeleteThresholdMaster(
&experience.DeleteThresholdMasterRequest {
NamespaceName: pointy.String("namespace1"),
ThresholdName: pointy.String("threshold-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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DeleteThresholdMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->deleteThresholdMaster(
(new DeleteThresholdMasterRequest())
->withNamespaceName(self::namespace1)
->withThresholdName("threshold-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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DeleteThresholdMasterRequest;
import io.gs2.experience.result.DeleteThresholdMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DeleteThresholdMasterResult result = client.deleteThresholdMaster(
new DeleteThresholdMasterRequest()
.withNamespaceName("namespace1")
.withThresholdName("threshold-0001")
);
ThresholdMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DeleteThresholdMasterRequest;
using Gs2.Gs2Experience.Result.DeleteThresholdMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DeleteThresholdMasterResult> asyncResult = null;
yield return client.DeleteThresholdMaster(
new Gs2.Gs2Experience.Request.DeleteThresholdMasterRequest()
.WithNamespaceName("namespace1")
.WithThresholdName("threshold-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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.deleteThresholdMaster(
new Gs2Experience.DeleteThresholdMasterRequest()
.withNamespaceName("namespace1")
.withThresholdName("threshold-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.delete_threshold_master(
experience.DeleteThresholdMasterRequest()
.with_namespace_name(self.hash1)
.with_threshold_name('threshold-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.delete_threshold_master({
namespaceName='namespace1',
thresholdName='threshold-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
exportMaster
Export master data for currently available experience settings
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name |
Result
Type | Description | |
---|---|---|
item | CurrentExperienceMaster | Currently available experience settings |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.ExportMaster(
&experience.ExportMasterRequest {
NamespaceName: pointy.String("namespace1"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\ExportMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->exportMaster(
(new ExportMasterRequest())
->withNamespaceName(self::namespace1)
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.ExportMasterRequest;
import io.gs2.experience.result.ExportMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
ExportMasterResult result = client.exportMaster(
new ExportMasterRequest()
.withNamespaceName("namespace1")
);
CurrentExperienceMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.ExportMasterRequest;
using Gs2.Gs2Experience.Result.ExportMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.ExportMasterResult> asyncResult = null;
yield return client.ExportMaster(
new Gs2.Gs2Experience.Request.ExportMasterRequest()
.WithNamespaceName("namespace1"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.exportMaster(
new Gs2Experience.ExportMasterRequest()
.withNamespaceName("namespace1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.export_master(
experience.ExportMasterRequest()
.with_namespace_name(self.hash1)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.export_master({
namespaceName='namespace1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getCurrentExperienceMaster
Retrieve the currently available experience settings
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name |
Result
Type | Description | |
---|---|---|
item | CurrentExperienceMaster | Currently available experience settings |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetCurrentExperienceMaster(
&experience.GetCurrentExperienceMasterRequest {
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\GetCurrentExperienceMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getCurrentExperienceMaster(
(new GetCurrentExperienceMasterRequest())
->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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetCurrentExperienceMasterRequest;
import io.gs2.experience.result.GetCurrentExperienceMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
GetCurrentExperienceMasterResult result = client.getCurrentExperienceMaster(
new GetCurrentExperienceMasterRequest()
.withNamespaceName("namespace1")
);
CurrentExperienceMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetCurrentExperienceMasterRequest;
using Gs2.Gs2Experience.Result.GetCurrentExperienceMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetCurrentExperienceMasterResult> asyncResult = null;
yield return client.GetCurrentExperienceMaster(
new Gs2.Gs2Experience.Request.GetCurrentExperienceMasterRequest()
.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getCurrentExperienceMaster(
new Gs2Experience.GetCurrentExperienceMasterRequest()
.withNamespaceName("namespace1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_current_experience_master(
experience.GetCurrentExperienceMasterRequest()
.with_namespace_name(self.hash1)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.get_current_experience_master({
namespaceName='namespace1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
updateCurrentExperienceMaster
Update the currently available experience settings
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
settings | string | ✓ | ~ 5242880 chars | Master data |
Result
Type | Description | |
---|---|---|
item | CurrentExperienceMaster | Updated and currently available experience settings |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.UpdateCurrentExperienceMaster(
&experience.UpdateCurrentExperienceMasterRequest {
NamespaceName: pointy.String("namespace1"),
Settings: pointy.String("{\"version\": \"2019-01-11\", \"experienceModels\": [{\"name\": \"character_ssr\", \"metadata\": \"SSR\", \"defaultExperience\": 0, \"defaultRankCap\": 50, \"maxRankCap\": 80, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_sr\", \"metadata\": \"SR\", \"defaultExperience\": 0, \"defaultRankCap\": 40, \"maxRankCap\": 70, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_r\", \"metadata\": \"R\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 60, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"equipment\", \"metadata\": \"EQUIPMENT\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 50, \"rankThreshold\": {\"metadata\": \"EQUIPMENT\", \"values\": [200, 400, 600, 800, 1000, 1200, 1400, 1600, 1800, 2000, 2200, 2400, 2600, 2800, 3000, 3200, 3400, 3600, 3800, 4000, 4200, 4400, 4600, 4800, 5000, 5200, 5400, 5600, 5800, 6000, 6200, 6400, 6600, 6800, 7000, 7200, 7400, 7600, 7800, 8000, 8200, 8400, 8600, 8800, 9000, 9200, 9400, 9600, 9800]}, \"acquireActionRates\": [{\"name\": \"rate-0001\", \"mode\": \"big\", \"bigRates\": [\"1\", \"10\", \"100\", \"1000\", \"10000\", \"100000\", \"1000000\", \"10000000\", \"100000000\", \"1000000000\", \"10000000000\", \"100000000000\", \"1000000000000\", \"10000000000000\", \"100000000000000\", \"1000000000000000\", \"10000000000000000\", \"100000000000000000\", \"1000000000000000000\", \"10000000000000000000\", \"100000000000000000000\", \"1000000000000000000000\", \"10000000000000000000000\", \"100000000000000000000000\", \"1000000000000000000000000\", \"10000000000000000000000000\", \"100000000000000000000000000\"]}]}, {\"name\": \"skill\", \"metadata\": \"SKILL\", \"defaultExperience\": 0, \"defaultRankCap\": 10, \"maxRankCap\": 20, \"rankThreshold\": {\"metadata\": \"SKILL\", \"values\": [300, 600, 900, 1200, 1500, 1800, 2100, 2400, 2700, 3000, 3300, 3600, 3900, 4200, 4500, 4800, 5100, 5400, 5700]}}]}"),
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\UpdateCurrentExperienceMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->updateCurrentExperienceMaster(
(new UpdateCurrentExperienceMasterRequest())
->withNamespaceName(self::namespace1)
->withSettings("{\"version\": \"2019-01-11\", \"experienceModels\": [{\"name\": \"character_ssr\", \"metadata\": \"SSR\", \"defaultExperience\": 0, \"defaultRankCap\": 50, \"maxRankCap\": 80, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_sr\", \"metadata\": \"SR\", \"defaultExperience\": 0, \"defaultRankCap\": 40, \"maxRankCap\": 70, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_r\", \"metadata\": \"R\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 60, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"equipment\", \"metadata\": \"EQUIPMENT\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 50, \"rankThreshold\": {\"metadata\": \"EQUIPMENT\", \"values\": [200, 400, 600, 800, 1000, 1200, 1400, 1600, 1800, 2000, 2200, 2400, 2600, 2800, 3000, 3200, 3400, 3600, 3800, 4000, 4200, 4400, 4600, 4800, 5000, 5200, 5400, 5600, 5800, 6000, 6200, 6400, 6600, 6800, 7000, 7200, 7400, 7600, 7800, 8000, 8200, 8400, 8600, 8800, 9000, 9200, 9400, 9600, 9800]}, \"acquireActionRates\": [{\"name\": \"rate-0001\", \"mode\": \"big\", \"bigRates\": [\"1\", \"10\", \"100\", \"1000\", \"10000\", \"100000\", \"1000000\", \"10000000\", \"100000000\", \"1000000000\", \"10000000000\", \"100000000000\", \"1000000000000\", \"10000000000000\", \"100000000000000\", \"1000000000000000\", \"10000000000000000\", \"100000000000000000\", \"1000000000000000000\", \"10000000000000000000\", \"100000000000000000000\", \"1000000000000000000000\", \"10000000000000000000000\", \"100000000000000000000000\", \"1000000000000000000000000\", \"10000000000000000000000000\", \"100000000000000000000000000\"]}]}, {\"name\": \"skill\", \"metadata\": \"SKILL\", \"defaultExperience\": 0, \"defaultRankCap\": 10, \"maxRankCap\": 20, \"rankThreshold\": {\"metadata\": \"SKILL\", \"values\": [300, 600, 900, 1200, 1500, 1800, 2100, 2400, 2700, 3000, 3300, 3600, 3900, 4200, 4500, 4800, 5100, 5400, 5700]}}]}")
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.UpdateCurrentExperienceMasterRequest;
import io.gs2.experience.result.UpdateCurrentExperienceMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
UpdateCurrentExperienceMasterResult result = client.updateCurrentExperienceMaster(
new UpdateCurrentExperienceMasterRequest()
.withNamespaceName("namespace1")
.withSettings("{\"version\": \"2019-01-11\", \"experienceModels\": [{\"name\": \"character_ssr\", \"metadata\": \"SSR\", \"defaultExperience\": 0, \"defaultRankCap\": 50, \"maxRankCap\": 80, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_sr\", \"metadata\": \"SR\", \"defaultExperience\": 0, \"defaultRankCap\": 40, \"maxRankCap\": 70, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_r\", \"metadata\": \"R\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 60, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"equipment\", \"metadata\": \"EQUIPMENT\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 50, \"rankThreshold\": {\"metadata\": \"EQUIPMENT\", \"values\": [200, 400, 600, 800, 1000, 1200, 1400, 1600, 1800, 2000, 2200, 2400, 2600, 2800, 3000, 3200, 3400, 3600, 3800, 4000, 4200, 4400, 4600, 4800, 5000, 5200, 5400, 5600, 5800, 6000, 6200, 6400, 6600, 6800, 7000, 7200, 7400, 7600, 7800, 8000, 8200, 8400, 8600, 8800, 9000, 9200, 9400, 9600, 9800]}, \"acquireActionRates\": [{\"name\": \"rate-0001\", \"mode\": \"big\", \"bigRates\": [\"1\", \"10\", \"100\", \"1000\", \"10000\", \"100000\", \"1000000\", \"10000000\", \"100000000\", \"1000000000\", \"10000000000\", \"100000000000\", \"1000000000000\", \"10000000000000\", \"100000000000000\", \"1000000000000000\", \"10000000000000000\", \"100000000000000000\", \"1000000000000000000\", \"10000000000000000000\", \"100000000000000000000\", \"1000000000000000000000\", \"10000000000000000000000\", \"100000000000000000000000\", \"1000000000000000000000000\", \"10000000000000000000000000\", \"100000000000000000000000000\"]}]}, {\"name\": \"skill\", \"metadata\": \"SKILL\", \"defaultExperience\": 0, \"defaultRankCap\": 10, \"maxRankCap\": 20, \"rankThreshold\": {\"metadata\": \"SKILL\", \"values\": [300, 600, 900, 1200, 1500, 1800, 2100, 2400, 2700, 3000, 3300, 3600, 3900, 4200, 4500, 4800, 5100, 5400, 5700]}}]}")
);
CurrentExperienceMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.UpdateCurrentExperienceMasterRequest;
using Gs2.Gs2Experience.Result.UpdateCurrentExperienceMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.UpdateCurrentExperienceMasterResult> asyncResult = null;
yield return client.UpdateCurrentExperienceMaster(
new Gs2.Gs2Experience.Request.UpdateCurrentExperienceMasterRequest()
.WithNamespaceName("namespace1")
.WithSettings("{\"version\": \"2019-01-11\", \"experienceModels\": [{\"name\": \"character_ssr\", \"metadata\": \"SSR\", \"defaultExperience\": 0, \"defaultRankCap\": 50, \"maxRankCap\": 80, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_sr\", \"metadata\": \"SR\", \"defaultExperience\": 0, \"defaultRankCap\": 40, \"maxRankCap\": 70, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_r\", \"metadata\": \"R\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 60, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"equipment\", \"metadata\": \"EQUIPMENT\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 50, \"rankThreshold\": {\"metadata\": \"EQUIPMENT\", \"values\": [200, 400, 600, 800, 1000, 1200, 1400, 1600, 1800, 2000, 2200, 2400, 2600, 2800, 3000, 3200, 3400, 3600, 3800, 4000, 4200, 4400, 4600, 4800, 5000, 5200, 5400, 5600, 5800, 6000, 6200, 6400, 6600, 6800, 7000, 7200, 7400, 7600, 7800, 8000, 8200, 8400, 8600, 8800, 9000, 9200, 9400, 9600, 9800]}, \"acquireActionRates\": [{\"name\": \"rate-0001\", \"mode\": \"big\", \"bigRates\": [\"1\", \"10\", \"100\", \"1000\", \"10000\", \"100000\", \"1000000\", \"10000000\", \"100000000\", \"1000000000\", \"10000000000\", \"100000000000\", \"1000000000000\", \"10000000000000\", \"100000000000000\", \"1000000000000000\", \"10000000000000000\", \"100000000000000000\", \"1000000000000000000\", \"10000000000000000000\", \"100000000000000000000\", \"1000000000000000000000\", \"10000000000000000000000\", \"100000000000000000000000\", \"1000000000000000000000000\", \"10000000000000000000000000\", \"100000000000000000000000000\"]}]}, {\"name\": \"skill\", \"metadata\": \"SKILL\", \"defaultExperience\": 0, \"defaultRankCap\": 10, \"maxRankCap\": 20, \"rankThreshold\": {\"metadata\": \"SKILL\", \"values\": [300, 600, 900, 1200, 1500, 1800, 2100, 2400, 2700, 3000, 3300, 3600, 3900, 4200, 4500, 4800, 5100, 5400, 5700]}}]}"),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.updateCurrentExperienceMaster(
new Gs2Experience.UpdateCurrentExperienceMasterRequest()
.withNamespaceName("namespace1")
.withSettings("{\"version\": \"2019-01-11\", \"experienceModels\": [{\"name\": \"character_ssr\", \"metadata\": \"SSR\", \"defaultExperience\": 0, \"defaultRankCap\": 50, \"maxRankCap\": 80, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_sr\", \"metadata\": \"SR\", \"defaultExperience\": 0, \"defaultRankCap\": 40, \"maxRankCap\": 70, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"character_r\", \"metadata\": \"R\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 60, \"rankThreshold\": {\"metadata\": \"CHARACTER\", \"values\": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {\"name\": \"equipment\", \"metadata\": \"EQUIPMENT\", \"defaultExperience\": 0, \"defaultRankCap\": 30, \"maxRankCap\": 50, \"rankThreshold\": {\"metadata\": \"EQUIPMENT\", \"values\": [200, 400, 600, 800, 1000, 1200, 1400, 1600, 1800, 2000, 2200, 2400, 2600, 2800, 3000, 3200, 3400, 3600, 3800, 4000, 4200, 4400, 4600, 4800, 5000, 5200, 5400, 5600, 5800, 6000, 6200, 6400, 6600, 6800, 7000, 7200, 7400, 7600, 7800, 8000, 8200, 8400, 8600, 8800, 9000, 9200, 9400, 9600, 9800]}, \"acquireActionRates\": [{\"name\": \"rate-0001\", \"mode\": \"big\", \"bigRates\": [\"1\", \"10\", \"100\", \"1000\", \"10000\", \"100000\", \"1000000\", \"10000000\", \"100000000\", \"1000000000\", \"10000000000\", \"100000000000\", \"1000000000000\", \"10000000000000\", \"100000000000000\", \"1000000000000000\", \"10000000000000000\", \"100000000000000000\", \"1000000000000000000\", \"10000000000000000000\", \"100000000000000000000\", \"1000000000000000000000\", \"10000000000000000000000\", \"100000000000000000000000\", \"1000000000000000000000000\", \"10000000000000000000000000\", \"100000000000000000000000000\"]}]}, {\"name\": \"skill\", \"metadata\": \"SKILL\", \"defaultExperience\": 0, \"defaultRankCap\": 10, \"maxRankCap\": 20, \"rankThreshold\": {\"metadata\": \"SKILL\", \"values\": [300, 600, 900, 1200, 1500, 1800, 2100, 2400, 2700, 3000, 3300, 3600, 3900, 4200, 4500, 4800, 5100, 5400, 5700]}}]}")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.update_current_experience_master(
experience.UpdateCurrentExperienceMasterRequest()
.with_namespace_name(self.hash1)
.with_settings('{"version": "2019-01-11", "experienceModels": [{"name": "character_ssr", "metadata": "SSR", "defaultExperience": 0, "defaultRankCap": 50, "maxRankCap": 80, "rankThreshold": {"metadata": "CHARACTER", "values": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {"name": "character_sr", "metadata": "SR", "defaultExperience": 0, "defaultRankCap": 40, "maxRankCap": 70, "rankThreshold": {"metadata": "CHARACTER", "values": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {"name": "character_r", "metadata": "R", "defaultExperience": 0, "defaultRankCap": 30, "maxRankCap": 60, "rankThreshold": {"metadata": "CHARACTER", "values": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {"name": "equipment", "metadata": "EQUIPMENT", "defaultExperience": 0, "defaultRankCap": 30, "maxRankCap": 50, "rankThreshold": {"metadata": "EQUIPMENT", "values": [200, 400, 600, 800, 1000, 1200, 1400, 1600, 1800, 2000, 2200, 2400, 2600, 2800, 3000, 3200, 3400, 3600, 3800, 4000, 4200, 4400, 4600, 4800, 5000, 5200, 5400, 5600, 5800, 6000, 6200, 6400, 6600, 6800, 7000, 7200, 7400, 7600, 7800, 8000, 8200, 8400, 8600, 8800, 9000, 9200, 9400, 9600, 9800]}, "acquireActionRates": [{"name": "rate-0001", "mode": "big", "bigRates": ["1", "10", "100", "1000", "10000", "100000", "1000000", "10000000", "100000000", "1000000000", "10000000000", "100000000000", "1000000000000", "10000000000000", "100000000000000", "1000000000000000", "10000000000000000", "100000000000000000", "1000000000000000000", "10000000000000000000", "100000000000000000000", "1000000000000000000000", "10000000000000000000000", "100000000000000000000000", "1000000000000000000000000", "10000000000000000000000000", "100000000000000000000000000"]}]}, {"name": "skill", "metadata": "SKILL", "defaultExperience": 0, "defaultRankCap": 10, "maxRankCap": 20, "rankThreshold": {"metadata": "SKILL", "values": [300, 600, 900, 1200, 1500, 1800, 2100, 2400, 2700, 3000, 3300, 3600, 3900, 4200, 4500, 4800, 5100, 5400, 5700]}}]}')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.update_current_experience_master({
namespaceName='namespace1',
settings='{"version": "2019-01-11", "experienceModels": [{"name": "character_ssr", "metadata": "SSR", "defaultExperience": 0, "defaultRankCap": 50, "maxRankCap": 80, "rankThreshold": {"metadata": "CHARACTER", "values": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {"name": "character_sr", "metadata": "SR", "defaultExperience": 0, "defaultRankCap": 40, "maxRankCap": 70, "rankThreshold": {"metadata": "CHARACTER", "values": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {"name": "character_r", "metadata": "R", "defaultExperience": 0, "defaultRankCap": 30, "maxRankCap": 60, "rankThreshold": {"metadata": "CHARACTER", "values": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400, 2500, 2600, 2700, 2800, 2900, 3000, 3100, 3200, 3300, 3400, 3500, 3600, 3700, 3800, 3900, 4000, 4100, 4200, 4300, 4400, 4500, 4600, 4700, 4800, 4900, 5000, 5100, 5200, 5300, 5400, 5500, 5600, 5700, 5800, 5900, 6000, 6100, 6200, 6300, 6400, 6500, 6600, 6700, 6800, 6900, 7000, 7100, 7200, 7300, 7400, 7500, 7600, 7700, 7800, 7900]}}, {"name": "equipment", "metadata": "EQUIPMENT", "defaultExperience": 0, "defaultRankCap": 30, "maxRankCap": 50, "rankThreshold": {"metadata": "EQUIPMENT", "values": [200, 400, 600, 800, 1000, 1200, 1400, 1600, 1800, 2000, 2200, 2400, 2600, 2800, 3000, 3200, 3400, 3600, 3800, 4000, 4200, 4400, 4600, 4800, 5000, 5200, 5400, 5600, 5800, 6000, 6200, 6400, 6600, 6800, 7000, 7200, 7400, 7600, 7800, 8000, 8200, 8400, 8600, 8800, 9000, 9200, 9400, 9600, 9800]}, "acquireActionRates": [{"name": "rate-0001", "mode": "big", "bigRates": ["1", "10", "100", "1000", "10000", "100000", "1000000", "10000000", "100000000", "1000000000", "10000000000", "100000000000", "1000000000000", "10000000000000", "100000000000000", "1000000000000000", "10000000000000000", "100000000000000000", "1000000000000000000", "10000000000000000000", "100000000000000000000", "1000000000000000000000", "10000000000000000000000", "100000000000000000000000", "1000000000000000000000000", "10000000000000000000000000", "100000000000000000000000000"]}]}, {"name": "skill", "metadata": "SKILL", "defaultExperience": 0, "defaultRankCap": 10, "maxRankCap": 20, "rankThreshold": {"metadata": "SKILL", "values": [300, 600, 900, 1200, 1500, 1800, 2100, 2400, 2700, 3000, 3300, 3600, 3900, 4200, 4500, 4800, 5100, 5400, 5700]}}]}',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
updateCurrentExperienceMasterFromGitHub
Update the currently available experience settings
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
checkoutSetting | GitHubCheckoutSetting | ✓ | Setup to check out master data from GitHub |
Result
Type | Description | |
---|---|---|
item | CurrentExperienceMaster | Updated and currently available experience settings |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.UpdateCurrentExperienceMasterFromGitHub(
&experience.UpdateCurrentExperienceMasterFromGitHubRequest {
NamespaceName: pointy.String("namespace1"),
CheckoutSetting: {'apiKeyId': '$gitHubApiKey1.apiKeyId', 'repositoryName': 'gs2io/master-data', 'sourcePath': 'path/to/file.json', 'referenceType': 'branch', 'branchName': 'develop'},
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\UpdateCurrentExperienceMasterFromGitHubRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->updateCurrentExperienceMasterFromGitHub(
(new UpdateCurrentExperienceMasterFromGitHubRequest())
->withNamespaceName(self::namespace1)
->withCheckoutSetting({'apiKeyId': '$gitHubApiKey1.apiKeyId', 'repositoryName': 'gs2io/master-data', 'sourcePath': 'path/to/file.json', 'referenceType': 'branch', 'branchName': 'develop'})
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.UpdateCurrentExperienceMasterFromGitHubRequest;
import io.gs2.experience.result.UpdateCurrentExperienceMasterFromGitHubResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
UpdateCurrentExperienceMasterFromGitHubResult result = client.updateCurrentExperienceMasterFromGitHub(
new UpdateCurrentExperienceMasterFromGitHubRequest()
.withNamespaceName("namespace1")
.withCheckoutSetting({'apiKeyId': '$gitHubApiKey1.apiKeyId', 'repositoryName': 'gs2io/master-data', 'sourcePath': 'path/to/file.json', 'referenceType': 'branch', 'branchName': 'develop'})
);
CurrentExperienceMaster 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.UpdateCurrentExperienceMasterFromGitHubRequest;
using Gs2.Gs2Experience.Result.UpdateCurrentExperienceMasterFromGitHubResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.UpdateCurrentExperienceMasterFromGitHubResult> asyncResult = null;
yield return client.UpdateCurrentExperienceMasterFromGitHub(
new Gs2.Gs2Experience.Request.UpdateCurrentExperienceMasterFromGitHubRequest()
.WithNamespaceName("namespace1")
.WithCheckoutSetting({'apiKeyId': '$gitHubApiKey1.apiKeyId', 'repositoryName': 'gs2io/master-data', 'sourcePath': 'path/to/file.json', 'referenceType': 'branch', 'branchName': 'develop'}),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.updateCurrentExperienceMasterFromGitHub(
new Gs2Experience.UpdateCurrentExperienceMasterFromGitHubRequest()
.withNamespaceName("namespace1")
.withCheckoutSetting({'apiKeyId': '$gitHubApiKey1.apiKeyId', 'repositoryName': 'gs2io/master-data', 'sourcePath': 'path/to/file.json', 'referenceType': 'branch', 'branchName': 'develop'})
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.update_current_experience_master_from_git_hub(
experience.UpdateCurrentExperienceMasterFromGitHubRequest()
.with_namespace_name(self.hash1)
.with_checkout_setting({'apiKeyId': '$gitHubApiKey1.apiKeyId', 'repositoryName': 'gs2io/master-data', 'sourcePath': 'path/to/file.json', 'referenceType': 'branch', 'branchName': 'develop'})
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.update_current_experience_master_from_git_hub({
namespaceName='namespace1',
checkoutSetting={'apiKeyId': '$gitHubApiKey1.apiKeyId', 'repositoryName': 'gs2io/master-data', 'sourcePath': 'path/to/file.json', 'referenceType': 'branch', 'branchName': 'develop'},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
describeStatuses
Get list of statuses
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
experienceName | string | ~ 128 chars | Experience Model Name | |||
accessToken | string | ✓ | ~ 128 chars | User Id | ||
pageToken | string | ~ 1024 chars | Token specifying the position from which to start acquiring data | |||
limit | int | ✓ | 30 | 1 ~ 1000 | Number of data acquired |
Result
Type | Description | |
---|---|---|
items | List<Status> | List of Status |
nextPageToken | string | Page token to retrieve the rest of the listing |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DescribeStatuses(
&experience.DescribeStatusesRequest {
NamespaceName: pointy.String("namespace1"),
ExperienceName: pointy.String("character_ssr"),
AccessToken: pointy.String("$access_token_0001"),
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DescribeStatusesRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeStatuses(
(new DescribeStatusesRequest())
->withNamespaceName(self::namespace1)
->withExperienceName("character_ssr")
->withAccessToken(self::$accessToken0001)
->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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DescribeStatusesRequest;
import io.gs2.experience.result.DescribeStatusesResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DescribeStatusesResult result = client.describeStatuses(
new DescribeStatusesRequest()
.withNamespaceName("namespace1")
.withExperienceName("character_ssr")
.withAccessToken("$access_token_0001")
.withPageToken(null)
.withLimit(null)
);
List<Status> 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DescribeStatusesRequest;
using Gs2.Gs2Experience.Result.DescribeStatusesResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DescribeStatusesResult> asyncResult = null;
yield return client.DescribeStatuses(
new Gs2.Gs2Experience.Request.DescribeStatusesRequest()
.WithNamespaceName("namespace1")
.WithExperienceName("character_ssr")
.WithAccessToken("$access_token_0001")
.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.describeStatuses(
new Gs2Experience.DescribeStatusesRequest()
.withNamespaceName("namespace1")
.withExperienceName("character_ssr")
.withAccessToken("$access_token_0001")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.describe_statuses(
experience.DescribeStatusesRequest()
.with_namespace_name(self.hash1)
.with_experience_name('character_ssr')
.with_access_token(self.access_token_0001)
.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('experience')
api_result = client.describe_statuses({
namespaceName='namespace1',
experienceName='character_ssr',
accessToken='$access_token_0001',
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;
describeStatusesByUserId
Get list of statuses by user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
experienceName | string | ~ 128 chars | Experience Model Name | |||
userId | string | ✓ | ~ 128 chars | User Id | ||
pageToken | string | ~ 1024 chars | Token specifying the position from which to start acquiring data | |||
limit | int | ✓ | 30 | 1 ~ 1000 | Number of data acquired |
Result
Type | Description | |
---|---|---|
items | List<Status> | List of Status |
nextPageToken | string | Page token to retrieve the rest of the listing |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DescribeStatusesByUserId(
&experience.DescribeStatusesByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
ExperienceName: pointy.String("character_ssr"),
UserId: pointy.String("user-0001"),
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DescribeStatusesByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeStatusesByUserId(
(new DescribeStatusesByUserIdRequest())
->withNamespaceName(self::namespace1)
->withExperienceName("character_ssr")
->withUserId("user-0001")
->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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DescribeStatusesByUserIdRequest;
import io.gs2.experience.result.DescribeStatusesByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DescribeStatusesByUserIdResult result = client.describeStatusesByUserId(
new DescribeStatusesByUserIdRequest()
.withNamespaceName("namespace1")
.withExperienceName("character_ssr")
.withUserId("user-0001")
.withPageToken(null)
.withLimit(null)
);
List<Status> 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DescribeStatusesByUserIdRequest;
using Gs2.Gs2Experience.Result.DescribeStatusesByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DescribeStatusesByUserIdResult> asyncResult = null;
yield return client.DescribeStatusesByUserId(
new Gs2.Gs2Experience.Request.DescribeStatusesByUserIdRequest()
.WithNamespaceName("namespace1")
.WithExperienceName("character_ssr")
.WithUserId("user-0001")
.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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.describeStatusesByUserId(
new Gs2Experience.DescribeStatusesByUserIdRequest()
.withNamespaceName("namespace1")
.withExperienceName("character_ssr")
.withUserId("user-0001")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.describe_statuses_by_user_id(
experience.DescribeStatusesByUserIdRequest()
.with_namespace_name(self.hash1)
.with_experience_name('character_ssr')
.with_user_id('user-0001')
.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('experience')
api_result = client.describe_statuses_by_user_id({
namespaceName='namespace1',
experienceName='character_ssr',
userId='user-0001',
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;
getStatus
Get Status
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
accessToken | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID |
Result
Type | Description | |
---|---|---|
item | Status | Status |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetStatus(
&experience.GetStatusRequest {
NamespaceName: pointy.String("namespace1"),
AccessToken: pointy.String("$access_token_0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\GetStatusRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getStatus(
(new GetStatusRequest())
->withNamespaceName(self::namespace1)
->withAccessToken(self::$accessToken0001)
->withExperienceName("character_ssr")
->withPropertyId("property-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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetStatusRequest;
import io.gs2.experience.result.GetStatusResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
GetStatusResult result = client.getStatus(
new GetStatusRequest()
.withNamespaceName("namespace1")
.withAccessToken("$access_token_0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetStatusRequest;
using Gs2.Gs2Experience.Result.GetStatusResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetStatusResult> asyncResult = null;
yield return client.GetStatus(
new Gs2.Gs2Experience.Request.GetStatusRequest()
.WithNamespaceName("namespace1")
.WithAccessToken("$access_token_0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getStatus(
new Gs2Experience.GetStatusRequest()
.withNamespaceName("namespace1")
.withAccessToken("$access_token_0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_status(
experience.GetStatusRequest()
.with_namespace_name(self.hash1)
.with_access_token(self.access_token_0001)
.with_experience_name('character_ssr')
.with_property_id('property-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.get_status({
namespaceName='namespace1',
accessToken='$access_token_0001',
experienceName='character_ssr',
propertyId='property-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getStatusByUserId
Get status by specifying user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID |
Result
Type | Description | |
---|---|---|
item | Status | Status |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetStatusByUserId(
&experience.GetStatusByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\GetStatusByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getStatusByUserId(
(new GetStatusByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetStatusByUserIdRequest;
import io.gs2.experience.result.GetStatusByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
GetStatusByUserIdResult result = client.getStatusByUserId(
new GetStatusByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetStatusByUserIdRequest;
using Gs2.Gs2Experience.Result.GetStatusByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetStatusByUserIdResult> asyncResult = null;
yield return client.GetStatusByUserId(
new Gs2.Gs2Experience.Request.GetStatusByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getStatusByUserId(
new Gs2Experience.GetStatusByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_status_by_user_id(
experience.GetStatusByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.get_status_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getStatusWithSignature
Get status along with signature
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
accessToken | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
item | Status | Status |
body | string | Object to be verified |
signature | string | signature |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetStatusWithSignature(
&experience.GetStatusWithSignatureRequest {
NamespaceName: pointy.String("namespace1"),
AccessToken: pointy.String("$access_token_0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
body := result.Body
signature := result.Signature
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\GetStatusWithSignatureRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getStatusWithSignature(
(new GetStatusWithSignatureRequest())
->withNamespaceName(self::namespace1)
->withAccessToken(self::$accessToken0001)
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withKeyId(self::$key1.keyId)
);
$item = $result->getItem();
$body = $result->getBody();
$signature = $result->getSignature();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetStatusWithSignatureRequest;
import io.gs2.experience.result.GetStatusWithSignatureResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
GetStatusWithSignatureResult result = client.getStatusWithSignature(
new GetStatusWithSignatureRequest()
.withNamespaceName("namespace1")
.withAccessToken("$access_token_0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withKeyId("$key1.keyId")
);
Status item = result.getItem();
String body = result.getBody();
String signature = result.getSignature();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetStatusWithSignatureRequest;
using Gs2.Gs2Experience.Result.GetStatusWithSignatureResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetStatusWithSignatureResult> asyncResult = null;
yield return client.GetStatusWithSignature(
new Gs2.Gs2Experience.Request.GetStatusWithSignatureRequest()
.WithNamespaceName("namespace1")
.WithAccessToken("$access_token_0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
var body = result.Body;
var signature = result.Signature;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getStatusWithSignature(
new Gs2Experience.GetStatusWithSignatureRequest()
.withNamespaceName("namespace1")
.withAccessToken("$access_token_0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withKeyId("$key1.keyId")
);
const item = result.getItem();
const body = result.getBody();
const signature = result.getSignature();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_status_with_signature(
experience.GetStatusWithSignatureRequest()
.with_namespace_name(self.hash1)
.with_access_token(self.access_token_0001)
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_key_id(self.key1.key_id)
)
item = result.item
body = result.body
signature = result.signature
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.get_status_with_signature({
namespaceName='namespace1',
accessToken='$access_token_0001',
experienceName='character_ssr',
propertyId='property-0001',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
body = result.body;
signature = result.signature;
getStatusWithSignatureByUserId
Get status with signature by specifying user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
item | Status | Status |
body | string | Object to be verified |
signature | string | signature |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.GetStatusWithSignatureByUserId(
&experience.GetStatusWithSignatureByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
body := result.Body
signature := result.Signature
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\GetStatusWithSignatureByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getStatusWithSignatureByUserId(
(new GetStatusWithSignatureByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withKeyId(self::$key1.keyId)
);
$item = $result->getItem();
$body = $result->getBody();
$signature = $result->getSignature();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.GetStatusWithSignatureByUserIdRequest;
import io.gs2.experience.result.GetStatusWithSignatureByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
GetStatusWithSignatureByUserIdResult result = client.getStatusWithSignatureByUserId(
new GetStatusWithSignatureByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withKeyId("$key1.keyId")
);
Status item = result.getItem();
String body = result.getBody();
String signature = result.getSignature();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.GetStatusWithSignatureByUserIdRequest;
using Gs2.Gs2Experience.Result.GetStatusWithSignatureByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.GetStatusWithSignatureByUserIdResult> asyncResult = null;
yield return client.GetStatusWithSignatureByUserId(
new Gs2.Gs2Experience.Request.GetStatusWithSignatureByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
var body = result.Body;
var signature = result.Signature;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.getStatusWithSignatureByUserId(
new Gs2Experience.GetStatusWithSignatureByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withKeyId("$key1.keyId")
);
const item = result.getItem();
const body = result.getBody();
const signature = result.getSignature();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.get_status_with_signature_by_user_id(
experience.GetStatusWithSignatureByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_key_id(self.key1.key_id)
)
item = result.item
body = result.body
signature = result.signature
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.get_status_with_signature_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
body = result.body;
signature = result.signature;
addExperienceByUserId
Add experience
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
experienceValue | long | ✓ | 0 | ~ 9223372036854775805 | Gained Experience |
Result
Type | Description | |
---|---|---|
item | Status | Status after addition |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.AddExperienceByUserId(
&experience.AddExperienceByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
ExperienceValue: pointy.Int64(10),
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\AddExperienceByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->addExperienceByUserId(
(new AddExperienceByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withExperienceValue(10)
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.AddExperienceByUserIdRequest;
import io.gs2.experience.result.AddExperienceByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
AddExperienceByUserIdResult result = client.addExperienceByUserId(
new AddExperienceByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withExperienceValue(10L)
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.AddExperienceByUserIdRequest;
using Gs2.Gs2Experience.Result.AddExperienceByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.AddExperienceByUserIdResult> asyncResult = null;
yield return client.AddExperienceByUserId(
new Gs2.Gs2Experience.Request.AddExperienceByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithExperienceValue(10L),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.addExperienceByUserId(
new Gs2Experience.AddExperienceByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withExperienceValue(10)
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.add_experience_by_user_id(
experience.AddExperienceByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_experience_value(10)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.add_experience_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
experienceValue=10,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
subExperienceByUserId
Sub experience
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
experienceValue | long | ✓ | 0 | ~ 9223372036854775805 | Lost Experience |
Result
Type | Description | |
---|---|---|
item | Status | Status after subtraction |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.SubExperienceByUserId(
&experience.SubExperienceByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
ExperienceValue: pointy.Int64(10),
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\SubExperienceByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->subExperienceByUserId(
(new SubExperienceByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withExperienceValue(10)
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.SubExperienceByUserIdRequest;
import io.gs2.experience.result.SubExperienceByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
SubExperienceByUserIdResult result = client.subExperienceByUserId(
new SubExperienceByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withExperienceValue(10L)
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.SubExperienceByUserIdRequest;
using Gs2.Gs2Experience.Result.SubExperienceByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.SubExperienceByUserIdResult> asyncResult = null;
yield return client.SubExperienceByUserId(
new Gs2.Gs2Experience.Request.SubExperienceByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithExperienceValue(10L),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.subExperienceByUserId(
new Gs2Experience.SubExperienceByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withExperienceValue(10)
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.sub_experience_by_user_id(
experience.SubExperienceByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_experience_value(10)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.sub_experience_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
experienceValue=10,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
setExperienceByUserId
Set cumulative experience gained
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
experienceValue | long | ✓ | 0 | ~ 9223372036854775805 | Cumulative experience gained |
Result
Type | Description | |
---|---|---|
item | Status | Updated Status |
old | Status | Status before update |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.SetExperienceByUserId(
&experience.SetExperienceByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
ExperienceValue: pointy.Int64(100),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
old := result.Old
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\SetExperienceByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->setExperienceByUserId(
(new SetExperienceByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withExperienceValue(100)
);
$item = $result->getItem();
$old = $result->getOld();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.SetExperienceByUserIdRequest;
import io.gs2.experience.result.SetExperienceByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
SetExperienceByUserIdResult result = client.setExperienceByUserId(
new SetExperienceByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withExperienceValue(100L)
);
Status item = result.getItem();
Status old = result.getOld();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.SetExperienceByUserIdRequest;
using Gs2.Gs2Experience.Result.SetExperienceByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.SetExperienceByUserIdResult> asyncResult = null;
yield return client.SetExperienceByUserId(
new Gs2.Gs2Experience.Request.SetExperienceByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithExperienceValue(100L),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
var old = result.Old;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.setExperienceByUserId(
new Gs2Experience.SetExperienceByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withExperienceValue(100)
);
const item = result.getItem();
const old = result.getOld();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.set_experience_by_user_id(
experience.SetExperienceByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_experience_value(100)
)
item = result.item
old = result.old
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.set_experience_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
experienceValue=100,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
old = result.old;
addRankCapByUserId
Add rank cap
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
rankCapValue | long | ✓ | ~ 9223372036854775805 | Current Rank Cap |
Result
Type | Description | |
---|---|---|
item | Status | Status after addition |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.AddRankCapByUserId(
&experience.AddRankCapByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
RankCapValue: pointy.Int64(30),
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\AddRankCapByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->addRankCapByUserId(
(new AddRankCapByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withRankCapValue(30)
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.AddRankCapByUserIdRequest;
import io.gs2.experience.result.AddRankCapByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
AddRankCapByUserIdResult result = client.addRankCapByUserId(
new AddRankCapByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withRankCapValue(30L)
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.AddRankCapByUserIdRequest;
using Gs2.Gs2Experience.Result.AddRankCapByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.AddRankCapByUserIdResult> asyncResult = null;
yield return client.AddRankCapByUserId(
new Gs2.Gs2Experience.Request.AddRankCapByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithRankCapValue(30L),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.addRankCapByUserId(
new Gs2Experience.AddRankCapByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withRankCapValue(30)
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.add_rank_cap_by_user_id(
experience.AddRankCapByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_rank_cap_value(30)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.add_rank_cap_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
rankCapValue=30,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
subRankCapByUserId
Sub rank cap
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
rankCapValue | long | ✓ | ~ 9223372036854775805 | Current Rank Cap |
Result
Type | Description | |
---|---|---|
item | Status | Status after subtraction |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.SubRankCapByUserId(
&experience.SubRankCapByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
RankCapValue: pointy.Int64(30),
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\SubRankCapByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->subRankCapByUserId(
(new SubRankCapByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withRankCapValue(30)
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.SubRankCapByUserIdRequest;
import io.gs2.experience.result.SubRankCapByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
SubRankCapByUserIdResult result = client.subRankCapByUserId(
new SubRankCapByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withRankCapValue(30L)
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.SubRankCapByUserIdRequest;
using Gs2.Gs2Experience.Result.SubRankCapByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.SubRankCapByUserIdResult> asyncResult = null;
yield return client.SubRankCapByUserId(
new Gs2.Gs2Experience.Request.SubRankCapByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithRankCapValue(30L),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.subRankCapByUserId(
new Gs2Experience.SubRankCapByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withRankCapValue(30)
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.sub_rank_cap_by_user_id(
experience.SubRankCapByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_rank_cap_value(30)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.sub_rank_cap_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
rankCapValue=30,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
setRankCapByUserId
Set rank cap
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
rankCapValue | long | ✓ | ~ 9223372036854775805 | Current Rank Cap |
Result
Type | Description | |
---|---|---|
item | Status | Updated Status |
old | Status | Status before update |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.SetRankCapByUserId(
&experience.SetRankCapByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
RankCapValue: pointy.Int64(30),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
old := result.Old
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\SetRankCapByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->setRankCapByUserId(
(new SetRankCapByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withRankCapValue(30)
);
$item = $result->getItem();
$old = $result->getOld();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.SetRankCapByUserIdRequest;
import io.gs2.experience.result.SetRankCapByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
SetRankCapByUserIdResult result = client.setRankCapByUserId(
new SetRankCapByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withRankCapValue(30L)
);
Status item = result.getItem();
Status old = result.getOld();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.SetRankCapByUserIdRequest;
using Gs2.Gs2Experience.Result.SetRankCapByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.SetRankCapByUserIdResult> asyncResult = null;
yield return client.SetRankCapByUserId(
new Gs2.Gs2Experience.Request.SetRankCapByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithRankCapValue(30L),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
var old = result.Old;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.setRankCapByUserId(
new Gs2Experience.SetRankCapByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withRankCapValue(30)
);
const item = result.getItem();
const old = result.getOld();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.set_rank_cap_by_user_id(
experience.SetRankCapByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_rank_cap_value(30)
)
item = result.item
old = result.old
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.set_rank_cap_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
rankCapValue=30,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
old = result.old;
deleteStatusByUserId
Delete status
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID |
Result
Type | Description | |
---|---|---|
item | Status | Deleted Status |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.DeleteStatusByUserId(
&experience.DeleteStatusByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\DeleteStatusByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->deleteStatusByUserId(
(new DeleteStatusByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.DeleteStatusByUserIdRequest;
import io.gs2.experience.result.DeleteStatusByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
DeleteStatusByUserIdResult result = client.deleteStatusByUserId(
new DeleteStatusByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.DeleteStatusByUserIdRequest;
using Gs2.Gs2Experience.Result.DeleteStatusByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.DeleteStatusByUserIdResult> asyncResult = null;
yield return client.DeleteStatusByUserId(
new Gs2.Gs2Experience.Request.DeleteStatusByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.deleteStatusByUserId(
new Gs2Experience.DeleteStatusByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.delete_status_by_user_id(
experience.DeleteStatusByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.delete_status_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
verifyRank
Verify rank
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
accessToken | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
verifyType | enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’] | ✓ | ~ 128 chars | Type of verification | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
rankValue | long | ✓ | 0 | ~ 9223372036854775805 | Current Rank |
Result
Type | Description |
---|
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.VerifyRank(
&experience.VerifyRankRequest {
NamespaceName: pointy.String("namespace2"),
AccessToken: pointy.String("$access_token_0001"),
ExperienceName: pointy.String("character_ssr"),
VerifyType: pointy.String("less"),
PropertyId: pointy.String("property-0001"),
RankValue: nil,
}
)
if err != nil {
panic("error occurred")
}
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\VerifyRankRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->verifyRank(
(new VerifyRankRequest())
->withNamespaceName(self::namespace2)
->withAccessToken(self::$accessToken0001)
->withExperienceName("character_ssr")
->withVerifyType("less")
->withPropertyId("property-0001")
->withRankValue(null)
);
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.VerifyRankRequest;
import io.gs2.experience.result.VerifyRankResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
VerifyRankResult result = client.verifyRank(
new VerifyRankRequest()
.withNamespaceName("namespace2")
.withAccessToken("$access_token_0001")
.withExperienceName("character_ssr")
.withVerifyType("less")
.withPropertyId("property-0001")
.withRankValue(null)
);
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.VerifyRankRequest;
using Gs2.Gs2Experience.Result.VerifyRankResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.VerifyRankResult> asyncResult = null;
yield return client.VerifyRank(
new Gs2.Gs2Experience.Request.VerifyRankRequest()
.WithNamespaceName("namespace2")
.WithAccessToken("$access_token_0001")
.WithExperienceName("character_ssr")
.WithVerifyType("less")
.WithPropertyId("property-0001")
.WithRankValue(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.verifyRank(
new Gs2Experience.VerifyRankRequest()
.withNamespaceName("namespace2")
.withAccessToken("$access_token_0001")
.withExperienceName("character_ssr")
.withVerifyType("less")
.withPropertyId("property-0001")
.withRankValue(null)
);
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.verify_rank(
experience.VerifyRankRequest()
.with_namespace_name(self.hash2)
.with_access_token(self.access_token_0001)
.with_experience_name('character_ssr')
.with_verify_type('less')
.with_property_id('property-0001')
.with_rank_value(None)
)
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.verify_rank({
namespaceName='namespace2',
accessToken='$access_token_0001',
experienceName='character_ssr',
verifyType='less',
propertyId='property-0001',
rankValue=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
verifyRankByUserId
Verify rank by user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
verifyType | enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’] | ✓ | ~ 128 chars | Type of verification | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
rankValue | long | ✓ | 0 | ~ 9223372036854775805 | Current Rank |
Result
Type | Description |
---|
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.VerifyRankByUserId(
&experience.VerifyRankByUserIdRequest {
NamespaceName: pointy.String("namespace2"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
VerifyType: pointy.String("less"),
PropertyId: pointy.String("property-0001"),
RankValue: nil,
}
)
if err != nil {
panic("error occurred")
}
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\VerifyRankByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->verifyRankByUserId(
(new VerifyRankByUserIdRequest())
->withNamespaceName(self::namespace2)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withVerifyType("less")
->withPropertyId("property-0001")
->withRankValue(null)
);
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.VerifyRankByUserIdRequest;
import io.gs2.experience.result.VerifyRankByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
VerifyRankByUserIdResult result = client.verifyRankByUserId(
new VerifyRankByUserIdRequest()
.withNamespaceName("namespace2")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withVerifyType("less")
.withPropertyId("property-0001")
.withRankValue(null)
);
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.VerifyRankByUserIdRequest;
using Gs2.Gs2Experience.Result.VerifyRankByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.VerifyRankByUserIdResult> asyncResult = null;
yield return client.VerifyRankByUserId(
new Gs2.Gs2Experience.Request.VerifyRankByUserIdRequest()
.WithNamespaceName("namespace2")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithVerifyType("less")
.WithPropertyId("property-0001")
.WithRankValue(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.verifyRankByUserId(
new Gs2Experience.VerifyRankByUserIdRequest()
.withNamespaceName("namespace2")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withVerifyType("less")
.withPropertyId("property-0001")
.withRankValue(null)
);
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.verify_rank_by_user_id(
experience.VerifyRankByUserIdRequest()
.with_namespace_name(self.hash2)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_verify_type('less')
.with_property_id('property-0001')
.with_rank_value(None)
)
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.verify_rank_by_user_id({
namespaceName='namespace2',
userId='user-0001',
experienceName='character_ssr',
verifyType='less',
propertyId='property-0001',
rankValue=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
verifyRankCap
Verify rank cap
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
accessToken | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
verifyType | enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’] | ✓ | ~ 128 chars | Type of verification | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
rankCapValue | long | ✓ | ~ 9223372036854775805 | Current Rank Cap |
Result
Type | Description |
---|
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.VerifyRankCap(
&experience.VerifyRankCapRequest {
NamespaceName: pointy.String("namespace2"),
AccessToken: pointy.String("$access_token_0001"),
ExperienceName: pointy.String("character_ssr"),
VerifyType: pointy.String("less"),
PropertyId: pointy.String("property-0001"),
RankCapValue: pointy.Int64(10),
}
)
if err != nil {
panic("error occurred")
}
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\VerifyRankCapRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->verifyRankCap(
(new VerifyRankCapRequest())
->withNamespaceName(self::namespace2)
->withAccessToken(self::$accessToken0001)
->withExperienceName("character_ssr")
->withVerifyType("less")
->withPropertyId("property-0001")
->withRankCapValue(10)
);
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.VerifyRankCapRequest;
import io.gs2.experience.result.VerifyRankCapResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
VerifyRankCapResult result = client.verifyRankCap(
new VerifyRankCapRequest()
.withNamespaceName("namespace2")
.withAccessToken("$access_token_0001")
.withExperienceName("character_ssr")
.withVerifyType("less")
.withPropertyId("property-0001")
.withRankCapValue(10L)
);
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.VerifyRankCapRequest;
using Gs2.Gs2Experience.Result.VerifyRankCapResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.VerifyRankCapResult> asyncResult = null;
yield return client.VerifyRankCap(
new Gs2.Gs2Experience.Request.VerifyRankCapRequest()
.WithNamespaceName("namespace2")
.WithAccessToken("$access_token_0001")
.WithExperienceName("character_ssr")
.WithVerifyType("less")
.WithPropertyId("property-0001")
.WithRankCapValue(10L),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.verifyRankCap(
new Gs2Experience.VerifyRankCapRequest()
.withNamespaceName("namespace2")
.withAccessToken("$access_token_0001")
.withExperienceName("character_ssr")
.withVerifyType("less")
.withPropertyId("property-0001")
.withRankCapValue(10)
);
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.verify_rank_cap(
experience.VerifyRankCapRequest()
.with_namespace_name(self.hash2)
.with_access_token(self.access_token_0001)
.with_experience_name('character_ssr')
.with_verify_type('less')
.with_property_id('property-0001')
.with_rank_cap_value(10)
)
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.verify_rank_cap({
namespaceName='namespace2',
accessToken='$access_token_0001',
experienceName='character_ssr',
verifyType='less',
propertyId='property-0001',
rankCapValue=10,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
verifyRankCapByUserId
Verify rank cap by user ID
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
verifyType | enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’] | ✓ | ~ 128 chars | Type of verification | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
rankCapValue | long | ✓ | ~ 9223372036854775805 | Current Rank Cap |
Result
Type | Description |
---|
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.VerifyRankCapByUserId(
&experience.VerifyRankCapByUserIdRequest {
NamespaceName: pointy.String("namespace2"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
VerifyType: pointy.String("less"),
PropertyId: pointy.String("property-0001"),
RankCapValue: pointy.Int64(10),
}
)
if err != nil {
panic("error occurred")
}
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\VerifyRankCapByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->verifyRankCapByUserId(
(new VerifyRankCapByUserIdRequest())
->withNamespaceName(self::namespace2)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withVerifyType("less")
->withPropertyId("property-0001")
->withRankCapValue(10)
);
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.VerifyRankCapByUserIdRequest;
import io.gs2.experience.result.VerifyRankCapByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
VerifyRankCapByUserIdResult result = client.verifyRankCapByUserId(
new VerifyRankCapByUserIdRequest()
.withNamespaceName("namespace2")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withVerifyType("less")
.withPropertyId("property-0001")
.withRankCapValue(10L)
);
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.VerifyRankCapByUserIdRequest;
using Gs2.Gs2Experience.Result.VerifyRankCapByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.VerifyRankCapByUserIdResult> asyncResult = null;
yield return client.VerifyRankCapByUserId(
new Gs2.Gs2Experience.Request.VerifyRankCapByUserIdRequest()
.WithNamespaceName("namespace2")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithVerifyType("less")
.WithPropertyId("property-0001")
.WithRankCapValue(10L),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.verifyRankCapByUserId(
new Gs2Experience.VerifyRankCapByUserIdRequest()
.withNamespaceName("namespace2")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withVerifyType("less")
.withPropertyId("property-0001")
.withRankCapValue(10)
);
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.verify_rank_cap_by_user_id(
experience.VerifyRankCapByUserIdRequest()
.with_namespace_name(self.hash2)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_verify_type('less')
.with_property_id('property-0001')
.with_rank_cap_value(10)
)
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.verify_rank_cap_by_user_id({
namespaceName='namespace2',
userId='user-0001',
experienceName='character_ssr',
verifyType='less',
propertyId='property-0001',
rankCapValue=10,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
addExperienceByStampSheet
Use stamp sheets to add experience
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
stampSheet | string | ✓ | ~ 5242880 chars | Stamp sheet | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
item | Status | Status after addition |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.AddExperienceByStampSheet(
&experience.AddExperienceByStampSheetRequest {
StampSheet: pointy.String("$stampSheet"),
KeyId: pointy.String("$key1.keyId"),
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\AddExperienceByStampSheetRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->addExperienceByStampSheet(
(new AddExperienceByStampSheetRequest())
->withStampSheet(self::$stampSheet)
->withKeyId(self::$key1.keyId)
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.AddExperienceByStampSheetRequest;
import io.gs2.experience.result.AddExperienceByStampSheetResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
AddExperienceByStampSheetResult result = client.addExperienceByStampSheet(
new AddExperienceByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.AddExperienceByStampSheetRequest;
using Gs2.Gs2Experience.Result.AddExperienceByStampSheetResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.AddExperienceByStampSheetResult> asyncResult = null;
yield return client.AddExperienceByStampSheet(
new Gs2.Gs2Experience.Request.AddExperienceByStampSheetRequest()
.WithStampSheet("$stampSheet")
.WithKeyId("$key1.keyId"),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.addExperienceByStampSheet(
new Gs2Experience.AddExperienceByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.add_experience_by_stamp_sheet(
experience.AddExperienceByStampSheetRequest()
.with_stamp_sheet(self.stamp_sheet)
.with_key_id(self.key1.key_id)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.add_experience_by_stamp_sheet({
stampSheet='$stampSheet',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
subExperienceByStampTask
Use stamp sheets to sub experience
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
stampTask | string | ✓ | ~ 5242880 chars | Stamp task | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
item | Status | Status after subtraction |
newContextStack | string | Request of context in which stamp task execution results are recorded |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.SubExperienceByStampTask(
&experience.SubExperienceByStampTaskRequest {
StampTask: pointy.String("$stampTask"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
newContextStack := result.NewContextStack
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\SubExperienceByStampTaskRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->subExperienceByStampTask(
(new SubExperienceByStampTaskRequest())
->withStampTask(self::$stampTask)
->withKeyId(self::$key1.keyId)
);
$item = $result->getItem();
$newContextStack = $result->getNewContextStack();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.SubExperienceByStampTaskRequest;
import io.gs2.experience.result.SubExperienceByStampTaskResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
SubExperienceByStampTaskResult result = client.subExperienceByStampTask(
new SubExperienceByStampTaskRequest()
.withStampTask("$stampTask")
.withKeyId("$key1.keyId")
);
Status item = result.getItem();
String newContextStack = result.getNewContextStack();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.SubExperienceByStampTaskRequest;
using Gs2.Gs2Experience.Result.SubExperienceByStampTaskResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.SubExperienceByStampTaskResult> asyncResult = null;
yield return client.SubExperienceByStampTask(
new Gs2.Gs2Experience.Request.SubExperienceByStampTaskRequest()
.WithStampTask("$stampTask")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
var newContextStack = result.NewContextStack;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.subExperienceByStampTask(
new Gs2Experience.SubExperienceByStampTaskRequest()
.withStampTask("$stampTask")
.withKeyId("$key1.keyId")
);
const item = result.getItem();
const newContextStack = result.getNewContextStack();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.sub_experience_by_stamp_task(
experience.SubExperienceByStampTaskRequest()
.with_stamp_task(self.stamp_task)
.with_key_id(self.key1.key_id)
)
item = result.item
new_context_stack = result.new_context_stack
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.sub_experience_by_stamp_task({
stampTask='$stampTask',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
newContextStack = result.newContextStack;
addRankCapByStampSheet
Use stamp sheet to add rank cap
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
stampSheet | string | ✓ | ~ 5242880 chars | Stamp sheet | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
item | Status | Status after addition |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.AddRankCapByStampSheet(
&experience.AddRankCapByStampSheetRequest {
StampSheet: pointy.String("$stampSheet"),
KeyId: pointy.String("$key1.keyId"),
}
)
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\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\AddRankCapByStampSheetRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->addRankCapByStampSheet(
(new AddRankCapByStampSheetRequest())
->withStampSheet(self::$stampSheet)
->withKeyId(self::$key1.keyId)
);
$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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.AddRankCapByStampSheetRequest;
import io.gs2.experience.result.AddRankCapByStampSheetResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
AddRankCapByStampSheetResult result = client.addRankCapByStampSheet(
new AddRankCapByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
Status 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.AddRankCapByStampSheetRequest;
using Gs2.Gs2Experience.Result.AddRankCapByStampSheetResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.AddRankCapByStampSheetResult> asyncResult = null;
yield return client.AddRankCapByStampSheet(
new Gs2.Gs2Experience.Request.AddRankCapByStampSheetRequest()
.WithStampSheet("$stampSheet")
.WithKeyId("$key1.keyId"),
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 Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.addRankCapByStampSheet(
new Gs2Experience.AddRankCapByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.add_rank_cap_by_stamp_sheet(
experience.AddRankCapByStampSheetRequest()
.with_stamp_sheet(self.stamp_sheet)
.with_key_id(self.key1.key_id)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.add_rank_cap_by_stamp_sheet({
stampSheet='$stampSheet',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
subRankCapByStampTask
Use stamp task to sub rank cap
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
stampTask | string | ✓ | ~ 5242880 chars | Stamp task | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
item | Status | Status after subtraction |
newContextStack | string | Request of context in which stamp task execution results are recorded |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.SubRankCapByStampTask(
&experience.SubRankCapByStampTaskRequest {
StampTask: pointy.String("$stampTask"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
newContextStack := result.NewContextStack
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\SubRankCapByStampTaskRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->subRankCapByStampTask(
(new SubRankCapByStampTaskRequest())
->withStampTask(self::$stampTask)
->withKeyId(self::$key1.keyId)
);
$item = $result->getItem();
$newContextStack = $result->getNewContextStack();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.SubRankCapByStampTaskRequest;
import io.gs2.experience.result.SubRankCapByStampTaskResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
SubRankCapByStampTaskResult result = client.subRankCapByStampTask(
new SubRankCapByStampTaskRequest()
.withStampTask("$stampTask")
.withKeyId("$key1.keyId")
);
Status item = result.getItem();
String newContextStack = result.getNewContextStack();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.SubRankCapByStampTaskRequest;
using Gs2.Gs2Experience.Result.SubRankCapByStampTaskResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.SubRankCapByStampTaskResult> asyncResult = null;
yield return client.SubRankCapByStampTask(
new Gs2.Gs2Experience.Request.SubRankCapByStampTaskRequest()
.WithStampTask("$stampTask")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
var newContextStack = result.NewContextStack;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.subRankCapByStampTask(
new Gs2Experience.SubRankCapByStampTaskRequest()
.withStampTask("$stampTask")
.withKeyId("$key1.keyId")
);
const item = result.getItem();
const newContextStack = result.getNewContextStack();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.sub_rank_cap_by_stamp_task(
experience.SubRankCapByStampTaskRequest()
.with_stamp_task(self.stamp_task)
.with_key_id(self.key1.key_id)
)
item = result.item
new_context_stack = result.new_context_stack
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.sub_rank_cap_by_stamp_task({
stampTask='$stampTask',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
newContextStack = result.newContextStack;
setRankCapByStampSheet
Update rank caps with stamp sheets
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
stampSheet | string | ✓ | ~ 5242880 chars | Stamp sheet | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
item | Status | Status after update |
old | Status | Status before update |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.SetRankCapByStampSheet(
&experience.SetRankCapByStampSheetRequest {
StampSheet: pointy.String("$stampSheet"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
old := result.Old
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\SetRankCapByStampSheetRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->setRankCapByStampSheet(
(new SetRankCapByStampSheetRequest())
->withStampSheet(self::$stampSheet)
->withKeyId(self::$key1.keyId)
);
$item = $result->getItem();
$old = $result->getOld();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.SetRankCapByStampSheetRequest;
import io.gs2.experience.result.SetRankCapByStampSheetResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
SetRankCapByStampSheetResult result = client.setRankCapByStampSheet(
new SetRankCapByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
Status item = result.getItem();
Status old = result.getOld();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.SetRankCapByStampSheetRequest;
using Gs2.Gs2Experience.Result.SetRankCapByStampSheetResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.SetRankCapByStampSheetResult> asyncResult = null;
yield return client.SetRankCapByStampSheet(
new Gs2.Gs2Experience.Request.SetRankCapByStampSheetRequest()
.WithStampSheet("$stampSheet")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
var old = result.Old;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.setRankCapByStampSheet(
new Gs2Experience.SetRankCapByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
const item = result.getItem();
const old = result.getOld();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.set_rank_cap_by_stamp_sheet(
experience.SetRankCapByStampSheetRequest()
.with_stamp_sheet(self.stamp_sheet)
.with_key_id(self.key1.key_id)
)
item = result.item
old = result.old
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.set_rank_cap_by_stamp_sheet({
stampSheet='$stampSheet',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
old = result.old;
multiplyAcquireActionsByUserId
Add resources according to the rank of the property subject to the experience value
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | ||
userId | string | ✓ | ~ 128 chars | User Id | ||
experienceName | string | ✓ | ~ 128 chars | Experience Model Name | ||
propertyId | string | ✓ | ~ 1024 chars | Property ID | ||
rateName | string | ✓ | ~ 128 chars | Remuneration addition table name | ||
acquireActions | List<AcquireAction> | [] | ~ 100 items | List of Acquire Action |
Result
Type | Description | |
---|---|---|
items | List<AcquireAction> | Rewards |
transactionId | string | Transaction ID of the stamp sheet issued |
stampSheet | string | Stamp sheet |
stampSheetEncryptionKeyId | string | Cryptographic key GRN used for stamp sheet signature calculations |
autoRunStampSheet | bool? | Is stamp sheet auto-execution enabled? |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.MultiplyAcquireActionsByUserId(
&experience.MultiplyAcquireActionsByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
ExperienceName: pointy.String("character_ssr"),
PropertyId: pointy.String("property-0001"),
RateName: pointy.String("rate-0001"),
AcquireActions: []experience.AcquireAction{
{'action': 'Gs2Experience:AddRankCapByUserId', 'request': '{"namespaceName": "namespace-0001", "experienceName": "character", "propertyId": "property-0001", "userId": "#{userId}", "rankCapValue": 1}'},
},
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
transactionId := result.TransactionId
stampSheet := result.StampSheet
stampSheetEncryptionKeyId := result.StampSheetEncryptionKeyId
autoRunStampSheet := result.AutoRunStampSheet
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\MultiplyAcquireActionsByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->multiplyAcquireActionsByUserId(
(new MultiplyAcquireActionsByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withExperienceName("character_ssr")
->withPropertyId("property-0001")
->withRateName("rate-0001")
->withAcquireActions([ {'action': 'Gs2Experience:AddRankCapByUserId', 'request': '{"namespaceName": "namespace-0001", "experienceName": "character", "propertyId": "property-0001", "userId": "#{userId}", "rankCapValue": 1}'},
])
);
$items = $result->getItems();
$transactionId = $result->getTransactionId();
$stampSheet = $result->getStampSheet();
$stampSheetEncryptionKeyId = $result->getStampSheetEncryptionKeyId();
$autoRunStampSheet = $result->getAutoRunStampSheet();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.MultiplyAcquireActionsByUserIdRequest;
import io.gs2.experience.result.MultiplyAcquireActionsByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
MultiplyAcquireActionsByUserIdResult result = client.multiplyAcquireActionsByUserId(
new MultiplyAcquireActionsByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withRateName("rate-0001")
.withAcquireActions(Arrays.asList(
{'action': 'Gs2Experience:AddRankCapByUserId', 'request': '{"namespaceName": "namespace-0001", "experienceName": "character", "propertyId": "property-0001", "userId": "#{userId}", "rankCapValue": 1}'}
))
);
List<AcquireAction> items = result.getItems();
String transactionId = result.getTransactionId();
String stampSheet = result.getStampSheet();
String stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId();
boolean autoRunStampSheet = result.getAutoRunStampSheet();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.MultiplyAcquireActionsByUserIdRequest;
using Gs2.Gs2Experience.Result.MultiplyAcquireActionsByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.MultiplyAcquireActionsByUserIdResult> asyncResult = null;
yield return client.MultiplyAcquireActionsByUserId(
new Gs2.Gs2Experience.Request.MultiplyAcquireActionsByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithExperienceName("character_ssr")
.WithPropertyId("property-0001")
.WithRateName("rate-0001")
.WithAcquireActions(new Gs2.Core.Model.AcquireAction[] {
{'action': 'Gs2Experience:AddRankCapByUserId', 'request': '{"namespaceName": "namespace-0001", "experienceName": "character", "propertyId": "property-0001", "userId": "#{userId}", "rankCapValue": 1}'}
}),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var transactionId = result.TransactionId;
var stampSheet = result.StampSheet;
var stampSheetEncryptionKeyId = result.StampSheetEncryptionKeyId;
var autoRunStampSheet = result.AutoRunStampSheet;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.multiplyAcquireActionsByUserId(
new Gs2Experience.MultiplyAcquireActionsByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withExperienceName("character_ssr")
.withPropertyId("property-0001")
.withRateName("rate-0001")
.withAcquireActions([
{'action': 'Gs2Experience:AddRankCapByUserId', 'request': '{"namespaceName": "namespace-0001", "experienceName": "character", "propertyId": "property-0001", "userId": "#{userId}", "rankCapValue": 1}'}
])
);
const items = result.getItems();
const transactionId = result.getTransactionId();
const stampSheet = result.getStampSheet();
const stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId();
const autoRunStampSheet = result.getAutoRunStampSheet();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.multiply_acquire_actions_by_user_id(
experience.MultiplyAcquireActionsByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_experience_name('character_ssr')
.with_property_id('property-0001')
.with_rate_name('rate-0001')
.with_acquire_actions([ {'action': 'Gs2Experience:AddRankCapByUserId', 'request': '{"namespaceName": "namespace-0001", "experienceName": "character", "propertyId": "property-0001", "userId": "#{userId}", "rankCapValue": 1}'},
])
)
items = result.items
transaction_id = result.transaction_id
stamp_sheet = result.stamp_sheet
stamp_sheet_encryption_key_id = result.stamp_sheet_encryption_key_id
auto_run_stamp_sheet = result.auto_run_stamp_sheet
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.multiply_acquire_actions_by_user_id({
namespaceName='namespace1',
userId='user-0001',
experienceName='character_ssr',
propertyId='property-0001',
rateName='rate-0001',
acquireActions={
{'action': 'Gs2Experience:AddRankCapByUserId', 'request': '{"namespaceName": "namespace-0001", "experienceName": "character", "propertyId": "property-0001", "userId": "#{userId}", "rankCapValue": 1}'}
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
transactionId = result.transactionId;
stampSheet = result.stampSheet;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId;
autoRunStampSheet = result.autoRunStampSheet;
multiplyAcquireActionsByStampSheet
Add resources according to the rank of the property subject to the experience value using stamp sheets
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
stampSheet | string | ✓ | ~ 5242880 chars | Stamp sheet | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
items | List<AcquireAction> | Rewards |
transactionId | string | Transaction ID of the stamp sheet issued |
stampSheet | string | Stamp sheet |
stampSheetEncryptionKeyId | string | Cryptographic key GRN used for stamp sheet signature calculations |
autoRunStampSheet | bool? | Is stamp sheet auto-execution enabled? |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.MultiplyAcquireActionsByStampSheet(
&experience.MultiplyAcquireActionsByStampSheetRequest {
StampSheet: pointy.String("$stampSheet"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
transactionId := result.TransactionId
stampSheet := result.StampSheet
stampSheetEncryptionKeyId := result.StampSheetEncryptionKeyId
autoRunStampSheet := result.AutoRunStampSheet
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\MultiplyAcquireActionsByStampSheetRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->multiplyAcquireActionsByStampSheet(
(new MultiplyAcquireActionsByStampSheetRequest())
->withStampSheet(self::$stampSheet)
->withKeyId(self::$key1.keyId)
);
$items = $result->getItems();
$transactionId = $result->getTransactionId();
$stampSheet = $result->getStampSheet();
$stampSheetEncryptionKeyId = $result->getStampSheetEncryptionKeyId();
$autoRunStampSheet = $result->getAutoRunStampSheet();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.MultiplyAcquireActionsByStampSheetRequest;
import io.gs2.experience.result.MultiplyAcquireActionsByStampSheetResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
MultiplyAcquireActionsByStampSheetResult result = client.multiplyAcquireActionsByStampSheet(
new MultiplyAcquireActionsByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
List<AcquireAction> items = result.getItems();
String transactionId = result.getTransactionId();
String stampSheet = result.getStampSheet();
String stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId();
boolean autoRunStampSheet = result.getAutoRunStampSheet();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.MultiplyAcquireActionsByStampSheetRequest;
using Gs2.Gs2Experience.Result.MultiplyAcquireActionsByStampSheetResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.MultiplyAcquireActionsByStampSheetResult> asyncResult = null;
yield return client.MultiplyAcquireActionsByStampSheet(
new Gs2.Gs2Experience.Request.MultiplyAcquireActionsByStampSheetRequest()
.WithStampSheet("$stampSheet")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var transactionId = result.TransactionId;
var stampSheet = result.StampSheet;
var stampSheetEncryptionKeyId = result.StampSheetEncryptionKeyId;
var autoRunStampSheet = result.AutoRunStampSheet;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.multiplyAcquireActionsByStampSheet(
new Gs2Experience.MultiplyAcquireActionsByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
const items = result.getItems();
const transactionId = result.getTransactionId();
const stampSheet = result.getStampSheet();
const stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId();
const autoRunStampSheet = result.getAutoRunStampSheet();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.multiply_acquire_actions_by_stamp_sheet(
experience.MultiplyAcquireActionsByStampSheetRequest()
.with_stamp_sheet(self.stamp_sheet)
.with_key_id(self.key1.key_id)
)
items = result.items
transaction_id = result.transaction_id
stamp_sheet = result.stamp_sheet
stamp_sheet_encryption_key_id = result.stamp_sheet_encryption_key_id
auto_run_stamp_sheet = result.auto_run_stamp_sheet
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.multiply_acquire_actions_by_stamp_sheet({
stampSheet='$stampSheet',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
transactionId = result.transactionId;
stampSheet = result.stampSheet;
stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId;
autoRunStampSheet = result.autoRunStampSheet;
verifyRankByStampTask
Use stamp task to verify rank
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
stampTask | string | ✓ | ~ 5242880 chars | Stamp task | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
newContextStack | string | Request of context in which stamp task execution results are recorded |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.VerifyRankByStampTask(
&experience.VerifyRankByStampTaskRequest {
StampTask: pointy.String("$stampTask"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
newContextStack := result.NewContextStack
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\VerifyRankByStampTaskRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->verifyRankByStampTask(
(new VerifyRankByStampTaskRequest())
->withStampTask(self::$stampTask)
->withKeyId(self::$key1.keyId)
);
$newContextStack = $result->getNewContextStack();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.VerifyRankByStampTaskRequest;
import io.gs2.experience.result.VerifyRankByStampTaskResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
VerifyRankByStampTaskResult result = client.verifyRankByStampTask(
new VerifyRankByStampTaskRequest()
.withStampTask("$stampTask")
.withKeyId("$key1.keyId")
);
String newContextStack = result.getNewContextStack();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.VerifyRankByStampTaskRequest;
using Gs2.Gs2Experience.Result.VerifyRankByStampTaskResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.VerifyRankByStampTaskResult> asyncResult = null;
yield return client.VerifyRankByStampTask(
new Gs2.Gs2Experience.Request.VerifyRankByStampTaskRequest()
.WithStampTask("$stampTask")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var newContextStack = result.NewContextStack;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.verifyRankByStampTask(
new Gs2Experience.VerifyRankByStampTaskRequest()
.withStampTask("$stampTask")
.withKeyId("$key1.keyId")
);
const newContextStack = result.getNewContextStack();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.verify_rank_by_stamp_task(
experience.VerifyRankByStampTaskRequest()
.with_stamp_task(self.stamp_task)
.with_key_id(self.key1.key_id)
)
new_context_stack = result.new_context_stack
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.verify_rank_by_stamp_task({
stampTask='$stampTask',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
newContextStack = result.newContextStack;
verifyRankCapByStampTask
Use stamp task to verify rank cap
Request
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
stampTask | string | ✓ | ~ 5242880 chars | Stamp task | ||
keyId | string | ✓ | ~ 1024 chars | encryption key GRN |
Result
Type | Description | |
---|---|---|
newContextStack | string | Request of context in which stamp task execution results are recorded |
Implementation Example
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/experience"
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 := experience.Gs2ExperienceRestClient{
Session: &session,
}
result, err := client.VerifyRankCapByStampTask(
&experience.VerifyRankCapByStampTaskRequest {
StampTask: pointy.String("$stampTask"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
newContextStack := result.NewContextStack
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Experience\Gs2ExperienceRestClient;
use Gs2\Experience\Request\VerifyRankCapByStampTaskRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->verifyRankCapByStampTask(
(new VerifyRankCapByStampTaskRequest())
->withStampTask(self::$stampTask)
->withKeyId(self::$key1.keyId)
);
$newContextStack = $result->getNewContextStack();
} 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.experience.rest.Gs2ExperienceRestClient;
import io.gs2.experience.request.VerifyRankCapByStampTaskRequest;
import io.gs2.experience.result.VerifyRankCapByStampTaskResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ExperienceRestClient client = new Gs2ExperienceRestClient(session);
try {
VerifyRankCapByStampTaskResult result = client.verifyRankCapByStampTask(
new VerifyRankCapByStampTaskRequest()
.withStampTask("$stampTask")
.withKeyId("$key1.keyId")
);
String newContextStack = result.getNewContextStack();
} 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.Gs2Experience.Gs2ExperienceRestClient;
using Gs2.Gs2Experience.Request.VerifyRankCapByStampTaskRequest;
using Gs2.Gs2Experience.Result.VerifyRankCapByStampTaskResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ExperienceRestClient(session);
AsyncResult<Gs2.Gs2Experience.Result.VerifyRankCapByStampTaskResult> asyncResult = null;
yield return client.VerifyRankCapByStampTask(
new Gs2.Gs2Experience.Request.VerifyRankCapByStampTaskRequest()
.WithStampTask("$stampTask")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var newContextStack = result.NewContextStack;
import Gs2Core from '@/gs2/core';
import * as Gs2Experience from '@/gs2/experience';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Experience.Gs2ExperienceRestClient(session);
try {
const result = await client.verifyRankCapByStampTask(
new Gs2Experience.VerifyRankCapByStampTaskRequest()
.withStampTask("$stampTask")
.withKeyId("$key1.keyId")
);
const newContextStack = result.getNewContextStack();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import experience
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = experience.Gs2ExperienceRestClient(session)
try:
result = client.verify_rank_cap_by_stamp_task(
experience.VerifyRankCapByStampTaskRequest()
.with_stamp_task(self.stamp_task)
.with_key_id(self.key1.key_id)
)
new_context_stack = result.new_context_stack
except core.Gs2Exception as e:
exit(1)
client = gs2('experience')
api_result = client.verify_rank_cap_by_stamp_task({
stampTask='$stampTask',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
newContextStack = result.newContextStack;