アプリの申請に関するロールアウトを停止するHalt the rollout for an app submission

このメソッドは、アプリの送信のために パッケージのロールアウトを停止 するために、MICROSOFT STORE 送信 API で使用します。Use this method in the Microsoft Store submission API to halt the package rollout for an app submission. Microsoft Store 申請 API を使ったアプリの申請の作成プロセスについて詳しくは、「アプリの申請の管理」をご覧ください。For more information about the process of process of creating an app submission by using the Microsoft Store submission API, see Manage app submissions.

注意

アプリの申請に関するロールアウトを停止してから、新しいアプリの申請を作成する場合、新しい申請は停止した申請を複製したものになります。If you halt the rollout for an app submission and then create a new app submission, the new submission is a clone of the halted submission.

前提条件Prerequisites

このメソッドを使うには、最初に次の作業を行う必要があります。To use this method, you need to first do the following:

  • Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。Obtain an Azure AD access token to use in the request header for this method. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れたら新しいトークンを取得できます。After the token expires, you can obtain a new one.
  • いずれかのアプリの送信を作成します。Create a submission for one of your apps. これはパートナーセンターで行うことができます。または、 [アプリの作成] 送信 方法を使用して行うこともできます。You can do this in Partner Center, or you can do this by using the create an app submission method.
  • 申請に関する段階的なパッケージのロールアウトを有効にします。Enable a gradual package rollout for the submission. これは パートナーセンターで行うことができます。または、 Microsoft Store 送信 API を使用して行うこともできます。You can do this in Partner Center, or you can do this by using the Microsoft Store submission API.

要求Request

このメソッドの構文は次のとおりです。This method has the following syntax. ヘッダーと要求のパラメーターの使用例と説明については、以下のセクションをご覧ください。See the following sections for usage examples and descriptions of the header and request parameters.

MethodMethod 要求 URIRequest URI
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout

要求ヘッダーRequest header

HeaderHeader TypeType 説明Description
承認Authorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

名前Name TypeType 説明Description
applicationIdapplicationId stringstring 必須。Required. 停止するパッケージのロールアウトの対象となる申請が含まれているアプリのストア ID です。The Store ID of the app that contains the submission with the package rollout you want to halt. ストア ID について詳しくは、「アプリ ID の詳細の表示」をご覧ください。For more information about the Store ID, see View app identity details.
submissionIdsubmissionId stringstring 必須。Required. 停止するパッケージのロールアウトの対象となる申請の ID です。The ID of the submission with the package rollout you want to halt. この ID は、アプリの申請の作成要求に対する応答データで確認できます。This ID is available in the response data for requests to create an app submission. パートナーセンターで作成された送信の場合、この ID はパートナーセンターの [送信] ページの URL でも利用できます。For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

[要求本文]Request body

このメソッドでは要求本文を指定しないでください。Do not provide a request body for this method.

要求の例Request example

アプリの申請に関するパッケージのロールアウトを停止する方法の例を次に示します。The following example demonstrates how to halt the package rollout for an app submission.

POST https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/submissions/1152921504621243680/haltpackagerollout HTTP/1.1
Authorization: Bearer <your access token>

応答Response

次の例は、このメソッドが正常に呼び出された場合の JSON 応答本文を示しています。The following example demonstrates the JSON response body for a successful call to this method. 応答本文の値について詳しくは、「パッケージのロールアウトのリソース」をご覧ください。For more details about the values in the response body, see Package rollout resource.

{
    "isPackageRollout": true,
    "packageRolloutPercentage": 0.0,
    "packageRolloutStatus": "PackageRolloutStopped",
    "fallbackSubmissionId": "1212922684621243058"
}

エラー コードError codes

要求を正常に完了できない場合、次の HTTP エラー コードのいずれかが応答に含まれます。If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

エラー コードError code 説明Description
404404 申請は見つかりませんでした。The submission could not be found.
409409 このコードは、次のエラーのいずれかを示します。This code indicates one of the following errors:

  • 申請が、段階的なロールアウト操作に対して有効な状態になっていません (このメソッドを呼び出す前に、申請を公開し、packageRolloutStatus の値を PackageRolloutInProgress に設定する必要があります)。The submission is not in a valid state for the gradual rollout operation (before calling this method, the submission must be published and the packageRolloutStatus value must be set to PackageRolloutInProgress).
  • 申請が、指定されたアプリに属していません。The submission does not belong to the specified app.
  • このアプリでは、 Microsoft Store 送信 API で現在サポートされていないパートナーセンター機能を使用しています。The app uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.