パッケージ フライトの申請の更新Update a package flight submission

既存のパッケージ フライトの申請を更新するには、Microsoft Store 申請 API の以下のメソッドを使います。Use this method in the Microsoft Store submission API to update an existing package flight submission. このメソッドを使って申請を正常に更新した後は、インジェストと公開のために申請をコミットする必要があります。After you successfully update a submission by using this method, you must commit the submission for ingestion and publishing.

このメソッドが Microsoft Store 申請 API を使ったパッケージ フライト申請の作成プロセスにどのように適合するかについては、「パッケージ フライトの申請の管理」をご覧ください。For more information about how this method fits into the process of creating a package flight submission by using the Microsoft Store submission API, see Manage package flight submissions.

前提条件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 package flight submission for one of your apps. パートナー センターでこれを行うかを使用してこれを行う、パッケージ フライトの提出の作成メソッド。You can do this in Partner Center, or you can do this by using the create a package flight submission method.

要求Request

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

メソッドMethod 要求 URIRequest URI
PUTPUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/flights/{flightId}/submissions/{submissionId}

要求ヘッダーRequest header

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

要求パラメーターRequest parameters

名前Name 種類Type 説明Description
applicationIdapplicationId stringstring 必須。Required. パッケージ フライト申請を更新するアプリのストア ID です。The Store ID of the app for which you want to update a package flight submission. ストア ID について詳しくは、「アプリ ID の詳細の表示」をご覧ください。For more information about the Store ID, see View app identity details.
flightIdflightId stringstring 必須。Required. 申請を更新するパッケージ フライトの ID です。The ID of the package flight for which you want to update a submission. この ID は、パッケージ フライトの作成要求とアプリのパッケージ フライトの取得要求の応答データで確認できます。This ID is available in the response data for requests to create a package flight and get package flights for an app. パートナー センターで作成されたフライトはこの ID はパートナー センターでのフライトのページの URL で使用できるも。For a flight that was created in Partner Center, this ID is also available in the URL for the flight page in Partner Center.
submissionIdsubmissionId stringstring 必須。Required. 更新する申請の ID です。The ID of the submission to update. この ID は、パッケージ フライトの申請の作成要求に対する応答データで確認できます。This ID is available in the response data for requests to create a package flight 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

要求本文には次のパラメーターがあります。The request body has the following parameters.

ValueValue 種類Type 説明Description
flightPackagesflightPackages arrayarray 申請の各パッケージに関する詳細を提供するオブジェクトが含まれています。Contains objects that provide details about each package in the submission. 応答本文の値について詳しくは、「フライト パッケージ リソース」をご覧ください。For more details about the values in the response body, see Flight package resource. このメソッドを呼び出してアプリの申請を更新するとき、要求の本文では、これらのオブジェクトの値 fileNamefileStatusminimumDirectXVersionminimumSystemRam だけが必須です。When calling this method to update an app submission, only the fileName, fileStatus, minimumDirectXVersion, and minimumSystemRam values of these objects are required in the request body. パートナー センターでは、その他の値が設定されます。The other values are populated by Partner Center.
packageDeliveryOptionspackageDeliveryOptions オブジェクトobject 申請の段階的なパッケージのロールアウトと必須の更新の設定が含まれています。Contains gradual package rollout and mandatory update settings for the submission. 詳しくは、「パッケージの配信オプション オブジェクト」をご覧ください。For more information, see Package delivery options object.
targetPublishModetargetPublishMode stringstring 申請の公開モードです。The publish mode for the submission. 次のいずれかの値を使用できます。This can be one of the following values:
  • 即時Immediate
  • ManualManual
  • SpecificDateSpecificDate
targetPublishDatetargetPublishDate stringstring targetPublishMode が SpecificDate に設定されている場合、ISO 8601 形式での申請の公開日です。The publish date for the submission in ISO 8601 format, if the targetPublishMode is set to SpecificDate.
notesForCertificationnotesForCertification stringstring テスト アカウントの資格情報や、機能のアクセスおよび検証手順など、審査担当者に対して追加情報を提供します。Provides additional info for the certification testers, such as test account credentials and steps to access and verify features. 詳しくは、「認定の注意書き」をご覧ください。For more information, see Notes for certification.

要求の例Request example

アプリのパッケージ フライト申請を更新する方法の例を次に示します。The following example demonstrates how to update a package flight submission for an app.

PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/flights/43e448df-97c9-4a43-a0bc-2a445e736bcd/submissions/1152921504621243649 HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
{
  "flightPackages": [
    {
      "fileName": "newPackage.appx",
      "fileStatus": "PendingUpload",
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None"
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "targetPublishMode": "Immediate",
  "targetPublishDate": "",
  "notesForCertification": "No special steps are required for certification of this app."
}

応答Response

次の例は、このメソッドが正常に呼び出された場合の JSON 応答本文を示しています。The following example demonstrates the JSON response body for a successful call to this method. 応答本文には、更新された申請に関する情報が含まれています。The response body contains information about the updated submission. 応答本文の値について詳しくは、「パッケージ フライトの申請のリソース」を参照してください。For more details about the values in the response body, see Package flight submission resource.

{
  "id": "1152921504621243649",
  "flightId": "cd2e368a-0da5-4026-9f34-0e7934bc6f23",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [],
    "warnings": [],
    "certificationReports": []
  },
  "flightPackages": [
    {
      "fileName": "newPackage.appx",
      "fileStatus": "PendingUpload",
      "id": "",
      "version": "1.0.0.0",
      "languages": ["en-us"],
      "capabilities": [],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None"
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/8b389577-5d5e-4cbe-a744-1ff2e97a9eb8?sv=2014-02-14&sr=b&sig=wgMCQPjPDkuuxNLkeG35rfHaMToebCxBNMPw7WABdXU%3D&se=2016-06-17T21:29:44Z&sp=rwl",
  "targetPublishMode": "Immediate",
  "targetPublishDate": "",
  "notesForCertification": "No special steps are required for certification of this app."
}

エラー コードError codes

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

エラー コードError code 説明Description
400400 要求が正しくないため、パッケージ フライト申請を更新できませんでした。The package flight submission could not be updated because the request is invalid.
409409 パッケージのフライトの送信をアプリの現在の状態であるため更新できませんでしたまたはアプリであるパートナー センター機能を使用する現在サポートされていません、Microsoft Store 送信 APIThe package flight submission could not be updated because of the current state of the app, or the app uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.