--seller-id を受け取ります。指定しない場合、コマンドは XBOX_SELLER_ID または
xbox context set で保存された販売者を使用し、それもない場合は唯一の販売者を使用します。販売者が複数ある場合は、
--seller-id を渡してください。
コマンド
batch create、batch update、batch delete は、何かを変更する前に確認を求めます。また、
リクエストは 1 回だけ送信され、再試行されることはありません。安全性と破壊的な操作を参照してください。
バッチを読み取るためのオプション
タグは、JSON 出力では
keywords として表示され、test_account_keyword_invalid などのエラー コードでも
同様に表されます。--tag はタグ全体と一致する場合にのみ一致し、タグの一部とは一致しません。
販売者のすべてのバッチを読み取ることができない場合でも、エラーにはなりません。batch list は、自分が作成した
バッチのみを返します。
期限切れのバッチ
バッチは、サンドボックス アクセスが終了する日付であるaccessExpirationDate を過ぎると期限切れになります。
日付のないバッチは期限切れになりません。期限切れかどうかは、アカウントがまだサインインできるかどうかを
示すものではありません。
batch list --expired は、期限切れのバッチを見つけるために販売者のリスト全体を読み取るため、
バッチが多い販売者では時間がかかります。--include-sandboxes と組み合わせることはできません。期限切れのバッチの
サンドボックス アクセスを確認するには、そのバッチに対して batch get を実行してください。
応答の形式
list は次のような応答を返します。
--include-sandboxesを渡さない限り、keywordsとsandboxAccessはnullです。getは 常にこれらを返します。isCompleteは、作成ジョブが停止したことを意味し、すべてのアカウントが作成されたことを意味するわけではありません。getから取得したアカウントの数をbatchSizeと比較し、状態メッセージについてはprogressを確認してください。createdByは数値のパートナー センター ユーザー ID です。jobIdはバッチで実行中のジョブで、ジョブが停止するとnullになります。更新ジョブと削除ジョブも ここに表示されますが、job waitで追跡できるのは作成ジョブのみです。
get は、同じバッチ オブジェクトとそのアカウントを返します。
xuid、email、gamertag、isDeleted のみが含まれます。xuid は文字列です。
バッチの読み取り時のエラー
batch list、batch get、test-account get は、失敗すると終了コード 1 で終了します。サービスが
JSON エラーを返した場合、stderr には、status、title、detail、code (応答に含まれる場合)、
および correlationId を含む JSON エラーが出力されます。ほとんどの場合、detail にはヒントが追加されます。その他の失敗では、
1 行のテキストが出力されます。stderr を解析する前に終了コードを確認してください。
アカウントの検索
test-account get <email> は、アカウントを含むバッチが期限切れかどうかを示します。メール アドレスは
@xboxtest.com で終わる必要があります。このコマンドは、メール テンプレートがアカウントの名前と一致する
バッチのうち、新しいものから 10 個を検索します。そこでアカウントが見つからない場合は、それより古い
バッチは検索されていないことを示し、自分で確認するための batch list コマンドと batch get コマンドを
表示します。
次の応答を返します (ここでは短縮しています)。batch には、batch list が返すすべてのバッチ フィールドが
含まれます。
expiredOn は null です。削除されたアカウントは、有効なコピーが存在しない場合にのみ、
account.isDeleted が設定された状態で報告されます。このコマンドは、期限切れかどうかにかかわらず、アカウントが見つかれば
常に終了コード 0 で終了するため、スクリプトでは expired を確認する必要があります。次の場合は終了コード 1 で終了します。
- 自分が参照できるバッチにアカウントがない場合。アカウントが別の販売者に属している可能性があるため、
--seller-idを試してください。または、別の開発者がそのバッチを作成しており、販売者のすべてのバッチを 読み取ることができない可能性があります。 - メール アドレスが複数のバッチに含まれている場合。stderr には、それぞれのバッチに対する
batch getコマンドが一覧表示されます。 - バッチの読み取り時のエラーと同様に、リクエストが失敗した場合。
バッチの作成
batch create は、アカウントを作成するジョブを開始し、そのジョブが停止するまで待機します。作成されたアカウントは、
バッチが削除されるまで、販売者のテスト アカウントの上限にカウントされます。
ターミナルでは、コマンドはセキュリティの質問の選択画面を表示し、
省略したオプションの既定値を含め、送信する値を一覧表示して、確認を求めます。その後、
パスワードとセキュリティの質問の答えの入力を求め、サインインして、リクエストを送信します。
--confirm (--yes、-y) によってスキップされるのは確認のみです。
ターミナルがない場合は、--password-file、--security-answer-file、--confirm を渡してください。
--confirm がない場合、コマンドは値を表示して処理を拒否し、何も送信しません。
セキュリティの質問の選択
ターミナルで--security-question と --security-answer-file のどちらも渡さない場合、コマンドは
次の質問を番号付きの選択画面に表示します。Enter キーを押すと最初の質問が選択されます。選択画面を使用せずに質問を選ぶには、
その質問のテキストを --security-question で渡します。
- What is your favorite hobby? (好きな趣味は何ですか?)
- Who is your favorite athlete? (好きなスポーツ選手は誰ですか?)
- What is your maternal grandmother’s first name? (母方の祖母の名前は何ですか?)
- What was your childhood best friend’s first name? (子どもの頃の親友の名前は何でしたか?)
- What was the name of your first pet? (初めて飼ったペットの名前は何でしたか?)
- What is your current best friend’s first name? (現在の親友の名前は何ですか?)
- What was your favorite city to visit as a child? (子どもの頃に訪れて好きだった都市はどこですか?)
What is your favorite hobby? になります。選択画面で Ctrl+C を押すと、何も作成せずにキャンセルされます。
質問を選択しても、作成は確定されません。
シークレット
パスワードとセキュリティの質問の答えは、オプションの値や環境変数としては受け付けられないため、 シェルの履歴、プロセスの一覧、ログに残ることはありません。それぞれ次のいずれかから取得されます。- 対応する
--password-fileまたは--security-answer-file。末尾の改行 1 つは削除されます。 - パスの代わりに
-を指定した場合は stdin。stdin から読み取ることができるのは、2 つのうち 1 つだけです。 - ファイル オプションがない場合は、入力内容をエコーしないターミナルのプロンプト。
待機と終了コード
待機中、コマンドは進行状況を stderr に出力します。最終的なジョブは、job get と
同じ形式で stdout に書き込まれます。
結果が不明な場合
リクエストの送信後に接続が切断された場合や、サービスが5xx エラーを返した場合など、サービスがバッチを作成したかどうかを
CLI が判断できない場合は、終了コード 3 で終了します。作成リクエストが再送信されることはありません。stderr には、
リクエストの開始時刻 (UTC) と、次の手順が出力されます。
- 数分待ちます。作成中のバッチは、まだ一覧に表示されていない可能性があります。
xbox test-account batch list --mine --email-prefix <prefix>を実行し、同じメール プレフィックスと テンプレートを持ち、その時刻以降に作成されたバッチを探します。- そのバッチの
jobIdが設定されている場合は、xbox test-account job wait <job-id> --batch-id <batch-id>で追跡します。jobIdがnullの場合、ジョブは 停止しています。xbox test-account batch get <batch-id>で調べてください。 - 該当するバッチが存在しない場合にのみ、再度作成します。
作成時のエラー
失敗すると、status、title、detail、および code (応答に含まれる場合) を含む JSON エラーが stderr に書き込まれます。
処理の分岐には、detail ではなく code を使用してください。
作成ジョブの追跡
batch create は、ジョブが受け付けられるとすぐにバッチ ID とジョブ ID を出力します。ジョブは数日間実行されることがあるため、
いつでも待機を停止して、後で追跡できます。
どちらのコマンドもジョブを返します。
state は running、succeeded、または failed です。ジョブが失敗した場合、errorCode は test_account_job_failed です。
job wait は、スロットリングや接続の切断など、一時的な読み取りエラーを再試行します。
ジョブの追跡時のエラー
次のエラー コードは、ジョブ ID、--batch-id、または --seller-id に問題があることを示します。
バッチの更新
batch update は、バッチ内のすべてのアカウントを変更します。アカウントにさらに多くのサンドボックスへのアクセス権を付与したり、
アクセス権を削除したり、アクセスの有効期限を変更したり、バッチのタグを追加または置換したりできます。
その後、バッチに変更が反映されるまで待機します。
ターミナルでは、コマンドはまず要求された各変更をバッチの現在の値と並べて表示し、バッチでジョブがまだ
実行中の場合は警告を表示して、確認を求めます。プロンプトをスキップするには、--confirm (--yes、
-y) を渡します。ターミナルがなく、--confirm もない場合、コマンドは変更内容を表示して処理を拒否し、
何も送信しません。
少なくとも 1 つの変更を渡してください。バッチに設定できるタグは最大 20 個です。
--replace-tags と
--clear-tags は、バッチを作成したツールを記録するタグを保持します。このタグは上限にカウントされません。
サンドボックスまたは有効期限を変更するには、それらのサンドボックスへのアクセス権が必要です。
有効期限を延長するには、バッチのすべてのサンドボックスへのアクセス権が必要です。
更新が完了すると、コマンドはバッチの値を返します。
state は、バッチに変更が反映されると updated になり、--no-wait を指定した場合や先に待機が終了した場合は
updating になります。要求されたすべての値がバッチに既に設定されている場合は、何も変更されません。
state は unchanged、jobId は null になり、コマンドは終了コード 0 で終了します。更新ジョブは
job get や job wait で追跡できません。
更新時の待機と終了コード
更新時のエラー
コードのない
404 または 405 は、バッチの更新を利用できないことを意味します。
バッチの削除
batch delete はバッチ全体を削除し、削除が完了するまで待機します。バッチ内のすべてのアカウントは
サンドボックス アクセスを失い、そのテスト アカウントのレコードは削除されます。アカウントの Microsoft
アカウントと XBOX プロフィールは閉鎖されません。
ターミナルでは、コマンドはまずバッチのメール テンプレート、サイズ、作成者を表示し、バッチでジョブがまだ
実行中の場合は警告を表示して、確認を求めます。プロンプトをスキップするには、--confirm (--yes、-y) を
渡します。ターミナルがなく、--confirm もない場合、コマンドは削除対象を表示して処理を拒否し、
何も送信しません。一括削除はできないため、バッチは 1 つずつ削除してください。
コマンドは次の応答を返します。
state は、バッチの削除が完了すると deleted になり、--no-wait を指定した場合や先に待機が終了した場合は
deleting になります。削除ジョブは job get や job wait で追跡できません。削除の実行中は、
バッチにその jobId が表示されます。
削除時の待機と終了コード
削除時のエラー
コードのない
404 または 405 は、バッチの削除を利用できないことを意味します。
テーブル出力
すべてのコマンドで--output table を使用できます。時刻は UTC で表示され、概要の行は stderr に出力されるため、
stdout にはテーブルのみが含まれます。
