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

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

VerifyAction

検証アクション

Gs2SerialKey:VerifyCodeByUserId

ユーザーIDを指定してシリアルコードの有効性を確認

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

型有効化条件必須デフォルト値の制限説明

namespaceName

string

✓

~ 128文字

ネームスペース名

ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。

userId

string

✓

~ 128文字

ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。

code

string

✓

~ 48文字

シリアルコード

campaignModelName string ~ 128文字キャンペーン名

verifyType

文字列列挙型
enum {
“active”,
“inactive”
}

✓

検証タイプ

定義	説明
“active”	有効
“inactive”	無効

timeOffsetToken string ~ 1024文字タイムオフセットトークン

{
    "action": "Gs2SerialKey:VerifyCodeByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "code": "[string]シリアルコード",
        "campaignModelName": "[string]キャンペーン名",
        "verifyType": "[string]検証タイプ",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2SerialKey:VerifyCodeByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  code: "[string]シリアルコード"
  campaignModelName: "[string]キャンペーン名"
  verifyType: "[string]検証タイプ"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("serialKey").verify.verify_code_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    code="[string]シリアルコード",
    campaignModelName="[string]キャンペーン名",
    verifyType="[string]検証タイプ",
    timeOffsetToken="[string]タイムオフセットトークン",
})

ConsumeAction

消費アクション

Gs2SerialKey:UseByUserId

ユーザーIDを指定してシリアルコードの使用済み化

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

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

	型	必須	値の制限	説明
namespaceName	string	✓	~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userId	string	✓	~ 128文字	ユーザーID `#{userId}` と設定することでログイン中のユーザーIDに置換されます。
code	string	✓	~ 48文字	シリアルコード
timeOffsetToken	string		~ 1024文字	タイムオフセットトークン

{
    "action": "Gs2SerialKey:UseByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "code": "[string]シリアルコード",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2SerialKey:UseByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  code: "[string]シリアルコード"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("serialKey").consume.use_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    code="[string]シリアルコード",
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2SerialKey:RevertUseByUserId

ユーザーIDを指定してシリアルコードを未使用化

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

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

	型	必須	値の制限	説明
namespaceName	string	✓	~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userId	string	✓	~ 128文字	ユーザーID `#{userId}` と設定することでログイン中のユーザーIDに置換されます。
code	string	✓	~ 48文字	シリアルコード
timeOffsetToken	string		~ 1024文字	タイムオフセットトークン

{
    "action": "Gs2SerialKey:RevertUseByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "code": "[string]シリアルコード",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2SerialKey:RevertUseByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  code: "[string]シリアルコード"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("serialKey").acquire.revert_use_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    code="[string]シリアルコード",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2SerialKey:IssueOnce

シリアルコードを1件発行

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

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

	型	必須	値の制限	説明
namespaceName	string	✓	~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
campaignModelName	string	✓	~ 128文字	キャンペーン名
metadata	string		~ 2048文字	メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。

{
    "action": "Gs2SerialKey:IssueOnce",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "campaignModelName": "[string]キャンペーン名",
        "metadata": "[string]メタデータ"
    }
}

action: Gs2SerialKey:IssueOnce
request:
  namespaceName: "[string]ネームスペース名"
  campaignModelName: "[string]キャンペーン名"
  metadata: "[string]メタデータ"

transaction.service("serialKey").acquire.issue_once({
    namespaceName="[string]ネームスペース名",
    campaignModelName="[string]キャンペーン名",
    metadata="[string]メタデータ",
})