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

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

VerifyAction

検証アクション

Gs2Mission:VerifyCompleteByUserId

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

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

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

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を指定してカウンター値を検証

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

	型	説明
namespaceName	string	ネームスペース名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
counterName	string	カウンター名
verifyType	enum [ “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” ]	検証の種類
scopeType	enum [ “resetTiming”, “verifyAction” ]	スコープの種類
resetType	enum [ “notReset”, “daily”, “weekly”, “monthly”, “days” ]	リセットタイミング
conditionName	string	条件名
value	long	カウント
multiplyValueSpecifyingQuantity	bool	数量指定した際に、検証に使用する値も乗算するか
timeOffsetToken	string	タイムオフセットトークン

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

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

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

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

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

定義	説明
notReset	リセットしない
daily	毎日
weekly	毎週
monthly	毎月
days	一定日数ごと

{
    "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

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

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

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

	型	説明
namespaceName	string	ネームスペース名
missionGroupName	string	ミッショングループ名
missionTaskName	string	タスク名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
timeOffsetToken	string	タイムオフセットトークン

{
    "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

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

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

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

	型	説明
namespaceName	string	ネームスペース名
missionGroupName	string	ミッショングループ名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
missionTaskNames	string[]	タスク名のリスト
timeOffsetToken	string	タイムオフセットトークン

{
    "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を指定してカウンターを減算

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

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

	型	説明
namespaceName	string	ネームスペース名
counterName	string	カウンター名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
value	long	減算する値
timeOffsetToken	string	タイムオフセットトークン

{
    "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]タイムオフセットトークン",
})

Gs2Mission:ResetCounterByUserId

ユーザーIDを指定してカウンターをリセット

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

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

	型	説明
namespaceName	string	ネームスペース名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
counterName	string	カウンター名
scopes	ScopedValue[]	スコープリスト
timeOffsetToken	string	タイムオフセットトークン

{
    "action": "Gs2Mission:ResetCounterByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "counterName": "[string]カウンター名",
        "scopes": [
            {
                "scopeType": "[string]スコープの種類",
                "resetType": "[string]リセットタイミング",
                "conditionName": "[string]条件名",
                "value": "[long]カウント",
                "nextResetAt": "[long]次回リセットタイミング",
                "updatedAt": "[long]最終更新日時"
            }
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Mission:ResetCounterByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  counterName: "[string]カウンター名"
  scopes: 
  - scopeType: "[string]スコープの種類"
    resetType: "[string]リセットタイミング"
    conditionName: "[string]条件名"
    value: "[long]カウント"
    nextResetAt: "[long]次回リセットタイミング"
    updatedAt: "[long]最終更新日時"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("mission").consume.reset_counter_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    counterName="[string]カウンター名",
    scopes={
        {
            scopeType="[string]スコープの種類",
            resetType="[string]リセットタイミング",
            conditionName="[string]条件名",
            value="[long]カウント",
            nextResetAt="[long]次回リセットタイミング",
            updatedAt="[long]最終更新日時"
        }
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2Mission:RevertReceiveByUserId

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

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

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

	型	説明
namespaceName	string	ネームスペース名
missionGroupName	string	ミッショングループ名
missionTaskName	string	タスク名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
timeOffsetToken	string	タイムオフセットトークン

{
    "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を指定してカウンターを加算

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

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

	型	説明
namespaceName	string	ネームスペース名
counterName	string	カウンター名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
value	long	加算する値
timeOffsetToken	string	タイムオフセットトークン

{
    "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を指定してカウンターを設定

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

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

	型	説明
namespaceName	string	ネームスペース名
counterName	string	カウンター名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
values	ScopedValue[]	設定する値のリスト
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]タイムオフセットトークン"
    }
}

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]タイムオフセットトークン",
})