API Reference of GS2-Idle 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 transactionSetting TransactionSetting ✓ Transaction settings receiveScript ScriptSetting Script to be executed when the receive rewards logSetting LogSetting Log output settings createdAt long ✓ Datetime of creation updatedAt long ✓ Datetime of last update revision long 0 ~ 9223372036854775805 Revision
CategoryModelMaster Category Model Master
A category model is an entity that sets the idle category that can be obtained as a reward for leaving.
The settings include information such as the reward for each waiting time and the maximum idle time.
Type Condition Require Default Limitation Description categoryModelId string ✓ ~ 1024 chars Category Model Master GRN name string ✓ ~ 128 chars Category Model Name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata rewardIntervalMinutes int ✓ ~ 2147483646 Interval at which idle rewards can be obtained (minutes) defaultMaximumIdleMinutes int ✓ ~ 2147483646 Maximum time to get idle rewards (minutes) acquireActions List<AcquireActionList> ✓ 1 ~ 100 items List of acquire actions for each waiting time idlePeriodScheduleId string ~ 1024 chars GS2-Schedule event GRN with time period used for idle rewards calculation receivePeriodScheduleId string ~ 1024 chars GS2-Schedule EventGRN that sets the period during which idle rewards can be obtained createdAt long ✓ Datetime of creation updatedAt long ✓ Datetime of last update revision long 0 ~ 9223372036854775805 Revision
CategoryModel Category Model Master
A category model is an entity that sets the idle category that can be obtained as a reward for leaving.
The settings include information such as the reward for each waiting time and the maximum idle time.
Type Condition Require Default Limitation Description categoryModelId string ✓ ~ 1024 chars Category Model GRN name string ✓ ~ 128 chars Category Model Name metadata string ~ 2048 chars metadata rewardIntervalMinutes int ✓ ~ 2147483646 Interval at which idle rewards can be obtained (minutes) defaultMaximumIdleMinutes int ✓ ~ 2147483646 Maximum time to get idle rewards (minutes) acquireActions List<AcquireActionList> ✓ 1 ~ 100 items List of acquire actions for each waiting time idlePeriodScheduleId string ~ 1024 chars GS2-Schedule event GRN with time period used for idle rewards calculation receivePeriodScheduleId string ~ 1024 chars GS2-Schedule EventGRN that sets the period during which idle rewards can be obtained
Status Status
Created when GetIdleStatus is called for the first time, and the idle time count starts from that time.
The idle time count is reset when you receive a reward.
If GS2-Schedule events are associated, you cannot access Category before the event is held, and you cannot create a status.
If an event is associated, the status holds the number of repetitions of the event.
If the current event ID and the event ID at the time of status creation do not match, if the number of repetitions of the current event and the number of repetitions held by the status do not match, or if the status is created before the start time of the event, the waiting time is reset.
Type Condition Require Default Limitation Description statusId string ✓ ~ 1024 chars Status GRN categoryName string ✓ ~ 128 chars Category Model Name userId string ✓ ~ 128 chars User Id randomSeed long ✓ 0 ~ 9223372036854775805 Random seed idleMinutes int ✓ ~ 2147483646 Idle time maximumIdleMinutes int ✓ 0 ~ 2147483646 Maximum idle time createdAt long ✓ Datetime of creation updatedAt long ✓ Datetime of last update revision long 0 ~ 9223372036854775805 Revision
CurrentCategoryMaster Currently available master data
GS2 uses JSON format files for master data management.
By uploading the file, you can actually reflect the settings on the server.
We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the
The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.
Please refer to the documentation for the format of the JSON file.
Type Condition Require Default Limitation Description namespaceId string ✓ ~ 1024 chars Namespace GRN settings string ✓ ~ 5242880 chars Master data
Config Type Condition Require Default Limitation Description key string ✓ ~ 64 chars Name value string ~ 51200 chars Value
AcquireAction Type Condition Require Default Limitation Description action enum [ ] ✓ ~ 128 chars Types of actions to be performed in the stamp sheet request string ✓ ~ 1048576 chars JSON of request
AcquireActionList Type Condition Require Default Limitation Description acquireActions List<AcquireAction> ~ 100 items List of Acquire Action
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
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
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
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . DescribeNamespaces (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.DescribeNamespacesRequest ;
import io.gs2.idle.result.DescribeNamespacesResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.DescribeNamespacesRequest ;
using Gs2.Gs2Idle.Result.DescribeNamespacesResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . DescribeNamespacesResult > asyncResult = null ;
yield return client . DescribeNamespaces (
new Gs2 . Gs2Idle . Request . DescribeNamespacesRequest ()
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . describeNamespaces (
new Gs2Idle . 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 idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . describe_namespaces (
idle . 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 ( 'idle' )
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 transactionSetting TransactionSetting ✓ Transaction settings receiveScript ScriptSetting Script to be executed when the receive rewards logSetting LogSetting Log output settings
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . CreateNamespace (
& idle . CreateNamespaceRequest {
Name : pointy . String ( "namespace1" ),
Description : nil ,
TransactionSetting : & idle . 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" ),
},
ReceiveScript : nil ,
LogSetting : & idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\Request\CreateNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createNamespace (
( new CreateNamespaceRequest ())
-> withName ( self :: namespace1 )
-> withDescription ( null )
-> withTransactionSetting (( new \Gs2\Idle\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" ))
-> withReceiveScript ( null )
-> withLogSetting (( new \Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.CreateNamespaceRequest ;
import io.gs2.idle.result.CreateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( session );
try {
CreateNamespaceResult result = client . createNamespace (
new CreateNamespaceRequest ()
. withName ( "namespace1" )
. withDescription ( null )
. withTransactionSetting ( new io . gs2 . idle . 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" ))
. withReceiveScript ( null )
. withLogSetting ( new io . gs2 . idle . 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.CreateNamespaceRequest ;
using Gs2.Gs2Idle.Result.CreateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . CreateNamespaceResult > asyncResult = null ;
yield return client . CreateNamespace (
new Gs2 . Gs2Idle . Request . CreateNamespaceRequest ()
. WithName ( "namespace1" )
. WithDescription ( null )
. WithTransactionSetting ( new Gs2 . Gs2Idle . 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" ))
. WithReceiveScript ( null )
. WithLogSetting ( new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . createNamespace (
new Gs2Idle . CreateNamespaceRequest ()
. withName ( "namespace1" )
. withDescription ( null )
. withTransactionSetting ( new Gs2Idle . 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" ))
. withReceiveScript ( null )
. withLogSetting ( new Gs2Idle . 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 idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . create_namespace (
idle . CreateNamespaceRequest ()
. with_name ( self . hash1 )
. with_description ( None )
. with_transaction_setting (
idle . 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_receive_script ( None )
. with_log_setting (
idle . 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 ( 'idle' )
api_result = client.create_namespace ({
name = 'namespace1' ,
description = nil ,
transactionSetting = {
enableAutoRun = false ,
queueNamespaceId = 'grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001' ,
keyId = 'grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001' ,
},
receiveScript = 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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . GetNamespaceStatus (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.GetNamespaceStatusRequest ;
import io.gs2.idle.result.GetNamespaceStatusResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.GetNamespaceStatusRequest ;
using Gs2.Gs2Idle.Result.GetNamespaceStatusResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . GetNamespaceStatusResult > asyncResult = null ;
yield return client . GetNamespaceStatus (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . getNamespaceStatus (
new Gs2Idle . GetNamespaceStatusRequest ()
. withNamespaceName ( "namespace1" )
);
const status = result . getStatus ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . get_namespace_status (
idle . GetNamespaceStatusRequest ()
. with_namespace_name ( self . hash1 )
)
status = result . status
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . GetNamespace (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.GetNamespaceRequest ;
import io.gs2.idle.result.GetNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.GetNamespaceRequest ;
using Gs2.Gs2Idle.Result.GetNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . GetNamespaceResult > asyncResult = null ;
yield return client . GetNamespace (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . getNamespace (
new Gs2Idle . GetNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . get_namespace (
idle . GetNamespaceRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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 transactionSetting TransactionSetting ✓ Transaction settings receiveScript ScriptSetting Script to be executed when the receive rewards logSetting LogSetting Log output settings
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . UpdateNamespace (
& idle . UpdateNamespaceRequest {
NamespaceName : pointy . String ( "namespace1" ),
Description : pointy . String ( "description1" ),
TransactionSetting : & idle . 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" ),
},
ReceiveScript : nil ,
LogSetting : & idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\Request\UpdateNamespaceRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> updateNamespace (
( new UpdateNamespaceRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withDescription ( "description1" )
-> withTransactionSetting (( new \Gs2\Idle\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" ))
-> withReceiveScript ( null )
-> withLogSetting (( new \Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.UpdateNamespaceRequest ;
import io.gs2.idle.result.UpdateNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( session );
try {
UpdateNamespaceResult result = client . updateNamespace (
new UpdateNamespaceRequest ()
. withNamespaceName ( "namespace1" )
. withDescription ( "description1" )
. withTransactionSetting ( new io . gs2 . idle . 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" ))
. withReceiveScript ( null )
. withLogSetting ( new io . gs2 . idle . 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.UpdateNamespaceRequest ;
using Gs2.Gs2Idle.Result.UpdateNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . UpdateNamespaceResult > asyncResult = null ;
yield return client . UpdateNamespace (
new Gs2 . Gs2Idle . Request . UpdateNamespaceRequest ()
. WithNamespaceName ( "namespace1" )
. WithDescription ( "description1" )
. WithTransactionSetting ( new Gs2 . Gs2Idle . 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" ))
. WithReceiveScript ( null )
. WithLogSetting ( new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . updateNamespace (
new Gs2Idle . UpdateNamespaceRequest ()
. withNamespaceName ( "namespace1" )
. withDescription ( "description1" )
. withTransactionSetting ( new Gs2Idle . 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" ))
. withReceiveScript ( null )
. withLogSetting ( new Gs2Idle . 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 idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . update_namespace (
idle . UpdateNamespaceRequest ()
. with_namespace_name ( self . hash1 )
. with_description ( 'description1' )
. with_transaction_setting (
idle . 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_receive_script ( None )
. with_log_setting (
idle . 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 ( 'idle' )
api_result = client.update_namespace ({
namespaceName = 'namespace1' ,
description = 'description1' ,
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' ,
},
receiveScript = 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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . DeleteNamespace (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.DeleteNamespaceRequest ;
import io.gs2.idle.result.DeleteNamespaceResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.DeleteNamespaceRequest ;
using Gs2.Gs2Idle.Result.DeleteNamespaceResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . DeleteNamespaceResult > asyncResult = null ;
yield return client . DeleteNamespace (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . deleteNamespace (
new Gs2Idle . DeleteNamespaceRequest ()
. withNamespaceName ( "namespace1" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . delete_namespace (
idle . DeleteNamespaceRequest ()
. with_namespace_name ( self . hash1 )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . DumpUserDataByUserId (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.DumpUserDataByUserIdRequest ;
import io.gs2.idle.result.DumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.DumpUserDataByUserIdRequest ;
using Gs2.Gs2Idle.Result.DumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . DumpUserDataByUserIdResult > asyncResult = null ;
yield return client . DumpUserDataByUserId (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . dumpUserDataByUserId (
new Gs2Idle . DumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . dump_user_data_by_user_id (
idle . DumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . CheckDumpUserDataByUserId (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.CheckDumpUserDataByUserIdRequest ;
import io.gs2.idle.result.CheckDumpUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.CheckDumpUserDataByUserIdRequest ;
using Gs2.Gs2Idle.Result.CheckDumpUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . CheckDumpUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckDumpUserDataByUserId (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . checkDumpUserDataByUserId (
new Gs2Idle . CheckDumpUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . check_dump_user_data_by_user_id (
idle . CheckDumpUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . CleanUserDataByUserId (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.CleanUserDataByUserIdRequest ;
import io.gs2.idle.result.CleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.CleanUserDataByUserIdRequest ;
using Gs2.Gs2Idle.Result.CleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . CleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CleanUserDataByUserId (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . cleanUserDataByUserId (
new Gs2Idle . CleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . clean_user_data_by_user_id (
idle . CleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . CheckCleanUserDataByUserId (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.CheckCleanUserDataByUserIdRequest ;
import io.gs2.idle.result.CheckCleanUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.CheckCleanUserDataByUserIdRequest ;
using Gs2.Gs2Idle.Result.CheckCleanUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . CheckCleanUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckCleanUserDataByUserId (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . checkCleanUserDataByUserId (
new Gs2Idle . CheckCleanUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . check_clean_user_data_by_user_id (
idle . CheckCleanUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . PrepareImportUserDataByUserId (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.PrepareImportUserDataByUserIdRequest ;
import io.gs2.idle.result.PrepareImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.PrepareImportUserDataByUserIdRequest ;
using Gs2.Gs2Idle.Result.PrepareImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . PrepareImportUserDataByUserIdResult > asyncResult = null ;
yield return client . PrepareImportUserDataByUserId (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . prepareImportUserDataByUserId (
new Gs2Idle . PrepareImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
);
const uploadToken = result . getUploadToken ();
const uploadUrl = result . getUploadUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . prepare_import_user_data_by_user_id (
idle . 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 ( 'idle' )
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . ImportUserDataByUserId (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.ImportUserDataByUserIdRequest ;
import io.gs2.idle.result.ImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.ImportUserDataByUserIdRequest ;
using Gs2.Gs2Idle.Result.ImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . ImportUserDataByUserIdResult > asyncResult = null ;
yield return client . ImportUserDataByUserId (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . importUserDataByUserId (
new Gs2Idle . ImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
);
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . import_user_data_by_user_id (
idle . ImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_upload_token ( 'upload-0001' )
)
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . CheckImportUserDataByUserId (
& idle . 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\Idle\Gs2IdleRestClient ;
use Gs2\Idle\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.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.CheckImportUserDataByUserIdRequest ;
import io.gs2.idle.result.CheckImportUserDataByUserIdResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( 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.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.CheckImportUserDataByUserIdRequest ;
using Gs2.Gs2Idle.Result.CheckImportUserDataByUserIdResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . CheckImportUserDataByUserIdResult > asyncResult = null ;
yield return client . CheckImportUserDataByUserId (
new Gs2 . Gs2Idle . 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 Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . checkImportUserDataByUserId (
new Gs2Idle . CheckImportUserDataByUserIdRequest ()
. withUserId ( "user-0001" )
. withUploadToken ( "upload-0001" )
);
const url = result . getUrl ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . check_import_user_data_by_user_id (
idle . CheckImportUserDataByUserIdRequest ()
. with_user_id ( 'user-0001' )
. with_upload_token ( 'upload-0001' )
)
url = result . url
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
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 ;
describeCategoryModelMasters Get list of category model masters
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 32 chars Namespace name pageToken string ~ 1024 chars Token specifying the position from which to start acquiring data limit int ✓ 30 1 ~ 1000 Number of data acquired
Result Type Description items List<CategoryModelMaster> List of Category Model Masters 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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . DescribeCategoryModelMasters (
& idle . DescribeCategoryModelMastersRequest {
NamespaceName : pointy . String ( "namespace1" ),
PageToken : nil ,
Limit : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
items := result . Items
nextPageToken := result . NextPageToken
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Idle\Gs2IdleRestClient ;
use Gs2\Idle\Request\DescribeCategoryModelMastersRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> describeCategoryModelMasters (
( new DescribeCategoryModelMastersRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withPageToken ( null )
-> withLimit ( null )
);
$items = $result -> getItems ();
$nextPageToken = $result -> getNextPageToken ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.DescribeCategoryModelMastersRequest ;
import io.gs2.idle.result.DescribeCategoryModelMastersResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( session );
try {
DescribeCategoryModelMastersResult result = client . describeCategoryModelMasters (
new DescribeCategoryModelMastersRequest ()
. withNamespaceName ( "namespace1" )
. withPageToken ( null )
. withLimit ( null )
);
List < CategoryModelMaster > items = result . getItems ();
String nextPageToken = result . getNextPageToken ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.DescribeCategoryModelMastersRequest ;
using Gs2.Gs2Idle.Result.DescribeCategoryModelMastersResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . DescribeCategoryModelMastersResult > asyncResult = null ;
yield return client . DescribeCategoryModelMasters (
new Gs2 . Gs2Idle . Request . DescribeCategoryModelMastersRequest ()
. WithNamespaceName ( "namespace1" )
. WithPageToken ( null )
. WithLimit ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var items = result . Items ;
var nextPageToken = result . NextPageToken ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . describeCategoryModelMasters (
new Gs2Idle . DescribeCategoryModelMastersRequest ()
. withNamespaceName ( "namespace1" )
. withPageToken ( null )
. withLimit ( null )
);
const items = result . getItems ();
const nextPageToken = result . getNextPageToken ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . describe_category_model_masters (
idle . DescribeCategoryModelMastersRequest ()
. with_namespace_name ( self . hash1 )
. with_page_token ( None )
. with_limit ( None )
)
items = result . items
next_page_token = result . next_page_token
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
api_result = client.describe_category_model_masters ({
namespaceName = 'namespace1' ,
pageToken = nil ,
limit = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
items = result.items ;
nextPageToken = result.nextPageToken ;
createCategoryModelMaster Create new category model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 32 chars Namespace name name string ✓ ~ 128 chars Category Model Name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata rewardIntervalMinutes int ✓ ~ 2147483646 Interval at which idle rewards can be obtained (minutes) defaultMaximumIdleMinutes int ✓ ~ 2147483646 Maximum time to get idle rewards (minutes) acquireActions List<AcquireActionList> ✓ 1 ~ 100 items List of acquire actions for each waiting time idlePeriodScheduleId string ~ 1024 chars GS2-Schedule event GRN with time period used for idle rewards calculation receivePeriodScheduleId string ~ 1024 chars GS2-Schedule EventGRN that sets the period during which idle rewards can be obtained
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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . CreateCategoryModelMaster (
& idle . CreateCategoryModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
Name : pointy . String ( "category-model-0001" ),
Description : nil ,
Metadata : nil ,
RewardIntervalMinutes : pointy . Int32 ( 5 ),
DefaultMaximumIdleMinutes : pointy . Int32 ( 1440 ),
AcquireActions : [] idle . AcquireActionList {
idle . AcquireActionList {
AcquireActions : [] idle . AcquireAction {
idle . AcquireAction {
Action : pointy . String ( "Gs2Experience:AddExperienceByUserId" ),
Request : pointy . String ( "Gs2Experience:AddExperienceByUserId-request1" ),
},
idle . AcquireAction {
Action : pointy . String ( "Gs2Experience:AddExperienceByUserId" ),
Request : pointy . String ( "Gs2Experience:AddExperienceByUserId-request2" ),
},
},
},
idle . AcquireActionList {
AcquireActions : [] idle . AcquireAction {
idle . AcquireAction {
Action : pointy . String ( "Gs2Experience:AddExperienceByUserId" ),
Request : pointy . String ( "Gs2Experience:AddExperienceByUserId-request3" ),
},
},
},
},
IdlePeriodScheduleId : nil ,
ReceivePeriodScheduleId : nil ,
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Idle\Gs2IdleRestClient ;
use Gs2\Idle\Request\CreateCategoryModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> createCategoryModelMaster (
( new CreateCategoryModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withName ( "category-model-0001" )
-> withDescription ( null )
-> withMetadata ( null )
-> withRewardIntervalMinutes ( 5 )
-> withDefaultMaximumIdleMinutes ( 1440 )
-> withAcquireActions ([ ( new \Gs2\Idle\Model\AcquireActionList ())
-> withAcquireActions ([ ( new \Gs2\Idle\Model\AcquireAction ())
-> withAction ( "Gs2Experience:AddExperienceByUserId" )
-> withRequest ( "Gs2Experience:AddExperienceByUserId-request1" ),
( new \Gs2\Idle\Model\AcquireAction ())
-> withAction ( "Gs2Experience:AddExperienceByUserId" )
-> withRequest ( "Gs2Experience:AddExperienceByUserId-request2" ),
]),
( new \Gs2\Idle\Model\AcquireActionList ())
-> withAcquireActions ([ ( new \Gs2\Idle\Model\AcquireAction ())
-> withAction ( "Gs2Experience:AddExperienceByUserId" )
-> withRequest ( "Gs2Experience:AddExperienceByUserId-request3" ),
]),
])
-> withIdlePeriodScheduleId ( null )
-> withReceivePeriodScheduleId ( null )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.CreateCategoryModelMasterRequest ;
import io.gs2.idle.result.CreateCategoryModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( session );
try {
CreateCategoryModelMasterResult result = client . createCategoryModelMaster (
new CreateCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withName ( "category-model-0001" )
. withDescription ( null )
. withMetadata ( null )
. withRewardIntervalMinutes ( 5 )
. withDefaultMaximumIdleMinutes ( 1440 )
. withAcquireActions ( Arrays . asList (
new io . gs2 . idle . model . AcquireActionList ()
. withAcquireActions ( Arrays . asList (
new io . gs2 . idle . model . AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "Gs2Experience:AddExperienceByUserId-request1" ),
new io . gs2 . idle . model . AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "Gs2Experience:AddExperienceByUserId-request2" )
)),
new io . gs2 . idle . model . AcquireActionList ()
. withAcquireActions ( Arrays . asList (
new io . gs2 . idle . model . AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "Gs2Experience:AddExperienceByUserId-request3" )
))
))
. withIdlePeriodScheduleId ( null )
. withReceivePeriodScheduleId ( null )
);
CategoryModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.CreateCategoryModelMasterRequest ;
using Gs2.Gs2Idle.Result.CreateCategoryModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . CreateCategoryModelMasterResult > asyncResult = null ;
yield return client . CreateCategoryModelMaster (
new Gs2 . Gs2Idle . Request . CreateCategoryModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithName ( "category-model-0001" )
. WithDescription ( null )
. WithMetadata ( null )
. WithRewardIntervalMinutes ( 5 )
. WithDefaultMaximumIdleMinutes ( 1440 )
. WithAcquireActions ( new Gs2 . Gs2Idle . Model . AcquireActionList [] {
new Gs2 . Gs2Idle . Model . AcquireActionList ()
. WithAcquireActions ( new Gs2 . Core . Model . AcquireAction [] {
new Gs2 . Core . Model . AcquireAction ()
. WithAction ( "Gs2Experience:AddExperienceByUserId" )
. WithRequest ( "Gs2Experience:AddExperienceByUserId-request1" ),
new Gs2 . Core . Model . AcquireAction ()
. WithAction ( "Gs2Experience:AddExperienceByUserId" )
. WithRequest ( "Gs2Experience:AddExperienceByUserId-request2" )
}),
new Gs2 . Gs2Idle . Model . AcquireActionList ()
. WithAcquireActions ( new Gs2 . Core . Model . AcquireAction [] {
new Gs2 . Core . Model . AcquireAction ()
. WithAction ( "Gs2Experience:AddExperienceByUserId" )
. WithRequest ( "Gs2Experience:AddExperienceByUserId-request3" )
})
})
. WithIdlePeriodScheduleId ( null )
. WithReceivePeriodScheduleId ( null ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . createCategoryModelMaster (
new Gs2Idle . CreateCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withName ( "category-model-0001" )
. withDescription ( null )
. withMetadata ( null )
. withRewardIntervalMinutes ( 5 )
. withDefaultMaximumIdleMinutes ( 1440 )
. withAcquireActions ([
new Gs2Idle . model . AcquireActionList ()
. withAcquireActions ([
new Gs2Idle . model . AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "Gs2Experience:AddExperienceByUserId-request1" ),
new Gs2Idle . model . AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "Gs2Experience:AddExperienceByUserId-request2" )
]),
new Gs2Idle . model . AcquireActionList ()
. withAcquireActions ([
new Gs2Idle . model . AcquireAction ()
. withAction ( "Gs2Experience:AddExperienceByUserId" )
. withRequest ( "Gs2Experience:AddExperienceByUserId-request3" )
])
])
. withIdlePeriodScheduleId ( null )
. withReceivePeriodScheduleId ( null )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . create_category_model_master (
idle . CreateCategoryModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_name ( 'category-model-0001' )
. with_description ( None )
. with_metadata ( None )
. with_reward_interval_minutes ( 5 )
. with_default_maximum_idle_minutes ( 1440 )
. with_acquire_actions ([ idle . AcquireActionList ()
. with_acquire_actions ([ idle . AcquireAction ()
. with_action ( 'Gs2Experience:AddExperienceByUserId' )
. with_request ( 'Gs2Experience:AddExperienceByUserId-request1' ),
idle . AcquireAction ()
. with_action ( 'Gs2Experience:AddExperienceByUserId' )
. with_request ( 'Gs2Experience:AddExperienceByUserId-request2' ),
]),
idle . AcquireActionList ()
. with_acquire_actions ([ idle . AcquireAction ()
. with_action ( 'Gs2Experience:AddExperienceByUserId' )
. with_request ( 'Gs2Experience:AddExperienceByUserId-request3' ),
]),
])
. with_idle_period_schedule_id ( None )
. with_receive_period_schedule_id ( None )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
api_result = client.create_category_model_master ({
namespaceName = 'namespace1' ,
name = 'category-model-0001' ,
description = nil ,
metadata = nil ,
rewardIntervalMinutes = 5 ,
defaultMaximumIdleMinutes = 1440 ,
acquireActions = {
{
acquireActions = {
{
action = 'Gs2Experience:AddExperienceByUserId' ,
request = 'Gs2Experience:AddExperienceByUserId-request1' ,
},
{
action = 'Gs2Experience:AddExperienceByUserId' ,
request = 'Gs2Experience:AddExperienceByUserId-request2' ,
}
},
},
{
acquireActions = {
{
action = 'Gs2Experience:AddExperienceByUserId' ,
request = 'Gs2Experience:AddExperienceByUserId-request3' ,
}
},
}
},
idlePeriodScheduleId = nil ,
receivePeriodScheduleId = nil ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
getCategoryModelMaster Get Experience model master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 32 chars Namespace name categoryName string ✓ ~ 128 chars Category Model 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/idle"
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 := idle . Gs2IdleRestClient {
Session : & session ,
}
result , err := client . GetCategoryModelMaster (
& idle . GetCategoryModelMasterRequest {
NamespaceName : pointy . String ( "namespace1" ),
CategoryName : pointy . String ( "category-model-0001" ),
}
)
if err != nil {
panic ( "error occurred" )
}
item := result . Item
use Gs2\Core\Model\BasicGs2Credential ;
use Gs2\Core\Model\Region ;
use Gs2\Core\Net\Gs2RestSession ;
use Gs2\Core\Exception\Gs2Exception ;
use Gs2\Idle\Gs2IdleRestClient ;
use Gs2\Idle\Request\GetCategoryModelMasterRequest ;
$session = new Gs2RestSession (
new BasicGs2Credential (
"your client id" ,
"your client secret"
),
Region :: AP_NORTHEAST_1
);
$session -> open ();
$client = new Gs2AccountRestClient (
$session
);
try {
$result = $client -> getCategoryModelMaster (
( new GetCategoryModelMasterRequest ())
-> withNamespaceName ( self :: namespace1 )
-> withCategoryName ( "category-model-0001" )
);
$item = $result -> getItem ();
} catch ( Gs2Exception $e ) {
exit ( "error occurred" )
}
import io.gs2.core.model.Region ;
import io.gs2.core.model.BasicGs2Credential ;
import io.gs2.core.rest.Gs2RestSession ;
import io.gs2.core.exception.Gs2Exception ;
import io.gs2.idle.rest.Gs2IdleRestClient ;
import io.gs2.idle.request.GetCategoryModelMasterRequest ;
import io.gs2.idle.result.GetCategoryModelMasterResult ;
Gs2RestSession session = new Gs2RestSession (
Region . AP_NORTHEAST_1 ,
new BasicGs2Credential (
' your client id ' ,
' your client secret '
)
);
session . connect ();
Gs2IdleRestClient client = new Gs2IdleRestClient ( session );
try {
GetCategoryModelMasterResult result = client . getCategoryModelMaster (
new GetCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-model-0001" )
);
CategoryModelMaster item = result . getItem ();
} catch ( Gs2Exception e ) {
System . exit ( 1 );
}
using Gs2.Core.Model.Region ;
using Gs2.Core.Model.BasicGs2Credential ;
using Gs2.Core.Net.Gs2RestSession ;
using Gs2.Core.Exception.Gs2Exception ;
using Gs2.Core.AsyncResult ;
using Gs2.Gs2Idle.Gs2IdleRestClient ;
using Gs2.Gs2Idle.Request.GetCategoryModelMasterRequest ;
using Gs2.Gs2Idle.Result.GetCategoryModelMasterResult ;
var session = new Gs2RestSession (
new BasicGs2Credential (
' your client id ' ,
' your client secret '
),
Region . ApNortheast1
);
yield return session . Open ();
var client = new Gs2IdleRestClient ( session );
AsyncResult < Gs2 . Gs2Idle . Result . GetCategoryModelMasterResult > asyncResult = null ;
yield return client . GetCategoryModelMaster (
new Gs2 . Gs2Idle . Request . GetCategoryModelMasterRequest ()
. WithNamespaceName ( "namespace1" )
. WithCategoryName ( "category-model-0001" ),
r => asyncResult = r
);
if ( asyncResult . Error != null ) {
throw asyncResult . Error ;
}
var result = asyncResult . Result ;
var item = result . Item ;
import Gs2Core from '@/gs2/core' ;
import * as Gs2Idle from '@/gs2/idle' ;
const session = new Gs2Core . Gs2RestSession (
"ap-northeast-1" ,
new Gs2Core . BasicGs2Credential (
'your client id' ,
'your client secret'
)
);
await session . connect ();
const client = new Gs2Idle . Gs2IdleRestClient ( session );
try {
const result = await client . getCategoryModelMaster (
new Gs2Idle . GetCategoryModelMasterRequest ()
. withNamespaceName ( "namespace1" )
. withCategoryName ( "category-model-0001" )
);
const item = result . getItem ();
} catch ( e ) {
process . exit ( 1 );
}
from gs2 import core
from gs2 import idle
session = core . Gs2RestSession (
core . BasicGs2Credential (
'your client id' ,
'your client secret'
),
"ap-northeast-1" ,
)
session . connect ()
client = idle . Gs2IdleRestClient ( session )
try :
result = client . get_category_model_master (
idle . GetCategoryModelMasterRequest ()
. with_namespace_name ( self . hash1 )
. with_category_name ( 'category-model-0001' )
)
item = result . item
except core . Gs2Exception as e :
exit ( 1 )
client = gs2 ( 'idle' )
api_result = client.get_category_model_master ({
namespaceName = 'namespace1' ,
categoryName = 'category-model-0001' ,
})
if ( api_result.isError ) then
-- When error occurs
fail ( api_result [ 'statusCode' ], api_result [ 'message' ])
end
result = api_result.result
item = result.item ;
updateCategoryModelMaster Update Category Model Master
Request Type Condition Require Default Limitation Description namespaceName string ✓ ~ 32 chars Namespace name categoryName string ✓ ~ 128 chars Category Model Name description string ~ 1024 chars Description metadata string ~ 2048 chars metadata rewardIntervalMinutes int ✓ ~ 2147483646 Interval at which idle rewards can be obtained (minutes) defaultMaximumIdleMinutes int ✓ ~ 2147483646 Maximum time to get idle rewards (minutes) acquireActions List<AcquireActionList> ✓ 1 ~ 100 items List of acquire actions for each waiting time idlePeriodScheduleId string ~ 1024 chars GS2-Schedule event GRN with time period used for idle rewards calculation receivePeriodScheduleId string ~ 1024 chars GS2-Schedule EventGRN that sets the period during which idle rewards can be obtained
Result Implementation Example
Language:
Go
PHP
Java
C#
TypeScript
Python
GS2-Script import "github.com/gs2io/gs2-golang-sdk/core"