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

# API

> 任意の PlayFab API エンドポイントを、そのパスと JSON 要求本文を指定して直接呼び出します。

`playfab api` は、任意の PlayFab API エンドポイントをそのパスで呼び出し、渡した要求本文を送信して、
PlayFab の応答を JSON として書き込みます。操作とその要求本文を見つけるには、
[API を見つける](https://docs.xbox.com/ja-jp/tools/xbox-cli/playfab-api.md#finding-an-api)を参照してください。

```text theme={null}
xbox playfab api <api-path> [flags]
```

このコマンドには PlayFab タイトルが必要です。ただし、1 つのタイトルにスコープされないスタジオ API (`/Studio/*`) は
例外です。[コンテキスト](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md)を参照してください。

コマンドによって何が変更されるかは、パスによって異なります。名前が `Get`、
`List`、または `Search` で始まる操作は読み取りのみを行います。`Delete*` と `Shutdown*` の操作は、ターミナルでは
事前に確認を求め、それ以外の環境では `--confirm` (`--yes`、`-y`) が必要です。
[安全性と破壊的な操作](https://docs.xbox.com/ja-jp/tools/xbox-cli/safety.md)を参照してください。

## 引数とオプション

| 引数/オプション | 必須 | 説明 |
| - | - | - |
| `<api-path>` | はい | PlayFab API パス `/<Prefix>/<Operation>` (`/Admin/GetTitleData` や `/Catalog/SearchItems` など)。`/` で始まる必要があります。Git Bash の場合は、[Windows の Git Bash から実行する](#running-from-git-bash-on-windows)を参照してください。 |
| `--body <body>` | いいえ | インラインで指定する操作の JSON 要求オブジェクト。`--body` と `--body-file` のどちらも渡さない場合、既定値は `{}` です。 |
| `--body-file <body-file>` | いいえ | JSON 要求オブジェクトを格納したファイルへのパス。stdin から読み取る場合は `-`。 |
| `--data-only` | いいえ | PlayFab の応答の `data` フィールドのみを書き込みます。 |
| `--output`、`-o` | いいえ | `json` (既定) または `json-compact`。 |
| `--verbose` | いいえ | 要求本文を除く診断情報を stderr に書き込みます。 |

`--body` と `--body-file` を組み合わせることはできません。CLI は、渡された本文を検証せずに
そのまま送信します。

## 例

```bash theme={null}
xbox --playfab-title-id ABC123 playfab api /Catalog/GetCatalogConfig
xbox --playfab-title-id ABC123 playfab api /Match/ListMatchmakingQueues --data-only --output json-compact
xbox --playfab-title-id ABC123 playfab api /Catalog/SearchItems --body-file search.json
xbox --playfab-title-id ABC123 playfab api /Admin/GetTitleData --body '{"Keys":["MyKey"]}' --data-only --output json-compact
```

### stdin から要求本文を読み取る

```bash theme={null}
printf '%s' '{"Keys":["MyKey"]}' |
  xbox --playfab-title-id ABC123 playfab api /Admin/GetTitleData --body-file -
```

stdin は、入力の終わりまで読み取られる 1 つの要求本文を提供します。1 行ごとに 1 つの要求ではありません。
`--body-file -` を指定した場合、stdin ではプロンプトに応答できないため、`Delete*` と `Shutdown*` の操作には
ターミナルでも `--confirm` が必要です。

## Windows の Git Bash から実行する

Git Bash は、他の MSYS シェルと同様に、Windows プログラムを起動する前に `/` で始まる引数を Windows の
パスに変換します。CLI は変換されたパスを拒否し、修正方法を
示します。

```console theme={null}
$ xbox playfab api /Catalog/GetCatalogConfig
The API path must start with '/', such as /Admin/GetTitleData; got 'C:/Program Files/Git/Catalog/GetCatalogConfig'.
That looks like /Catalog/GetCatalogConfig after Git Bash converted it to a Windows path. Turn the conversion off for the command, for example:
  MSYS_NO_PATHCONV=1 xbox playfab api /Catalog/GetCatalogConfig
```

1 つのコマンドに対して `MSYS_NO_PATHCONV=1` を設定します。

```bash theme={null}
MSYS_NO_PATHCONV=1 xbox --playfab-title-id ABC123 playfab api /Catalog/GetCatalogConfig
```

または、セッションの残りの部分に対してエクスポートします。

```bash theme={null}
export MSYS_NO_PATHCONV=1
```

変換を無効にすると、Git Bash は他のパスも変換しなくなります。そのため、`--body-file` には
`/c/requests/search.json` ではなく、相対パスまたは `C:/requests/search.json` などの Windows パスを
渡してください。

## 出力

`{code,status,data}` エンベロープに含まれる PlayFab の応答です。
[レスポンス エンベロープ](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab.md#response-envelope)を参照してください。呼び出しが失敗した場合、コマンドは
エラーを stderr に書き込み、終了コード `1` で終了します。
[エラー レスポンス](https://docs.xbox.com/ja-jp/tools/xbox-cli/playfab-api.md#error-responses)を参照してください。

`playfab api` は `--output table` を受け付けません。


## Related topics

- [api_operation](https://docs.xbox.com/ja-jp/services/playfab/api-references/events/Segmentation/api-operation.md)
- [Validate Api Policy](https://docs.xbox.com/api-reference/authentication/validate-api-policy.md)
- [実験の API](https://docs.xbox.com/ja-jp/services/playfab/live-service-management/game-configuration/experiments/experimentation-apis.md)
- [api_rate_limit_alert](https://docs.xbox.com/ja-jp/services/playfab/api-references/events/Title/api-rate-limit-alert.md)
- [その他の Xtf API (API の内容)](https://docs.xbox.com/ja-jp/reference/tools/xtf/xtfapi/atoc-xtfapi.md)
