> ## 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.

# プレイヤー データ

> タイトル スコープまたはパブリッシャー スコープで、プレイヤーのカスタム データを読み書きします。

プレイヤーのカスタム データを、タイトル用、またはパブリッシャーのタイトル間で共有されるデータとして
読み書きします。

| コマンド | 説明 |
| - | - |
| `playfab player-data get` | プレイヤーのキーの一部またはすべてを読み取ります。 |
| `playfab player-data set` | 1 つ以上のキーを設定します。 |
| `playfab player-data delete` | 1 つ以上のキーを削除します。 |

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

## オプション

すべての `player-data` コマンドは、次のオプションを受け取ります。

| オプション | 必須 | 説明 |
| - | - | - |
| `--playfab-id` | はい | プレイヤーの PlayFab ID (マスター プレイヤー アカウント ID)。 |
| `--visibility` | いいえ | データ層: `client` (既定)、`read-only`、または `internal`。 |
| `--publisher` | いいえ | プレイヤーのタイトル データの代わりにパブリッシャー データを使用します。 |

| コマンド | オプション |
| - | - |
| `player-data get` | 1 つのキーの場合は `--key`、コンマ区切りの複数のキーの場合は `--keys`。すべてのキーを取得するには両方を省略します。`--key` と共に `--value-only` を指定すると、値のみが出力されます。`--if-changed-from-version` は、バージョンが異なる場合にのみデータを返します。`--value-only` と組み合わせることはできません。 |
| `player-data set` | `--key` と `--value`、またはキーと値の JSON オブジェクトを指定した `--data` のいずれか。オブジェクトと配列の値は JSON 文字列として保存されます。`--permission` は必須です。ただし、`--visibility internal` では有効ではありません。[権限](#permission)を参照してください。 |
| `player-data delete` | `--keys` (必須)。削除するキーのコンマ区切りリストです。 |

## PlayFab API パス

`--visibility` と `--publisher` によって API が選択されます。

| スコープと可視性 | `get` API | `set` と `delete` の API |
| - | - | - |
| タイトル、`client` | `/Admin/GetUserData` | `/Admin/UpdateUserData` |
| タイトル、`read-only` | `/Admin/GetUserReadOnlyData` | `/Admin/UpdateUserReadOnlyData` |
| タイトル、`internal` | `/Admin/GetUserInternalData` | `/Admin/UpdateUserInternalData` |
| パブリッシャー、`client` | `/Admin/GetUserPublisherData` | `/Admin/UpdateUserPublisherData` |
| パブリッシャー、`read-only` | `/Admin/GetUserPublisherReadOnlyData` | `/Admin/UpdateUserPublisherReadOnlyData` |
| パブリッシャー、`internal` | `/Admin/GetUserPublisherInternalData` | `/Admin/UpdateUserPublisherInternalData` |

## 権限

`client` または `read-only` のキーは、プレイヤーのみが読み取れる `Private`、または他のプレイヤーも読み取れる
`Public` のいずれかです。PlayFab は、`set` が書き込むすべてのキーに、渡された権限を付与し、
既存の権限を置き換えます。そのため、これらの層では `set` に `--permission` が必要です。権限は
`--data` 内のすべてのキーに適用されます。キーごとに異なる権限を付与するには、別々のコマンドで設定します。

## 例

プレイヤーの `level` キーの値を出力します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab player-data get --playfab-id PLAYER123 --key level --value-only
```

他のプレイヤーも読み取れるように、プレイヤーの読み取り専用データに `level` を設定します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab player-data set --playfab-id PLAYER123 --visibility read-only --key level --value 5 --permission Public
```

プレイヤーの内部データに `rating` を設定します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab player-data set --playfab-id PLAYER123 --visibility internal --key rating --value 1500
```

プレイヤーの `level` キーと `legacyFlag` キーを削除します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab player-data delete --playfab-id PLAYER123 --keys level,legacyFlag
```


## Related topics

- [プレイヤー データ](https://docs.xbox.com/ja-jp/services/playfab/player-progression/player-data/index.md)
- [PlayFab プレイヤー進行ドキュメント](https://docs.xbox.com/ja-jp/services/playfab/player-progression/index.md)
- [概要](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/live-xbl-overview.md)
- [プレイヤー データ (目次)](https://docs.xbox.com/ja-jp/services/xbox-services/player-data/live-playerdata-nav.md)
- [クイックスタート: プレイヤー データ](https://docs.xbox.com/ja-jp/services/playfab/player-progression/player-data/quickstart.md)
