> For the complete documentation index, see [llms.txt](/llms.txt)

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

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




## Verify Action

検証アクション

### Gs2Dictionary:VerifyEntryByUserId

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

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

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| entryModelName | string |  | ✓|  |  ~ 128文字 | エントリーモデル名<br>エントリーモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| verifyType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"havent",<br>&nbsp;&nbsp;"have"<br>}<br> |  | ✓|  |  | 検証の種類"havent": 指定したエントリーを保有していないこと / "have": 指定したエントリーを保有していること /  |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Dictionary:VerifyEntryByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "entryModelName": "[string]エントリーモデル名",
        "verifyType": "[string]検証の種類",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Dictionary:VerifyEntryByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  entryModelName: "[string]エントリーモデル名"
  verifyType: "[string]検証の種類"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("dictionary").verify.verify_entry_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    entryModelName="[string]エントリーモデル名",
    verifyType="[string]検証の種類",
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---

## Consume Action

消費アクション

### Gs2Dictionary:DeleteEntriesByUserId

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

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

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

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| entryModelNames | List&lt;string&gt; |  | | [] | 0 ~ 100 items | エントリーモデル名のリスト |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Dictionary:DeleteEntriesByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "entryModelNames": [
            "[string]エントリーモデル名"
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Dictionary:DeleteEntriesByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  entryModelNames: 
    - "[string]エントリーモデル名"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("dictionary").consume.delete_entries_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    entryModelNames={
        "[string]エントリーモデル名"
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---

## Acquire Action

入手アクション

### Gs2Dictionary:AddEntriesByUserId

ユーザーIDを指定してエントリーを登録<br>

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

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

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string |  | ✓|  |  ~ 128文字 | ユーザーID<br>`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| entryModelNames | List&lt;string&gt; |  | | [] | 0 ~ 100 items | エントリーモデル名のリスト |
| timeOffsetToken | string |  | |  |  ~ 1024文字 | タイムオフセットトークン |




**JSON**
```json
{
    "action": "Gs2Dictionary:AddEntriesByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "entryModelNames": [
            "[string]エントリーモデル名"
        ],
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}
```

**YAML**
```yaml

action: Gs2Dictionary:AddEntriesByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  entryModelNames: 
    - "[string]エントリーモデル名"
  timeOffsetToken: "[string]タイムオフセットトークン"
```

**GS2-Script**
```lua

transaction.service("dictionary").acquire.add_entries_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    entryModelNames={
        "[string]エントリーモデル名"
    },
    timeOffsetToken="[string]タイムオフセットトークン",
})
```


---