> ## 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 タイトルなどの既定値を後続のコマンド用に保存します。複数の値のセットが必要な場合は、名前付きプロファイルに保存します。

`xbox context` は、販売者、PlayFab タイトル、XBOX タイトル、サンドボックスの既定値を保存するため、
これらの値をすべてのコマンドに渡す必要がなくなります。このページでは、これらの値を渡さなかった場合に
コマンドがどこから値を取得するかについても説明します。コンテキストはローカルです。これらのコマンドによって
パートナー センターや PlayFab の内容が変更されることはありません。

## コマンド

| コマンド | 説明 |
| - | - |
| `context get` | 保存されている値を表示します。 |
| `context set` | 値を 1 つ保存します。 |
| `context unset` | 保存されている値を削除します。 |
| `context key list` | 保存できるキーと、各キーを使用するコマンドを一覧表示します。サインインは不要です。 |
| `context profile list` | プロファイルを `default` から順に一覧表示します。 |
| `context profile delete` | 名前付きプロファイルと、そのプロファイルに保存されているすべての値を削除します。 |

## キー

キーは、そのキーで値を設定するオプションの名前です。

| キー | オプション | 変数 | 使用するコマンド |
| - | - | - | - |
| `playfab-title-id` | `--playfab-title-id` | `XBOX_PLAYFAB_TITLE_ID` | [`playfab`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab) コマンド |
| `sandbox-id` | `--sandbox-id` | `XBOX_SANDBOX_ID` | [`xbl`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/xbl) の `config status` と `config publish` |
| `seller-id` | `--seller-id` | `XBOX_SELLER_ID` | [`audience`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/audience)、[`game`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/game)、[`package`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/package)、[`playtest`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playtest)、[`sandbox`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/sandbox)、[`test-account`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/test-account)、[`xbl`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/xbl) の各コマンド |
| `title-id` | `--title-id` | `XBOX_TITLE_ID` | [`xbl`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/xbl#title-targeting) の `config list`、`config status`、`config publish`、およびサンドボックス スコープの `config download` と `config save` |

これら以外のオプションでは、保存された値や変数は使用されません。

`title-id` は `1234ABCD` のような 16 進数の XBOX タイトル ID であり、PlayFab タイトル ID ではありません。
`xbl` コマンドはこの値を使用してタイトルのサービス構成識別子 (SCID) を検索します。`--scid` を渡した場合、
この値は無視されます。[タイトルの指定](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/xbl.md#title-targeting)を参照してください。

## コマンドでの保存された値の使用方法

コマンドがこれらのオプションのいずれかを受け取る場合、最初に見つかった値が使用されます。

1. `--seller-id` などのコマンド ラインのオプション。
2. `XBOX_SELLER_ID` などのオプションに対応する `XBOX_` 変数。空の変数は未設定として扱われます。
3. 選択されている[プロファイル](#profiles)に `context set` で保存された値。

```bash theme={null}
xbox context set playfab-title-id ABC123
xbox playfab title-data get                                # uses ABC123
XBOX_PLAYFAB_TITLE_ID=DEF456 xbox playfab title-data get   # uses DEF456
xbox --playfab-title-id GHI789 playfab title-data get      # uses GHI789
```

変数または保存されたコンテキストの値は、入力された値と同じようにチェックされます。エラーには、
`XBOX_SELLER_ID: --seller-id must be a positive numeric value.` のように値の取得元が示されます。
コマンドに必要な値がどこからも提供されない場合は、値の設定方法が表示されます。販売者が省略可能な
コマンドである `xbl` と `test-account` では、承認されている販売者が 1 つだけの場合、その販売者が使用されます。

変更を行うコマンドは、`--confirm` を指定した場合でも、設定した各値とその取得元を stderr に書き込みます。
`--verbose` を指定すると、すべてのコマンドがこの情報を書き込みます。

```text theme={null}
Using --playfab-title-id ABC123 from saved context.
```

[既知の問題](https://docs.xbox.com/ja-jp/tools/xbox-cli/known-issues.md)では、`game` コマンドと `sandbox` コマンドが、この方法で選択された販売者とは
異なる販売者を使用してしまう 2 つの問題について説明しています。

## プロファイル

プロファイルは、テスト タイトル用と運用環境用など、保存された値の名前付きセットです。
コマンドは、`--profile` で指定されたプロファイルを使用します。指定がない場合は `XBOX_PROFILE` で指定されたプロファイルを使用し、それもない場合は `default` を使用します。

```bash theme={null}
xbox --profile test context set playfab-title-id TEST1   # creates "test"
xbox --profile test playfab title-data get               # uses TEST1
xbox playfab title-data get                              # uses the default profile
```

シェル内のすべてのコマンドでプロファイルを使用するには、`XBOX_PROFILE` を設定します。

```bash theme={null}
export XBOX_PROFILE=test
```

プロファイルを一覧表示するには、次のコマンドを実行します。

```bash theme={null}
xbox context profile list
```

プロファイルと、そのプロファイルに保存されているすべての値を削除するには、次のコマンドを実行します。

```bash theme={null}
xbox context profile delete test
```

* プロファイルに最初の値を保存すると、そのプロファイルが作成されます。名前には英字、数字、ハイフンを
  64 文字まで使用でき、大文字と小文字は区別されません。

* 名前のスペルを間違えた場合など、存在しないプロファイルを指定すると、`default` にフォールバックせずに
  失敗します。

* プロファイルが `default` の値を借用することはありません。

* `XBOX_` 変数は、プロファイルよりも引き続き優先されます。`--profile` で指定されたプロファイルよりも変数が優先された場合、
  コマンドは何も変更しない場合でもその旨を表示します。

  ```text theme={null}
  Using --playfab-title-id PROD1 from XBOX_PLAYFAB_TITLE_ID, not profile test.
  ```

* CLI はコマンド間でプロファイルを記憶しないため、プロファイルを選択しても、別のターミナルやエージェントが
  使用するプロファイルが変わることはありません。

## 値の保存場所

保存された値は、CLI の状態ディレクトリ内の `context.json` にあります。

| OS | ディレクトリ |
| - | - |
| Windows | `%LOCALAPPDATA%\XboxDevCLI` |
| macOS | `~/Library/Application Support/XboxDevCLI` |
| Linux | `$XDG_DATA_HOME/XboxDevCLI`、既定では `~/.local/share/XboxDevCLI` |

各値はその値を保存したアカウントに属するため、別のアカウントがその値を使用することはありません。
`auth logout` を実行しても保存された値は保持され、同じアカウントで再度サインインすると値が復元されます。

## 引数とオプション

| 引数またはオプション | コマンド | 説明 |
| - | - | - |
| `<key> <value>` | `set` | 保存するキーとその値。値はキーのオプションに対して有効である必要があります。`seller-id` は正の数値 ([`xbox seller list`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/seller) を参照) で、`playfab-title-id` は英字と数字です。 |
| `<key>...` | `unset` | 削除するキー。保存されていないキーを削除しても成功します。 |
| `<name>` | `profile delete` | 削除するプロファイル。`default` は削除できません。 |
| `--profile <name>` | すべて | `XBOX_PROFILE` のプロファイルや `default` の代わりに、このプロファイルを使用します。[グローバル オプション](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands.md)です。 |
| `--all` | `unset` | 選択されているプロファイルに保存されているすべての値を削除します。キー名と組み合わせることはできません。 |
| `--base-url <url>` | `get`、`set`、`unset` | `XboxPartner:BaseUrl` 設定をオーバーライドします。保存された販売者の値は、その値を保存したときのエンドポイントに属します。 |
| `--output <format>` | すべて | `json` (既定)、`json-compact`、または `table`。 |

## 動作

`get` は、サインインしている `account`、`profile`、および `key` と `value` から成る `values` 配列を返します。
保存されていないキーの値は `null` になります。`get` が表示するのは保存されている値であり、コマンドが使用する値ではありません。
コマンドが使用する値を確認するには、そのコマンドを `--verbose` 付きで実行します。サインアウトしている場合、`get` は値を表示せず、
サインインの方法を表示します。

`set`、`unset`、および `profile` コマンドには、サインインしているアカウントが必要です。`set` はサービスで
値をチェックしないため、使用できない販売者を保存した場合は、その販売者を送信する最初のコマンドで失敗します。

サービス プリンシパルには保存されたコンテキストがありません。サービス プリンシパル モードでは、サインインするコマンドは
`--profile` と `XBOX_PROFILE` を拒否し、`key list` を除くすべての `context` コマンドが失敗します。
代わりに、各値をそのオプションまたは `XBOX_` 変数で渡してください。
[自動化 (サービス プリンシパル) 認証](https://docs.xbox.com/ja-jp/tools/xbox-cli/authentication.md#automation-service-principal-authentication)を参照してください。

## コマンド ライン以外から取得される値

保存されたコンテキストは、OS ユーザーが実行するすべてのターミナルとエージェントで共有されます。また、環境変数は
コマンド ラインに表示されません。そのため、設定した各値の名前を表示することに加えて、次のように動作します。

* 対象がコンテキストの値そのものである操作では、その値をコマンド ラインで指定する必要があります。
  `/Admin/DeleteTitle` はタイトルを削除し、`playfab api-policy set --overwrite` はタイトルの
  API アクセス ポリシー全体を置き換えます。そのため、これらの操作は保存されたコンテキストまたは変数からのタイトルを拒否し、
  代わりに実行するコマンドを表示します。

  ```text theme={null}
  $ xbox playfab api /Admin/DeleteTitle --confirm
  Using --playfab-title-id ABC123 from saved context.
  '/Admin/DeleteTitle' acts on playfab-title-id ABC123, which comes from saved context.
  The target of a destructive operation must be named on the command line. To proceed, run:
    xbox --playfab-title-id ABC123 playfab api /Admin/DeleteTitle --confirm
  ```

  リクエスト本文にはシークレットが含まれる可能性があるため、表示されるコマンドには、インラインの `--body` や `--statements` の値は
  含まれません。`<body>` または `<statements>` の部分を元の値に置き換えてください。

* 保存された値を使用するコマンドの実行中に、たとえば確認を待っている間に別のアカウントがサインインした場合、
  コマンドは何かを送信する前に停止します。コマンドをもう一度実行してください。

確認のルールについては、[安全性と破壊的な操作](https://docs.xbox.com/ja-jp/tools/xbox-cli/safety.md)を参照してください。

## テーブル出力

すべての context コマンドで `--output table` を使用できます。

| コマンド | 列 |
| - | - |
| `context get`、`set`、`unset` | `KEY`、`VALUE` |
| `context key list` | `KEY`、`USED BY` |
| `context profile list`、`profile delete` | `NAME` |

## 例

保存できるキーを一覧表示します。

```bash theme={null}
xbox context key list --output table
```

販売者と PlayFab タイトルを保存し、保存されている内容を確認します。

```bash theme={null}
xbox context set seller-id 1234567
xbox context set playfab-title-id ABC123
xbox context get --output table
```

保存された値を使用するコマンドを実行し、タイトルの取得元を確認します。

```bash theme={null}
xbox game list
xbox --verbose playfab title-data get
```

保存されている値を 1 つ削除します。

```bash theme={null}
xbox context unset playfab-title-id
```

選択されているプロファイルに保存されているすべての値を削除します。

```bash theme={null}
xbox context unset --all
```

設定については [構成](https://docs.xbox.com/ja-jp/tools/xbox-cli/configuration.md)を参照してください。コンテキストによって設定が変更されることはありません。


## Related topics

- [クラフト ゲーム - コンテキスト](https://docs.xbox.com/ja-jp/services/playfab/economy-monetization/economy-v2/tutorials/craftingGame/game-context.md)
- [Azure Functions コンテキスト モデルを使用した PlayFab CloudScript](https://docs.xbox.com/ja-jp/services/playfab/live-service-management/service-gateway/automation/cloudscript-af/CloudScript-af-context.md)
- [ランキングにコンテキスト データを追加する](https://docs.xbox.com/ja-jp/services/playfab/community/leaderboards/metadata-leaderboards.md)
- [SHAPE_CONTEXTS](https://docs.xbox.com/ja-jp/reference/audio/acphal/structs/shape_contexts.md)
- [SHARED_SHAPE_CONTEXTS](https://docs.xbox.com/ja-jp/reference/audio/acphal/structs/shared_shape_contexts.md)
