GS2-Exchange トランザクションアクション
検証/消費/入手の各トランザクションアクションの仕様
ConsumeAction
消費アクション
Gs2Exchange:DeleteAwaitByUserId
交換待機を削除
数量指定可能なアクション:いいえ
反転可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| awaitName | string | ✓ | UUID | ~ 36文字 | 交換待機の名前 交換待機の一意な名前を保持します。 名前は UUID(Universally Unique Identifier)フォーマットで自動的に生成され、交換待機を識別するために使用されます。 | |
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Exchange:DeleteAwaitByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"awaitName": "[string]交換待機の名前",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Exchange:DeleteAwaitByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
awaitName: "[string]交換待機の名前"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("exchange").consume.delete_await_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
awaitName="[string]交換待機の名前",
timeOffsetToken="[string]タイムオフセットトークン",
})AcquireAction
入手アクション
Gs2Exchange:ExchangeByUserId
ユーザーIDを指定して交換を実行
数量指定可能なアクション:はい
反転可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| rateName | string | ✓ | ~ 128文字 | 交換レートモデル名 交換レートモデルの種類固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| count | int | ✓ | 1 ~ 1073741821 | 交換するロット数 | ||
| config | List<Config> | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | ||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Exchange:ExchangeByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"rateName": "[string]交換レートモデル名",
"userId": "[string]ユーザーID",
"count": "[int]交換するロット数",
"config": [
{
"key": "[string]名前",
"value": "[string]値"
}
],
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Exchange:ExchangeByUserId
request:
namespaceName: "[string]ネームスペース名"
rateName: "[string]交換レートモデル名"
userId: "[string]ユーザーID"
count: "[int]交換するロット数"
config:
- key: "[string]名前"
value: "[string]値"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("exchange").acquire.exchange_by_user_id({
namespaceName="[string]ネームスペース名",
rateName="[string]交換レートモデル名",
userId="[string]ユーザーID",
count="[int]交換するロット数",
config={
{
key="[string]名前",
value="[string]値"
}
},
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Exchange:IncrementalExchangeByUserId
ユーザーIDを指定してコスト上昇型交換を実行
数量指定可能なアクション:はい
反転可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| rateName | string | ✓ | ~ 128文字 | コスト上昇型交換レートモデルの名前 コスト上昇型交換レートモデルの種類固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| count | int | ✓ | 1 ~ 1073741821 | 交換するロット数 | ||
| config | List<Config> | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | ||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Exchange:IncrementalExchangeByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"rateName": "[string]コスト上昇型交換レートモデルの名前",
"userId": "[string]ユーザーID",
"count": "[int]交換するロット数",
"config": [
{
"key": "[string]名前",
"value": "[string]値"
}
],
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Exchange:IncrementalExchangeByUserId
request:
namespaceName: "[string]ネームスペース名"
rateName: "[string]コスト上昇型交換レートモデルの名前"
userId: "[string]ユーザーID"
count: "[int]交換するロット数"
config:
- key: "[string]名前"
value: "[string]値"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("exchange").acquire.incremental_exchange_by_user_id({
namespaceName="[string]ネームスペース名",
rateName="[string]コスト上昇型交換レートモデルの名前",
userId="[string]ユーザーID",
count="[int]交換するロット数",
config={
{
key="[string]名前",
value="[string]値"
}
},
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Exchange:CreateAwaitByUserId
ユーザーIDを指定して交換待機を作成
数量指定可能なアクション:はい
反転可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| rateName | string | ✓ | ~ 128文字 | 交換レートモデル名 交換レートモデルの種類固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| count | int | ✓ | 1 | 1 ~ 10000 | 交換数 | |
| config | List<Config> | [] | 0 ~ 32 items | 報酬取得時に適用する設定値のデフォルト値 | ||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Exchange:CreateAwaitByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"rateName": "[string]交換レートモデル名",
"count": "[int]交換数",
"config": [
{
"key": "[string]名前",
"value": "[string]値"
}
],
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Exchange:CreateAwaitByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
rateName: "[string]交換レートモデル名"
count: "[int]交換数"
config:
- key: "[string]名前"
value: "[string]値"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("exchange").acquire.create_await_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
rateName="[string]交換レートモデル名",
count="[int]交換数",
config={
{
key="[string]名前",
value="[string]値"
}
},
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Exchange:AcquireForceByUserId
交換待機の報酬を、待機時間の判定を行わず強制取得
数量指定可能なアクション:いいえ
反転可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| awaitName | string | ✓ | UUID | ~ 36文字 | 交換待機の名前 交換待機の一意な名前を保持します。 名前は UUID(Universally Unique Identifier)フォーマットで自動的に生成され、交換待機を識別するために使用されます。 | |
| config | List<Config> | [] | 0 ~ 32 items | トランザクションの変数に適用する設定値 | ||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Exchange:AcquireForceByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"awaitName": "[string]交換待機の名前",
"config": [
{
"key": "[string]名前",
"value": "[string]値"
}
],
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Exchange:AcquireForceByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
awaitName: "[string]交換待機の名前"
config:
- key: "[string]名前"
value: "[string]値"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("exchange").acquire.acquire_force_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
awaitName="[string]交換待機の名前",
config={
{
key="[string]名前",
value="[string]値"
}
},
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Exchange:SkipByUserId
ユーザーIDを指定して交換待機をスキップ
数量指定可能なアクション:はい
反転可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||||||||||||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||||||||||||
| awaitName | string | ✓ | UUID | ~ 36文字 | 交換待機の名前 交換待機の一意な名前を保持します。 名前は UUID(Universally Unique Identifier)フォーマットで自動的に生成され、交換待機を識別するために使用されます。 | |||||||||||
| skipType | 文字列列挙型 enum { “complete”, “minutes”, “totalRate”, “remainRate” } | ✓ | “complete” | スキップ方法
| ||||||||||||
| minutes | int | {skipType} == “minutes” | 0 ~ 2147483646 | スキップする分数 ※ skipType が “minutes” であれば有効 | ||||||||||||
| rate | float | {skipType} == “totalRate” or {skipType} == “remainRate” | 0 ~ 1 | スキップする割合 | ||||||||||||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Exchange:SkipByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"awaitName": "[string]交換待機の名前",
"skipType": "[string]スキップ方法",
"minutes": "[int]スキップする分数",
"rate": "[float]スキップする割合",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Exchange:SkipByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
awaitName: "[string]交換待機の名前"
skipType: "[string]スキップ方法"
minutes: "[int]スキップする分数"
rate: "[float]スキップする割合"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("exchange").acquire.skip_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
awaitName="[string]交換待機の名前",
skipType="[string]スキップ方法",
minutes="[int]スキップする分数",
rate="[float]スキップする割合",
timeOffsetToken="[string]タイムオフセットトークン",
})