> For the complete documentation index, see [llms.txt](/llms.txt) # GS2-Idle SDK API リファレンス 各種プログラミング言語向け GS2-Idle SDK の モデルの仕様 と API のリファレンス ## モデル ### Namespace ネームスペース
ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceId | string | | ※ | | ~ 1024文字 | ネームスペースGRN
※ サーバーが自動で設定 | | name | string | | ✓ | | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | transactionSetting | [TransactionSetting](#transactionsetting) | | ✓ | | | トランザクション設定
放置報酬の付与時のトランザクションの処理方法を制御する設定です。 | | receiveScript | [ScriptSetting](#scriptsetting) | | | | | 報酬を受け取ったときに実行するスクリプトの設定
Script トリガーリファレンス - [`receive`](../script/#receive) | | overrideAcquireActionsScriptId | string | | | | ~ 1024文字 | 放置報酬の入手アクションを動的に決定するスクリプトGRN
Script トリガーリファレンス - [`overrideAcquireActions`](../script/#overrideacquireactions) | | logSetting | [LogSetting](#logsetting) | | | | | ログの出力設定
放置報酬操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。放置ステータスの作成、報酬の受け取り、タイミング問題のデバッグに役立ちます。 | | createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | updatedAt | long | | ※ | 現在時刻 | | 最終更新日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン | **関連するメソッド:** describeNamespaces - ネームスペースの一覧を取得 createNamespace - ネームスペースを新規作成 getNamespace - ネームスペースを取得 updateNamespace - ネームスペースを更新 deleteNamespace - ネームスペースを削除 --- ### TransactionSetting トランザクション設定
トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | enableAutoRun | bool | | | false | | 発行したトランザクションをサーバーサイドで自動的に実行するか | | enableAtomicCommit | bool | {enableAutoRun} == true | | false | | トランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば 有効 | | transactionUseDistributor | bool | {enableAtomicCommit} == true | | false | | トランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば 有効 | | commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | | false | | スクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば 有効 | | acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | | false | | 入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば 有効 | | distributorNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:distributor:default" | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN | | queueNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:queue:default" | ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペースGRN | **関連するメソッド:** createNamespace - ネームスペースを新規作成 updateNamespace - ネームスペースを更新 **関連するモデル:** Namespace - ネームスペース --- ### ScriptSetting スクリプト設定
GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。
スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。
一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。
非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | triggerScriptId | string | | | | ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプトGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 | | doneTriggerTargetType | 文字列列挙型
enum {
  "none",
  "gs2_script",
  "aws"
}
| | | "none" | | 非同期スクリプトの実行方法
非同期実行で使用するスクリプトの種類を指定します。
「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。"none": なし / "gs2_script": GS2-Script / "aws": Amazon EventBridge / | | doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024文字 | 非同期実行する GS2-Script スクリプトGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
※ doneTriggerTargetType が "gs2_script" であれば 有効 | | doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペースGRN
非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。
GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。
※ doneTriggerTargetType が "gs2_script" であれば 有効 | **関連するメソッド:** createNamespace - ネームスペースを新規作成 updateNamespace - ネームスペースを更新 **関連するモデル:** Namespace - ネームスペース --- ### LogSetting ログの出力設定
ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | loggingNamespaceId | string | | ✓ | | ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 | **関連するメソッド:** createNamespace - ネームスペースを新規作成 updateNamespace - ネームスペースを更新 **関連するモデル:** Namespace - ネームスペース --- ### GitHubCheckoutSetting GitHubからマスターデータをチェックアウトする設定 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | apiKeyId | string | | ✓ | | ~ 1024文字 | GitHub APIキーのGRN | | repositoryName | string | | ✓ | | ~ 1024文字 | リポジトリ名 | | sourcePath | string | | ✓ | | ~ 1024文字 | マスターデータ（JSON）ファイルのパス | | referenceType | 文字列列挙型
enum {
  "commit_hash",
  "branch",
  "tag"
}
| | ✓ | | | コードの取得元"commit_hash": コミットハッシュ / "branch": ブランチ / "tag": タグ / | | commitHash | string | {referenceType} == "commit_hash" | ✓※ | | ~ 1024文字 | コミットハッシュ
※ referenceType が "commit_hash" であれば 必須 | | branchName | string | {referenceType} == "branch" | ✓※ | | ~ 1024文字 | ブランチ名
※ referenceType が "branch" であれば 必須 | | tagName | string | {referenceType} == "tag" | ✓※ | | ~ 1024文字 | タグ名
※ referenceType が "tag" であれば 必須 | **関連するメソッド:** updateCurrentCategoryMasterFromGitHub - 現在アクティブなカテゴリーモデルのマスターデータをGitHubから更新 --- ### Status ステータス
初めて GetIdleStatus を呼び出した時に作成され、その時間から放置時間のカウントが始まります。
放置時間のカウントは報酬を受け取るとリセットされます。
GS2-Schedule のイベントが関連づけられている場合、イベントの開催前には Category にアクセスできず、ステータスを作成することもできません。
イベントが関連づけられている場合、ステータス はイベントの繰り返し回数を保持します。
現在のイベントIDとステータス作成時のイベントIDが一致しない場合、現在のイベントの繰り返し回数とステータスが保持する繰り返し回数が一致しない場合、またはイベントの開始時刻より前にステータスが作成されている場合、待機時間 はリセットされます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | statusId | string | | ※ | | ~ 1024文字 | ステータスGRN
※ サーバーが自動で設定 | | categoryName | string | | ✓ | | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | userId | string | | ✓ | | ~ 128文字 | ユーザーID | | randomSeed | long | | | 0 | 0 ~ 9223372036854775805 | 乱数シード
放置報酬の計算時に決定論的な乱数生成に使用されるシード値です。報酬計算が再現可能で一貫性があることを保証し、サーバーが報酬結果を検証できるようにします。報酬を受け取るたびに更新されます。 | | idleMinutes | int | | ✓ | | 0 ~ 2147483646 | 放置時間（分）
最後の報酬受け取りまたはステータス作成からの累積放置時間（分）です。この値は idleStartedAt からの経過時間から計算され、maximumIdleMinutes で上限が設定されます。利用可能な報酬数はこの値をカテゴリーモデルの rewardIntervalMinutes で割ることで決定されます。 | | nextRewardsAt | long | | | | | 次に追加の報酬が得られる時刻
UNIX 時間・ミリ秒 | | maximumIdleMinutes | int | | | 0 | 0 ~ 2147483646 | 最大放置時間（分）
このステータスが蓄積できる最大放置時間（分）です。ステータス作成時にカテゴリーモデルの defaultMaximumIdleMinutes から初期化されます。入手アクションを通じてユーザーごとに増加でき、プレミアムユーザーやイベント参加者がより多くの放置報酬を蓄積できるようにします。 | | createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | updatedAt | long | | ※ | 現在時刻 | | 最終更新日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン | **関連するメソッド:** describeStatuses - ステータスの一覧を取得 describeStatusesByUserId - ユーザーIDを指定してステータスの一覧を取得 getStatus - ステータスを取得 getStatusByUserId - ユーザーIDを指定してステータスを取得 prediction - 獲得報酬の一覧を取得 predictionByUserId - ユーザーIDを指定して獲得報酬の一覧を取得 receive - 報酬を受け取る receiveByUserId - ユーザーIDを指定して報酬を受け取る increaseMaximumIdleMinutesByUserId - ユーザーIDを指定して最大待機時間を加算 decreaseMaximumIdleMinutes - 最大待機時間を減算 decreaseMaximumIdleMinutesByUserId - ユーザーIDを指定して最大待機時間を減算 setMaximumIdleMinutesByUserId - ユーザーIDを指定して最大待機時間を設定 --- ### CategoryModel カテゴリーモデル
カテゴリーモデルとは、放置報酬を得られる待機カテゴリーを設定するエンティティです。
設定には、待機時間ごとの報酬や、最大待機時間などの情報が含まれます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | categoryModelId | string | | ※ | | ~ 1024文字 | カテゴリーモデルGRN
※ サーバーが自動で設定 | | name | string | | ✓ | | ~ 128文字 | カテゴリーモデル名
カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | metadata | string | | | | ~ 2048文字 | メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | | rewardIntervalMinutes | int | | ✓ | | 0 ~ 2147483646 | 報酬間隔（分）
各放置報酬の間の時間間隔（分）です。例えば60に設定すると、ユーザーは放置時間60分ごとに1つの報酬ユニットを獲得します。報酬の総数は（経過放置分数）/ rewardIntervalMinutes として計算され、acquireActions配列を循環します。 | | defaultMaximumIdleMinutes | int | | ✓ | | 0 ~ 2147483646 | デフォルト最大放置時間（分）
このカテゴリーの新しいステータスに対するデフォルトの最大放置時間（分）です。この制限を超える放置時間は追加の報酬を蓄積しません。この値はステータス作成時に各ステータスの maximumIdleMinutes にコピーされ、入手アクションを通じてユーザーごとに拡張できます。 | | rewardResetMode | 文字列列挙型
enum {
  "Reset",
  "CarryOver"
}
| | | "Reset" | | 報酬リセットモード
ユーザーが報酬を受け取った後の放置時間の扱いを決定します。「Reset」は放置時間をゼロに戻し、部分的な間隔時間は失われます。「CarryOver」は追加の報酬を得るに足りなかった残り時間を保持し、次の報酬サイクルにカウントされます。"Reset": 待機時間を0にリセット / "CarryOver": 報酬を得るに至らなかった残り時間を持ち越す / | | acquireActions | [List<AcquireActionList>](#acquireactionlist) | | | [] | 1 ~ 100 items | 待機時間ごとに得られる入手アクションリスト
待機時間を「X分」だと仮定すると
「X / rewardIntervalMinutes」が報酬を受け取れる数になりますが、ここで指定した配列の要素をループすることで、待機時間ごとに異なる報酬を付与できます。 | | idlePeriodScheduleId | string | | | | ~ 1024文字 | 放置期間スケジュールID
放置時間が蓄積される期間を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ放置時間がカウントされます。イベントが繰り返される場合、ステータスは繰り返し回数を追跡し、新しいサイクルの開始時に放置時間をリセットして、イベント期間ごとに報酬が計算されるようにします。 | | receivePeriodScheduleId | string | | | | ~ 1024文字 | 受取期間スケジュールID
ユーザーが蓄積された放置報酬を受け取れる時間枠を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ報酬の受け取りが受け付けられます。これにより、放置蓄積期間とは別の期間限定の報酬受取期間を設定できます。 | **関連するメソッド:** describeCategoryModels - カテゴリーモデルの一覧を取得 getCategoryModel - カテゴリーモデルを取得 --- ### VerifyActionResult 検証アクションの実行結果 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | action | 文字列列挙型
enum {
}
| | ✓ | | | 検証アクションで実行するアクションの種類 | | verifyRequest | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 | | statusCode | int | | | | 0 ~ 999 | ステータスコード | | verifyResult | string | | | | ~ 1048576文字 | 結果内容 | **関連するモデル:** TransactionResult - トランザクション実行結果 --- ### ConsumeActionResult 消費アクションの実行結果 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | action | 文字列列挙型
enum {
}
| | ✓ | | | 消費アクションで実行するアクションの種類 | | consumeRequest | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 | | statusCode | int | | | | 0 ~ 999 | ステータスコード | | consumeResult | string | | | | ~ 1048576文字 | 結果内容 | **関連するモデル:** TransactionResult - トランザクション実行結果 --- ### AcquireActionResult 入手アクションの実行結果 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | action | 文字列列挙型
enum {
}
| | ✓ | | | 入手アクションで実行するアクションの種類 | | acquireRequest | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 | | statusCode | int | | | | 0 ~ 999 | ステータスコード | | acquireResult | string | | | | ~ 1048576文字 | 結果内容 | **関連するモデル:** TransactionResult - トランザクション実行結果 --- ### TransactionResult トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | transactionId | string | | ✓ | | 36 ~ 36文字 | トランザクションID | | verifyResults | [List<VerifyActionResult>](#verifyactionresult) | | | | 0 ~ 10 items | 検証アクションの実行結果リスト | | consumeResults | [List<ConsumeActionResult>](#consumeactionresult) | | | [] | 0 ~ 10 items | 消費アクションの実行結果リスト | | acquireResults | [List<AcquireActionResult>](#acquireactionresult) | | | [] | 0 ~ 100 items | 入手アクションの実行結果リスト | | hasError | bool | | | false | | トランザクション実行中にエラーが発生したかどうか | **関連するメソッド:** receive - 報酬を受け取る receiveByUserId - ユーザーIDを指定して報酬を受け取る --- ### Config コンフィグ設定
トランザクションの変数に適用する設定値 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | key | string | | ✓ | | ~ 64文字 | 名前 | | value | string | | | | ~ 51200文字 | 値 | --- ### AcquireAction 入手アクション
放置報酬として使用される単一の入手アクションを表します。アクションタイプ（例：アイテム追加、通貨増加）とそのリクエストパラメータで構成されます。放置報酬が受け取られると、これらのアクションがトランザクションに組み立てられ、実行されてユーザーに報酬が配布されます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | action | 文字列列挙型
enum {
}
| | ✓ | | | 入手アクションで実行するアクションの種類 | | request | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 | **関連するメソッド:** prediction - 獲得報酬の一覧を取得 predictionByUserId - ユーザーIDを指定して獲得報酬の一覧を取得 receive - 報酬を受け取る receiveByUserId - ユーザーIDを指定して報酬を受け取る **関連するモデル:** AcquireActionList - 入手アクションリスト --- ### AcquireActionList 入手アクションリスト
1つの報酬間隔で一括して付与される複数の入手アクションをグループ化するラッパーです。各 AcquireActionList はカテゴリーモデルの acquireActions 配列内の1つの報酬サイクルに対応し、各間隔で異なる報酬の組み合わせを設定できます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | acquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | 入手アクションリスト
この報酬間隔がトリガーされた時に一括で実行される入手アクションのコレクションです。複数のアクションを組み合わせて、1つの放置報酬サイクルで異なる種類の報酬を同時に付与できます。リストあたり最大100アクションです。 | **関連するモデル:** CategoryModel - カテゴリーモデル CategoryModelMaster - カテゴリーモデルマスター --- ### CurrentCategoryMaster 現在アクティブなカテゴリーモデルのマスターデータ
現在ネームスペース内で有効な、カテゴリーモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。 {{% alert title="Note" color="info" %}} JSONファイルの形式については [GS2-Idle マスターデータリファレンス](api_reference/idle/master_data/) をご参照ください。 {{% /alert %}} | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceId | string | | ※ | | ~ 1024文字 | ネームスペースGRN
※ サーバーが自動で設定 | | settings | string | | ✓ | | ~ 5242880 バイト (5MB) | マスターデータ | **関連するメソッド:** exportMaster - カテゴリーモデルマスターを有効化可能なマスターデータ形式でエクスポート getCurrentCategoryMaster - 現在アクティブなカテゴリーモデルのマスターデータを取得 updateCurrentCategoryMaster - 現在アクティブなカテゴリーモデルのマスターデータを更新 updateCurrentCategoryMasterFromGitHub - 現在アクティブなカテゴリーモデルのマスターデータをGitHubから更新 --- ### CategoryModelMaster カテゴリーモデルマスター
カテゴリーモデルマスターは、ゲーム内で使用されるカテゴリーモデルの編集・管理用データで、マネージメントコンソールのマスターデータエディタで一時的に保持されます。
インポート・更新処理を行うことで、実際にゲームから参照されるカテゴリーモデルとして反映されます。
カテゴリーモデルとは、放置報酬を得られる待機カテゴリーを設定するエンティティです。
設定には、待機時間ごとの報酬や、最大待機時間などの情報が含まれます。 | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | categoryModelId | string | | ※ | | ~ 1024文字 | カテゴリーモデルマスターGRN
※ サーバーが自動で設定 | | name | string | | ✓ | | ~ 128文字 | カテゴリーモデル名
カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | metadata | string | | | | ~ 2048文字 | メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | | rewardIntervalMinutes | int | | ✓ | | 0 ~ 2147483646 | 報酬間隔（分）
各放置報酬の間の時間間隔（分）です。例えば60に設定すると、ユーザーは放置時間60分ごとに1つの報酬ユニットを獲得します。報酬の総数は（経過放置分数）/ rewardIntervalMinutes として計算され、acquireActions配列を循環します。 | | defaultMaximumIdleMinutes | int | | ✓ | | 0 ~ 2147483646 | デフォルト最大放置時間（分）
このカテゴリーの新しいステータスに対するデフォルトの最大放置時間（分）です。この制限を超える放置時間は追加の報酬を蓄積しません。この値はステータス作成時に各ステータスの maximumIdleMinutes にコピーされ、入手アクションを通じてユーザーごとに拡張できます。 | | rewardResetMode | 文字列列挙型
enum {
  "Reset",
  "CarryOver"
}
| | | "Reset" | | 報酬リセットモード
ユーザーが報酬を受け取った後の放置時間の扱いを決定します。「Reset」は放置時間をゼロに戻し、部分的な間隔時間は失われます。「CarryOver」は追加の報酬を得るに足りなかった残り時間を保持し、次の報酬サイクルにカウントされます。"Reset": 待機時間を0にリセット / "CarryOver": 報酬を得るに至らなかった残り時間を持ち越す / | | acquireActions | [List<AcquireActionList>](#acquireactionlist) | | | [] | 1 ~ 100 items | 待機時間ごとに得られる入手アクションリスト
待機時間を「X分」だと仮定すると
「X / rewardIntervalMinutes」が報酬を受け取れる数になりますが、ここで指定した配列の要素をループすることで、待機時間ごとに異なる報酬を付与できます。 | | idlePeriodScheduleId | string | | | | ~ 1024文字 | 放置期間スケジュールID
放置時間が蓄積される期間を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ放置時間がカウントされます。イベントが繰り返される場合、ステータスは繰り返し回数を追跡し、新しいサイクルの開始時に放置時間をリセットして、イベント期間ごとに報酬が計算されるようにします。 | | receivePeriodScheduleId | string | | | | ~ 1024文字 | 受取期間スケジュールID
ユーザーが蓄積された放置報酬を受け取れる時間枠を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ報酬の受け取りが受け付けられます。これにより、放置蓄積期間とは別の期間限定の報酬受取期間を設定できます。 | | createdAt | long | | ※ | 現在時刻 | | 作成日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | updatedAt | long | | ※ | 現在時刻 | | 最終更新日時
UNIX 時間・ミリ秒
※ サーバーが自動で設定 | | revision | long | | | 0 | 0 ~ 9223372036854775805 | リビジョン | **関連するメソッド:** describeCategoryModelMasters - カテゴリーモデルマスターの一覧を取得 createCategoryModelMaster - カテゴリーモデルマスターを新規作成 getCategoryModelMaster - カテゴリーモデルマスターを取得 updateCategoryModelMaster - カテゴリーモデルマスターを更新 deleteCategoryModelMaster - カテゴリーモデルマスターを削除 --- ## メソッド ### describeNamespaces ネームスペースの一覧を取得
プロジェクト内において、サービス単位で作成されたネームスペースの一覧を取得します。
オプションのページトークンを使用して、リストの特定の位置からデータの取得を開始できます。
また、取得するネームスペースの数を制限することも可能です。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namePrefix | string | | | | ~ 64文字 | ネームスペース名のフィルター接頭辞 | | pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン | | limit | int | | | 30 | 1 ~ 1000 | データの取得件数 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<Namespace>](#namespace) | ネームスペースのリスト | | nextPageToken | string | リストの続きを取得するためのページトークン | #### 実装例 **Go** ```go 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 { NamePrefix: nil, PageToken: nil, Limit: nil, } ) if err != nil { panic("error occurred") } items := result.Items nextPageToken := result.NextPageToken ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->describeNamespaces( (new DescribeNamespacesRequest()) ->withNamePrefix(null) ->withPageToken(null) ->withLimit(null) ); $items = $result->getItems(); $nextPageToken = $result->getNextPageToken(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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() .withNamePrefix(null) .withPageToken(null) .withLimit(null) ); List items = result.getItems(); String nextPageToken = result.getNextPageToken(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeNamespaces( new Gs2.Gs2Idle.Request.DescribeNamespacesRequest() .WithNamePrefix(null) .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; ``` **TypeScript** ```typescript 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() .withNamePrefix(null) .withPageToken(null) .withLimit(null) ); const items = result.getItems(); const nextPageToken = result.getNextPageToken(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_name_prefix(None) .with_page_token(None) .with_limit(None) ) items = result.items next_page_token = result.next_page_token except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.describe_namespaces({ namePrefix=nil, pageToken=nil, limit=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.describe_namespaces_async({ namePrefix=nil, pageToken=nil, limit=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` --- ### createNamespace ネームスペースを新規作成
GS2-Idle サービスの新しいネームスペースを作成します。
トランザクション設定、receiveScript（放置報酬の付与前に実行され、操作の検証や変更が可能）、overrideAcquireActionsScriptId（レート修正の適用など入手アクションを変更）、およびログ設定を構成できます。
作成後、放置報酬設定を定義するためにマスターデータ経由でカテゴリーモデルを設定する必要があります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | name | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | transactionSetting | [TransactionSetting](#transactionsetting) | | ✓| | | トランザクション設定
放置報酬の付与時のトランザクションの処理方法を制御する設定です。 | | receiveScript | [ScriptSetting](#scriptsetting) | | | | | 報酬を受け取ったときに実行するスクリプトの設定
Script トリガーリファレンス - [`receive`](../script/#receive) | | overrideAcquireActionsScriptId | string | | | | ~ 1024文字 | 放置報酬の入手アクションを動的に決定するスクリプトGRN
Script トリガーリファレンス - [`overrideAcquireActions`](../script/#overrideacquireactions) | | logSetting | [LogSetting](#logsetting) | | | | | ログの出力設定
放置報酬操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。放置ステータスの作成、報酬の受け取り、タイミング問題のデバッグに役立ちます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Namespace](#namespace) | 作成したネームスペース | #### 実装例 **Go** ```go 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("namespace-0001"), Description: nil, TransactionSetting: &idle.TransactionSetting{ EnableAutoRun: pointy.Bool(false), QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"), }, ReceiveScript: nil, OverrideAcquireActionsScriptId: nil, LogSetting: &idle.LogSetting{ LoggingNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"), }, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->createNamespace( (new CreateNamespaceRequest()) ->withName("namespace-0001") ->withDescription(null) ->withTransactionSetting((new \Gs2\Idle\Model\TransactionSetting()) ->withEnableAutoRun(false) ->withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")) ->withReceiveScript(null) ->withOverrideAcquireActionsScriptId(null) ->withLogSetting((new \Gs2\Idle\Model\LogSetting()) ->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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("namespace-0001") .withDescription(null) .withTransactionSetting(new io.gs2.idle.model.TransactionSetting() .withEnableAutoRun(false) .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")) .withReceiveScript(null) .withOverrideAcquireActionsScriptId(null) .withLogSetting(new io.gs2.idle.model.LogSetting() .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); Namespace item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.CreateNamespace( new Gs2.Gs2Idle.Request.CreateNamespaceRequest() .WithName("namespace-0001") .WithDescription(null) .WithTransactionSetting(new Gs2.Gs2Idle.Model.TransactionSetting() .WithEnableAutoRun(false) .WithQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")) .WithReceiveScript(null) .WithOverrideAcquireActionsScriptId(null) .WithLogSetting(new Gs2.Gs2Idle.Model.LogSetting() .WithLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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("namespace-0001") .withDescription(null) .withTransactionSetting(new Gs2Idle.model.TransactionSetting() .withEnableAutoRun(false) .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")) .withReceiveScript(null) .withOverrideAcquireActionsScriptId(null) .withLogSetting(new Gs2Idle.model.LogSetting() .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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('namespace-0001') .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_receive_script(None) .with_override_acquire_actions_script_id(None) .with_log_setting( idle.LogSetting() .with_logging_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001')) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.create_namespace({ name="namespace-0001", description=nil, transactionSetting={ enableAutoRun=false, queueNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001", }, receiveScript=nil, overrideAcquireActionsScriptId=nil, logSetting={ loggingNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001", }, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.create_namespace_async({ name="namespace-0001", description=nil, transactionSetting={ enableAutoRun=false, queueNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001", }, receiveScript=nil, overrideAcquireActionsScriptId=nil, logSetting={ loggingNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001", }, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getNamespaceStatus ネームスペースの状態を取得
指定されたネームスペースの現在の状態を取得します。
これには、ネームスペースがアクティブか、保留中か、またはその他の状態にあるかが含まれます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | status | string | | #### 実装例 **Go** ```go 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("namespace-0001"), } ) if err != nil { panic("error occurred") } status := result.Status ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->getNamespaceStatus( (new GetNamespaceStatusRequest()) ->withNamespaceName("namespace-0001") ); $status = $result->getStatus(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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("namespace-0001") ); String status = result.getStatus(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.GetNamespaceStatus( new Gs2.Gs2Idle.Request.GetNamespaceStatusRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var status = result.Status; ``` **TypeScript** ```typescript 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("namespace-0001") ); const status = result.getStatus(); } catch (e) { process.exit(1); } ``` **Python** ```python 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('namespace-0001') ) status = result.status except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.get_namespace_status({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result status = result.status; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.get_namespace_status_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result status = result.status; ``` --- ### getNamespace ネームスペースを取得
指定されたネームスペースの詳細情報を取得します。
これには、ネームスペースの名前、説明、およびその他の設定情報が含まれます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Namespace](#namespace) | ネームスペース | #### 実装例 **Go** ```go 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("namespace-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->getNamespace( (new GetNamespaceRequest()) ->withNamespaceName("namespace-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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("namespace-0001") ); Namespace item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.GetNamespace( new Gs2.Gs2Idle.Request.GetNamespaceRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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("namespace-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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('namespace-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.get_namespace({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.get_namespace_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### updateNamespace ネームスペースを更新
指定されたネームスペースの設定を更新します。
説明、トランザクション設定、receiveScript（放置報酬の付与前に実行）、overrideAcquireActionsScriptId（入手アクションの変更）、およびログ設定を変更できます。
変更は以降の操作に即座に反映されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | transactionSetting | [TransactionSetting](#transactionsetting) | | ✓| | | トランザクション設定
放置報酬の付与時のトランザクションの処理方法を制御する設定です。 | | receiveScript | [ScriptSetting](#scriptsetting) | | | | | 報酬を受け取ったときに実行するスクリプトの設定
Script トリガーリファレンス - [`receive`](../script/#receive) | | overrideAcquireActionsScriptId | string | | | | ~ 1024文字 | 放置報酬の入手アクションを動的に決定するスクリプトGRN
Script トリガーリファレンス - [`overrideAcquireActions`](../script/#overrideacquireactions) | | logSetting | [LogSetting](#logsetting) | | | | | ログの出力設定
放置報酬操作に関連するAPIリクエストおよびレスポンスログを出力するためのGS2-Logネームスペースを指定します。放置ステータスの作成、報酬の受け取り、タイミング問題のデバッグに役立ちます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Namespace](#namespace) | 更新したネームスペース | #### 実装例 **Go** ```go 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("namespace-0001"), Description: pointy.String("description1"), TransactionSetting: &idle.TransactionSetting{ EnableAutoRun: pointy.Bool(false), QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002"), }, ReceiveScript: nil, OverrideAcquireActionsScriptId: nil, LogSetting: &idle.LogSetting{ LoggingNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"), }, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->updateNamespace( (new UpdateNamespaceRequest()) ->withNamespaceName("namespace-0001") ->withDescription("description1") ->withTransactionSetting((new \Gs2\Idle\Model\TransactionSetting()) ->withEnableAutoRun(false) ->withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002")) ->withReceiveScript(null) ->withOverrideAcquireActionsScriptId(null) ->withLogSetting((new \Gs2\Idle\Model\LogSetting()) ->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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("namespace-0001") .withDescription("description1") .withTransactionSetting(new io.gs2.idle.model.TransactionSetting() .withEnableAutoRun(false) .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002")) .withReceiveScript(null) .withOverrideAcquireActionsScriptId(null) .withLogSetting(new io.gs2.idle.model.LogSetting() .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); Namespace item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateNamespace( new Gs2.Gs2Idle.Request.UpdateNamespaceRequest() .WithNamespaceName("namespace-0001") .WithDescription("description1") .WithTransactionSetting(new Gs2.Gs2Idle.Model.TransactionSetting() .WithEnableAutoRun(false) .WithQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002")) .WithReceiveScript(null) .WithOverrideAcquireActionsScriptId(null) .WithLogSetting(new Gs2.Gs2Idle.Model.LogSetting() .WithLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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("namespace-0001") .withDescription("description1") .withTransactionSetting(new Gs2Idle.model.TransactionSetting() .withEnableAutoRun(false) .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002")) .withReceiveScript(null) .withOverrideAcquireActionsScriptId(null) .withLogSetting(new Gs2Idle.model.LogSetting() .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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('namespace-0001') .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_receive_script(None) .with_override_acquire_actions_script_id(None) .with_log_setting( idle.LogSetting() .with_logging_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001')) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.update_namespace({ namespaceName="namespace-0001", description="description1", transactionSetting={ enableAutoRun=false, queueNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002", }, receiveScript=nil, overrideAcquireActionsScriptId=nil, logSetting={ loggingNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001", }, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.update_namespace_async({ namespaceName="namespace-0001", description="description1", transactionSetting={ enableAutoRun=false, queueNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0002", }, receiveScript=nil, overrideAcquireActionsScriptId=nil, logSetting={ loggingNamespaceId="grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001", }, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### deleteNamespace ネームスペースを削除
指定されたネームスペースを削除します。
この操作は不可逆であり、削除されたネームスペースに関連するすべてのデータは回復不能になります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Namespace](#namespace) | 削除したネームスペース | #### 実装例 **Go** ```go 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("namespace-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->deleteNamespace( (new DeleteNamespaceRequest()) ->withNamespaceName("namespace-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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("namespace-0001") ); Namespace item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DeleteNamespace( new Gs2.Gs2Idle.Request.DeleteNamespaceRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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("namespace-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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('namespace-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.delete_namespace({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.delete_namespace_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getServiceVersion マイクロサービスのバージョンを取得 #### Request リクエストパラメータ: なし #### Result | | 型 | 説明 | | --- | --- | --- | | item | string | バージョン | #### 実装例 **Go** ```go 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.GetServiceVersion( &idle.GetServiceVersionRequest { } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\GetServiceVersionRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->getServiceVersion( (new GetServiceVersionRequest()) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.GetServiceVersionRequest; import io.gs2.idle.result.GetServiceVersionResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { GetServiceVersionResult result = client.getServiceVersion( new GetServiceVersionRequest() ); String item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.GetServiceVersion( new Gs2.Gs2Idle.Request.GetServiceVersionRequest(), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.getServiceVersion( new Gs2Idle.GetServiceVersionRequest() ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_service_version( idle.GetServiceVersionRequest() ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.get_service_version({ }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.get_service_version_async({ }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### dumpUserDataByUserId 指定したユーザーIDに紐づくデータのダンプを取得
個人情報保護の法的要件を満たすために使用したり、データのバックアップや移行に使用できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | #### 実装例 **Go** ```go 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"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->dumpUserDataByUserId( (new DumpUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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") .withTimeOffsetToken(null) ); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DumpUserDataByUserId( new Gs2.Gs2Idle.Request.DumpUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; ``` **TypeScript** ```typescript 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") .withTimeOffsetToken(null) ); } catch (e) { process.exit(1); } ``` **Python** ```python 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') .with_time_offset_token(None) ) except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.dump_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.dump_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` --- ### checkDumpUserDataByUserId 指定したユーザーIDに紐づくデータのダンプが完了しているか確認
ダンプが完了している場合、出力データの URL を返します。ダンプがまだ進行中の場合、URL は空になります。
ダンプされたデータには、指定されたユーザーのすべての放置ステータスレコードが gzip 形式で圧縮されて含まれます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | url | string | 出力データのURL | #### 実装例 **Go** ```go 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"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } url := result.Url ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->checkDumpUserDataByUserId( (new CheckDumpUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); $url = $result->getUrl(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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") .withTimeOffsetToken(null) ); String url = result.getUrl(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.CheckDumpUserDataByUserId( new Gs2.Gs2Idle.Request.CheckDumpUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var url = result.Url; ``` **TypeScript** ```typescript 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") .withTimeOffsetToken(null) ); const url = result.getUrl(); } catch (e) { process.exit(1); } ``` **Python** ```python 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') .with_time_offset_token(None) ) url = result.url except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.check_dump_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result url = result.url; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.check_dump_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result url = result.url; ``` --- ### cleanUserDataByUserId ユーザーデータの完全削除
指定されたユーザーIDに紐づくデータのクリーニングを実行します。
これにより、特定のユーザーデータをプロジェクトから安全に削除できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | #### 実装例 **Go** ```go 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"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->cleanUserDataByUserId( (new CleanUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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") .withTimeOffsetToken(null) ); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.CleanUserDataByUserId( new Gs2.Gs2Idle.Request.CleanUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; ``` **TypeScript** ```typescript 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") .withTimeOffsetToken(null) ); } catch (e) { process.exit(1); } ``` **Python** ```python 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') .with_time_offset_token(None) ) except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.clean_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.clean_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` --- ### checkCleanUserDataByUserId 指定したユーザーIDのユーザーデータの完全削除が完了しているか確認
クリーン操作の完了状態を返します。クリーン操作は、同じオーナーが所有するすべてのネームスペースにわたって、指定されたユーザーのすべての放置ステータスレコードを削除します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | #### 実装例 **Go** ```go 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"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->checkCleanUserDataByUserId( (new CheckCleanUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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") .withTimeOffsetToken(null) ); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.CheckCleanUserDataByUserId( new Gs2.Gs2Idle.Request.CheckCleanUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; ``` **TypeScript** ```typescript 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") .withTimeOffsetToken(null) ); } catch (e) { process.exit(1); } ``` **Python** ```python 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') .with_time_offset_token(None) ) except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.check_clean_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.check_clean_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` --- ### prepareImportUserDataByUserId 指定したユーザーIDに紐づくデータのインポートを準備
インポートに使用できるデータは GS2 によってエクスポートして取得したデータに限定され、古いデータはインポートに失敗する可能性があります。
エクスポートしたユーザーIDと異なるユーザーIDでインポートすることができますが、ユーザーデータのペイロード内にユーザーIDが含まれる場合はその限りではありません。
このAPIの戻り値で応答されたURLにエクスポートした zip ファイルをアップロードし、importUserDataByUserId を呼び出すことで実際のインポート処理を開始できます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | uploadToken | string | アップロード後に結果を反映する際に使用するトークン | | uploadUrl | string | ユーザーデータアップロード処理の実行に使用するURL | #### 実装例 **Go** ```go 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"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } uploadToken := result.UploadToken uploadUrl := result.UploadUrl ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->prepareImportUserDataByUserId( (new PrepareImportUserDataByUserIdRequest()) ->withUserId("user-0001") ->withTimeOffsetToken(null) ); $uploadToken = $result->getUploadToken(); $uploadUrl = $result->getUploadUrl(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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") .withTimeOffsetToken(null) ); String uploadToken = result.getUploadToken(); String uploadUrl = result.getUploadUrl(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.PrepareImportUserDataByUserId( new Gs2.Gs2Idle.Request.PrepareImportUserDataByUserIdRequest() .WithUserId("user-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var uploadToken = result.UploadToken; var uploadUrl = result.UploadUrl; ``` **TypeScript** ```typescript 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") .withTimeOffsetToken(null) ); const uploadToken = result.getUploadToken(); const uploadUrl = result.getUploadUrl(); } catch (e) { process.exit(1); } ``` **Python** ```python 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') .with_time_offset_token(None) ) upload_token = result.upload_token upload_url = result.upload_url except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.prepare_import_user_data_by_user_id({ userId="user-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result uploadToken = result.uploadToken; uploadUrl = result.uploadUrl; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.prepare_import_user_data_by_user_id_async({ userId="user-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result uploadToken = result.uploadToken; uploadUrl = result.uploadUrl; ``` --- ### importUserDataByUserId 指定したユーザーIDに紐づくデータのインポートを実行
インポートに使用できるデータは GS2 によってエクスポートして取得したデータに限定され、古いデータはインポートに失敗する可能性があります。
エクスポートしたユーザーIDと異なるユーザーIDでインポートすることができますが、ユーザーデータのペイロード内にユーザーIDが含まれる場合はその限りではありません。
このAPIを呼び出す前に prepareImportUserDataByUserId を呼び出して、アップロード準備を完了させる必要があります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | uploadToken | string | | ✓| | ~ 1024文字 | アップロード準備で受け取ったトークン | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | #### 実装例 **Go** ```go 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"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->importUserDataByUserId( (new ImportUserDataByUserIdRequest()) ->withUserId("user-0001") ->withUploadToken("upload-0001") ->withTimeOffsetToken(null) ); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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") .withTimeOffsetToken(null) ); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.ImportUserDataByUserId( new Gs2.Gs2Idle.Request.ImportUserDataByUserIdRequest() .WithUserId("user-0001") .WithUploadToken("upload-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; ``` **TypeScript** ```typescript 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") .withTimeOffsetToken(null) ); } catch (e) { process.exit(1); } ``` **Python** ```python 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') .with_time_offset_token(None) ) except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.import_user_data_by_user_id({ userId="user-0001", uploadToken="upload-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.import_user_data_by_user_id_async({ userId="user-0001", uploadToken="upload-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result ``` --- ### checkImportUserDataByUserId 指定したユーザーIDに紐づくデータのインポートが完了しているか確認
完了状態と、利用可能な場合はインポートログの URL を返します。
インポートは、放置ステータスデータを含むアップロードされた ZIP ファイルを処理し、JSON 構造を検証し、指定されたユーザーのレコードを復元します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | uploadToken | string | | ✓| | ~ 1024文字 | アップロード準備で受け取ったトークン | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | url | string | 出力ログのURL | #### 実装例 **Go** ```go 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"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } url := result.Url ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->checkImportUserDataByUserId( (new CheckImportUserDataByUserIdRequest()) ->withUserId("user-0001") ->withUploadToken("upload-0001") ->withTimeOffsetToken(null) ); $url = $result->getUrl(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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") .withTimeOffsetToken(null) ); String url = result.getUrl(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.CheckImportUserDataByUserId( new Gs2.Gs2Idle.Request.CheckImportUserDataByUserIdRequest() .WithUserId("user-0001") .WithUploadToken("upload-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var url = result.Url; ``` **TypeScript** ```typescript 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") .withTimeOffsetToken(null) ); const url = result.getUrl(); } catch (e) { process.exit(1); } ``` **Python** ```python 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') .with_time_offset_token(None) ) url = result.url except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.check_import_user_data_by_user_id({ userId="user-0001", uploadToken="upload-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result url = result.url; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.check_import_user_data_by_user_id_async({ userId="user-0001", uploadToken="upload-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result url = result.url; ``` --- ### describeStatuses ステータスの一覧を取得
指定されたネームスペース内の認証済みユーザーの放置ステータスのページネーション付きリストを取得します。
各ステータスはカテゴリーごとの放置状態を表し、放置蓄積の開始時刻と現在の最大待機時間を含みます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン | | limit | int | | | 30 | 1 ~ 1000 | データの取得件数 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<Status>](#status) | ステータスのリスト | | nextPageToken | string | リストの続きを取得するためのページトークン | #### 実装例 **Go** ```go 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.DescribeStatuses( &idle.DescribeStatusesRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), PageToken: nil, Limit: nil, } ) if err != nil { panic("error occurred") } items := result.Items nextPageToken := result.NextPageToken ``` **PHP** ```php 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\DescribeStatusesRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->describeStatuses( (new DescribeStatusesRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withPageToken(null) ->withLimit(null) ); $items = $result->getItems(); $nextPageToken = $result->getNextPageToken(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.DescribeStatusesRequest; import io.gs2.idle.result.DescribeStatusesResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { DescribeStatusesResult result = client.describeStatuses( new DescribeStatusesRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withPageToken(null) .withLimit(null) ); List items = result.getItems(); String nextPageToken = result.getNextPageToken(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeStatuses( new Gs2.Gs2Idle.Request.DescribeStatusesRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithPageToken(null) .WithLimit(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var nextPageToken = result.NextPageToken; ``` **TypeScript** ```typescript 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.describeStatuses( new Gs2Idle.DescribeStatusesRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withPageToken(null) .withLimit(null) ); const items = result.getItems(); const nextPageToken = result.getNextPageToken(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_statuses( idle.DescribeStatusesRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_page_token(None) .with_limit(None) ) items = result.items next_page_token = result.next_page_token except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.describe_statuses({ namespaceName="namespace-0001", accessToken="accessToken-0001", pageToken=nil, limit=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.describe_statuses_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", pageToken=nil, limit=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` --- ### describeStatusesByUserId ユーザーIDを指定してステータスの一覧を取得
指定されたユーザーの放置ステータスのページネーション付きリストを取得します。
各ステータスはカテゴリーごとの放置状態を表し、放置蓄積の開始時刻と現在の最大待機時間を含みます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン | | limit | int | | | 30 | 1 ~ 1000 | データの取得件数 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<Status>](#status) | ステータスのリスト | | nextPageToken | string | リストの続きを取得するためのページトークン | #### 実装例 **Go** ```go 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.DescribeStatusesByUserId( &idle.DescribeStatusesByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), PageToken: nil, Limit: nil, TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } items := result.Items nextPageToken := result.NextPageToken ``` **PHP** ```php 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\DescribeStatusesByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->describeStatusesByUserId( (new DescribeStatusesByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withPageToken(null) ->withLimit(null) ->withTimeOffsetToken(null) ); $items = $result->getItems(); $nextPageToken = $result->getNextPageToken(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.DescribeStatusesByUserIdRequest; import io.gs2.idle.result.DescribeStatusesByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { DescribeStatusesByUserIdResult result = client.describeStatusesByUserId( new DescribeStatusesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withPageToken(null) .withLimit(null) .withTimeOffsetToken(null) ); List items = result.getItems(); String nextPageToken = result.getNextPageToken(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeStatusesByUserId( new Gs2.Gs2Idle.Request.DescribeStatusesByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithPageToken(null) .WithLimit(null) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var nextPageToken = result.NextPageToken; ``` **TypeScript** ```typescript 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.describeStatusesByUserId( new Gs2Idle.DescribeStatusesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withPageToken(null) .withLimit(null) .withTimeOffsetToken(null) ); const items = result.getItems(); const nextPageToken = result.getNextPageToken(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_statuses_by_user_id( idle.DescribeStatusesByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_page_token(None) .with_limit(None) .with_time_offset_token(None) ) items = result.items next_page_token = result.next_page_token except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.describe_statuses_by_user_id({ namespaceName="namespace-0001", userId="user-0001", pageToken=nil, limit=nil, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.describe_statuses_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", pageToken=nil, limit=nil, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` --- ### getStatus ステータスを取得
認証済みユーザーの特定カテゴリーの放置ステータスを取得します。
ステータスレコードがまだ存在しない場合、現在時刻を放置開始時刻とし、カテゴリーモデルの defaultMaximumIdleMinutes を最大待機時間として自動的に作成されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Status](#status) | ステータス | #### 実装例 **Go** ```go 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.GetStatus( &idle.GetStatusRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), CategoryName: pointy.String("category-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\GetStatusRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->getStatus( (new GetStatusRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withCategoryName("category-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.GetStatusRequest; import io.gs2.idle.result.GetStatusResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { GetStatusResult result = client.getStatus( new GetStatusRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withCategoryName("category-0001") ); Status item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.GetStatus( new Gs2.Gs2Idle.Request.GetStatusRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithCategoryName("category-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.getStatus( new Gs2Idle.GetStatusRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withCategoryName("category-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_status( idle.GetStatusRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_category_name('category-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.get_status({ namespaceName="namespace-0001", accessToken="accessToken-0001", categoryName="category-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.get_status_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", categoryName="category-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getStatusByUserId ユーザーIDを指定してステータスを取得
指定されたユーザーの特定カテゴリーの放置ステータスを取得します。
ステータスレコードがまだ存在しない場合、現在時刻を放置開始時刻とし、カテゴリーモデルの defaultMaximumIdleMinutes を最大待機時間として自動的に作成されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Status](#status) | ステータス | #### 実装例 **Go** ```go 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.GetStatusByUserId( &idle.GetStatusByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), CategoryName: pointy.String("category-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\GetStatusByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->getStatusByUserId( (new GetStatusByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withCategoryName("category-0001") ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.GetStatusByUserIdRequest; import io.gs2.idle.result.GetStatusByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { GetStatusByUserIdResult result = client.getStatusByUserId( new GetStatusByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withTimeOffsetToken(null) ); Status item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.GetStatusByUserId( new Gs2.Gs2Idle.Request.GetStatusByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithCategoryName("category-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.getStatusByUserId( new Gs2Idle.GetStatusByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_status_by_user_id( idle.GetStatusByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_category_name('category-0001') .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.get_status_by_user_id({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.get_status_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### prediction 獲得報酬の一覧を取得
実際に受け取ることなく、現在の待機時間に基づいて受け取れる報酬を計算して返します。
計算は、経過した待機時間を rewardIntervalMinutes で割った値に基づき、maximumIdleMinutes で上限が設定されます。
これはステータスを変更したり待機タイマーをリセットしたりしない読み取り専用の操作です。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<AcquireAction>](#acquireaction) | 報酬 | | status | [Status](#status) | ステータス | #### 実装例 **Go** ```go 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.Prediction( &idle.PredictionRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), CategoryName: pointy.String("category-0001"), } ) if err != nil { panic("error occurred") } items := result.Items status := result.Status ``` **PHP** ```php 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\PredictionRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->prediction( (new PredictionRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withCategoryName("category-0001") ); $items = $result->getItems(); $status = $result->getStatus(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.PredictionRequest; import io.gs2.idle.result.PredictionResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { PredictionResult result = client.prediction( new PredictionRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withCategoryName("category-0001") ); List items = result.getItems(); Status status = result.getStatus(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.Prediction( new Gs2.Gs2Idle.Request.PredictionRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithCategoryName("category-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var status = result.Status; ``` **TypeScript** ```typescript 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.prediction( new Gs2Idle.PredictionRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withCategoryName("category-0001") ); const items = result.getItems(); const status = result.getStatus(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.prediction( idle.PredictionRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_category_name('category-0001') ) items = result.items status = result.status except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.prediction({ namespaceName="namespace-0001", accessToken="accessToken-0001", categoryName="category-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; status = result.status; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.prediction_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", categoryName="category-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; status = result.status; ``` --- ### predictionByUserId ユーザーIDを指定して獲得報酬の一覧を取得
指定されたユーザーの現在の待機時間に基づいて、実際に受け取ることなく受け取れる報酬を計算して返します。
計算は、経過した待機時間を rewardIntervalMinutes で割った値に基づき、maximumIdleMinutes で上限が設定されます。
これはステータスを変更したり待機タイマーをリセットしたりしない読み取り専用の操作です。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<AcquireAction>](#acquireaction) | 報酬 | | status | [Status](#status) | ステータス | #### 実装例 **Go** ```go 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.PredictionByUserId( &idle.PredictionByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), CategoryName: pointy.String("category-0001"), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } items := result.Items status := result.Status ``` **PHP** ```php 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\PredictionByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->predictionByUserId( (new PredictionByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withCategoryName("category-0001") ->withTimeOffsetToken(null) ); $items = $result->getItems(); $status = $result->getStatus(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.PredictionByUserIdRequest; import io.gs2.idle.result.PredictionByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { PredictionByUserIdResult result = client.predictionByUserId( new PredictionByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withTimeOffsetToken(null) ); List items = result.getItems(); Status status = result.getStatus(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.PredictionByUserId( new Gs2.Gs2Idle.Request.PredictionByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithCategoryName("category-0001") .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var status = result.Status; ``` **TypeScript** ```typescript 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.predictionByUserId( new Gs2Idle.PredictionByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withTimeOffsetToken(null) ); const items = result.getItems(); const status = result.getStatus(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.prediction_by_user_id( idle.PredictionByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_category_name('category-0001') .with_time_offset_token(None) ) items = result.items status = result.status except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.prediction_by_user_id({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; status = result.status; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.prediction_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; status = result.status; ``` --- ### receive 報酬を受け取る
蓄積された待機時間に基づいて、指定されたカテゴリーの放置報酬を受け取ります。
報酬量は、経過した待機時間を rewardIntervalMinutes で割った値から計算され、maximumIdleMinutes で上限が設定されます。
receiveScript が設定されている場合、報酬付与前に実行され、受け取り操作を変更または拒否できます。
overrideAcquireActionsScriptId によって入手アクション（レート修正の適用など）を変更することも可能です。
受け取り後、待機タイマーは現在時刻にリセットされます。rewardResetMode が設定されている場合、待機タイマーの動作が異なる場合があります。
計算された報酬の入手アクションを含むトランザクションを返します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | config | [List<Config>](#config) | | | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<AcquireAction>](#acquireaction) | 報酬 | | status | [Status](#status) | 更新したステータス | | transactionId | string | 発行されたトランザクションID | | stampSheet | string | クエストの開始処理の実行に使用するスタンプシート | | stampSheetEncryptionKeyId | string | スタンプシートの署名計算に使用した暗号鍵GRN | | autoRunStampSheet | bool? | トランザクションの自動実行が有効か | | atomicCommit | bool? | トランザクションをアトミックにコミットするか | | transaction | string | 発行されたトランザクション | | transactionResult | [TransactionResult](#transactionresult) | トランザクション実行結果 | #### 実装例 **Go** ```go 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.Receive( &idle.ReceiveRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), CategoryName: pointy.String("category-0001"), Config: nil, } ) if err != nil { panic("error occurred") } items := result.Items status := result.Status transactionId := result.TransactionId stampSheet := result.StampSheet stampSheetEncryptionKeyId := result.StampSheetEncryptionKeyId autoRunStampSheet := result.AutoRunStampSheet atomicCommit := result.AtomicCommit transaction := result.Transaction transactionResult := result.TransactionResult ``` **PHP** ```php 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\ReceiveRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->receive( (new ReceiveRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withCategoryName("category-0001") ->withConfig(null) ); $items = $result->getItems(); $status = $result->getStatus(); $transactionId = $result->getTransactionId(); $stampSheet = $result->getStampSheet(); $stampSheetEncryptionKeyId = $result->getStampSheetEncryptionKeyId(); $autoRunStampSheet = $result->getAutoRunStampSheet(); $atomicCommit = $result->getAtomicCommit(); $transaction = $result->getTransaction(); $transactionResult = $result->getTransactionResult(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.ReceiveRequest; import io.gs2.idle.result.ReceiveResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { ReceiveResult result = client.receive( new ReceiveRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withCategoryName("category-0001") .withConfig(null) ); List items = result.getItems(); Status status = result.getStatus(); String transactionId = result.getTransactionId(); String stampSheet = result.getStampSheet(); String stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); boolean autoRunStampSheet = result.getAutoRunStampSheet(); boolean atomicCommit = result.getAtomicCommit(); String transaction = result.getTransaction(); TransactionResult transactionResult = result.getTransactionResult(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.Receive( new Gs2.Gs2Idle.Request.ReceiveRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithCategoryName("category-0001") .WithConfig(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var status = result.Status; var transactionId = result.TransactionId; var stampSheet = result.StampSheet; var stampSheetEncryptionKeyId = result.StampSheetEncryptionKeyId; var autoRunStampSheet = result.AutoRunStampSheet; var atomicCommit = result.AtomicCommit; var transaction = result.Transaction; var transactionResult = result.TransactionResult; ``` **TypeScript** ```typescript 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.receive( new Gs2Idle.ReceiveRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withCategoryName("category-0001") .withConfig(null) ); const items = result.getItems(); const status = result.getStatus(); const transactionId = result.getTransactionId(); const stampSheet = result.getStampSheet(); const stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); const autoRunStampSheet = result.getAutoRunStampSheet(); const atomicCommit = result.getAtomicCommit(); const transaction = result.getTransaction(); const transactionResult = result.getTransactionResult(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.receive( idle.ReceiveRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_category_name('category-0001') .with_config(None) ) items = result.items status = result.status transaction_id = result.transaction_id stamp_sheet = result.stamp_sheet stamp_sheet_encryption_key_id = result.stamp_sheet_encryption_key_id auto_run_stamp_sheet = result.auto_run_stamp_sheet atomic_commit = result.atomic_commit transaction = result.transaction transaction_result = result.transaction_result except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.receive({ namespaceName="namespace-0001", accessToken="accessToken-0001", categoryName="category-0001", config=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; status = result.status; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.receive_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", categoryName="category-0001", config=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; status = result.status; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` --- ### receiveByUserId ユーザーIDを指定して報酬を受け取る
指定されたユーザーとカテゴリーの蓄積された待機時間に基づいて放置報酬を受け取ります。
報酬量は、経過した待機時間を rewardIntervalMinutes で割った値から計算され、maximumIdleMinutes で上限が設定されます。
receiveScript が設定されている場合、報酬付与前に実行され、受け取り操作を変更または拒否できます。
overrideAcquireActionsScriptId によって入手アクション（レート修正の適用など）を変更することも可能です。
受け取り後、待機タイマーは現在時刻にリセットされます。
計算された報酬の入手アクションを含むトランザクションを返します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | config | [List<Config>](#config) | | | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<AcquireAction>](#acquireaction) | 報酬 | | status | [Status](#status) | 更新したステータス | | transactionId | string | 発行されたトランザクションID | | stampSheet | string | クエストの開始処理の実行に使用するスタンプシート | | stampSheetEncryptionKeyId | string | スタンプシートの署名計算に使用した暗号鍵GRN | | autoRunStampSheet | bool? | トランザクションの自動実行が有効か | | atomicCommit | bool? | トランザクションをアトミックにコミットするか | | transaction | string | 発行されたトランザクション | | transactionResult | [TransactionResult](#transactionresult) | トランザクション実行結果 | #### 実装例 **Go** ```go 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.ReceiveByUserId( &idle.ReceiveByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), CategoryName: pointy.String("category-0001"), Config: nil, TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } items := result.Items status := result.Status transactionId := result.TransactionId stampSheet := result.StampSheet stampSheetEncryptionKeyId := result.StampSheetEncryptionKeyId autoRunStampSheet := result.AutoRunStampSheet atomicCommit := result.AtomicCommit transaction := result.Transaction transactionResult := result.TransactionResult ``` **PHP** ```php 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\ReceiveByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->receiveByUserId( (new ReceiveByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withCategoryName("category-0001") ->withConfig(null) ->withTimeOffsetToken(null) ); $items = $result->getItems(); $status = $result->getStatus(); $transactionId = $result->getTransactionId(); $stampSheet = $result->getStampSheet(); $stampSheetEncryptionKeyId = $result->getStampSheetEncryptionKeyId(); $autoRunStampSheet = $result->getAutoRunStampSheet(); $atomicCommit = $result->getAtomicCommit(); $transaction = $result->getTransaction(); $transactionResult = $result->getTransactionResult(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.ReceiveByUserIdRequest; import io.gs2.idle.result.ReceiveByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { ReceiveByUserIdResult result = client.receiveByUserId( new ReceiveByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withConfig(null) .withTimeOffsetToken(null) ); List items = result.getItems(); Status status = result.getStatus(); String transactionId = result.getTransactionId(); String stampSheet = result.getStampSheet(); String stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); boolean autoRunStampSheet = result.getAutoRunStampSheet(); boolean atomicCommit = result.getAtomicCommit(); String transaction = result.getTransaction(); TransactionResult transactionResult = result.getTransactionResult(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.ReceiveByUserId( new Gs2.Gs2Idle.Request.ReceiveByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithCategoryName("category-0001") .WithConfig(null) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; var status = result.Status; var transactionId = result.TransactionId; var stampSheet = result.StampSheet; var stampSheetEncryptionKeyId = result.StampSheetEncryptionKeyId; var autoRunStampSheet = result.AutoRunStampSheet; var atomicCommit = result.AtomicCommit; var transaction = result.Transaction; var transactionResult = result.TransactionResult; ``` **TypeScript** ```typescript 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.receiveByUserId( new Gs2Idle.ReceiveByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withConfig(null) .withTimeOffsetToken(null) ); const items = result.getItems(); const status = result.getStatus(); const transactionId = result.getTransactionId(); const stampSheet = result.getStampSheet(); const stampSheetEncryptionKeyId = result.getStampSheetEncryptionKeyId(); const autoRunStampSheet = result.getAutoRunStampSheet(); const atomicCommit = result.getAtomicCommit(); const transaction = result.getTransaction(); const transactionResult = result.getTransactionResult(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.receive_by_user_id( idle.ReceiveByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_category_name('category-0001') .with_config(None) .with_time_offset_token(None) ) items = result.items status = result.status transaction_id = result.transaction_id stamp_sheet = result.stamp_sheet stamp_sheet_encryption_key_id = result.stamp_sheet_encryption_key_id auto_run_stamp_sheet = result.auto_run_stamp_sheet atomic_commit = result.atomic_commit transaction = result.transaction transaction_result = result.transaction_result except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.receive_by_user_id({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", config=nil, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; status = result.status; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.receive_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", config=nil, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; status = result.status; transactionId = result.transactionId; stampSheet = result.stampSheet; stampSheetEncryptionKeyId = result.stampSheetEncryptionKeyId; autoRunStampSheet = result.autoRunStampSheet; atomicCommit = result.atomicCommit; transaction = result.transaction; transactionResult = result.transactionResult; ``` --- ### increaseMaximumIdleMinutesByUserId ユーザーIDを指定して最大待機時間を加算
指定されたカテゴリーにおけるユーザーの最大待機時間に指定された分数を加算します。
最大待機時間は、放置報酬が蓄積される時間の上限を決定します。
ステータスがまだ存在しない場合、加算を適用する前に自動的に作成されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | increaseMinutes | int | | | | 1 ~ 2147483646 | 最大待機時間を増やす分数 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Status](#status) | 更新したステータス | #### 実装例 **Go** ```go 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.IncreaseMaximumIdleMinutesByUserId( &idle.IncreaseMaximumIdleMinutesByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), CategoryName: pointy.String("category-0001"), IncreaseMinutes: pointy.Int32(5), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\IncreaseMaximumIdleMinutesByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->increaseMaximumIdleMinutesByUserId( (new IncreaseMaximumIdleMinutesByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withCategoryName("category-0001") ->withIncreaseMinutes(5) ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.IncreaseMaximumIdleMinutesByUserIdRequest; import io.gs2.idle.result.IncreaseMaximumIdleMinutesByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { IncreaseMaximumIdleMinutesByUserIdResult result = client.increaseMaximumIdleMinutesByUserId( new IncreaseMaximumIdleMinutesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withIncreaseMinutes(5) .withTimeOffsetToken(null) ); Status item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.IncreaseMaximumIdleMinutesByUserId( new Gs2.Gs2Idle.Request.IncreaseMaximumIdleMinutesByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithCategoryName("category-0001") .WithIncreaseMinutes(5) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.increaseMaximumIdleMinutesByUserId( new Gs2Idle.IncreaseMaximumIdleMinutesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withIncreaseMinutes(5) .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.increase_maximum_idle_minutes_by_user_id( idle.IncreaseMaximumIdleMinutesByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_category_name('category-0001') .with_increase_minutes(5) .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.increase_maximum_idle_minutes_by_user_id({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", increaseMinutes=5, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.increase_maximum_idle_minutes_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", increaseMinutes=5, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### decreaseMaximumIdleMinutes 最大待機時間を減算
指定されたカテゴリーにおける認証済みユーザーの最大待機時間から指定された分数を減算します。
最大待機時間はゼロを下回ることはできません。
ステータスがまだ存在しない場合、減算を適用する前に自動的に作成されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | accessToken | string | | ✓| | ~ 128文字 | アクセストークン | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | decreaseMinutes | int | | | | 1 ~ 2147483646 | 最大待機時間を減らす分数 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Status](#status) | 更新したステータス | #### 実装例 **Go** ```go 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.DecreaseMaximumIdleMinutes( &idle.DecreaseMaximumIdleMinutesRequest { NamespaceName: pointy.String("namespace-0001"), AccessToken: pointy.String("accessToken-0001"), CategoryName: pointy.String("category-0001"), DecreaseMinutes: pointy.Int32(5), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\DecreaseMaximumIdleMinutesRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->decreaseMaximumIdleMinutes( (new DecreaseMaximumIdleMinutesRequest()) ->withNamespaceName("namespace-0001") ->withAccessToken("accessToken-0001") ->withCategoryName("category-0001") ->withDecreaseMinutes(5) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.DecreaseMaximumIdleMinutesRequest; import io.gs2.idle.result.DecreaseMaximumIdleMinutesResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { DecreaseMaximumIdleMinutesResult result = client.decreaseMaximumIdleMinutes( new DecreaseMaximumIdleMinutesRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withCategoryName("category-0001") .withDecreaseMinutes(5) ); Status item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DecreaseMaximumIdleMinutes( new Gs2.Gs2Idle.Request.DecreaseMaximumIdleMinutesRequest() .WithNamespaceName("namespace-0001") .WithAccessToken("accessToken-0001") .WithCategoryName("category-0001") .WithDecreaseMinutes(5), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.decreaseMaximumIdleMinutes( new Gs2Idle.DecreaseMaximumIdleMinutesRequest() .withNamespaceName("namespace-0001") .withAccessToken("accessToken-0001") .withCategoryName("category-0001") .withDecreaseMinutes(5) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.decrease_maximum_idle_minutes( idle.DecreaseMaximumIdleMinutesRequest() .with_namespace_name('namespace-0001') .with_access_token('accessToken-0001') .with_category_name('category-0001') .with_decrease_minutes(5) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.decrease_maximum_idle_minutes({ namespaceName="namespace-0001", accessToken="accessToken-0001", categoryName="category-0001", decreaseMinutes=5, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.decrease_maximum_idle_minutes_async({ namespaceName="namespace-0001", accessToken="accessToken-0001", categoryName="category-0001", decreaseMinutes=5, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### decreaseMaximumIdleMinutesByUserId ユーザーIDを指定して最大待機時間を減算
指定されたカテゴリーにおけるユーザーの最大待機時間から指定された分数を減算します。
最大待機時間はゼロを下回ることはできません。
ステータスがまだ存在しない場合、減算を適用する前に自動的に作成されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | decreaseMinutes | int | | | | 1 ~ 2147483646 | 最大待機時間を減らす分数 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Status](#status) | 更新したステータス | #### 実装例 **Go** ```go 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.DecreaseMaximumIdleMinutesByUserId( &idle.DecreaseMaximumIdleMinutesByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), CategoryName: pointy.String("category-0001"), DecreaseMinutes: pointy.Int32(5), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\DecreaseMaximumIdleMinutesByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->decreaseMaximumIdleMinutesByUserId( (new DecreaseMaximumIdleMinutesByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withCategoryName("category-0001") ->withDecreaseMinutes(5) ->withTimeOffsetToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.DecreaseMaximumIdleMinutesByUserIdRequest; import io.gs2.idle.result.DecreaseMaximumIdleMinutesByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { DecreaseMaximumIdleMinutesByUserIdResult result = client.decreaseMaximumIdleMinutesByUserId( new DecreaseMaximumIdleMinutesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withDecreaseMinutes(5) .withTimeOffsetToken(null) ); Status item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DecreaseMaximumIdleMinutesByUserId( new Gs2.Gs2Idle.Request.DecreaseMaximumIdleMinutesByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithCategoryName("category-0001") .WithDecreaseMinutes(5) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.decreaseMaximumIdleMinutesByUserId( new Gs2Idle.DecreaseMaximumIdleMinutesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withDecreaseMinutes(5) .withTimeOffsetToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.decrease_maximum_idle_minutes_by_user_id( idle.DecreaseMaximumIdleMinutesByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_category_name('category-0001') .with_decrease_minutes(5) .with_time_offset_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.decrease_maximum_idle_minutes_by_user_id({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", decreaseMinutes=5, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.decrease_maximum_idle_minutes_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", decreaseMinutes=5, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### setMaximumIdleMinutesByUserId ユーザーIDを指定して最大待機時間を設定
指定されたカテゴリーにおけるユーザーの最大待機時間を指定された絶対値に設定します。
加算/減算操作とは異なり、現在の最大待機時間を直接置き換えます。
更新後のステータスと更新前のステータスの両方を返すため、呼び出し元は変更内容を確認できます。
ステータスがまだ存在しない場合、値を適用する前に自動的に作成されます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | userId | string | | ✓| | ~ 128文字 | ユーザーID | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
このステータスが属するカテゴリーモデルの名前です。放置報酬計算に使用される報酬間隔、最大放置時間、入手アクション、スケジュール設定を含むカテゴリーモデル定義を参照します。 | | maximumIdleMinutes | int | | | | 1 ~ 2147483646 | 設定する最大待機時間 | | timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [Status](#status) | 更新したステータス | | old | [Status](#status) | 更新前のステータス | #### 実装例 **Go** ```go 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.SetMaximumIdleMinutesByUserId( &idle.SetMaximumIdleMinutesByUserIdRequest { NamespaceName: pointy.String("namespace-0001"), UserId: pointy.String("user-0001"), CategoryName: pointy.String("category-0001"), MaximumIdleMinutes: pointy.Int32(5), TimeOffsetToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item old := result.Old ``` **PHP** ```php 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\SetMaximumIdleMinutesByUserIdRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->setMaximumIdleMinutesByUserId( (new SetMaximumIdleMinutesByUserIdRequest()) ->withNamespaceName("namespace-0001") ->withUserId("user-0001") ->withCategoryName("category-0001") ->withMaximumIdleMinutes(5) ->withTimeOffsetToken(null) ); $item = $result->getItem(); $old = $result->getOld(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.SetMaximumIdleMinutesByUserIdRequest; import io.gs2.idle.result.SetMaximumIdleMinutesByUserIdResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { SetMaximumIdleMinutesByUserIdResult result = client.setMaximumIdleMinutesByUserId( new SetMaximumIdleMinutesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withMaximumIdleMinutes(5) .withTimeOffsetToken(null) ); Status item = result.getItem(); Status old = result.getOld(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.SetMaximumIdleMinutesByUserId( new Gs2.Gs2Idle.Request.SetMaximumIdleMinutesByUserIdRequest() .WithNamespaceName("namespace-0001") .WithUserId("user-0001") .WithCategoryName("category-0001") .WithMaximumIdleMinutes(5) .WithTimeOffsetToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; var old = result.Old; ``` **TypeScript** ```typescript 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.setMaximumIdleMinutesByUserId( new Gs2Idle.SetMaximumIdleMinutesByUserIdRequest() .withNamespaceName("namespace-0001") .withUserId("user-0001") .withCategoryName("category-0001") .withMaximumIdleMinutes(5) .withTimeOffsetToken(null) ); const item = result.getItem(); const old = result.getOld(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.set_maximum_idle_minutes_by_user_id( idle.SetMaximumIdleMinutesByUserIdRequest() .with_namespace_name('namespace-0001') .with_user_id('user-0001') .with_category_name('category-0001') .with_maximum_idle_minutes(5) .with_time_offset_token(None) ) item = result.item old = result.old except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.set_maximum_idle_minutes_by_user_id({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", maximumIdleMinutes=5, timeOffsetToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; old = result.old; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.set_maximum_idle_minutes_by_user_id_async({ namespaceName="namespace-0001", userId="user-0001", categoryName="category-0001", maximumIdleMinutes=5, timeOffsetToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; old = result.old; ``` --- ### describeCategoryModels カテゴリーモデルの一覧を取得
指定されたネームスペース内の現在アクティブ（公開済み）なカテゴリーモデルの一覧を取得します。
これらはマスターデータの更新プロセスを通じて有効化されたモデルであり、プレイヤーが利用可能な放置報酬の設定を定義します。
各モデルには、報酬間隔、最大待機時間、報酬リセットモード、入手アクション、スケジュール参照などの設定が含まれます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<CategoryModel>](#categorymodel) | カテゴリーモデルリスト | #### 実装例 **Go** ```go 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.DescribeCategoryModels( &idle.DescribeCategoryModelsRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } items := result.Items ``` **PHP** ```php 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\DescribeCategoryModelsRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->describeCategoryModels( (new DescribeCategoryModelsRequest()) ->withNamespaceName("namespace-0001") ); $items = $result->getItems(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.DescribeCategoryModelsRequest; import io.gs2.idle.result.DescribeCategoryModelsResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { DescribeCategoryModelsResult result = client.describeCategoryModels( new DescribeCategoryModelsRequest() .withNamespaceName("namespace-0001") ); List items = result.getItems(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeCategoryModels( new Gs2.Gs2Idle.Request.DescribeCategoryModelsRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var items = result.Items; ``` **TypeScript** ```typescript 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.describeCategoryModels( new Gs2Idle.DescribeCategoryModelsRequest() .withNamespaceName("namespace-0001") ); const items = result.getItems(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_models( idle.DescribeCategoryModelsRequest() .with_namespace_name('namespace-0001') ) items = result.items except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.describe_category_models({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.describe_category_models_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; ``` --- ### getCategoryModel カテゴリーモデルを取得
名前を指定して特定のアクティブなカテゴリーモデルの詳細を取得します。
モデルには、rewardIntervalMinutes（報酬が蓄積される間隔）、defaultMaximumIdleMinutes（待機時間の上限）、acquireActions（付与される報酬）、および待機期間と受け取り期間を制御するオプションのスケジュール参照を含む放置報酬設定が定義されています。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CategoryModel](#categorymodel) | カテゴリーモデル | #### 実装例 **Go** ```go 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.GetCategoryModel( &idle.GetCategoryModelRequest { NamespaceName: pointy.String("namespace-0001"), CategoryName: pointy.String("category-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\GetCategoryModelRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->getCategoryModel( (new GetCategoryModelRequest()) ->withNamespaceName("namespace-0001") ->withCategoryName("category-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.GetCategoryModelRequest; import io.gs2.idle.result.GetCategoryModelResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { GetCategoryModelResult result = client.getCategoryModel( new GetCategoryModelRequest() .withNamespaceName("namespace-0001") .withCategoryName("category-0001") ); CategoryModel item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.GetCategoryModel( new Gs2.Gs2Idle.Request.GetCategoryModelRequest() .WithNamespaceName("namespace-0001") .WithCategoryName("category-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.getCategoryModel( new Gs2Idle.GetCategoryModelRequest() .withNamespaceName("namespace-0001") .withCategoryName("category-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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( idle.GetCategoryModelRequest() .with_namespace_name('namespace-0001') .with_category_name('category-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.get_category_model({ namespaceName="namespace-0001", categoryName="category-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.get_category_model_async({ namespaceName="namespace-0001", categoryName="category-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### exportMaster カテゴリーモデルマスターを有効化可能なマスターデータ形式でエクスポート
ネームスペース内のすべてのカテゴリーモデルマスターを、有効化に適した JSON ドキュメントとしてエクスポートします。
エクスポートされるデータには、各カテゴリーモデルの完全な設定（報酬間隔、最大待機時間、報酬リセットモード、入手アクション、スケジュール参照）が含まれます。
このデータは別のネームスペースでマスターデータを有効化するために使用したり、バージョン管理目的で保存したりできます。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CurrentCategoryMaster](#currentcategorymaster) | 有効化可能なカテゴリーモデルのマスターデータ | #### 実装例 **Go** ```go 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.ExportMaster( &idle.ExportMasterRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\ExportMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->exportMaster( (new ExportMasterRequest()) ->withNamespaceName("namespace-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.ExportMasterRequest; import io.gs2.idle.result.ExportMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { ExportMasterResult result = client.exportMaster( new ExportMasterRequest() .withNamespaceName("namespace-0001") ); CurrentCategoryMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.ExportMaster( new Gs2.Gs2Idle.Request.ExportMasterRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.exportMaster( new Gs2Idle.ExportMasterRequest() .withNamespaceName("namespace-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.export_master( idle.ExportMasterRequest() .with_namespace_name('namespace-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.export_master({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.export_master_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getCurrentCategoryMaster 現在アクティブなカテゴリーモデルのマスターデータを取得
ネームスペース内で利用可能なカテゴリーモデルを定義する、現在アクティブなマスターデータを取得します。
これは最後に有効化されたデータであり、プレイヤーへのカテゴリーモデルリクエストの提供に使用されています。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CurrentCategoryMaster](#currentcategorymaster) | 現在アクティブなカテゴリーモデルのマスターデータ | #### 実装例 **Go** ```go 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.GetCurrentCategoryMaster( &idle.GetCurrentCategoryMasterRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\GetCurrentCategoryMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->getCurrentCategoryMaster( (new GetCurrentCategoryMasterRequest()) ->withNamespaceName("namespace-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.GetCurrentCategoryMasterRequest; import io.gs2.idle.result.GetCurrentCategoryMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { GetCurrentCategoryMasterResult result = client.getCurrentCategoryMaster( new GetCurrentCategoryMasterRequest() .withNamespaceName("namespace-0001") ); CurrentCategoryMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.GetCurrentCategoryMaster( new Gs2.Gs2Idle.Request.GetCurrentCategoryMasterRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.getCurrentCategoryMaster( new Gs2Idle.GetCurrentCategoryMasterRequest() .withNamespaceName("namespace-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_current_category_master( idle.GetCurrentCategoryMasterRequest() .with_namespace_name('namespace-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.get_current_category_master({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.get_current_category_master_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### preUpdateCurrentCategoryMaster 現在アクティブなカテゴリーモデルのマスターデータを更新（3フェーズ版）
1MBを超えるマスターデータをアップロードする場合は、3フェーズで更新を行います。
1. このAPIを実行し、アップロード用のトークンとURLを取得します。
2. 取得したURLに対して、マスターデータをアップロードします。
3. UpdateCurrentCategoryMaster にアップロードで取得したトークンを渡して実行し、マスターデータを反映します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | uploadToken | string | アップロード後に結果を反映する際に使用するトークン | | uploadUrl | string | アップロード処理の実行に使用するURL | #### 実装例 **Go** ```go 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.PreUpdateCurrentCategoryMaster( &idle.PreUpdateCurrentCategoryMasterRequest { NamespaceName: pointy.String("namespace-0001"), } ) if err != nil { panic("error occurred") } uploadToken := result.UploadToken uploadUrl := result.UploadUrl ``` **PHP** ```php 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\PreUpdateCurrentCategoryMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->preUpdateCurrentCategoryMaster( (new PreUpdateCurrentCategoryMasterRequest()) ->withNamespaceName("namespace-0001") ); $uploadToken = $result->getUploadToken(); $uploadUrl = $result->getUploadUrl(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.PreUpdateCurrentCategoryMasterRequest; import io.gs2.idle.result.PreUpdateCurrentCategoryMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { PreUpdateCurrentCategoryMasterResult result = client.preUpdateCurrentCategoryMaster( new PreUpdateCurrentCategoryMasterRequest() .withNamespaceName("namespace-0001") ); String uploadToken = result.getUploadToken(); String uploadUrl = result.getUploadUrl(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.PreUpdateCurrentCategoryMaster( new Gs2.Gs2Idle.Request.PreUpdateCurrentCategoryMasterRequest() .WithNamespaceName("namespace-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var uploadToken = result.UploadToken; var uploadUrl = result.UploadUrl; ``` **TypeScript** ```typescript 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.preUpdateCurrentCategoryMaster( new Gs2Idle.PreUpdateCurrentCategoryMasterRequest() .withNamespaceName("namespace-0001") ); const uploadToken = result.getUploadToken(); const uploadUrl = result.getUploadUrl(); } catch (e) { process.exit(1); } ``` **Python** ```python 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.pre_update_current_category_master( idle.PreUpdateCurrentCategoryMasterRequest() .with_namespace_name('namespace-0001') ) upload_token = result.upload_token upload_url = result.upload_url except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.pre_update_current_category_master({ namespaceName="namespace-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result uploadToken = result.uploadToken; uploadUrl = result.uploadUrl; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.pre_update_current_category_master_async({ namespaceName="namespace-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result uploadToken = result.uploadToken; uploadUrl = result.uploadUrl; ``` --- ### updateCurrentCategoryMaster 現在アクティブなカテゴリーモデルのマスターデータを更新
現在アクティブなカテゴリーモデルを置き換える新しいマスターデータを有効化します。
2つのモードをサポートします：「direct」はインライン JSON データ用（小さなペイロードに適用）、「preUpload」は署名付き URL 経由でアップロードされたデータ用（1MBを超えるデータに必要、PreUpdate で取得したトークンを使用）。
有効化後、新しいカテゴリーモデルは放置報酬処理に即座に利用可能になります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | mode | 文字列列挙型
enum {
  "direct",
  "preUpload"
}
| | | "direct" | | 更新モード"direct": マスターデータを直接更新 / "preUpload": マスターデータをアップロードしてから更新 / | | settings | string | {mode} == "direct" | ✓※| | ~ 5242880 バイト (5MB) | マスターデータ
※ mode が "direct" であれば必須 | | uploadToken | string | {mode} == "preUpload" | ✓※| | ~ 1024文字 | 事前アップロードで取得したトークン
アップロードしたマスターデータを適用するために使用されます。
※ mode が "preUpload" であれば必須 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CurrentCategoryMaster](#currentcategorymaster) | 更新された現在アクティブなカテゴリーモデルのマスターデータ | #### 実装例 **Go** ```go 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.UpdateCurrentCategoryMaster( &idle.UpdateCurrentCategoryMasterRequest { NamespaceName: pointy.String("namespace-0001"), Mode: pointy.String("direct"), Settings: pointy.String("{\"version\": \"2023-06-06\", \"categoryModels\": [{\"name\": \"category-0001\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"rewardResetMode\": \"Reset\", \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}]}, {\"name\": \"category-0002\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}], \"idlePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001\", \"receivePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002\"}]}"), UploadToken: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\UpdateCurrentCategoryMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->updateCurrentCategoryMaster( (new UpdateCurrentCategoryMasterRequest()) ->withNamespaceName("namespace-0001") ->withMode("direct") ->withSettings("{\"version\": \"2023-06-06\", \"categoryModels\": [{\"name\": \"category-0001\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"rewardResetMode\": \"Reset\", \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}]}, {\"name\": \"category-0002\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}], \"idlePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001\", \"receivePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002\"}]}") ->withUploadToken(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.UpdateCurrentCategoryMasterRequest; import io.gs2.idle.result.UpdateCurrentCategoryMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { UpdateCurrentCategoryMasterResult result = client.updateCurrentCategoryMaster( new UpdateCurrentCategoryMasterRequest() .withNamespaceName("namespace-0001") .withMode("direct") .withSettings("{\"version\": \"2023-06-06\", \"categoryModels\": [{\"name\": \"category-0001\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"rewardResetMode\": \"Reset\", \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}]}, {\"name\": \"category-0002\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}], \"idlePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001\", \"receivePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002\"}]}") .withUploadToken(null) ); CurrentCategoryMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateCurrentCategoryMaster( new Gs2.Gs2Idle.Request.UpdateCurrentCategoryMasterRequest() .WithNamespaceName("namespace-0001") .WithMode("direct") .WithSettings("{\"version\": \"2023-06-06\", \"categoryModels\": [{\"name\": \"category-0001\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"rewardResetMode\": \"Reset\", \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}]}, {\"name\": \"category-0002\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}], \"idlePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001\", \"receivePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002\"}]}") .WithUploadToken(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.updateCurrentCategoryMaster( new Gs2Idle.UpdateCurrentCategoryMasterRequest() .withNamespaceName("namespace-0001") .withMode("direct") .withSettings("{\"version\": \"2023-06-06\", \"categoryModels\": [{\"name\": \"category-0001\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"rewardResetMode\": \"Reset\", \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}]}, {\"name\": \"category-0002\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}], \"idlePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001\", \"receivePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002\"}]}") .withUploadToken(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_current_category_master( idle.UpdateCurrentCategoryMasterRequest() .with_namespace_name('namespace-0001') .with_mode('direct') .with_settings('{"version": "2023-06-06", "categoryModels": [{"name": "category-0001", "rewardIntervalMinutes": 5, "defaultMaximumIdleMinutes": 1440, "rewardResetMode": "Reset", "acquireActions": [{"acquireActions": [{"action": "Gs2Experience:AddExperienceByUserId", "request": {"namespaceName": "namespace-0001", "experienceName": "player", "userId": "#{userId}", "propertyId": "player", "experienceValue": 10}}]}, {"acquireActions": [{"action": "Gs2Experience:AddExperienceByUserId", "request": {"namespaceName": "namespace-0001", "experienceName": "player", "userId": "#{userId}", "propertyId": "player", "experienceValue": 5}}]}]}, {"name": "category-0002", "rewardIntervalMinutes": 5, "defaultMaximumIdleMinutes": 1440, "acquireActions": [{"acquireActions": [{"action": "Gs2Experience:AddExperienceByUserId", "request": {"namespaceName": "namespace-0001", "experienceName": "player", "userId": "#{userId}", "propertyId": "player", "experienceValue": 10}}]}, {"acquireActions": [{"action": "Gs2Experience:AddExperienceByUserId", "request": {"namespaceName": "namespace-0001", "experienceName": "player", "userId": "#{userId}", "propertyId": "player", "experienceValue": 5}}]}], "idlePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001", "receivePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"}]}') .with_upload_token(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.update_current_category_master({ namespaceName="namespace-0001", mode="direct", settings="{\"version\": \"2023-06-06\", \"categoryModels\": [{\"name\": \"category-0001\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"rewardResetMode\": \"Reset\", \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}]}, {\"name\": \"category-0002\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}], \"idlePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001\", \"receivePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002\"}]}", uploadToken=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.update_current_category_master_async({ namespaceName="namespace-0001", mode="direct", settings="{\"version\": \"2023-06-06\", \"categoryModels\": [{\"name\": \"category-0001\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"rewardResetMode\": \"Reset\", \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}]}, {\"name\": \"category-0002\", \"rewardIntervalMinutes\": 5, \"defaultMaximumIdleMinutes\": 1440, \"acquireActions\": [{\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 10}}]}, {\"acquireActions\": [{\"action\": \"Gs2Experience:AddExperienceByUserId\", \"request\": {\"namespaceName\": \"namespace-0001\", \"experienceName\": \"player\", \"userId\": \"#{userId}\", \"propertyId\": \"player\", \"experienceValue\": 5}}]}], \"idlePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001\", \"receivePeriodScheduleId\": \"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002\"}]}", uploadToken=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### updateCurrentCategoryMasterFromGitHub 現在アクティブなカテゴリーモデルのマスターデータをGitHubから更新
GitHub リポジトリからマスターデータを取得し、現在のカテゴリーモデル設定として有効化します。
チェックアウト設定で、マスターデータ JSON を取得するリポジトリ、ブランチ/タグ、およびファイルパスを指定します。
これにより、バージョン管理を活用した GitOps スタイルの放置報酬設定管理が可能になります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | checkoutSetting | [GitHubCheckoutSetting](#githubcheckoutsetting) | | ✓| | | GitHubからマスターデータをチェックアウトする設定 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CurrentCategoryMaster](#currentcategorymaster) | 更新された現在アクティブなカテゴリーモデルのマスターデータ | #### 実装例 **Go** ```go 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.UpdateCurrentCategoryMasterFromGitHub( &idle.UpdateCurrentCategoryMasterFromGitHubRequest { NamespaceName: pointy.String("namespace-0001"), CheckoutSetting: &idle.GitHubCheckoutSetting{ ApiKeyId: pointy.String("apiKeyId-0001"), RepositoryName: pointy.String("gs2io/master-data"), SourcePath: pointy.String("path/to/file.json"), ReferenceType: pointy.String("branch"), BranchName: pointy.String("develop"), }, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\UpdateCurrentCategoryMasterFromGitHubRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->updateCurrentCategoryMasterFromGitHub( (new UpdateCurrentCategoryMasterFromGitHubRequest()) ->withNamespaceName("namespace-0001") ->withCheckoutSetting((new GitHubCheckoutSetting()) ->withApiKeyId("apiKeyId-0001") ->withRepositoryName("gs2io/master-data") ->withSourcePath("path/to/file.json") ->withReferenceType("branch") ->withBranchName("develop") ) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.UpdateCurrentCategoryMasterFromGitHubRequest; import io.gs2.idle.result.UpdateCurrentCategoryMasterFromGitHubResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { UpdateCurrentCategoryMasterFromGitHubResult result = client.updateCurrentCategoryMasterFromGitHub( new UpdateCurrentCategoryMasterFromGitHubRequest() .withNamespaceName("namespace-0001") .withCheckoutSetting(new GitHubCheckoutSetting() .withApiKeyId("apiKeyId-0001") .withRepositoryName("gs2io/master-data") .withSourcePath("path/to/file.json") .withReferenceType("branch") .withBranchName("develop") ) ); CurrentCategoryMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateCurrentCategoryMasterFromGitHub( new Gs2.Gs2Idle.Request.UpdateCurrentCategoryMasterFromGitHubRequest() .WithNamespaceName("namespace-0001") .WithCheckoutSetting(new Gs2.Gs2Idle.Model.GitHubCheckoutSetting() .WithApiKeyId("apiKeyId-0001") .WithRepositoryName("gs2io/master-data") .WithSourcePath("path/to/file.json") .WithReferenceType("branch") .WithBranchName("develop") ), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.updateCurrentCategoryMasterFromGitHub( new Gs2Idle.UpdateCurrentCategoryMasterFromGitHubRequest() .withNamespaceName("namespace-0001") .withCheckoutSetting(new Gs2Idle.model.GitHubCheckoutSetting() .withApiKeyId("apiKeyId-0001") .withRepositoryName("gs2io/master-data") .withSourcePath("path/to/file.json") .withReferenceType("branch") .withBranchName("develop") ) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_current_category_master_from_git_hub( idle.UpdateCurrentCategoryMasterFromGitHubRequest() .with_namespace_name('namespace-0001') .with_checkout_setting(idle.GitHubCheckoutSetting() .with_api_key_id('apiKeyId-0001') .with_repository_name('gs2io/master-data') .with_source_path('path/to/file.json') .with_reference_type('branch') .with_branch_name('develop') ) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.update_current_category_master_from_git_hub({ namespaceName="namespace-0001", checkoutSetting={ api_key_id="apiKeyId-0001", repository_name="gs2io/master-data", source_path="path/to/file.json", reference_type="branch", branch_name="develop", }, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.update_current_category_master_from_git_hub_async({ namespaceName="namespace-0001", checkoutSetting={ api_key_id="apiKeyId-0001", repository_name="gs2io/master-data", source_path="path/to/file.json", reference_type="branch", branch_name="develop", }, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### describeCategoryModelMasters カテゴリーモデルマスターの一覧を取得
指定されたネームスペース内の編集可能なカテゴリーモデルマスターのページネーション付きリストを取得します。
カテゴリーモデルマスターは、放置報酬設定を定義するカテゴリーモデルの編集可能なバージョンです。
マスターへの変更は、現在のマスターデータの更新プロセスを通じて有効化するまで反映されません。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | namePrefix | string | | | | ~ 64文字 | カテゴリーモデル名のフィルター接頭辞 | | pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン | | limit | int | | | 30 | 1 ~ 1000 | データの取得件数 | #### Result | | 型 | 説明 | | --- | --- | --- | | items | [List<CategoryModelMaster>](#categorymodelmaster) | カテゴリーモデルマスターのリスト | | nextPageToken | string | リストの続きを取得するためのページトークン | #### 実装例 **Go** ```go 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("namespace-0001"), NamePrefix: nil, PageToken: nil, Limit: nil, } ) if err != nil { panic("error occurred") } items := result.Items nextPageToken := result.NextPageToken ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->describeCategoryModelMasters( (new DescribeCategoryModelMastersRequest()) ->withNamespaceName("namespace-0001") ->withNamePrefix(null) ->withPageToken(null) ->withLimit(null) ); $items = $result->getItems(); $nextPageToken = $result->getNextPageToken(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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("namespace-0001") .withNamePrefix(null) .withPageToken(null) .withLimit(null) ); List items = result.getItems(); String nextPageToken = result.getNextPageToken(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DescribeCategoryModelMasters( new Gs2.Gs2Idle.Request.DescribeCategoryModelMastersRequest() .WithNamespaceName("namespace-0001") .WithNamePrefix(null) .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; ``` **TypeScript** ```typescript 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("namespace-0001") .withNamePrefix(null) .withPageToken(null) .withLimit(null) ); const items = result.getItems(); const nextPageToken = result.getNextPageToken(); } catch (e) { process.exit(1); } ``` **Python** ```python 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('namespace-0001') .with_name_prefix(None) .with_page_token(None) .with_limit(None) ) items = result.items next_page_token = result.next_page_token except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.describe_category_model_masters({ namespaceName="namespace-0001", namePrefix=nil, pageToken=nil, limit=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.describe_category_model_masters_async({ namespaceName="namespace-0001", namePrefix=nil, pageToken=nil, limit=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result items = result.items; nextPageToken = result.nextPageToken; ``` --- ### createCategoryModelMaster カテゴリーモデルマスターを新規作成
放置報酬設定を定義する新しい編集可能なカテゴリーモデルマスターを作成します。
主な設定には、rewardIntervalMinutes（報酬が蓄積される間隔）、defaultMaximumIdleMinutes（待機時間の上限）、rewardResetMode（受け取り時に報酬をリセットするかどうか）、acquireActions（付与される報酬）があります。
オプションで、idlePeriodScheduleId と receivePeriodScheduleId に GS2-Schedule のイベントを参照して、待機蓄積と報酬受け取りが有効な期間を制御できます。
作成したマスターは、現在のマスターデータの更新プロセスを通じて有効化する必要があります。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | name | string | | ✓| | ~ 128文字 | カテゴリーモデル名
カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | metadata | string | | | | ~ 2048文字 | メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | | rewardIntervalMinutes | int | | ✓| | 0 ~ 2147483646 | 報酬間隔（分）
各放置報酬の間の時間間隔（分）です。例えば60に設定すると、ユーザーは放置時間60分ごとに1つの報酬ユニットを獲得します。報酬の総数は（経過放置分数）/ rewardIntervalMinutes として計算され、acquireActions配列を循環します。 | | defaultMaximumIdleMinutes | int | | ✓| | 0 ~ 2147483646 | デフォルト最大放置時間（分）
このカテゴリーの新しいステータスに対するデフォルトの最大放置時間（分）です。この制限を超える放置時間は追加の報酬を蓄積しません。この値はステータス作成時に各ステータスの maximumIdleMinutes にコピーされ、入手アクションを通じてユーザーごとに拡張できます。 | | rewardResetMode | 文字列列挙型
enum {
  "Reset",
  "CarryOver"
}
| | | "Reset" | | 報酬リセットモード
ユーザーが報酬を受け取った後の放置時間の扱いを決定します。「Reset」は放置時間をゼロに戻し、部分的な間隔時間は失われます。「CarryOver」は追加の報酬を得るに足りなかった残り時間を保持し、次の報酬サイクルにカウントされます。"Reset": 待機時間を0にリセット / "CarryOver": 報酬を得るに至らなかった残り時間を持ち越す / | | acquireActions | [List<AcquireActionList>](#acquireactionlist) | | | [] | 1 ~ 100 items | 待機時間ごとに得られる入手アクションリスト
待機時間を「X分」だと仮定すると
「X / rewardIntervalMinutes」が報酬を受け取れる数になりますが、ここで指定した配列の要素をループすることで、待機時間ごとに異なる報酬を付与できます。 | | idlePeriodScheduleId | string | | | | ~ 1024文字 | 放置期間スケジュールID
放置時間が蓄積される期間を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ放置時間がカウントされます。イベントが繰り返される場合、ステータスは繰り返し回数を追跡し、新しいサイクルの開始時に放置時間をリセットして、イベント期間ごとに報酬が計算されるようにします。 | | receivePeriodScheduleId | string | | | | ~ 1024文字 | 受取期間スケジュールID
ユーザーが蓄積された放置報酬を受け取れる時間枠を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ報酬の受け取りが受け付けられます。これにより、放置蓄積期間とは別の期間限定の報酬受取期間を設定できます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CategoryModelMaster](#categorymodelmaster) | 作成したカテゴリーモデルマスター | #### 実装例 **Go** ```go 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("namespace-0001"), Name: pointy.String("category-model-0001"), Description: nil, Metadata: nil, RewardIntervalMinutes: pointy.Int32(5), DefaultMaximumIdleMinutes: pointy.Int32(1440), RewardResetMode: pointy.String("Reset"), 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 ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->createCategoryModelMaster( (new CreateCategoryModelMasterRequest()) ->withNamespaceName("namespace-0001") ->withName("category-model-0001") ->withDescription(null) ->withMetadata(null) ->withRewardIntervalMinutes(5) ->withDefaultMaximumIdleMinutes(1440) ->withRewardResetMode("Reset") ->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") } ``` **Java** ```java 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("namespace-0001") .withName("category-model-0001") .withDescription(null) .withMetadata(null) .withRewardIntervalMinutes(5) .withDefaultMaximumIdleMinutes(1440) .withRewardResetMode("Reset") .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); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.CreateCategoryModelMaster( new Gs2.Gs2Idle.Request.CreateCategoryModelMasterRequest() .WithNamespaceName("namespace-0001") .WithName("category-model-0001") .WithDescription(null) .WithMetadata(null) .WithRewardIntervalMinutes(5) .WithDefaultMaximumIdleMinutes(1440) .WithRewardResetMode("Reset") .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; ``` **TypeScript** ```typescript 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("namespace-0001") .withName("category-model-0001") .withDescription(null) .withMetadata(null) .withRewardIntervalMinutes(5) .withDefaultMaximumIdleMinutes(1440) .withRewardResetMode("Reset") .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); } ``` **Python** ```python 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('namespace-0001') .with_name('category-model-0001') .with_description(None) .with_metadata(None) .with_reward_interval_minutes(5) .with_default_maximum_idle_minutes(1440) .with_reward_reset_mode('Reset') .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) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.create_category_model_master({ namespaceName="namespace-0001", name="category-model-0001", description=nil, metadata=nil, rewardIntervalMinutes=5, defaultMaximumIdleMinutes=1440, rewardResetMode="Reset", 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['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.create_category_model_master_async({ namespaceName="namespace-0001", name="category-model-0001", description=nil, metadata=nil, rewardIntervalMinutes=5, defaultMaximumIdleMinutes=1440, rewardResetMode="Reset", 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, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### getCategoryModelMaster カテゴリーモデルマスターを取得
特定の編集可能なカテゴリーモデルマスターの詳細を取得します。
報酬間隔、最大待機時間、報酬リセットモード、入手アクション、スケジュール参照を含む完全な設定を返します。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CategoryModelMaster](#categorymodelmaster) | カテゴリーモデルマスター | #### 実装例 **Go** ```go 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("namespace-0001"), CategoryName: pointy.String("category-model-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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 Gs2IdleRestClient( $session ); try { $result = $client->getCategoryModelMaster( (new GetCategoryModelMasterRequest()) ->withNamespaceName("namespace-0001") ->withCategoryName("category-model-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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("namespace-0001") .withCategoryName("category-model-0001") ); CategoryModelMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.GetCategoryModelMaster( new Gs2.Gs2Idle.Request.GetCategoryModelMasterRequest() .WithNamespaceName("namespace-0001") .WithCategoryName("category-model-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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("namespace-0001") .withCategoryName("category-model-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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('namespace-0001') .with_category_name('category-model-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.get_category_model_master({ namespaceName="namespace-0001", categoryName="category-model-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.get_category_model_master_async({ namespaceName="namespace-0001", categoryName="category-model-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### updateCategoryModelMaster カテゴリーモデルマスターを更新
既存のカテゴリーモデルマスターの設定を更新します。
報酬間隔、最大待機時間、報酬リセットモード、入手アクション、スケジュール参照を変更できます。
変更はマスターデータの更新プロセスで再度有効化するまで、現在アクティブなモデルには反映されません。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | description | string | | | | ~ 1024文字 | 説明文 | | metadata | string | | | | ~ 2048文字 | メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 | | rewardIntervalMinutes | int | | ✓| | 0 ~ 2147483646 | 報酬間隔（分）
各放置報酬の間の時間間隔（分）です。例えば60に設定すると、ユーザーは放置時間60分ごとに1つの報酬ユニットを獲得します。報酬の総数は（経過放置分数）/ rewardIntervalMinutes として計算され、acquireActions配列を循環します。 | | defaultMaximumIdleMinutes | int | | ✓| | 0 ~ 2147483646 | デフォルト最大放置時間（分）
このカテゴリーの新しいステータスに対するデフォルトの最大放置時間（分）です。この制限を超える放置時間は追加の報酬を蓄積しません。この値はステータス作成時に各ステータスの maximumIdleMinutes にコピーされ、入手アクションを通じてユーザーごとに拡張できます。 | | rewardResetMode | 文字列列挙型
enum {
  "Reset",
  "CarryOver"
}
| | | "Reset" | | 報酬リセットモード
ユーザーが報酬を受け取った後の放置時間の扱いを決定します。「Reset」は放置時間をゼロに戻し、部分的な間隔時間は失われます。「CarryOver」は追加の報酬を得るに足りなかった残り時間を保持し、次の報酬サイクルにカウントされます。"Reset": 待機時間を0にリセット / "CarryOver": 報酬を得るに至らなかった残り時間を持ち越す / | | acquireActions | [List<AcquireActionList>](#acquireactionlist) | | | [] | 1 ~ 100 items | 待機時間ごとに得られる入手アクションリスト
待機時間を「X分」だと仮定すると
「X / rewardIntervalMinutes」が報酬を受け取れる数になりますが、ここで指定した配列の要素をループすることで、待機時間ごとに異なる報酬を付与できます。 | | idlePeriodScheduleId | string | | | | ~ 1024文字 | 放置期間スケジュールID
放置時間が蓄積される期間を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ放置時間がカウントされます。イベントが繰り返される場合、ステータスは繰り返し回数を追跡し、新しいサイクルの開始時に放置時間をリセットして、イベント期間ごとに報酬が計算されるようにします。 | | receivePeriodScheduleId | string | | | | ~ 1024文字 | 受取期間スケジュールID
ユーザーが蓄積された放置報酬を受け取れる時間枠を定義するGS2-ScheduleイベントのGRNです。設定すると、イベントがアクティブな間のみ報酬の受け取りが受け付けられます。これにより、放置蓄積期間とは別の期間限定の報酬受取期間を設定できます。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CategoryModelMaster](#categorymodelmaster) | 更新したカテゴリーモデルマスター | #### 実装例 **Go** ```go 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.UpdateCategoryModelMaster( &idle.UpdateCategoryModelMasterRequest { NamespaceName: pointy.String("namespace-0001"), CategoryName: pointy.String("category-model-0001"), Description: pointy.String("description1"), Metadata: pointy.String("{\"hoge\": \"fuga\"}"), RewardIntervalMinutes: pointy.Int32(10), DefaultMaximumIdleMinutes: pointy.Int32(2880), RewardResetMode: nil, AcquireActions: []idle.AcquireActionList{ idle.AcquireActionList{ AcquireActions: []idle.AcquireAction{ idle.AcquireAction{ Action: pointy.String("Gs2Experience:AddExperienceByUserId"), Request: pointy.String("Gs2Experience:AddExperienceByUserId-request4"), }, idle.AcquireAction{ Action: pointy.String("Gs2Experience:AddExperienceByUserId"), Request: pointy.String("Gs2Experience:AddExperienceByUserId-request5"), }, }, }, idle.AcquireActionList{ AcquireActions: []idle.AcquireAction{ idle.AcquireAction{ Action: pointy.String("Gs2Experience:AddExperienceByUserId"), Request: pointy.String("Gs2Experience:AddExperienceByUserId-request6"), }, }, }, }, IdlePeriodScheduleId: nil, ReceivePeriodScheduleId: nil, } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\UpdateCategoryModelMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->updateCategoryModelMaster( (new UpdateCategoryModelMasterRequest()) ->withNamespaceName("namespace-0001") ->withCategoryName("category-model-0001") ->withDescription("description1") ->withMetadata("{\"hoge\": \"fuga\"}") ->withRewardIntervalMinutes(10) ->withDefaultMaximumIdleMinutes(2880) ->withRewardResetMode(null) ->withAcquireActions([ (new \Gs2\Idle\Model\AcquireActionList()) ->withAcquireActions([ (new \Gs2\Idle\Model\AcquireAction()) ->withAction("Gs2Experience:AddExperienceByUserId") ->withRequest("Gs2Experience:AddExperienceByUserId-request4"), (new \Gs2\Idle\Model\AcquireAction()) ->withAction("Gs2Experience:AddExperienceByUserId") ->withRequest("Gs2Experience:AddExperienceByUserId-request5"), ]), (new \Gs2\Idle\Model\AcquireActionList()) ->withAcquireActions([ (new \Gs2\Idle\Model\AcquireAction()) ->withAction("Gs2Experience:AddExperienceByUserId") ->withRequest("Gs2Experience:AddExperienceByUserId-request6"), ]), ]) ->withIdlePeriodScheduleId(null) ->withReceivePeriodScheduleId(null) ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.UpdateCategoryModelMasterRequest; import io.gs2.idle.result.UpdateCategoryModelMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { UpdateCategoryModelMasterResult result = client.updateCategoryModelMaster( new UpdateCategoryModelMasterRequest() .withNamespaceName("namespace-0001") .withCategoryName("category-model-0001") .withDescription("description1") .withMetadata("{\"hoge\": \"fuga\"}") .withRewardIntervalMinutes(10) .withDefaultMaximumIdleMinutes(2880) .withRewardResetMode(null) .withAcquireActions(Arrays.asList( new io.gs2.idle.model.AcquireActionList() .withAcquireActions(Arrays.asList( new io.gs2.idle.model.AcquireAction() .withAction("Gs2Experience:AddExperienceByUserId") .withRequest("Gs2Experience:AddExperienceByUserId-request4"), new io.gs2.idle.model.AcquireAction() .withAction("Gs2Experience:AddExperienceByUserId") .withRequest("Gs2Experience:AddExperienceByUserId-request5") )), new io.gs2.idle.model.AcquireActionList() .withAcquireActions(Arrays.asList( new io.gs2.idle.model.AcquireAction() .withAction("Gs2Experience:AddExperienceByUserId") .withRequest("Gs2Experience:AddExperienceByUserId-request6") )) )) .withIdlePeriodScheduleId(null) .withReceivePeriodScheduleId(null) ); CategoryModelMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.UpdateCategoryModelMaster( new Gs2.Gs2Idle.Request.UpdateCategoryModelMasterRequest() .WithNamespaceName("namespace-0001") .WithCategoryName("category-model-0001") .WithDescription("description1") .WithMetadata("{\"hoge\": \"fuga\"}") .WithRewardIntervalMinutes(10) .WithDefaultMaximumIdleMinutes(2880) .WithRewardResetMode(null) .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-request4"), new Gs2.Core.Model.AcquireAction() .WithAction("Gs2Experience:AddExperienceByUserId") .WithRequest("Gs2Experience:AddExperienceByUserId-request5"), }), new Gs2.Gs2Idle.Model.AcquireActionList() .WithAcquireActions(new Gs2.Core.Model.AcquireAction[] { new Gs2.Core.Model.AcquireAction() .WithAction("Gs2Experience:AddExperienceByUserId") .WithRequest("Gs2Experience:AddExperienceByUserId-request6"), }), }) .WithIdlePeriodScheduleId(null) .WithReceivePeriodScheduleId(null), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.updateCategoryModelMaster( new Gs2Idle.UpdateCategoryModelMasterRequest() .withNamespaceName("namespace-0001") .withCategoryName("category-model-0001") .withDescription("description1") .withMetadata("{\"hoge\": \"fuga\"}") .withRewardIntervalMinutes(10) .withDefaultMaximumIdleMinutes(2880) .withRewardResetMode(null) .withAcquireActions([ new Gs2Idle.model.AcquireActionList() .withAcquireActions([ new Gs2Idle.model.AcquireAction() .withAction("Gs2Experience:AddExperienceByUserId") .withRequest("Gs2Experience:AddExperienceByUserId-request4"), new Gs2Idle.model.AcquireAction() .withAction("Gs2Experience:AddExperienceByUserId") .withRequest("Gs2Experience:AddExperienceByUserId-request5"), ]), new Gs2Idle.model.AcquireActionList() .withAcquireActions([ new Gs2Idle.model.AcquireAction() .withAction("Gs2Experience:AddExperienceByUserId") .withRequest("Gs2Experience:AddExperienceByUserId-request6"), ]), ]) .withIdlePeriodScheduleId(null) .withReceivePeriodScheduleId(null) ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_category_model_master( idle.UpdateCategoryModelMasterRequest() .with_namespace_name('namespace-0001') .with_category_name('category-model-0001') .with_description('description1') .with_metadata('{"hoge": "fuga"}') .with_reward_interval_minutes(10) .with_default_maximum_idle_minutes(2880) .with_reward_reset_mode(None) .with_acquire_actions([ idle.AcquireActionList() .with_acquire_actions([ idle.AcquireAction() .with_action('Gs2Experience:AddExperienceByUserId') .with_request('Gs2Experience:AddExperienceByUserId-request4'), idle.AcquireAction() .with_action('Gs2Experience:AddExperienceByUserId') .with_request('Gs2Experience:AddExperienceByUserId-request5'), ]), idle.AcquireActionList() .with_acquire_actions([ idle.AcquireAction() .with_action('Gs2Experience:AddExperienceByUserId') .with_request('Gs2Experience:AddExperienceByUserId-request6'), ]), ]) .with_idle_period_schedule_id(None) .with_receive_period_schedule_id(None) ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.update_category_model_master({ namespaceName="namespace-0001", categoryName="category-model-0001", description="description1", metadata="{\"hoge\": \"fuga\"}", rewardIntervalMinutes=10, defaultMaximumIdleMinutes=2880, rewardResetMode=nil, acquireActions={ { acquireActions={ { action="Gs2Experience:AddExperienceByUserId", request="Gs2Experience:AddExperienceByUserId-request4", }, { action="Gs2Experience:AddExperienceByUserId", request="Gs2Experience:AddExperienceByUserId-request5", } }, }, { acquireActions={ { action="Gs2Experience:AddExperienceByUserId", request="Gs2Experience:AddExperienceByUserId-request6", } }, } }, idlePeriodScheduleId=nil, receivePeriodScheduleId=nil, }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.update_category_model_master_async({ namespaceName="namespace-0001", categoryName="category-model-0001", description="description1", metadata="{\"hoge\": \"fuga\"}", rewardIntervalMinutes=10, defaultMaximumIdleMinutes=2880, rewardResetMode=nil, acquireActions={ { acquireActions={ { action="Gs2Experience:AddExperienceByUserId", request="Gs2Experience:AddExperienceByUserId-request4", }, { action="Gs2Experience:AddExperienceByUserId", request="Gs2Experience:AddExperienceByUserId-request5", } }, }, { acquireActions={ { action="Gs2Experience:AddExperienceByUserId", request="Gs2Experience:AddExperienceByUserId-request6", } }, } }, idlePeriodScheduleId=nil, receivePeriodScheduleId=nil, }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` --- ### deleteCategoryModelMaster カテゴリーモデルマスターを削除
指定されたカテゴリーモデルマスターを削除します。
現在アクティブなモデルには影響せず、削除はマスターデータを再度有効化した後にのみ反映されます。
このカテゴリーに関連する既存のユーザーステータスは自動的には削除されません。 #### Request | | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | | --- | --- | --- | --- | --- | --- | --- | | namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | | categoryName | string | | ✓| | ~ 128文字 | カテゴリーモデル名
カテゴリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | #### Result | | 型 | 説明 | | --- | --- | --- | | item | [CategoryModelMaster](#categorymodelmaster) | 削除したカテゴリーモデルマスター | #### 実装例 **Go** ```go 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.DeleteCategoryModelMaster( &idle.DeleteCategoryModelMasterRequest { NamespaceName: pointy.String("namespace-0001"), CategoryName: pointy.String("category-model-0001"), } ) if err != nil { panic("error occurred") } item := result.Item ``` **PHP** ```php 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\DeleteCategoryModelMasterRequest; $session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region::AP_NORTHEAST_1 ); $session->open(); $client = new Gs2IdleRestClient( $session ); try { $result = $client->deleteCategoryModelMaster( (new DeleteCategoryModelMasterRequest()) ->withNamespaceName("namespace-0001") ->withCategoryName("category-model-0001") ); $item = $result->getItem(); } catch (Gs2Exception $e) { exit("error occurred") } ``` **Java** ```java 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.DeleteCategoryModelMasterRequest; import io.gs2.idle.result.DeleteCategoryModelMasterResult; Gs2RestSession session = new Gs2RestSession( Region.AP_NORTHEAST_1, new BasicGs2Credential( "your client id", "your client secret" ) ); session.connect(); Gs2IdleRestClient client = new Gs2IdleRestClient(session); try { DeleteCategoryModelMasterResult result = client.deleteCategoryModelMaster( new DeleteCategoryModelMasterRequest() .withNamespaceName("namespace-0001") .withCategoryName("category-model-0001") ); CategoryModelMaster item = result.getItem(); } catch (Gs2Exception e) { System.exit(1); } ``` **C#** ```csharp using Gs2.Core; using Gs2.Core.Model; using Gs2.Core.Net; using Gs2.Core.Exception; var session = new Gs2RestSession( new BasicGs2Credential( "your client id", "your client secret" ), Region.ApNortheast1 ); yield return session.OpenAsync(r => { }); var client = new Gs2IdleRestClient(session); AsyncResult asyncResult = null; yield return client.DeleteCategoryModelMaster( new Gs2.Gs2Idle.Request.DeleteCategoryModelMasterRequest() .WithNamespaceName("namespace-0001") .WithCategoryName("category-model-0001"), r => asyncResult = r ); if (asyncResult.Error != null) { throw asyncResult.Error; } var result = asyncResult.Result; var item = result.Item; ``` **TypeScript** ```typescript 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.deleteCategoryModelMaster( new Gs2Idle.DeleteCategoryModelMasterRequest() .withNamespaceName("namespace-0001") .withCategoryName("category-model-0001") ); const item = result.getItem(); } catch (e) { process.exit(1); } ``` **Python** ```python 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_category_model_master( idle.DeleteCategoryModelMasterRequest() .with_namespace_name('namespace-0001') .with_category_name('category-model-0001') ) item = result.item except core.Gs2Exception as e: exit(1) ``` **GS2-Script** ```lua client = gs2('idle') api_result = client.delete_category_model_master({ namespaceName="namespace-0001", categoryName="category-model-0001", }) if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` **GS2-Script(Async)** ```lua client = gs2('idle') api_result_handler = client.delete_category_model_master_async({ namespaceName="namespace-0001", categoryName="category-model-0001", }) api_result = api_result_handler() -- Call the handler to get the result if(api_result.isError) then -- When error occurs fail(api_result['statusCode'], api_result['errorMessage']) end result = api_result.result item = result.item; ``` ---