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

VerifyAction

検証アクション

Gs2Mission:VerifyCompleteByUserId

ユーザーIDを指定してミッションの達成状況を検証

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

説明
namespaceNamestringネームスペース名
missionGroupNamestringミッショングループ名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
verifyTypeenum [
    “completed”,
    “notCompleted”,
    “received”,
    “notReceived”,
    “completedAndNotReceived”
]
検証の種類
missionTaskNamestringタスク名
multiplyValueSpecifyingQuantitybool数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstringタイムオフセットトークン

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

定義説明
completed条件が達成済みであること
notCompleted条件が未達成であること
received報酬を受け取り済みであること
notReceived報酬が未受け取りであること
completedAndNotReceived条件が達成済みで、報酬を未受け取りであること
{
    "action": "Gs2Mission:VerifyCompleteByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "missionGroupName": "[string]ミッショングループ名",
        "userId": "[string]ユーザーID",
        "verifyType": "[string]検証の種類",
        "missionTaskName": "[string]タスク名",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Mission:VerifyCompleteByUserId
request:
  namespaceName: "[string]ネームスペース名"
  missionGroupName: "[string]ミッショングループ名"
  userId: "[string]ユーザーID"
  verifyType: "[string]検証の種類"
  missionTaskName: "[string]タスク名"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("mission").consume.verify_complete_by_user_id({
    namespaceName="[string]ネームスペース名",
    missionGroupName="[string]ミッショングループ名",
    userId="[string]ユーザーID",
    verifyType="[string]検証の種類",
    missionTaskName="[string]タスク名",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Mission:VerifyCounterValueByUserId

ユーザーIDを指定してカウンター値を検証

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

説明
namespaceNamestringネームスペース名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
counterNamestringカウンター名
verifyTypeenum [
    “less”,
    “lessEqual”,
    “greater”,
    “greaterEqual”,
    “equal”,
    “notEqual”
]
検証の種類
scopeTypeenum [
    “resetTiming”,
    “verifyAction”
]
スコープの種類
resetTypeenum [
    “notReset”,
    “daily”,
    “weekly”,
    “monthly”
]
リセットタイミング
conditionNamestring条件名
valuelongカウント
multiplyValueSpecifyingQuantitybool数量指定した際に、検証に使用する値も乗算するか
timeOffsetTokenstringタイムオフセットトークン

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

定義説明
lessカウンター値が指定値未満であること
lessEqualカウンター値が指定値以下であること
greaterカウンター値が指定値超過であること
greaterEqualカウンター値が指定値以上であること
equalカウンター値が指定値と一致すること
notEqualカウンター値が指定値と一致しないこと

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

定義説明
resetTimingリセットタイミング
verifyAction検証アクション

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

定義説明
notResetリセットしない
daily毎日
weekly毎週
monthly毎月
{
    "action": "Gs2Mission:VerifyCounterValueByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "counterName": "[string]カウンター名",
        "verifyType": "[string]検証の種類",
        "scopeType": "[string]スコープの種類",
        "resetType": "[string]リセットタイミング",
        "conditionName": "[string]条件名",
        "value": "[long]カウント",
        "multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Mission:VerifyCounterValueByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  counterName: "[string]カウンター名"
  verifyType: "[string]検証の種類"
  scopeType: "[string]スコープの種類"
  resetType: "[string]リセットタイミング"
  conditionName: "[string]条件名"
  value: "[long]カウント"
  multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("mission").consume.verify_counter_value_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    counterName="[string]カウンター名",
    verifyType="[string]検証の種類",
    scopeType="[string]スコープの種類",
    resetType="[string]リセットタイミング",
    conditionName="[string]条件名",
    value="[long]カウント",
    multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
    timeOffsetToken="[string]タイムオフセットトークン",
})

ConsumeAction

消費アクション

Gs2Mission:ReceiveByUserId

ミッション達成報酬を受領する

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

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

説明
namespaceNamestringネームスペース名
missionGroupNamestringミッショングループ名
missionTaskNamestringタスク名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Mission:ReceiveByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "missionGroupName": "[string]ミッショングループ名",
        "missionTaskName": "[string]タスク名",
        "userId": "[string]ユーザーID",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Mission:ReceiveByUserId
request:
  namespaceName: "[string]ネームスペース名"
  missionGroupName: "[string]ミッショングループ名"
  missionTaskName: "[string]タスク名"
  userId: "[string]ユーザーID"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("mission").consume.receive_by_user_id({
    namespaceName="[string]ネームスペース名",
    missionGroupName="[string]ミッショングループ名",
    missionTaskName="[string]タスク名",
    userId="[string]ユーザーID",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Mission:BatchReceiveByUserId

複数のミッションタスクの達成報酬を一括で受領状態にする

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

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

説明
namespaceNamestringネームスペース名
missionGroupNamestringミッショングループ名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
missionTaskNamesstring[]タスク名のリスト
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Mission:BatchReceiveByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "missionGroupName": "[string]ミッショングループ名",
        "userId": "[string]ユーザーID",
        "missionTaskNames": [
            "[string]タスク名"
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Mission:BatchReceiveByUserId
request:
  namespaceName: "[string]ネームスペース名"
  missionGroupName: "[string]ミッショングループ名"
  userId: "[string]ユーザーID"
  missionTaskNames: 
  - "[string]タスク名"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("mission").consume.batch_receive_by_user_id({
    namespaceName="[string]ネームスペース名",
    missionGroupName="[string]ミッショングループ名",
    userId="[string]ユーザーID",
    missionTaskNames={
        "[string]タスク名"
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Mission:DecreaseCounterByUserId

ユーザーIDを指定してカウンターを減算

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

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

説明
namespaceNamestringネームスペース名
counterNamestringカウンター名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
valuelong減算する値
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Mission:DecreaseCounterByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "counterName": "[string]カウンター名",
        "userId": "[string]ユーザーID",
        "value": "[long]減算する値",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Mission:DecreaseCounterByUserId
request:
  namespaceName: "[string]ネームスペース名"
  counterName: "[string]カウンター名"
  userId: "[string]ユーザーID"
  value: "[long]減算する値"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("mission").consume.decrease_counter_by_user_id({
    namespaceName="[string]ネームスペース名",
    counterName="[string]カウンター名",
    userId="[string]ユーザーID",
    value="[long]減算する値",
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2Mission:RevertReceiveByUserId

ミッション達成報酬を未受領状態にする

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

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

説明
namespaceNamestringネームスペース名
missionGroupNamestringミッショングループ名
missionTaskNamestringタスク名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Mission:RevertReceiveByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "missionGroupName": "[string]ミッショングループ名",
        "missionTaskName": "[string]タスク名",
        "userId": "[string]ユーザーID",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Mission:RevertReceiveByUserId
request:
  namespaceName: "[string]ネームスペース名"
  missionGroupName: "[string]ミッショングループ名"
  missionTaskName: "[string]タスク名"
  userId: "[string]ユーザーID"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("mission").acquire.revert_receive_by_user_id({
    namespaceName="[string]ネームスペース名",
    missionGroupName="[string]ミッショングループ名",
    missionTaskName="[string]タスク名",
    userId="[string]ユーザーID",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Mission:IncreaseCounterByUserId

ユーザーIDを指定してカウンターを加算

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

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

説明
namespaceNamestringネームスペース名
counterNamestringカウンター名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
valuelong加算する値
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Mission:IncreaseCounterByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "counterName": "[string]カウンター名",
        "userId": "[string]ユーザーID",
        "value": "[long]加算する値",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Mission:IncreaseCounterByUserId
request:
  namespaceName: "[string]ネームスペース名"
  counterName: "[string]カウンター名"
  userId: "[string]ユーザーID"
  value: "[long]加算する値"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("mission").acquire.increase_counter_by_user_id({
    namespaceName="[string]ネームスペース名",
    counterName="[string]カウンター名",
    userId="[string]ユーザーID",
    value="[long]加算する値",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Mission:SetCounterByUserId

ユーザーIDを指定してカウンターを設定

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

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

説明
namespaceNamestringネームスペース名
counterNamestringカウンター名
userIdstring#{userId} と設定することでログイン中のユーザーIDに置換されます
valuesScopedValue[]設定する値のリスト
timeOffsetTokenstringタイムオフセットトークン
{
    "action": "Gs2Mission:SetCounterByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "counterName": "[string]カウンター名",
        "userId": "[string]ユーザーID",
        "values": [
            {
                "scopeType": "[string]スコープの種類",
                "resetType": "[string]リセットタイミング",
                "conditionName": "[string]条件名",
                "value": "[long]カウント",
                "nextResetAt": "[long]次回リセットタイミング",
                "updatedAt": "[long]最終更新日時"
            }
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Mission:SetCounterByUserId
request:
  namespaceName: "[string]ネームスペース名"
  counterName: "[string]カウンター名"
  userId: "[string]ユーザーID"
  values: 
    - scopeType: "[string]スコープの種類"
      resetType: "[string]リセットタイミング"
      conditionName: "[string]条件名"
      value: "[long]カウント"
      nextResetAt: "[long]次回リセットタイミング"
      updatedAt: "[long]最終更新日時"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("mission").acquire.set_counter_by_user_id({
    namespaceName="[string]ネームスペース名",
    counterName="[string]カウンター名",
    userId="[string]ユーザーID",
    values={
        {
            scopeType="[string]スコープの種類",
            resetType="[string]リセットタイミング",
            conditionName="[string]条件名",
            value="[long]カウント",
            nextResetAt="[long]次回リセットタイミング",
            updatedAt="[long]最終更新日時"
        }
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})