GS2-Experience トランザクションアクション
検証/消費/入手の各トランザクションアクションの仕様
VerifyAction
検証アクション
Gs2Experience:VerifyRankByUserId
ユーザーIDを指定してランクを検証
数量指定可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||||||||||||||||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||||||||||||||||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||||||||||||||||
| verifyType | 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | 検証の種類
| |||||||||||||||||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||||||||||||||||
| rankValue | long | ✓ | 0 | 0 ~ 9223372036854775805 | 現在のランク | |||||||||||||||
| multiplyValueSpecifyingQuantity | bool | ✓ | false | 数量指定した際に、検証に使用する値も乗算するか | ||||||||||||||||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:VerifyRankByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"verifyType": "[string]検証の種類",
"propertyId": "[string]プロパティID",
"rankValue": "[long]現在のランク",
"multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:VerifyRankByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
verifyType: "[string]検証の種類"
propertyId: "[string]プロパティID"
rankValue: "[long]現在のランク"
multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").verify.verify_rank_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
verifyType="[string]検証の種類",
propertyId="[string]プロパティID",
rankValue="[long]現在のランク",
multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Experience:VerifyRankCapByUserId
ユーザーIDを指定してランクキャップを検証
数量指定可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||||||||||||||||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||||||||||||||||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||||||||||||||||
| verifyType | 文字列列挙型 enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | 検証の種類
| |||||||||||||||||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||||||||||||||||
| rankCapValue | long | ✓ | 0 ~ 9223372036854775805 | 現在のランクキャップ | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | ✓ | false | 数量指定した際に、検証に使用する値も乗算するか | ||||||||||||||||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:VerifyRankCapByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"verifyType": "[string]検証の種類",
"propertyId": "[string]プロパティID",
"rankCapValue": "[long]現在のランクキャップ",
"multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:VerifyRankCapByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
verifyType: "[string]検証の種類"
propertyId: "[string]プロパティID"
rankCapValue: "[long]現在のランクキャップ"
multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").verify.verify_rank_cap_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
verifyType="[string]検証の種類",
propertyId="[string]プロパティID",
rankCapValue="[long]現在のランクキャップ",
multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
timeOffsetToken="[string]タイムオフセットトークン",
})ConsumeAction
消費アクション
Gs2Experience:SubExperienceByUserId
ユーザーIDを指定して経験値を減算
数量指定可能なアクション:はい
反転可能なアクション:はい
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||
| experienceValue | long | ✓ | 0 | 0 ~ 9223372036854775805 | 失う経験値 | |
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:SubExperienceByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"propertyId": "[string]プロパティID",
"experienceValue": "[long]失う経験値",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:SubExperienceByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
propertyId: "[string]プロパティID"
experienceValue: "[long]失う経験値"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").consume.sub_experience_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
propertyId="[string]プロパティID",
experienceValue="[long]失う経験値",
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Experience:SubRankCapByUserId
ユーザーIDを指定してランクキャップを減算
数量指定可能なアクション:はい
反転可能なアクション:はい
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||
| rankCapValue | long | ✓ | 0 ~ 9223372036854775805 | 現在のランクキャップ | ||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:SubRankCapByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"propertyId": "[string]プロパティID",
"rankCapValue": "[long]現在のランクキャップ",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:SubRankCapByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
propertyId: "[string]プロパティID"
rankCapValue: "[long]現在のランクキャップ"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").consume.sub_rank_cap_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
propertyId="[string]プロパティID",
rankCapValue="[long]現在のランクキャップ",
timeOffsetToken="[string]タイムオフセットトークン",
})AcquireAction
入手アクション
Gs2Experience:AddExperienceByUserId
ユーザーIDを指定して経験値を加算
数量指定可能なアクション:はい
反転可能なアクション:はい
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||
| experienceValue | long | ✓ | 0 | 0 ~ 9223372036854775805 | 獲得経験値 | |
| truncateExperienceWhenRankUp | bool? | false | ランクアップ時に残りの経験値を切り捨てるか | |||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"propertyId": "[string]プロパティID",
"experienceValue": "[long]獲得経験値",
"truncateExperienceWhenRankUp": "[bool]ランクアップ時に残りの経験値を切り捨てるか",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:AddExperienceByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
propertyId: "[string]プロパティID"
experienceValue: "[long]獲得経験値"
truncateExperienceWhenRankUp: "[bool]ランクアップ時に残りの経験値を切り捨てるか"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").acquire.add_experience_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
propertyId="[string]プロパティID",
experienceValue="[long]獲得経験値",
truncateExperienceWhenRankUp="[bool]ランクアップ時に残りの経験値を切り捨てるか",
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Experience:SetExperienceByUserId
ユーザーIDを指定して経験値を設定
数量指定可能なアクション:はい
反転可能なアクション:はい
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||
| experienceValue | long | ✓ | 0 | 0 ~ 9223372036854775805 | 累計獲得経験値 | |
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:SetExperienceByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"propertyId": "[string]プロパティID",
"experienceValue": "[long]累計獲得経験値",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:SetExperienceByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
propertyId: "[string]プロパティID"
experienceValue: "[long]累計獲得経験値"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").acquire.set_experience_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
propertyId="[string]プロパティID",
experienceValue="[long]累計獲得経験値",
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Experience:AddRankCapByUserId
ユーザーIDを指定してランクキャップを加算
数量指定可能なアクション:はい
反転可能なアクション:はい
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||
| rankCapValue | long | ✓ | 0 ~ 9223372036854775805 | 現在のランクキャップ | ||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:AddRankCapByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"propertyId": "[string]プロパティID",
"rankCapValue": "[long]現在のランクキャップ",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:AddRankCapByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
propertyId: "[string]プロパティID"
rankCapValue: "[long]現在のランクキャップ"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").acquire.add_rank_cap_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
propertyId="[string]プロパティID",
rankCapValue="[long]現在のランクキャップ",
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Experience:SetRankCapByUserId
ユーザーIDを指定してランクキャップを設定
数量指定可能なアクション:いいえ
反転可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||
| rankCapValue | long | ✓ | 0 ~ 9223372036854775805 | 現在のランクキャップ | ||
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:SetRankCapByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"propertyId": "[string]プロパティID",
"rankCapValue": "[long]現在のランクキャップ",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:SetRankCapByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
propertyId: "[string]プロパティID"
rankCapValue: "[long]現在のランクキャップ"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").acquire.set_rank_cap_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
propertyId="[string]プロパティID",
rankCapValue="[long]現在のランクキャップ",
timeOffsetToken="[string]タイムオフセットトークン",
})Gs2Experience:MultiplyAcquireActionsByUserId
ユーザーIDを指定して経験値の対象プロパティのランクに応じてリソースを加算
数量指定可能なアクション:はい
反転可能なアクション:いいえ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 | ||
| userId | string | ✓ | ~ 128文字 | ユーザーID#{userId} と設定することでログイン中のユーザーIDに置換されます。 | ||
| experienceName | string | ✓ | ~ 128文字 | 経験値モデル名 | ||
| propertyId | string | ✓ | ~ 1024文字 | プロパティID | ||
| rateName | string | ✓ | ~ 128文字 | 報酬加算テーブル名 | ||
| acquireActions | List<AcquireAction> | [] | 0 ~ 100 items | 入手アクションリスト | ||
| baseRate | float | ✓ | 1 | 0 ~ 1000000 | 基礎倍率 | |
| timeOffsetToken | string | ~ 1024文字 | タイムオフセットトークン |
{
"action": "Gs2Experience:MultiplyAcquireActionsByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"experienceName": "[string]経験値モデル名",
"propertyId": "[string]プロパティID",
"rateName": "[string]報酬加算テーブル名",
"acquireActions": [
{
"action": "[string]入手アクションで実行するアクションの種類",
"request": "[string]アクション実行時に使用されるリクエストのJSON文字列"
}
],
"baseRate": "[float]基礎倍率",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}action: Gs2Experience:MultiplyAcquireActionsByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
experienceName: "[string]経験値モデル名"
propertyId: "[string]プロパティID"
rateName: "[string]報酬加算テーブル名"
acquireActions:
- action: "[string]入手アクションで実行するアクションの種類"
request: "[string]アクション実行時に使用されるリクエストのJSON文字列"
baseRate: "[float]基礎倍率"
timeOffsetToken: "[string]タイムオフセットトークン"transaction.service("experience").acquire.multiply_acquire_actions_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
experienceName="[string]経験値モデル名",
propertyId="[string]プロパティID",
rateName="[string]報酬加算テーブル名",
acquireActions={
{
action="[string]入手アクションで実行するアクションの種類",
request="[string]アクション実行時に使用されるリクエストのJSON文字列"
}
},
baseRate="[float]基礎倍率",
timeOffsetToken="[string]タイムオフセットトークン",
})