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

# XBOX サービスの構成

> 状態、ドキュメント、公開、スキーマ、実績の画像など、XBOX サービスの構成を管理します。

`xbl` コマンド ファミリーは試験段階 (Experimental) です。CLI インターフェイスは、フィードバックに基づいて変更または
削除される可能性があります。

`xbox xbl` は、XBOX サービスの構成 (作業中および公開済みの構成の状態、構成ドキュメント、公開、
構成スキーマ) と、実績の画像を管理します。構成コマンドの対象となるサンドボックスを一覧表示するには、
[`xbox sandbox list`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/sandbox) を使用します。

これらのコマンドは、パートナー センターで編集するものと同じ構成を扱います。XBOX サービスの各機能の
役割と構成方法については、XBOX 開発者向けドキュメントの
[ポータル構成の概要](https://devdocs.xbox.com/services/xbox-services/fundamentals/portal-config/live-portal-config-overview)
を参照してください。

| グループ | コマンド | 目的 |
| - | - | - |
| `config` | `list`、`status`、`download`、`save`、`publish` | 作業中および公開済みの構成の状態を調べ、構成ドキュメントをダウンロードおよび保存し、構成をサンドボックスに公開します。 |
| `schema` | `list`、`get`、`download` | 構成スキーマの種類とバージョンを一覧表示したり、1 つのバージョンを取得したり、XSD をダウンロードしたりします。 |
| [`achievement-image`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/xbl/achievement-image) | `upload`、`get`、`list`、`download` | 実績の画像を登録、確認、またはダウンロードします。 |

## 共通の動作

### 販売者とサンドボックス

`schema` コマンドを除くすべてのコマンドは `--seller-id` を受け取ります。指定しない場合、コマンドは
`XBOX_SELLER_ID` または [`xbox context set`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context) で保存された販売者を使用し、それもない場合は唯一の
販売者を使用します。販売者が複数ある場合は、`--seller-id` を渡してください。

`config status` と `config publish` は、`--sandbox-id` を省略した場合、`XBOX_SANDBOX_ID` または保存された
`sandbox-id` から取得します。`config download` と `config save` でサンドボックスのドキュメントを扱う場合は、
コマンド ラインで `--sandbox-id` を指定する必要があります。

### タイトルの指定

`config list`、`config status`、`config publish`、およびサンドボックス スコープの `config download` と
`config save` は、タイトルのサービス構成識別子 (SCID) を `--scid` で、またはタイトルの
XBOX タイトル ID を `--title-id` で受け取ります。両方を指定することはできません。どちらも指定しない場合は、`XBOX_TITLE_ID` または
保存された `title-id` を使用します。[コンテキスト](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/context.md)を参照してください。`--scid` を指定すると、この両方が無視されます。

* `--title-id` は、[`game get`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/game) が表示するとおりの 16 進数で、`00000001` から
  `7FFFFFFF` までの値です。`0x` プレフィックスは省略可能です。それ以外のタイトル ID の場合は、SCID を渡してください。
* 別のタイトルの構成にバインドされているタイトルを読み取る場合は、プライマリ タイトルの SCID が使用されます。
* バインドされたタイトルの ID による `config save` と `config publish` は、`--validate-only` を指定した場合でも
  拒否されます (`bound_title_requires_scid`)。エラーにはプライマリ タイトルと
  SCID が示されるため、その `--scid` を指定して再実行してください。
* 他のタイトルがバインドされている構成に `--title-id` で保存または公開すると、
  それらすべてのタイトルの構成が変更されます。ターミナルでは、CLI はバインドされているタイトルを一覧表示して最初に確認を求めます。
  ターミナルがない場合は失敗します。`--allow-shared-configuration` を指定すると、確認はスキップされます。`--scid` による
  書き込みでは確認は求められません。
* `config save` と `config publish` は、使用した販売者と SCID を stderr に書き込みます。読み取り
  コマンドは、`--verbose` を指定した場合にこれらを書き込みます。

次のコマンドは、タイトル ID を保存し、その ID を使用して XDKS.1 のタイトルの構成を読み取り、ダウンロードし、
検証します。最後のコマンドでは、代わりに `--title-id` でタイトルを指定しています。

```powershell theme={null}
xbox context set title-id 1234ABCD
xbox xbl config list --output table
xbox xbl config status --sandbox-id XDKS.1
xbox xbl config download --sandbox-id XDKS.1 --view draft --dest .\xbox-config
xbox xbl config save --sandbox-id XDKS.1 --file ".\xbox-config\*.xml" --validate-only
xbox xbl config status --title-id 1234ABCD --sandbox-id XDKS.1
```

### 出力

すべての `xbl` コマンドは、`json` (既定) と `json-compact` に加えて `--output table` を受け付けます。
各コマンドのオプションの表に、テーブルの列が記載されています。

### エラー

リクエストが失敗すると、終了コード 1 で終了し、`status`、`title`、`detail`、および `code` (サービスが送信した場合) を含む
JSON エラーを stderr に書き込みます。処理の分岐には、`detail` の文言ではなく `status` または `code` を使用してください。
429 エラーには `retryAfterSeconds` が含まれます。
[レート制限](https://docs.xbox.com/ja-jp/tools/xbox-cli/cli-for-agents.md#rate-limits)を参照してください。

XBOX サービスの検証で構成が拒否された場合、エラーには `validation` の下に各メッセージが一覧表示されます。

```json theme={null}
{
  "status": 409,
  "title": "Validation failed.",
  "detail": "The configuration failed XBOX services validation. See validation for each message. MS-CV: ...",
  "code": "validation_failed",
  "validation": [
    {
      "severity": "Error",
      "documentName": "achievements2017.xml",
      "message": "XblLimited products do not support achievements or stats2013/stats2015 configuration. Please remove the unsupported configuration. Document failing validation: achievements2017.xml."
    }
  ]
}
```

`--validate-only` を指定しない `config save` と `config publish` は、失敗した変更が適用された可能性があるかどうかを
示します。

| 終了コード | 意味 |
| - | - |
| 1 | 何も変更されませんでした。リクエストが送信前に停止されたか失敗したか、`408` 以外の `4xx` で拒否されました。 |
| 3 | 結果は不明です。リクエストの送信後に Ctrl+C、タイムアウト、または接続の切断が発生したか、その他のエラー状態が返されたか、CLI が読み取れない成功応答が返されました。 |

終了コード 3 の場合は、再送信しないでください。stderr には、確認用の読み取り専用コマンドが出力されます。保存の場合は、
保存したファイルと比較するための `config download --view draft`、公開の場合は
`config status` です。

***

## config

1 つの SCID について、XBOX サービスの構成を調べ、ダウンロードし、保存し、公開します。サンドボックスには、
`config save` で変更する作業中の構成と、`config publish` で作業中の構成をライブにした後にプレイヤーとテスト アカウントに
表示される公開済みの構成があります。

| コマンド | 説明 |
| - | - |
| `config list` | アクセス可能なすべてのサンドボックスの作業中および公開済みの状態を一覧表示します。 |
| `config status` | 1 つのサンドボックスの作業中および公開済みの状態と、最後の公開を取得します。 |
| `config download` | ドキュメント セットをダウンロードして展開します。 |
| `config save` | 作業中のドキュメント セットを検証または保存します。 |
| `config publish` | 1 つの構成セットを検証するか、公開を開始します。 |

### `config list` と `config status`

どちらのコマンドも、最新の作業中のバージョンと公開済みのバージョン、各バージョンのコミット
時刻、および作業中のバージョンに未公開の変更があるかどうかを報告します。公開済みのコミット時刻は、
公開済みバージョンのコミット時刻であり、公開が完了した時刻ではありません。

`config list` は、サンドボックスごとに 1 つのオブジェクトを含む配列を返します。`config status` は、1 つのサンドボックスについて
1 つのオブジェクトを返し、最後の公開を `lastPublish` の下に追加します。報告する公開がない場合は `null` になります。
`--sandbox-id ALL` の場合、`ALL` のタイトル全体の構成は `HIDDEN` への公開によってライブになるため、
`lastPublish` は常に `null` です。

| `lastPublish` のフィールド | 説明 |
| - | - |
| `status` | `Running`、`Success`、または `Failed`。サービスが報告しない場合は `null`。 |
| `jobId` | 公開ジョブの ID。 |
| `message` | 公開に関するサービスのメッセージ、または `null`。 |

```json theme={null}
{
  "sandbox": "SANDBOX1",
  "hasWorkingConfiguration": true,
  "workingVersion": 9,
  "workingCommitTime": "2026-10-29T21:40:12+00:00",
  "hasPublishedConfiguration": true,
  "publishedVersion": 9,
  "publishedCommitTime": "2026-10-29T21:40:12+00:00",
  "hasUnpublishedChanges": false,
  "lastPublish": {
    "status": "Success",
    "jobId": "11111111-2222-3333-4444-555555555555",
    "message": null
  }
}
```

#### `config list` のオプション

| オプション | 必須 | 説明 |
| - | - | - |
| `--scid <guid>` | またはタイトル | タイトルの構成の SCID。 |
| `--title-id <hex-id>` | または SCID | XBOX タイトル ID。[タイトルの指定](#title-targeting)を参照してください。 |
| `--seller-id <id>` | いいえ | パートナー センターの販売者 ID。 |
| `--output <format>` | いいえ | `json` (既定)、`json-compact`、または `table`。 |

#### `config status` のオプション

| オプション | 必須 | 説明 |
| - | - | - |
| `--scid <guid>` | またはタイトル | タイトルの構成の SCID。 |
| `--title-id <hex-id>` | または SCID | XBOX タイトル ID。[タイトルの指定](#title-targeting)を参照してください。 |
| `--sandbox-id <id>` | はい | 大文字と小文字が区別されるサンドボックス ID。既定値は `XBOX_SANDBOX_ID`、それがない場合は保存されたサンドボックス ID です。 |
| `--seller-id <id>` | いいえ | パートナー センターの販売者 ID。 |
| `--output <format>` | いいえ | `json` (既定)、`json-compact`、または `table`。 |

どちらのコマンドのテーブルにも、`SANDBOX`、`WORKING`、`WORKING COMMIT`、
`PUBLISHED`、`PUBLISHED COMMIT`、`UNPUBLISHED` の列があります。`config status` では、最後の公開の
`status` である `PUBLISH STATUS` が追加されます。

#### `config list` と `config status` の例

```bash theme={null}
# Every accessible sandbox for one title
xbox xbl config list \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --output table

# One sandbox, single JSON object
xbox xbl config status \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1

# Compact output for scripting
xbox xbl config status \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 --output json-compact
```

### `config download` と `config save`

XBOX サービスの構成ドキュメント セットをダウンロード、検証、保存します。ドキュメント セットは、
サンドボックス (既定。SCID またはタイトルと `--sandbox-id` が必要) またはアカウント
(`--type account`。SCID、タイトル、サンドボックスは指定しません) に属します。

`config download` は、ドキュメント セットの ETag をドキュメントと同じ場所に `<sandbox>.etag` として保存します。
アカウント スコープの場合は `Account.etag` です。Windows では、このファイルは非表示になります。`config save` は、
`--file` で最初に一致したファイルと同じ場所にある ETag ファイルを読み取り、保存後に書き換えます。
ダウンロード後に構成が変更されていた場合、保存は失敗します。それらの変更を上書きして保存するには `--force` を渡し、
ETag を自分で指定するには `--etag` を渡します。

`config save` は保存する前に確認を求めません。また、`--confirm` は `config save` には適用されません。最初に
`--validate-only` を指定して実行してください。

#### `config download` のオプション

| オプション | 必須 | 説明 |
| - | - | - |
| `--view <draft\|published>` | はい | `draft` は `config save` で変更する作業中の構成、`published` はプレイヤーとテスト アカウントに表示されるライブの構成です。パートナー センターでも同じ 2 つの名前が使用されます。 |
| `--dest <directory>` | はい | ドキュメントと ETag ファイルを保存するディレクトリ。 |
| `--type <sandbox\|account>` | いいえ | ドキュメントのスコープ。既定値は `sandbox` です。 |
| `--scid <guid>` | `sandbox` の場合、またはタイトル | タイトルの構成の SCID。 |
| `--title-id <hex-id>` | `sandbox` の場合、または SCID | XBOX タイトル ID。[タイトルの指定](#title-targeting)を参照してください。 |
| `--sandbox-id <id>` | `sandbox` の場合 | 大文字と小文字が区別されるサンドボックス ID。 |
| `--version <number>` | いいえ | ドキュメント セットの過去のバージョン (正の数)。既定値は最新バージョンです。 |
| `--document <filename>` | いいえ | ダウンロードするドキュメントのファイル名。複数指定するには繰り返します。既定値はすべてのドキュメントです。 |
| `--seller-id <id>` | いいえ | パートナー センターの販売者 ID。 |
| `--output <format>` | いいえ | `json` (既定)、`json-compact`、または `TYPE`、`SANDBOX`、`VIEW`、`VERSION`、`FILES`、`DESTINATION` の列を含む `table`。 |

#### `config save` のオプション

| オプション | 必須 | 説明 |
| - | - | - |
| `--file <path-or-glob>` | はい | ローカル ファイル、または引用符で囲んだファイル名の glob。複数指定するには `--file` を繰り返し、それぞれに 1 つのパスまたはパターンを指定します (`--file a.xml --file b.xml`)。各ファイルの名前がそのドキュメント名になります。どのファイルにも一致しない値を指定すると、コマンドは失敗します。 |
| `--type <sandbox\|account>` | いいえ | ドキュメントのスコープ。既定値は `sandbox` です。 |
| `--scid <guid>` | `sandbox` の場合、またはタイトル | タイトルの構成の SCID。 |
| `--title-id <hex-id>` | `sandbox` の場合、または SCID | XBOX タイトル ID。[タイトルの指定](#title-targeting)を参照してください。 |
| `--sandbox-id <id>` | `sandbox` の場合 | 大文字と小文字が区別されるサンドボックス ID。 |
| `--validate-only` | いいえ | 保存せずに検証します。 |
| `--allow-shared-configuration` | いいえ | 他のタイトルがバインドされている構成に、確認なしで `--title-id` によって保存します。[タイトルの指定](#title-targeting)を参照してください。 |
| `--etag <value>` | いいえ | 保存の基準とする ETag。既定値は保存された ETag ファイルです。 |
| `--force` | いいえ | 保存された ETag 以降に行われた変更を上書きして保存します。 |
| `--message <text>` | いいえ | 保存メッセージ。 |
| `--seller-id <id>` | いいえ | パートナー センターの販売者 ID。 |
| `--output <format>` | いいえ | `json` (既定)、`json-compact`、または `TYPE`、`SANDBOX`、`VALIDATE ONLY`、`CAN COMMIT`、`COMMITTED`、`FILES`、`ETAG FILE` の列を含む `table`。 |

XBOX サービスがドキュメントを保存できない場合 (`--validate-only` では `CanCommit` が false、
それ以外では `Committed` が false)、コマンドは結果を stdout に書き込み、各検証メッセージを stderr に書き込み、
ETag ファイルを変更せずに、終了コード 1 で終了します。

```text theme={null}
XBOX services can't save these documents:
Error: achievements2017.xml: The root namespace doesn't match the document type. (NamespaceDocTypeMismatch)
```

ドキュメントが最新の作業中のドキュメントと一致する場合は、失敗にはなりません。何も保存されず、
`ValidationInfo` は `FilesNotChangedCommit` を報告し、コマンドは終了コード 0 で終了します。

#### `config download` と `config save` の例

最新の下書きのサンドボックス ドキュメントを `xbox-config` にダウンロードします。

```bash theme={null}
xbox xbl config download \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 --view draft --dest xbox-config
```

ドキュメントを編集した後、すべてのドキュメント、または変更した 2 つのドキュメントのみを検証します。

```bash theme={null}
xbox xbl config save \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 \
  --file "xbox-config/*.xml" --validate-only

xbox xbl config save \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 \
  --file xbox-config/achievements2017.xml --file xbox-config/localization.xml --validate-only
```

メッセージを付けて保存します。

```bash theme={null}
xbox xbl config save \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 \
  --file "xbox-config/*.xml" --message "Update achievements"
```

公開済みバージョン 7 の時点のドキュメントを 1 つダウンロードします。

```bash theme={null}
xbox xbl config download \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 \
  --view published --version 7 --document achievements.xml --dest xbox-config
```

アカウントの下書きドキュメントをダウンロードします。

```bash theme={null}
xbox xbl config download --type account --view draft --dest xbox-config --output table
```

### `config publish`

XBOX サービスの構成の作業中のバージョンを、サンドボックスの公開済みの構成に公開します。
公開は非同期です。`config publish` で公開を開始し、
`lastPublish.status` が `Success` または `Failed` になるまで、公開先のサンドボックスに対して [`config status`](#config-list-and-config-status) を実行します。

#### ソースの選択

`--sandbox-id` は公開先です。ソースはソース サンドボックスの作業中のバージョンで、
既定では公開先と同じサンドボックスです。

| シナリオ | 効果 |
| - | - |
| `--source-sandbox-id` が省略されているか、`--sandbox-id` と同じ | サンドボックスの最新の作業中のバージョンを公開します。 |
| `--source-sandbox-id` が `--sandbox-id` と異なる | ソース サンドボックスの最新の作業中のバージョンを公開先に公開し、[公開先のグローバル タイトル ストレージ ファイルを置き換えます](#cross-sandbox-publishing-replaces-global-title-storage-files)。 |
| `--configset <number>` | ソース サンドボックスの指定した作業中のバージョンを公開します。 |

ソース サンドボックスに未公開の変更がある場合、その最新の作業中のバージョンは、そのサンドボックスでライブになっているものとは異なります。
その場合、`--configset` を指定しないサンドボックス間の公開では警告が表示され、ライブになっているバージョンが
示されます。

```text theme={null}
Warning: XDKS.1 has unpublished changes. This publish uses its latest working version, 53; what's live in XDKS.1 is working version 52. To publish that instead, add --configset 52.
```

ソースでライブになっているものをそのまま昇格するには、最初に `--validate-only` を指定して実行し、提案された
`--configset` を追加します。JSON 出力では、`SourceVersion` は使用された作業中のバージョン、
`sourceHasUnpublishedChanges` はそのバージョンがソースでライブになっているものと異なるかどうか、
`sourceLiveVersion` はソースでライブになっているバージョン (見つかった場合) を示します。

タイトル全体の公開 (`--sandbox-id HIDDEN`) では、常に `ALL` の最新の作業中の構成が公開されるため、
`--source-sandbox-id` や `--configset` は指定しません。どのバージョンがライブになるかを確認するには、
最初に `config status --sandbox-id ALL` を実行して `workingVersion` を確認します。

#### 確認

`config publish` は、次の場合に公開する前に確認を求めます。

| 公開 | 確認を求める理由 |
| - | - |
| `--sandbox-id RETAIL` | 公開が完了すると、プレイヤーに変更が表示されます。 |
| `--sandbox-id CERT` または `CERT.DEBUG` | XBOX のサーティフィケーションのテストがこれらのサンドボックスで行われます。 |
| `--sandbox-id HIDDEN` | RETAIL を含むすべてのサンドボックスで使用される、タイトル全体の構成を公開します。 |
| `--source-sandbox-id` が `--sandbox-id` と異なる | 最初に、公開先の同じ名前の作業中のドキュメントと、[グローバル タイトル ストレージ ファイル](#cross-sandbox-publishing-replaces-global-title-storage-files)を置き換えます。 |

ターミナルでは、公開の内容を説明して確認を求めます。ターミナルがない場合は、処理を拒否して終了コード 1 で終了します。
`--confirm` (`--yes`、`-y`) を指定すると確認はスキップされ、`--validate-only` では確認は求められません。
[安全性と破壊的な操作](https://docs.xbox.com/ja-jp/tools/xbox-cli/safety.md)を参照してください。

RETAIL への公開について確認を求める前に、公開を検証し、
[追加される実績](#achievements-a-retail-publish-adds)を一覧表示します。「はい」と答えると、検証した作業中のバージョンが
公開されるため、ライブになるのは一覧表示された内容です。

```console theme={null}
$ xbox xbl config publish --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --source-sandbox-id CERT --sandbox-id RETAIL
This publish adds 2 achievements to RETAIL: 1, 2. Once they're live in RETAIL, achievements can't be removed, and their unlock rules and gamerscore can't change.
This publishes working version 52 of CERT's configuration to RETAIL for SCID aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee.
RETAIL is live: players see the change when the publish finishes.
Publishing from CERT first replaces RETAIL's working documents that have the same names.
Warning: publishing from CERT to RETAIL replaces RETAIL's global title storage files with CERT's. Files with the same path are overwritten, files only CERT holds are added, and files only RETAIL holds are deleted. Deleted files can't be recovered.

Publish to RETAIL? [y/N]:
```

この検証が失敗した場合は、何も公開されず、確認も求められません。そのため、ターミナルで、他のタイトルがバインドされている構成に
`--title-id` によって RETAIL への公開を行うには、`--allow-shared-configuration` が必要です。`--confirm` を指定した場合は一覧が表示されないため、
一覧を確認するには最初に `--validate-only` を実行してください。

#### RETAIL への公開で追加される実績

実績が RETAIL でライブになると、その実績は削除できず、ロック解除のルールとゲーマースコアも変更できなくなります。
そのため、RETAIL への公開では、RETAIL にまだ存在せず、公開によって追加される実績 ID が示されます。

* `--validate-only` を指定した場合、一覧は stderr に出力され、JSON 出力では
  `achievementChanges.added` に含まれます。
* `--validate-only` を指定せずにターミナルで実行した場合、[確認](#confirmation)に示すように、
  一覧は確認の前に表示されます。

```console theme={null}
$ xbox xbl config publish --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --source-sandbox-id CERT --sandbox-id RETAIL --validate-only
This publish would add 2 achievements to RETAIL: 1, 2. Once they're live in RETAIL, achievements can't be removed, and their unlock rules and gamerscore can't change.
```

実績を追加しない公開では、その旨が表示されます。その他のサンドボックスでは、実績は一覧表示されません。

#### 再公開

`config publish` は変更のみを公開します。公開先の前回の公開が成功してから何も変更されていない場合、
公開は開始されず、結果の `Status` は `AlreadyPublished` になります。公開が失敗した後に
`config publish` を再度実行すると、公開が再試行されます。

XBOX が製品の RETAIL をロックすることがあり、その場合、RETAIL から RETAIL への公開は
`retail_locked` で失敗します。それでも公開するには、`--republish` を追加します。これにより、選択された
構成 (既定では RETAIL の最新の作業中の構成) が RETAIL に強制的に適用されます。CERT などの別のサンドボックスから
RETAIL に公開してもロックは解除されますが、RETAIL の作業中のドキュメントがそのサンドボックスのドキュメントに置き換えられます。

`--republish` は、何も変更されていない場合でも完全な公開を行います。`--validate-only` と組み合わせることは
できません。

#### 診断

公表解禁を設定せずに RETAIL に初めて公開する場合の警告など、XBOX サービスからの検証診断は、
1 行に 1 つずつ stderr に出力されます。JSON 出力では、これらは
`ValidationResult` に保持されます。

```text theme={null}
XBOX services warning (FirstRetailPublishWithoutEffectiveEmbargo): This is the first time these Xbox Gameplay Settings will be published to RETAIL, and no embargo is configured.
```

検証が失敗すると、`config publish` は終了コード 1 で終了し、[エラー](#errors)に示すように、
`validation` の下に各メッセージを一覧表示します。

#### サンドボックス間の公開によるグローバル タイトル ストレージ ファイルの置き換え

> [!CAUTION]
>
> あるサンドボックスから別のサンドボックスに公開すると、公開先のグローバル タイトル ストレージ ファイルは
> ソースのファイルの完全なコピーになります。公開先にのみ存在するファイルは削除され、復元
> できません。

グローバル ファイルとは、ニュース フィードやマップなど、ゲームのすべてのプレイヤーが読み取るファイルです。

| ファイル | ソース | 公開前の公開先 | 公開後の公開先 |
| - | - | - | - |
| `news.json` | あり | あり | ソースのコピーで上書き |
| `tuning.cfg` | あり | — | 追加 |
| `maps.bin` | — | あり | **削除** |

コピーには、公開の実行時点でソースに存在するものがすべて使用されます。プレイヤー自身のデータには
影響せず、同じサンドボックス内での公開ではグローバル ファイルは変更されません。公開先のファイルを保持するには、
公開する前にそのファイルをソース サンドボックスに追加してください。

サンドボックス間の公開では、`--validate-only` を指定した場合も含め、常にこの警告が stderr に書き込まれ、
[確認](#confirmation)の質問にも含まれます。

```text theme={null}
Warning: publishing from SANDBOX1 to SANDBOX2 replaces SANDBOX2's global title storage files with SANDBOX1's. Files with the same path are overwritten, files only SANDBOX1 holds are added, and files only SANDBOX2 holds are deleted. Deleted files can't be recovered.
```

#### `config publish` のオプション

| オプション | エイリアス | 必須 | 説明 |
| - | - | - | - |
| `--scid <guid>` | — | またはタイトル | タイトルの構成の SCID。 |
| `--title-id <hex-id>` | — | または SCID | XBOX タイトル ID。[タイトルの指定](#title-targeting)を参照してください。 |
| `--sandbox-id <id>` | — | はい | 公開先のサンドボックス ID。既定値は `XBOX_SANDBOX_ID`、それがない場合は保存されたサンドボックス ID です。 |
| `--source-sandbox-id <id>` | — | いいえ | ソースのサンドボックス ID。既定値は `--sandbox-id` です。`--sandbox-id HIDDEN` と一緒に使用することはできません。 |
| `--validate-only` | — | いいえ | 公開せずに検証します。RETAIL の場合は、[公開で追加される実績](#achievements-a-retail-publish-adds)も一覧表示します。 |
| `--allow-shared-configuration` | — | いいえ | 他のタイトルがバインドされている構成に、確認なしで `--title-id` によって公開します。[タイトルの指定](#title-targeting)を参照してください。 |
| `--configset <number>` | — | いいえ | ソース サンドボックスの作業中のバージョン (正の数)。既定値は最新のバージョンです。`--sandbox-id HIDDEN` と一緒に使用することはできません。 |
| `--republish` | — | いいえ | 何も変更されていない場合や、移行後にロックされた RETAIL に対しても、完全な公開を行います。[再公開](#republishing)を参照してください。 |
| `--confirm` | `--yes`、`-y` | いいえ | 確認なしで公開します。[確認](#confirmation)を参照してください。 |
| `--seller-id <id>` | — | いいえ | パートナー センターの販売者 ID。 |
| `--output <format>` | `-o` | いいえ | `json` (既定)、`json-compact`、または `STATUS`、`SOURCE`、`DESTINATION`、`VALIDATE ONLY`、`SOURCE VERSION` の列を含む `table`。 |

#### `config publish` の例

公開せずに、SANDBOX1 への公開を検証します。

```bash theme={null}
xbox xbl config publish \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 --validate-only
```

SANDBOX1 の最新の作業中の構成を公開し、SANDBOX1 でライブにします。

```bash theme={null}
xbox xbl config publish \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1
```

SANDBOX1 の最新の作業中のバージョンを SANDBOX2 に公開します。これにより、SANDBOX2 のグローバル
タイトル ストレージ ファイルも SANDBOX1 のファイルに置き換えられます。

```bash theme={null}
xbox xbl config publish \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --source-sandbox-id SANDBOX1 --sandbox-id SANDBOX2
```

SANDBOX1 の作業中のバージョン 42 を SANDBOX2 に公開します。

```bash theme={null}
xbox xbl config publish \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee \
  --source-sandbox-id SANDBOX1 --sandbox-id SANDBOX2 --configset 42
```

CERT から RETAIL への公開を検証し、追加される実績を一覧表示します。

```bash theme={null}
xbox xbl config publish \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --source-sandbox-id CERT --sandbox-id RETAIL --validate-only
```

次に、出力の `SourceVersion` を `--configset` として渡し、検証したバージョンを
プロンプトなしで公開します。

```bash theme={null}
xbox xbl config publish \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --source-sandbox-id CERT --sandbox-id RETAIL --configset 52 --confirm
```

何も変更されていなくても、SANDBOX1 を再度公開します。

```bash theme={null}
xbox xbl config publish \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 --republish
```

SANDBOX2 への公開を確認します。

```bash theme={null}
xbox xbl config status \
  --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX2 --output table
```

***

## schema

XBOX サービスの構成ドキュメントのスキーマを検出し、ダウンロードします。

| コマンド | 説明 |
| - | - |
| `schema list` | すべてのスキーマの種類を一覧表示します。 |
| `schema list --type <type>` | 1 つのスキーマの種類のバージョンを一覧表示します。 |
| `schema get --type <type>` | スキーマの種類の 1 つのバージョンを取得します。種類、バージョン、名前空間が含まれます。既定値は最新バージョンです。 |
| `schema download --dest <directory>` | XSD をディレクトリに保存します。1 つのバージョン、1 つの種類のすべてのバージョン、またはすべての種類のすべてのバージョンを保存できます。 |
| `schema download --type <type> --version <n> --dest -` | 1 つの XSD を stdout に書き込みます。 |

### `schema list` のオプション

| オプション | 必須 | 説明 |
| - | - | - |
| `--type <type>` | いいえ | バージョンを一覧表示するスキーマの種類。すべての種類を一覧表示するには省略します。 |
| `--output <format>` | いいえ | `json` (既定)、`json-compact`、または `TYPE`、`VERSION`、`NAMESPACE`、`PATH`、`BYTES` の列を含む `table`。 |

### `schema get` のオプション

| オプション | 必須 | 説明 |
| - | - | - |
| `--type <type>` | はい | スキーマの種類。 |
| `--version <number>` | いいえ | スキーマのバージョン (正の数)。既定値は、その種類の最新バージョンです。 |
| `--output <format>` | いいえ | `json` (既定)、`json-compact`、または `TYPE`、`VERSION`、`NAMESPACE` の列を含む `table`。 |

`schema get` は 1 つの JSON オブジェクトを書き込みます。

```json theme={null}
{
  "type": "achievements2017",
  "version": 1,
  "namespace": "http://config.mgt.xboxlive.com/schema/achievements2017/1"
}
```

### `schema download` のオプション

| オプション | 必須 | 説明 |
| - | - | - |
| `--dest <directory>` | はい | XSD ファイルを保存するディレクトリ。1 つの XSD を stdout に書き込む場合は `-`。`-` には `--type` と `--version` の両方が必要です。 |
| `--type <type>` | いいえ | スキーマの種類。すべての種類をダウンロードするには省略します。 |
| `--version <number>` | いいえ | スキーマのバージョン (正の数)。`--type` が必要です。すべてのバージョンをダウンロードするには省略します。 |
| `--output <format>` | いいえ | `json` (既定)、`json-compact`、または `TYPE`、`VERSION`、`NAMESPACE`、`PATH`、`BYTES` の列を含む `table`。 |

各スキーマは、種類を小文字にした `<type>_<version>.xsd` として保存され、コマンドは
保存されたパスを表示します。`--dest -` を指定した場合は、代わりに未加工の XSD を stdout に書き込み、
`--output` は適用されません。

### `schema` の例

```bash theme={null}
# List every schema type
xbox xbl schema list

# List versions of one type, as a table
xbox xbl schema list --type achievements2017 --output table

# Get the latest version of one type
xbox xbl schema get --type achievements2017

# Redirect one XSD straight to a file
xbox xbl schema download --type achievements2017 --version 1 --dest - > achievements2017_1.xsd

# Save one XSD into a directory
xbox xbl schema download --type achievements2017 --version 1 --dest schemas

# Download every version of one schema type
xbox xbl schema download --type achievements2017 --dest schemas

# Download every version of every schema type
xbox xbl schema download --dest schemas
```

***

## 構成の一般的なラウンド トリップ

1. アクセスできるサンドボックスを確認します。

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

2. 作業中および公開済みの構成の状態を確認します。

   ```bash theme={null}
   xbox xbl config list \
     --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --output table
   ```

3. 下書きのドキュメント セットをダウンロードします。これにより、`SANDBOX1.etag` も保存されます。

   ```bash theme={null}
   xbox xbl config download \
     --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 --view draft --dest xbox-config
   ```

4. `xbox-config` 内のドキュメントを編集してから、検証します。

   ```bash theme={null}
   xbox xbl config save \
     --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 \
     --file "xbox-config/*.xml" --validate-only
   ```

5. ドキュメントを保存します。

   ```bash theme={null}
   xbox xbl config save \
     --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 \
     --file "xbox-config/*.xml" --message "Update configuration"
   ```

6. SANDBOX1 でドキュメントを公開します。

   ```bash theme={null}
   xbox xbl config publish \
     --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1
   ```

7. 公開を確認し、状態が `Success` または `Failed` になるまで繰り返します。

   ```bash theme={null}
   xbox xbl config status \
     --scid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --sandbox-id SANDBOX1 --output table
   ```


## Related topics

- [XBOX サービスの構成](https://docs.xbox.com/ja-jp/publishing/game-publishing/concepts/xbox-services.md)
- [ゲームの XBOX サービスを構成する](https://docs.xbox.com/ja-jp/publishing/game-publishing/tutorial-xbox-managed/how-to-configure-xbox-services.md)
- [パートナー センターでの初期構成](https://docs.xbox.com/ja-jp/publishing/xstore-commerce/xstore-initial-configuration.md)
- [マルチプレイヤー サービスの構成](https://docs.xbox.com/ja-jp/services/xbox-services/multiplayer/concepts/live-configure-the-multiplayer-service.md)
- [Web サービス エンドポイントの構成 (目次)](https://docs.xbox.com/ja-jp/services/xbox-services/fundamentals/s2s-auth-calls/custom-service-config/web-services/live-web-services-nav.md)
