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

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

VerifyAction

検証アクション

Gs2Dictionary:VerifyEntryByUserId

ユーザーIDを指定してエントリーを検証

指定されたユーザーが特定のエントリーを収集済みか未収集かを検証します。
検証タイプで条件を指定します：‘have’ はユーザーがエントリーを保有していることを確認し、‘havent’ は保有していないことを確認します。
検証に失敗した場合、エラーが返されます。

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

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
✓
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
entryModelNamestring
✓
~ 128文字エントリーモデル名
エントリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
verifyType文字列列挙型
enum {
  “havent”,
  “have”
}
✓
検証の種類
定義説明
“havent”指定したエントリーを保有していないこと
“have”指定したエントリーを保有していること
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Dictionary:VerifyEntryByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "entryModelName": "[string]エントリーモデル名",
        "verifyType": "[string]検証の種類",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Dictionary:VerifyEntryByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  entryModelName: "[string]エントリーモデル名"
  verifyType: "[string]検証の種類"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("dictionary").verify.verify_entry_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    entryModelName="[string]エントリーモデル名",
    verifyType="[string]検証の種類",
    timeOffsetToken="[string]タイムオフセットトークン",
})

ConsumeAction

消費アクション

Gs2Dictionary:DeleteEntriesByUserId

ユーザーIDを指定してエントリーを削除

エントリーモデル名のリストを指定して、指定されたユーザーの図鑑から特定のエントリーを削除します。
バッチ操作として複数のエントリーを一度に削除できます。
返されるリストには、実際に削除されたエントリーが含まれます。

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

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

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
✓
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
entryModelNamesList<string>[]0 ~ 100 itemsエントリーモデル名のリスト
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Dictionary:DeleteEntriesByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "entryModelNames": [
            "[string]エントリーモデル名"
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Dictionary:DeleteEntriesByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  entryModelNames: 
  - "[string]エントリーモデル名"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("dictionary").consume.delete_entries_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    entryModelNames={
        "[string]エントリーモデル名"
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2Dictionary:AddEntriesByUserId

ユーザーIDを指定してエントリーを追加

指定されたユーザーの図鑑に1つ以上のエントリーモデル名を登録します。
バッチ操作として複数のエントリーモデル名を一度に指定できます。
既に登録済みのエントリーはエラーにならず、スキップされます。
返されるリストには、新たに追加されたエントリーのみが含まれます。

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

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

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
userIdstring
✓
~ 128文字ユーザーID
#{userId} と設定することでログイン中のユーザーIDに置換されます。
entryModelNamesList<string>[]0 ~ 100 itemsエントリーモデル名のリスト
timeOffsetTokenstring~ 1024文字タイムオフセットトークン
{
    "action": "Gs2Dictionary:AddEntriesByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "entryModelNames": [
            "[string]エントリーモデル名"
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
action: Gs2Dictionary:AddEntriesByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  entryModelNames: 
    - "[string]エントリーモデル名"
  timeOffsetToken: "[string]タイムオフセットトークン"
transaction.service("dictionary").acquire.add_entries_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    entryModelNames={
        "[string]エントリーモデル名"
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})