GS2-Grade トランザクションアクション

検証/消費/入手の各トランザクションアクションの仕様

VerifyAction

検証アクション

Gs2Grade:VerifyGradeByUserId

ユーザーIDを指定してグレードを検証

数量指定可能なアクション:いいえ

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
gradeNamestringグレードモデルの名前
verifyTypeenum [
    “less”,
    “lessEqual”,
    “greater”,
    “greaterEqual”,
    “equal”,
    “notEqual”
]
検証の種類
propertyIdstringプロパティID
gradeValuelong現在のグレード
multiplyValueSpecifyingQuantitybool数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstringタイムオフセットトークン

verifyType に指定する列挙型の定義

定義説明
lessグレードが指定値未満であること
lessEqualグレードが指定値以下であること
greaterグレードが指定値超過であること
greaterEqualグレードが指定値以上であること
equalグレードが指定値と一致すること
notEqualグレードが指定値と一致しないこと
{ "action": "Gs2Grade:VerifyGradeByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "gradeName": "[string]グレードモデルの名前", "verifyType": "[string]検証の種類", "propertyId": "[string]プロパティID", "gradeValue": "[long]現在のグレード", "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか", "timeOffsetToken": "[string]タイムオフセットトークン" } }
action: Gs2Grade:VerifyGradeByUserId request: namespaceName: "[string]ネームスペース名" userId: "[string]ユーザーID" gradeName: "[string]グレードモデルの名前" verifyType: "[string]検証の種類" propertyId: "[string]プロパティID" gradeValue: "[long]現在のグレード" multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか" timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("grade").consume.verify_grade_by_user_id({ namespaceName="[string]ネームスペース名", userId="[string]ユーザーID", gradeName="[string]グレードモデルの名前", verifyType="[string]検証の種類", propertyId="[string]プロパティID", gradeValue="[long]現在のグレード", multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか", timeOffsetToken="[string]タイムオフセットトークン", })

Gs2Grade:VerifyGradeUpMaterialByUserId

ユーザーIDを指定してグレードアップに使用する素材を検証

数量指定可能なアクション:いいえ

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
gradeNamestringグレードモデルの名前
verifyTypeenum [
    “match”,
    “notMatch”
]
検証の種類
propertyIdstringプロパティID
materialPropertyIdstringプロパティID
timeOffsetTokenstringタイムオフセットトークン

verifyType に指定する列挙型の定義

定義説明
match条件に一致していること
notMatch条件に一致していないこと
{ "action": "Gs2Grade:VerifyGradeUpMaterialByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "gradeName": "[string]グレードモデルの名前", "verifyType": "[string]検証の種類", "propertyId": "[string]プロパティID", "materialPropertyId": "[string]プロパティID", "timeOffsetToken": "[string]タイムオフセットトークン" } }
action: Gs2Grade:VerifyGradeUpMaterialByUserId request: namespaceName: "[string]ネームスペース名" userId: "[string]ユーザーID" gradeName: "[string]グレードモデルの名前" verifyType: "[string]検証の種類" propertyId: "[string]プロパティID" materialPropertyId: "[string]プロパティID" timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("grade").consume.verify_grade_up_material_by_user_id({ namespaceName="[string]ネームスペース名", userId="[string]ユーザーID", gradeName="[string]グレードモデルの名前", verifyType="[string]検証の種類", propertyId="[string]プロパティID", materialPropertyId="[string]プロパティID", timeOffsetToken="[string]タイムオフセットトークン", })

ConsumeAction

消費アクション

Gs2Grade:SubGradeByUserId

ユーザーIDを指定してグレードを減算

数量指定可能なアクション:はい

反転可能なアクション:はい

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
gradeNamestringグレードモデルの名前
propertyIdstringプロパティID
gradeValuelong失うグレード
timeOffsetTokenstringタイムオフセットトークン
{ "action": "Gs2Grade:SubGradeByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "gradeName": "[string]グレードモデルの名前", "propertyId": "[string]プロパティID", "gradeValue": "[long]失うグレード", "timeOffsetToken": "[string]タイムオフセットトークン" } }
action: Gs2Grade:SubGradeByUserId request: namespaceName: "[string]ネームスペース名" userId: "[string]ユーザーID" gradeName: "[string]グレードモデルの名前" propertyId: "[string]プロパティID" gradeValue: "[long]失うグレード" timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("grade").consume.sub_grade_by_user_id({ namespaceName="[string]ネームスペース名", userId="[string]ユーザーID", gradeName="[string]グレードモデルの名前", propertyId="[string]プロパティID", gradeValue="[long]失うグレード", timeOffsetToken="[string]タイムオフセットトークン", })

AcquireAction

入手アクション

Gs2Grade:AddGradeByUserId

ユーザーIDを指定してグレードを加算

数量指定可能なアクション:はい

反転可能なアクション:はい

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
gradeNamestringグレードモデルの名前
propertyIdstringプロパティID
gradeValuelong獲得グレード
timeOffsetTokenstringタイムオフセットトークン
{ "action": "Gs2Grade:AddGradeByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "gradeName": "[string]グレードモデルの名前", "propertyId": "[string]プロパティID", "gradeValue": "[long]獲得グレード", "timeOffsetToken": "[string]タイムオフセットトークン" } }
action: Gs2Grade:AddGradeByUserId request: namespaceName: "[string]ネームスペース名" userId: "[string]ユーザーID" gradeName: "[string]グレードモデルの名前" propertyId: "[string]プロパティID" gradeValue: "[long]獲得グレード" timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("grade").acquire.add_grade_by_user_id({ namespaceName="[string]ネームスペース名", userId="[string]ユーザーID", gradeName="[string]グレードモデルの名前", propertyId="[string]プロパティID", gradeValue="[long]獲得グレード", timeOffsetToken="[string]タイムオフセットトークン", })

Gs2Grade:ApplyRankCapByUserId

ユーザーIDを指定して GS2-Experience にランクキャップを適用

数量指定可能なアクション:いいえ

反転可能なアクション:いいえ

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
gradeNamestringグレードモデルの名前
propertyIdstringプロパティID
timeOffsetTokenstringタイムオフセットトークン
{ "action": "Gs2Grade:ApplyRankCapByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "gradeName": "[string]グレードモデルの名前", "propertyId": "[string]プロパティID", "timeOffsetToken": "[string]タイムオフセットトークン" } }
action: Gs2Grade:ApplyRankCapByUserId request: namespaceName: "[string]ネームスペース名" userId: "[string]ユーザーID" gradeName: "[string]グレードモデルの名前" propertyId: "[string]プロパティID" timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("grade").acquire.apply_rank_cap_by_user_id({ namespaceName="[string]ネームスペース名", userId="[string]ユーザーID", gradeName="[string]グレードモデルの名前", propertyId="[string]プロパティID", timeOffsetToken="[string]タイムオフセットトークン", })

Gs2Grade:MultiplyAcquireActionsByUserId

ユーザーIDを指定してグレードの対象プロパティのグレードに応じてリソースを加算

数量指定可能なアクション:いいえ

反転可能なアクション:いいえ

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
gradeNamestringグレードモデルの名前
propertyIdstringプロパティID
rateNamestring報酬加算テーブル名
acquireActionsAcquireAction[]入手アクションリスト
timeOffsetTokenstringタイムオフセットトークン
{ "action": "Gs2Grade:MultiplyAcquireActionsByUserId", "request": { "namespaceName": "[string]ネームスペース名", "userId": "[string]ユーザーID", "gradeName": "[string]グレードモデルの名前", "propertyId": "[string]プロパティID", "rateName": "[string]報酬加算テーブル名", "acquireActions": [ { "action": "[string]入手アクションで実行するアクションの種類", "request": "[string]リクエストのJSON" } ], "timeOffsetToken": "[string]タイムオフセットトークン" } }
action: Gs2Grade:MultiplyAcquireActionsByUserId request: namespaceName: "[string]ネームスペース名" userId: "[string]ユーザーID" gradeName: "[string]グレードモデルの名前" propertyId: "[string]プロパティID" rateName: "[string]報酬加算テーブル名" acquireActions: - action: "[string]入手アクションで実行するアクションの種類" request: "[string]リクエストのJSON" timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("grade").acquire.multiply_acquire_actions_by_user_id({ namespaceName="[string]ネームスペース名", userId="[string]ユーザーID", gradeName="[string]グレードモデルの名前", propertyId="[string]プロパティID", rateName="[string]報酬加算テーブル名", acquireActions={ { action="[string]入手アクションで実行するアクションの種類", request="[string]リクエストのJSON" } }, timeOffsetToken="[string]タイムオフセットトークン", })