> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# タイトル データ

> タイトル全体のキーと値のデータを、クライアントから読み取り可能なデータまたは内部データとして読み取り、設定、削除します。

タイトル全体のキーと値のデータを管理します。コマンドは、プレイヤーのゲーム クライアントが読み取る、クライアントから読み取り可能な
タイトル データを対象とします。`--internal` を追加すると、サーバー専用の内部タイトル データが対象になります。
タイトルに対する **Admin** 権限が必要です。
[PlayFab 認証のしくみ](https://docs.xbox.com/ja-jp/tools/xbox-cli/authentication.md#how-playfab-authentication-works)を参照してください。

| コマンド | PlayFab API パス | 説明 |
| - | - | - |
| `playfab title-data get` | `/Admin/GetTitleData` または `/Admin/GetTitleInternalData` | 1 つのキー、複数のキー、またはすべてのキーを読み取ります。 |
| `playfab title-data set` | `/Admin/SetTitleData` または `/Admin/SetTitleInternalData` | 1 つ以上のキーを設定します。 |
| `playfab title-data delete` | `null` 値を指定した `/Admin/SetTitleData` または `/Admin/SetTitleInternalData` | 1 つ以上のキーを削除します。 |

`title-data` コマンドは `--output table` を受け付けません。

## `playfab title-data get`

```text theme={null}
xbox --playfab-title-id ABC123 playfab title-data get [key] [flags]
```

| 引数/オプション | 説明 |
| - | - |
| `[key]` | 読み取る 1 つのキー。`--key` と同じです。どちらか一方を渡します。空白のキーは、すべてのキーとして読み取られるのではなく、拒否されます。 |
| `--key <key>` | 読み取る 1 つのキー。 |
| `--keys <a,b,c>` | 読み取るキーのコンマ区切りリスト。単一のキーと組み合わせることはできません。 |
| `--internal` | クライアントから読み取り可能なタイトル データの代わりに、内部タイトル データを読み取ります。 |

すべてのキーを読み取るには、キーと `--keys` を省略します。

1 つのキーに対する `get` は、キーの値のみを出力します。代わりに JSON を取得するには、エンベロープ全体の場合は
`--output` を、その `data` の場合は `--data-only` を渡します。複数のキーまたはすべてのキーを読み取る場合は、
常に JSON が返されます。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data get MyKey
```

```text theme={null}
my-value
```

指定した 1 つのキーが存在しない場合、`get` は `Key 'MyKey' was not found.` を stderr に書き込み、
終了コード `1` で終了します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data get MyKey --internal
xbox --playfab-title-id ABC123 playfab title-data get MyKey --output json
xbox --playfab-title-id ABC123 playfab title-data get --keys MyKey,OtherKey
xbox --playfab-title-id ABC123 playfab title-data get
```

## `playfab title-data set`

| オプション | 説明 |
| - | - |
| `--key <key>` | 設定するキー。`--value` と共に使用します。 |
| `--value <value>` | `--key` の値。そのまま保存されます。 |
| `--data <data>` | 複数のキーを一度に設定するための、キーと値のペアの JSON オブジェクト。`--key` および `--value` と組み合わせることはできません。 |
| `--internal` | クライアントから読み取り可能なタイトル データの代わりに、内部タイトル データを書き込みます。 |

1 つのキーを設定します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data set --key MyKey --value my-value
```

または、複数のキーを一度に設定します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data set --data '{"MyKey":"my-value","OtherKey":"2"}'
```

成功すると、`set` は設定したキーを書き込みます (`{"applied":["MyKey","OtherKey"]}` など)。

## `playfab title-data delete`

| オプション | 必須 | 説明 |
| - | - | - |
| `--keys <a,b,c>` | はい | 削除するキーのコンマ区切りリスト。 |
| `--internal` | いいえ | クライアントから読み取り可能なタイトル データの代わりに、内部タイトル データを削除します。 |

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data delete --keys MyKey,OldKey
```

成功すると、`delete` は削除したキーを書き込みます (`{"applied":["MyKey","OldKey"]}` など)。

## 複数キーの書き込みが途中で停止した場合

`set` と `delete` は一度に 1 つのキーを順番に書き込み、成功しなかった最初のキーで停止します。
そのキーより前のキーは書き込まれ、後のキーは試行されません。コマンドは
終了コード `1` で終了し、概要を stderr に書き込みます。

| フィールド | 意味 |
| - | - |
| `applied` | 書き込まれたキー。 |
| `failed` | PlayFab が拒否したキーとそのエラー。このキーは書き込まれていません。 |
| `unknown` | タイムアウト、Ctrl+C、HTTP 5xx エラーの後など、要求が PlayFab に到達した可能性があるものの、確定的な応答がなかったキー。書き込まれた可能性があるため、コマンドを再実行する前に `title-data get` で確認してください。 |
| `notSent` | サインインが失敗した場合など、要求が送信されなかったキー。このキーは書き込まれていません。 |

```json theme={null}
{
  "applied": ["MyKey"],
  "unknown": {
    "key": "OtherKey",
    "error": "The operation was canceled.",
    "outcomeUnknown": "/Admin/SetTitleData may have reached PlayFab, but the request was canceled, so its outcome is unknown. Check whether it was applied before retrying."
  }
}
```


## Related topics

- [タイトル データの取得](https://docs.xbox.com/ja-jp/services/playfab/api-references/rest/client/title-wide-data-management/get-title-data.md)
- [タイトル データの設定](https://docs.xbox.com/ja-jp/services/playfab/api-references/rest/server/title-wide-data-management/set-title-data.md)
- [プレイヤー データ](https://docs.xbox.com/ja-jp/services/playfab/player-progression/player-data/index.md)
- [タイトル データ オーバーライドの削除](https://docs.xbox.com/ja-jp/services/playfab/api-references/rest/admin/title-wide-data-management/delete-title-data-override.md)
- [タイトル データとオーバーライドの設定](https://docs.xbox.com/ja-jp/services/playfab/api-references/rest/admin/title-wide-data-management/set-title-data-and-overrides.md)
