アプリの申請の更新Update an app submission

既存のアプリの申請を更新するには、Microsoft Store 申請 API の以下のメソッドを使います。Use this method in the Microsoft Store submission API to update an existing app 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 an app submission by using the Microsoft Store submission API, see Manage app 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 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.

要求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}/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 submission. ストア ID について詳しくは、「アプリ ID の詳細の表示」をご覧ください。For more information about the Store ID, see View app identity details.
submissionIdsubmissionId stringstring 必須。Required. 更新する申請の ID です。The ID of the submission to update. この 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

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

ValueValue 種類Type 説明Description
applicationCategoryapplicationCategory stringstring アプリのカテゴリとサブカテゴリを指定する文字列です。A string that specifies the category and/or subcategory for your app. カテゴリとサブカテゴリは、アンダースコア "" で 1 つの文字列に連結します (例: BooksAndReference_EReader)。Categories and subcategories are combined into a single string with the underscore '' character, such as BooksAndReference_EReader.
pricingpricing オブジェクトobject アプリの価格情報を含むオブジェクトです。An object that contains pricing info for the app. 詳しくは、「価格リソース」セクションをご覧ください。For more information, see the Pricing resource section.
visibilityvisibility stringstring アプリの可視性です。The visibility of the app. 次のいずれかの値を使用できます。This can be one of the following values:
  • HiddenHidden
  • パブリックPublic
  • PrivatePrivate
  • NotSetNotSet
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.
listingslistings オブジェクトobject キーと値のペアのディクショナリです。各キーは国コード、各値はアプリの登録情報を含む登録情報リソース オブジェクトです。A dictionary of key and value pairs, where each key is a country code and each value is a Listing resource object that contains listing info for the app.
hardwarePreferenceshardwarePreferences arrayarray アプリのハードウェアの基本設定を定義する文字列の配列です。An array of strings that define the hardware preferences for your app. 次のいずれかの値を使用できます。This can be one of the following values:
  • タッチTouch
  • キーボードKeyboard
  • マウスMouse
  • CameraCamera
  • NfcHceNfcHce
  • NfcNfc
  • BluetoothLEBluetoothLE
  • TelephonyTelephony
automaticBackupEnabledautomaticBackupEnabled booleanboolean OneDrive への自動バックアップにアプリのデータを含めることができるかどうかを示します。Indicates whether Windows can include your app's data in automatic backups to OneDrive. 詳しくは、「アプリの宣言」をご覧ください。For more information, see App declarations.
canInstallOnRemovableMediacanInstallOnRemovableMedia booleanboolean ユーザーがアプリをリムーバブル記憶域にインストールできるかどうかを示します。Indicates whether customers can install your app to removable storage. 詳しくは、「アプリの宣言」をご覧ください。For more information, see App declarations.
isGameDvrEnabledisGameDvrEnabled booleanboolean アプリのゲーム録画が有効になっているかどうかを示します。Indicates whether game DVR is enabled for the app.
gamingOptionsgamingOptions オブジェクトobject アプリのゲーム関連の設定を定義する 1 つのゲーム オプション リソースを格納する配列です。An array that contains one gaming options resource that defines game-related settings for the app.
hasExternalInAppProductshasExternalInAppProducts booleanboolean ユーザーが Microsoft Store コマース システムを使わないで購入することをアプリが許可するかどうかを示します。Indicates whether your app allows users to make purchase outside the Microsoft Store commerce system. 詳しくは、「アプリの宣言」をご覧ください。For more information, see App declarations.
meetAccessibilityGuidelinesmeetAccessibilityGuidelines booleanboolean アプリがアクセシビリティ ガイドラインを満たことをテストされているかどうかを示します。Indicates whether your app has been tested to meet accessibility guidelines. 詳しくは、「アプリの宣言」をご覧ください。For more information, see App declarations.
notesForCertificationnotesForCertification stringstring アプリの認定の注意書きが含まれます。Contains notes for certification for your app.
applicationPackagesapplicationPackages arrayarray 申請の各パッケージに関する詳細を提供するオブジェクトが含まれています。Contains objects that provide details about each package in the submission. 詳しくは、「アプリ パッケージ」セクションをご覧ください。For more information, see the Application package section. このメソッドを呼び出してアプリの申請を更新するとき、要求の本文では、これらのオブジェクトの値 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.
enterpriseLicensingenterpriseLicensing stringstring アプリのエンタープライズ ライセンス動作を示すエンタープライズ ライセンス値のいずれかです。One of the enterprise licensing values values that indicate the enterprise licensing behavior for the app.
allowMicrosftDecideAppAvailabilityToFutureDeviceFamiliesallowMicrosftDecideAppAvailabilityToFutureDeviceFamilies booleanboolean アプリを将来の Windows 10 デバイス ファミリで利用できるようにすることを Microsoft が許可されているかどうかを示すします。Indicates whether Microsoft is allowed to make the app available to future Windows 10 device families.
allowTargetFutureDeviceFamiliesallowTargetFutureDeviceFamilies booleanboolean 将来の Windows 10 デバイス ファミリをターゲットにすることをアプリが許可されているかどうかを示します。Indicates whether your app is allowed to target future Windows 10 device families.
trailerstrailers arrayarray アプリの登録情報用のビデオ トレーラーを表すトレーラー リソースを格納する配列です。格納できるトレーラー リソースの数には上限があります。An array that contains up to trailer resources that represent video trailers for the app listing.

要求の例Request example

次の例は、アプリの申請を更新する方法を示しています。The following example demonstrates how to update an app submission.

PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/submissions/1152921504621230023 HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
{
  "applicationCategory": "BooksAndReference_EReader",
  "pricing": {
    "trialPeriod": "FifteenDays",
    "marketSpecificPricings": {},
    "sales": [],
    "priceId": "Tier2"
  },
  "visibility": "Public",
  "targetPublishMode": "Manual",
  "targetPublishDate": "1601-01-01T00:00:00Z",
  "listings": {
    "en-us": {
      "baseListing": {
        "copyrightAndTrademarkInfo": "",
        "keywords": [
              "epub"
            ],
        "licenseTerms": "",
        "privacyPolicy": "",
        "supportContact": "",
        "websiteUrl": "",
        "description": "Description",
        "features": [
              "Free ebook reader"
            ],
        "releaseNotes": "",
        "images": [
          {
            "fileName": "contoso.png",
            "fileStatus": "Uploaded",
            "id": "1152921504672272757",
            "imageType": "Screenshot"
          }
        ],
        "recommendedHardware": [],
        "title": "Contoso ebook reader"
      },
      "platformOverrides": {
        "Windows81": {
          "description": "Ebook reader for Windows 8.1"
        }
      }
    }
  },
  "hardwarePreferences": [
    "Touch"
  ],
  "automaticBackupEnabled": false,
  "canInstallOnRemovableMedia": true,
  "isGameDvrEnabled": false,
  "gamingOptions": [],
  "hasExternalInAppProducts": false,
  "meetAccessibilityGuidelines": true,
  "notesForCertification": "",
  "applicationPackages": [
    {
      "fileName": "contoso_app.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"
  },
  "enterpriseLicensing": "Online",
  "allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
  "allowTargetFutureDeviceFamilies": {
    "Desktop": false,
    "Mobile": true,
    "Holographic": true,
    "Xbox": false,
    "Team": true
  },
  "trailers": []
}

応答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 App submission resource.

{
  "id": "1152921504621243540",
  "applicationCategory": "BooksAndReference_EReader",
  "pricing": {
    "trialPeriod": "FifteenDays",
    "marketSpecificPricings": {},
    "sales": [],
    "priceId": "Tier2"
  },
  "visibility": "Public",
  "targetPublishMode": "Manual",
  "targetPublishDate": "1601-01-01T00:00:00Z",
  "listings": {
    "en-us": {
      "baseListing": {
        "copyrightAndTrademarkInfo": "",
        "keywords": [
           "epub"
        ],
        "licenseTerms": "",
        "privacyPolicy": "",
        "supportContact": "",
        "websiteUrl": "",
        "description": "Description",
        "features": [
          "Free ebook reader"
        ],
        "releaseNotes": "",
        "images": [
          {
            "fileName": "contoso.png",
            "fileStatus": "Uploaded",
            "id": "1152921504672272757",
            "imageType": "Screenshot"
          }
        ],
        "recommendedHardware": [],
        "title": "Contoso ebook reader"
      },
      "platformOverrides": {
        "Windows81": {
          "description": "Ebook reader for Windows 8.1",
        }
      }
    }
  },
  "hardwarePreferences": [
    "Touch"
  ],
  "automaticBackupEnabled": false,
  "canInstallOnRemovableMedia": true,
  "isGameDvrEnabled": false,
  "gamingOptions": [],
  "hasExternalInAppProducts": false,
  "meetAccessibilityGuidelines": true,
  "notesForCertification": "",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [],
    "warnings": [],
    "certificationReports": []
  },
  "fileUploadUrl": "https://productingestionbin1.blob.core.windows.net/ingestion/387a9ea8-a412-43a9-8fb3-a38d03eb483d?sv=2014-02-14&sr=b&sig=sdd12JmoaT6BhvC%2BZUrwRweA%2Fkvj%2BEBCY09C2SZZowg%3D&se=2016-06-17T18:32:26Z&sp=rwl",
  "applicationPackages": [
    {
      "fileName": "contoso_app.appx",
      "fileStatus": "PendingUpload",
      "id": "1152921504620138797",
      "version": "1.0.0.0",
      "architecture": "ARM",
      "languages": [
        "en-US"
      ],
      "capabilities": [
        "ID_RESOLUTION_HD720P",
        "ID_RESOLUTION_WVGA",
        "ID_RESOLUTION_WXGA"
      ],
      "minimumDirectXVersion": "None",
      "minimumSystemRam": "None",
      "targetDeviceFamilies": [
        "Windows.Mobile min version 10.0.10240.0"
      ]
    }
  ],
  "packageDeliveryOptions": {
    "packageRollout": {
        "isPackageRollout": false,
        "packageRolloutPercentage": 0.0,
        "packageRolloutStatus": "PackageRolloutNotStarted",
        "fallbackSubmissionId": "0"
    },
    "isMandatoryUpdate": false,
    "mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
  },
  "enterpriseLicensing": "Online",
  "allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies": true,
  "allowTargetFutureDeviceFamilies": {
    "Desktop": false,
    "Mobile": true,
    "Holographic": true,
    "Xbox": false,
    "Team": true
  },
  "friendlyName": "Submission 2",
  "trailers": []
}

エラー コード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 submission could not be updated because the request is invalid.
409409 アプリの現在の状態であるため、送信を更新できませんでしたまたはアプリであるパートナー センター機能を使用する現在サポートされていません、Microsoft Store 送信 APIThe 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.