API Reference of GS2-Enhance 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 enableDirectEnhance bool ✓ false DirectEnhance is available transactionSetting TransactionSetting ✓ Transaction settings enhanceScript ScriptSetting Script to be executed at the time of reinforcement logSetting LogSetting Log output settings createdAt long ✓ Datetime of creation updatedAt long ✓ Datetime of last update queueNamespaceId string ~ 1024 chars Namespace in GS2-JobQueue used to run the stamp sheet keyId string ~ 1024 chars GS2-Key namespace used to issue stamp sheets revision long 0 ~ 9223372036854775805 Revision
RateModel Enhancement Rates
The enhancement rate is data that defines the materials used for enhancement and the target of enhancement.
Both material data and enhancement target data must be managed in GS2-Inventory.
The experience value obtained from the enhancement is recorded in GS2-Inventory metadata in JSON format.
Here, it is necessary to describe at which level of the metadata the experience value is stored.
A correction value can be applied to the amount of experience value that can be obtained with a certain probability of great success
during enhancement.
The probability of that draw is also defined in this entity.
Type Condition Require Default Limitation Description rateModelId string ✓ ~ 1024 chars Enhance Rate Model GRN name string ✓ ~ 128 chars Enhanced Rate Name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata targetInventoryModelId string ✓ ~ 1024 chars Inventory available for enhancement targets acquireExperienceSuffix string ✓ ~ 1024 chars Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience materialInventoryModelId string ✓ ~ 1024 chars Inventory model GRN acquireExperienceHierarchy List<string> ~ 10 items JSON hierarchy of metadata storing acquired experience values experienceModelId string ✓ ~ 1024 chars Experience Model GRN bonusRates List<BonusRate> ~ 1000 items Experience gain bonus
RateModelMaster Enhancement Rate Master
The reinforcement rate is data that defines the materials used for reinforcement and the target of reinforcement.
Both material data and reinforcement target data must be managed in GS2-Inventory.
The experience value obtained from the reinforcement is recorded in GS2-Inventory metadata in JSON format.
Here, it is necessary to describe at which level of the metadata the experience value is stored.
A correction value can be applied to the amount of experience value that can be obtained with a certain probability of great success
during reinforcement.
The probability of that draw is also defined in this entity.
Type Condition Require Default Limitation Description rateModelId string ✓ ~ 1024 chars Enhance Rate Model Master GRN name string ✓ ~ 128 chars Enhanced Rate Name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata targetInventoryModelId string ✓ ~ 1024 chars Inventory available for enhancement targets acquireExperienceSuffix string ✓ ~ 1024 chars Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience materialInventoryModelId string ✓ ~ 1024 chars Inventory available for materials acquireExperienceHierarchy List<string> ~ 10 items JSON hierarchy of metadata storing acquired experience values experienceModelId string ✓ ~ 1024 chars Experience gained as a result of reinforcement bonusRates List<BonusRate> ~ 1000 items Experience gain bonus createdAt long ✓ Datetime of creation updatedAt long ✓ Datetime of last update revision long 0 ~ 9223372036854775805 Revision
Progress Enhance Progress
It is created at the beginning of the enhance and deleted at the end.
When you exit the application in the middle of an enhance, this data will remain.
It is possible to resume the game from the ongoing enhance information maintained by the entity.
Type Condition Require Default Limitation Description progressId string ✓ ~ 1024 chars Progress GRN userId string ✓ ~ 128 chars User Id rateName string ✓ ~ 128 chars Rate Model Name name string ✓ UUID ~ 36 chars Conduct ID propertyId string ✓ ~ 1024 chars Property ID to be enhanced experienceValue long ✓ ~ 9223372036854775805 Experience value rate float ✓ ~ 100.0 Experience value scale factor createdAt long ✓ Datetime of creation updatedAt long ✓ Datetime of last update revision long 0 ~ 9223372036854775805 Revision
CurrentRateMaster Currently available enhanced rate masters
GS2 uses JSON format files for master data management.
By uploading the file, the settings can actually be reflected 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 your own 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 Currently available enhance experience rate setting GRN settings string ✓ ~ 5242880 chars Master data
BonusRate Type Condition Require Default Limitation Description rate float ✓ 1.0 ~ 10000 Experience bonus multiplier (1.0 = no bonus) weight int ✓ 1 ~ 2147483645 lottery weight
Material Type Condition Require Default Limitation Description materialItemSetId string ✓ ~ 1024 chars Quantity of items held per expiration date GRN count int ✓ 1 ~ 2147483645 Number of consumption
Config Type Condition Require Default Limitation Description key string ✓ ~ 64 chars Name value string ~ 51200 chars Value
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 ✓ “grn:gs2:{region}:{ownerId}:distributor:default” ~ 1024 chars GS2-Distributor namespace used for stamp sheet execution keyId string !{enableAutoRun} ✓ “grn:gs2:{region}:{ownerId}:key:default:key:default” ~ 1024 chars GS2-Key encryption key used to sign the stamp sheet queueNamespaceId string ✓ “grn:gs2:{region}:{ownerId}:queue:default” ~ 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
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . DescribeNamespaces (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.DescribeNamespacesRequest ;
import io.gs2.enhance.result.DescribeNamespacesResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.DescribeNamespacesRequest ;
using Gs2.Gs2Enhance.Result.DescribeNamespacesResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . DescribeNamespacesResult > asyncResult = null ;
yield return client . DescribeNamespaces (
new Gs2 . Gs2Enhance . Request . DescribeNamespacesRequest ()
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . I tems ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . describeNamespaces (
new Gs2Enhance . 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 enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . describe_namespaces (
enhance . 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 ( 'enhance' )
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 enableDirectEnhance bool ✓ false DirectEnhance is available transactionSetting TransactionSetting ✓ Transaction settings enhanceScript ScriptSetting Script to be executed at the time of reinforcement logSetting LogSetting Log output settings queueNamespaceId string ~ 1024 chars Namespace in GS2-JobQueue used to run the stamp sheet keyId string ~ 1024 chars GS2-Key namespace used to issue stamp sheets
Result Type Description item Namespace Namespace created
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . CreateNamespace (
& enhance . CreateNamespaceRequest {
Name : pointy . String ( "namespace1" ),
Description : nil ,
EnableDirectEnhance : pointy . Bool ( true ),
TransactionSetting : & enhance . TransactionSetting {
EnableAutoRun : pointy . Bool ( false ),
QueueNamespaceId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" ),
KeyId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001" ),
},
EnhanceScript : nil ,
LogSetting : & enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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 )
-> withEnableDirectEnhance ( True )
-> withTransactionSetting (( new \Gs2\Enhance\Model\TransactionSetting ())
-> withEnableAutoRun ( False )
-> withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" )
-> withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key: \n amespace1:key:key-0001" ))
-> withEnhanceScript ( null )
-> withLogSetting (( new \Gs2\Enhance\Model\LogSetting ())
-> withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log: \n amespace1" ))
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.CreateNamespaceRequest ;
import io.gs2.enhance.result.CreateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( session );
try {
CreateNamespaceResult result = client . createNamespace (
new CreateNamespaceRequest ()
. withName ( "namespace1" )
. withDescription ( null )
. withEnableDirectEnhance ( true )
. withTransactionSetting ( new io . gs2 . enhance . model . TransactionSetting ()
. withEnableAutoRun ( false )
. withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" )
. withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001" ))
. withEnhanceScript ( null )
. withLogSetting ( new io . gs2 . enhance . 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.CreateNamespaceRequest ;
using Gs2.Gs2Enhance.Result.CreateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . CreateNamespaceResult > asyncResult = null ;
yield return client . CreateNamespace (
new Gs2 . Gs2Enhance . Request . CreateNamespaceRequest ()
. WithName ( "namespace1" )
. WithDescription ( null )
. WithEnableDirectEnhance ( true )
. WithTransactionSetting ( new Gs2 . Gs2Enhance . Model . TransactionSetting ()
. WithEnableAutoRun ( false )
. WithQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" )
. WithKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001" ))
. WithEnhanceScript ( null )
. WithLogSetting ( new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . createNamespace (
new Gs2Enhance . CreateNamespaceRequest ()
. withName ( "namespace1" )
. withDescription ( null )
. withEnableDirectEnhance ( true )
. withTransactionSetting ( new Gs2Enhance . model . TransactionSetting ()
. withEnableAutoRun ( false )
. withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001" )
. withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001" ))
. withEnhanceScript ( null )
. withLogSetting ( new Gs2Enhance . 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 enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . create_namespace (
enhance . CreateNamespaceRequest ()
. with_name ( self . hash1 )
. with_description ( None )
. with_enable_direct_enhance ( True )
. with_transaction_setting (
enhance . TransactionSetting ()
. with_enable_auto_run ( False )
. with_queue_namespace_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001' )
. with_key_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001' ))
. with_enhance_script ( None )
. with_log_setting (
enhance . 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 ( 'enhance' )
api_result = client.create_namespace ({
name = 'namespace1' ,
description = nil ,
enableDirectEnhance = true ,
transactionSetting = {
enableAutoRun = false ,
queueNamespaceId = 'grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001' ,
keyId = 'grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001' ,
},
enhanceScript = 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
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . GetNamespaceStatus (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.GetNamespaceStatusRequest ;
import io.gs2.enhance.result.GetNamespaceStatusResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.GetNamespaceStatusRequest ;
using Gs2.Gs2Enhance.Result.GetNamespaceStatusResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . GetNamespaceStatusResult > asyncResult = null ;
yield return client . GetNamespaceStatus (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . getNamespaceStatus (
new Gs2Enhance . GetNamespaceStatusRequest ()
. withNamespaceName ( "namespace1" )
);
const status = result . getStatus ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . get_namespace_status (
enhance . GetNamespaceStatusRequest ()
. with_namespace_name ( self . hash1 )
)
status = result . status
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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 Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . GetNamespace (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.GetNamespaceRequest ;
import io.gs2.enhance.result.GetNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.GetNamespaceRequest ;
using Gs2.Gs2Enhance.Result.GetNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . GetNamespaceResult > asyncResult = null ;
yield return client . GetNamespace (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . getNamespace (
new Gs2Enhance . GetNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . get_namespace (
enhance . GetNamespaceRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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 enableDirectEnhance bool ✓ false DirectEnhance is available transactionSetting TransactionSetting ✓ Transaction settings enhanceScript ScriptSetting Script to be executed at the time of reinforcement logSetting LogSetting Log output settings queueNamespaceId string ~ 1024 chars Namespace in GS2-JobQueue used to run the stamp sheet keyId string ~ 1024 chars GS2-Key namespace used to issue stamp sheets
Result Type Description item Namespace Updated namespace
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . UpdateNamespace (
& enhance . UpdateNamespaceRequest {
NamespaceName : pointy . String ( "namespace1" ),
Description : pointy . String ( "description1" ),
EnableDirectEnhance : pointy . Bool ( false ),
TransactionSetting : & enhance . TransactionSetting {
EnableAutoRun : pointy . Bool ( false ),
QueueNamespaceId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" ),
KeyId : pointy . String ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0002" ),
},
EnhanceScript : nil ,
LogSetting : & enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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" )
-> withEnableDirectEnhance ( False )
-> withTransactionSetting (( new \Gs2\Enhance\Model\TransactionSetting ())
-> withEnableAutoRun ( False )
-> withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" )
-> withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key: \n amespace1:key:key-0002" ))
-> withEnhanceScript ( null )
-> withLogSetting (( new \Gs2\Enhance\Model\LogSetting ())
-> withLoggingNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:log: \n amespace1" ))
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.UpdateNamespaceRequest ;
import io.gs2.enhance.result.UpdateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( session );
try {
UpdateNamespaceResult result = client . updateNamespace (
new UpdateNamespaceRequest ()
. withNamespaceName ( "namespace1" )
. withDescription ( "description1" )
. withEnableDirectEnhance ( false )
. withTransactionSetting ( new io . gs2 . enhance . model . TransactionSetting ()
. withEnableAutoRun ( false )
. withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" )
. withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0002" ))
. withEnhanceScript ( null )
. withLogSetting ( new io . gs2 . enhance . 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.UpdateNamespaceRequest ;
using Gs2.Gs2Enhance.Result.UpdateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . UpdateNamespaceResult > asyncResult = null ;
yield return client . UpdateNamespace (
new Gs2 . Gs2Enhance . Request . UpdateNamespaceRequest ()
. WithNamespaceName ( "namespace1" )
. WithDescription ( "description1" )
. WithEnableDirectEnhance ( false )
. WithTransactionSetting ( new Gs2 . Gs2Enhance . Model . TransactionSetting ()
. WithEnableAutoRun ( false )
. WithQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" )
. WithKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0002" ))
. WithEnhanceScript ( null )
. WithLogSetting ( new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . updateNamespace (
new Gs2Enhance . UpdateNamespaceRequest ()
. withNamespaceName ( "namespace1" )
. withDescription ( "description1" )
. withEnableDirectEnhance ( false )
. withTransactionSetting ( new Gs2Enhance . model . TransactionSetting ()
. withEnableAutoRun ( false )
. withQueueNamespaceId ( "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002" )
. withKeyId ( "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0002" ))
. withEnhanceScript ( null )
. withLogSetting ( new Gs2Enhance . 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 enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . update_namespace (
enhance . UpdateNamespaceRequest ()
. with_namespace_name ( self . hash1 )
. with_description ( 'description1' )
. with_enable_direct_enhance ( False )
. with_transaction_setting (
enhance . TransactionSetting ()
. with_enable_auto_run ( False )
. with_queue_namespace_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002' )
. with_key_id ( 'grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0002' ))
. with_enhance_script ( None )
. with_log_setting (
enhance . 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 ( 'enhance' )
api_result = client.update_namespace ({
namespaceName = 'namespace1' ,
description = 'description1' ,
enableDirectEnhance = false ,
transactionSetting = {
enableAutoRun = false ,
queueNamespaceId = 'grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002' ,
keyId = 'grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0002' ,
},
enhanceScript = 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 ;
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
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . DeleteNamespace (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.DeleteNamespaceRequest ;
import io.gs2.enhance.result.DeleteNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.DeleteNamespaceRequest ;
using Gs2.Gs2Enhance.Result.DeleteNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . DeleteNamespaceResult > asyncResult = null ;
yield return client . DeleteNamespace (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . deleteNamespace (
new Gs2Enhance . DeleteNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . delete_namespace (
enhance . DeleteNamespaceRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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 Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . DumpUserDataByUserId (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.DumpUserDataByUserIdRequest ;
import io.gs2.enhance.result.DumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.DumpUserDataByUserIdRequest ;
using Gs2.Gs2Enhance.Result.DumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . DumpUserDataByUserIdResult > asyncResult = null ;
yield return client . DumpUserDataByUserId (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . dumpUserDataByUserId (
new Gs2Enhance . DumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . dump_user_data_by_user_id (
enhance . DumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . CheckDumpUserDataByUserId (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.CheckDumpUserDataByUserIdRequest ;
import io.gs2.enhance.result.CheckDumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.CheckDumpUserDataByUserIdRequest ;
using Gs2.Gs2Enhance.Result.CheckDumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . CheckDumpUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckDumpUserDataByUserId (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . checkDumpUserDataByUserId (
new Gs2Enhance . CheckDumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . check_dump_user_data_by_user_id (
enhance . CheckDumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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 Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . CleanUserDataByUserId (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.CleanUserDataByUserIdRequest ;
import io.gs2.enhance.result.CleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.CleanUserDataByUserIdRequest ;
using Gs2.Gs2Enhance.Result.CleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . CleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CleanUserDataByUserId (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . cleanUserDataByUserId (
new Gs2Enhance . CleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . clean_user_data_by_user_id (
enhance . CleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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 Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . CheckCleanUserDataByUserId (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.CheckCleanUserDataByUserIdRequest ;
import io.gs2.enhance.result.CheckCleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.CheckCleanUserDataByUserIdRequest ;
using Gs2.Gs2Enhance.Result.CheckCleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . CheckCleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckCleanUserDataByUserId (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . checkCleanUserDataByUserId (
new Gs2Enhance . CheckCleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . check_clean_user_data_by_user_id (
enhance . CheckCleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . PrepareImportUserDataByUserId (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.PrepareImportUserDataByUserIdRequest ;
import io.gs2.enhance.result.PrepareImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.PrepareImportUserDataByUserIdRequest ;
using Gs2.Gs2Enhance.Result.PrepareImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . PrepareImportUserDataByUserIdResult > asyncResult = null ;
yield return client . PrepareImportUserDataByUserId (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . prepareImportUserDataByUserId (
new Gs2Enhance . PrepareImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
const uploadToken = result . getUploadToken ();
const uploadUrl = result . getUploadUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . prepare_import_user_data_by_user_id (
enhance . 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 ( 'enhance' )
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 Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . ImportUserDataByUserId (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.ImportUserDataByUserIdRequest ;
import io.gs2.enhance.result.ImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.ImportUserDataByUserIdRequest ;
using Gs2.Gs2Enhance.Result.ImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . ImportUserDataByUserIdResult > asyncResult = null ;
yield return client . ImportUserDataByUserId (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . importUserDataByUserId (
new Gs2Enhance . ImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . import_user_data_by_user_id (
enhance . ImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_upload_token ( 'upload-0001' )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . CheckImportUserDataByUserId (
& enhance . 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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.CheckImportUserDataByUserIdRequest ;
import io.gs2.enhance.result.CheckImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.CheckImportUserDataByUserIdRequest ;
using Gs2.Gs2Enhance.Result.CheckImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . CheckImportUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckImportUserDataByUserId (
new Gs2 . Gs2Enhance . 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . checkImportUserDataByUserId (
new Gs2Enhance . CheckImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . check_import_user_data_by_user_id (
enhance . CheckImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_upload_token ( 'upload-0001' )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
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 ;
describeRateModels Get list of enhanced rate models
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 32 chars Namespace name
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . DescribeRateModels (
& enhance . DescribeRateModelsRequest {
NamespaceName : pointy . String ( "namespace1" ),
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\Request\DescribeRateModelsRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeRateModels (
( new DescribeRateModelsRequest ())
-> withNamespaceName ( self :: namespace1 )
);
$items = $result -> getItems ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.DescribeRateModelsRequest ;
import io.gs2.enhance.result.DescribeRateModelsResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( session );
try {
DescribeRateModelsResult result = client . describeRateModels (
new DescribeRateModelsRequest ()
. withNamespaceName ( "namespace1" )
);
List < RateModel > 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.DescribeRateModelsRequest ;
using Gs2.Gs2Enhance.Result.DescribeRateModelsResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . DescribeRateModelsResult > asyncResult = null ;
yield return client . DescribeRateModels (
new Gs2 . Gs2Enhance . Request . DescribeRateModelsRequest ()
. WithNamespaceName ( "namespace1" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . describeRateModels (
new Gs2Enhance . DescribeRateModelsRequest ()
. withNamespaceName ( "namespace1" )
);
const items = result . getItems ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . describe_rate_models (
enhance . DescribeRateModelsRequest ()
. with_namespace_name ( self . hash1 )
)
items = result . items
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
api_result = client.describe_rate_models ({
namespaceName = 'namespace1' ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
getRateModel Get Enhanced Rate Model
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 32 chars Namespace name rateName string ✓ ~ 128 chars Enhanced Rate Name
Result Type Description item RateModel Enhanced Rate Model
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . GetRateModel (
& enhance . GetRateModelRequest {
NamespaceName : pointy . String ( "namespace1" ),
RateName : pointy . String ( "character-level" ),
}
)
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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\Request\GetRateModelRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getRateModel (
( new GetRateModelRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withRateName ( "character-level" )
);
$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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.GetRateModelRequest ;
import io.gs2.enhance.result.GetRateModelResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( session );
try {
GetRateModelResult result = client . getRateModel (
new GetRateModelRequest ()
. withNamespaceName ( "namespace1" )
. withRateName ( "character-level" )
);
RateModel 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.GetRateModelRequest ;
using Gs2.Gs2Enhance.Result.GetRateModelResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . GetRateModelResult > asyncResult = null ;
yield return client . GetRateModel (
new Gs2 . Gs2Enhance . Request . GetRateModelRequest ()
. WithNamespaceName ( "namespace1" )
. WithRateName ( "character-level" ),
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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . getRateModel (
new Gs2Enhance . GetRateModelRequest ()
. withNamespaceName ( "namespace1" )
. withRateName ( "character-level" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . get_rate_model (
enhance . GetRateModelRequest ()
. with_namespace_name ( self . hash1 )
. with_rate_name ( 'character-level' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'enhance' )
api_result = client.get_rate_model ({
namespaceName = 'namespace1' ,
rateName = 'character-level' ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
describeRateModelMasters Get list of enhanced rate 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<RateModelMaster> List of Enhanced Rate Master nextPageToken string Page token to retrieve the rest of the listing
Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . DescribeRateModelMasters (
& enhance . DescribeRateModelMastersRequest {
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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\Request\DescribeRateModelMastersRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeRateModelMasters (
( new DescribeRateModelMastersRequest ())
-> 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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.DescribeRateModelMastersRequest ;
import io.gs2.enhance.result.DescribeRateModelMastersResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( session );
try {
DescribeRateModelMastersResult result = client . describeRateModelMasters (
new DescribeRateModelMastersRequest ()
. withNamespaceName ( "namespace1" )
. withPageToken ( null )
. withLimit ( null )
);
List < RateModelMaster > 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.Gs2Enhance.Gs2EnhanceRestClient ;
using Gs2.Gs2Enhance.Request.DescribeRateModelMastersRequest ;
using Gs2.Gs2Enhance.Result.DescribeRateModelMastersResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2EnhanceRestClient ( session );
AsyncResult < Gs2 . Gs2Enhance . Result . DescribeRateModelMastersResult > asyncResult = null ;
yield return client . DescribeRateModelMasters (
new Gs2 . Gs2Enhance . Request . DescribeRateModelMastersRequest ()
. 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 Gs2Enhance from '@/gs2/enhance' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Enhance . Gs2EnhanceRestClient ( session );
try {
const result = await client . describeRateModelMasters (
new Gs2Enhance . DescribeRateModelMastersRequest ()
. 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 enhance
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = enhance . Gs2EnhanceRestClient ( session )
try :
result = client . describe_rate_model_masters (
enhance . DescribeRateModelMastersRequest ()
. 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 ( 'enhance' )
api_result = client.describe_rate_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 ;
createRateModelMaster Create a new Enhanced Rate Master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 32 chars Namespace name name string ✓ ~ 128 chars Enhanced Rate Name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata targetInventoryModelId string ✓ ~ 1024 chars Inventory available for enhancement targets acquireExperienceSuffix string ✓ ~ 1024 chars Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience materialInventoryModelId string ✓ ~ 1024 chars Inventory available for materials acquireExperienceHierarchy List<string> ~ 10 items JSON hierarchy of metadata storing acquired experience values experienceModelId string ✓ ~ 1024 chars Experience gained as a result of reinforcement bonusRates List<BonusRate> ~ 1000 items Experience gain bonus
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/enhance"
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 := enhance . Gs2EnhanceRestClient {
Session : & session ,
}
result , err := client . CreateRateModelMaster (
& enhance . CreateRateModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Name : pointy . String ( "character-level" ),
Description : nil ,
Metadata : pointy . String ( "CHARACTER_LEVEL" ),
TargetInventoryModelId : pointy . String ( "grn:inventory:character" ),
AcquireExperienceSuffix : pointy . String ( ":level" ),
MaterialInventoryModelId : pointy . String ( "grn:inventory:material" ),
AcquireExperienceHierarchy : [] * string {
pointy . String ( "experience" ),
},
ExperienceModelId : pointy . String ( "grn:experience:level" ),
BonusRates : [] enhance . BonusRate {
enhance . BonusRate {
Rate : pointy . Float32 ( 1.0 ),
Weight : pointy . Int32 ( 90 ),
},
enhance . BonusRate {
Rate : pointy . Float32 ( 1.5 ),
Weight : pointy . Int32 ( 9 ),
},
enhance . BonusRate {
Rate : pointy . Float32 ( 2.0 ),
Weight : pointy . Int32 ( 1 ),
},
},
}
)
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\Enhance\Gs2EnhanceRestClient ;
use Gs2\Enhance\Request\CreateRateModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createRateModelMaster (
( new CreateRateModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withName ( "character-level" )
-> withDescription ( null )
-> withMetadata ( "CHARACTER_LEVEL" )
-> withTargetInventoryModelId ( "grn:inventory:character" )
-> withAcquireExperienceSuffix ( ":level" )
-> withMaterialInventoryModelId ( "grn:inventory:material" )
-> withAcquireExperienceHierarchy ([ "experience" ,
])
-> withExperienceModelId ( "grn:experience:level" )
-> withBonusRates ([ ( new \Gs2\Enhance\Model\BonusRate ())
-> withRate ( 1.0 )
-> withWeight ( 90 ),
( new \Gs2\Enhance\Model\BonusRate ())
-> withRate ( 1.5 )
-> withWeight ( 9 ),
( new \Gs2\Enhance\Model\BonusRate ())
-> withRate ( 2.0 )
-> withWeight ( 1 ),
])
);
$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.enhance.rest.Gs2EnhanceRestClient ;
import io.gs2.enhance.request.CreateRateModelMasterRequest ;
import io.gs2.enhance.result.CreateRateModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2EnhanceRestClient client = new Gs2EnhanceRestClient ( session );
try {
CreateRateModelMasterResult result = client . createRateModelMaster (
new CreateRateModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withName ( "character-level" )
. withDescription ( null )
. withMetadata ( "CHARACTER_LEVEL" )
. withTargetInventoryModelId ( "grn:inventory:character" )
. withAcquireExperienceSuffix ( ":level" )
. withMaterialInventoryModelId ( "grn:inventory:material" )
. withAcquireExperienceHierarchy ( Arrays . asList (
"experience"
))
. withExperienceModelId ( "grn:experience:level" )
. withBonusRates ( Arrays . asList (
new io . gs2 . enhance . model . BonusRate ()
. withRate ( 1 . 0f )
. withWeight ( 90 ),
new io . gs2 . enhance . model . BonusRate ()
. withRate ( 1 . 5f )
. withWeight ( 9 ),
new io . gs2 . enhance . model . BonusRate ()
. withRate ( 2 . 0f )
. withWeight ( 1 )
))
);
RateModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSessio