アプリの申請の更新

[アーティクル]
07/05/2024

既存のアプリの申請を更新するには、Microsoft Store 申請 API の次のメソッドを使用します。このメソッドを使って申請を正常に更新した後は、インジェストと公開のために申請をコミットする必要があります。

このメソッドが Microsoft Store 申請 API を使ったアプリの申請の作成プロセスにどのように適合するかについては、「アプリの申請の管理」をご覧ください。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
このメソッドの要求ヘッダーで使う Azure AD アクセストークンを取得します。アクセストークンを取得した後、アクセストークンを使用できるのは、その有効期限が切れるまでの 60 分間です。トークンの有効期限が切れたら新しいトークンを取得できます。
いずれかのアプリの申請を作成します。これは、パートナーセンターで、またはアプリの申請の作成メソッドを使用して実行できます。

要求

このメソッドの構文は次のとおりです。ヘッダーと要求本文の使用例と説明については、次のセクションをご覧ください。

認証方法	要求 URI
PUT	`https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}`

要求ヘッダー

Header	型	説明
承認	string	必須。 Bearer<トークン> という形式の Azure AD アクセストークン。

要求パラメーター

名前	種類	内容
applicationId	string	必須。申請を更新するアプリのストア ID。ストア ID について詳しくは、「アプリ ID の詳細の表示」をご覧ください。
submissionId	string	必須。更新する申請の ID です。この ID は、アプリの申請の作成要求に対する応答データで確認できます。アプリの申請をパートナーセンターで作成した場合、この ID は、パートナーセンターの申請ページの URL でも確認できます。

要求本文

要求本文には次のパラメーターがあります。

値	種類	説明
applicationCategory	string	アプリのカテゴリまたはサブカテゴリを指定する文字列。カテゴリとサブカテゴリは、 BooksAndReference_EReaderなど、アンダースコア '_' 文字を持つ 1 つの文字列に結合されます。
価格	オブジェクト	アプリの価格情報を含むオブジェクト。詳細については、「 Pricing リソース」セクションを参照してください。
visibility	string	アプリの可視性。次のいずれかの値を指定できます。非表示パブリックプライベート NotSet
targetPublishMode	string	申請の公開モードです。次のいずれかの値を指定できます。即時手動 SpecificDate
targetPublishDate	string	targetPublishMode が SpecificDate に設定されている場合、ISO 8601 形式での申請の公開日です。
listings	オブジェクト	キーと値のペアのディクショナリ。各キーは国コードであり、各値はアプリのリスト情報を含む Listing resource オブジェクトです。
hardwarePreferences	配列	アプリのハードウェアの基本設定を定義する文字列の配列。次のいずれかの値を指定できます。タッチキーボードマウスカメラ NfcHce Nfc BluetoothLE テレフォニー
automaticBackupEnabled	boolean	Windows が OneDrive への自動バックアップにアプリのデータを含めることができるかどうかを示します。詳細については、「 App 宣言」を参照してください。
canInstallOnRemovableMedia	boolean	ユーザーがアプリをリムーバブル記憶域にインストールできるかどうかを示します。詳細については、「 App 宣言」を参照してください。
isGameDvrEnabled	boolean	アプリに対してゲーム録画が有効になっているかどうかを示します。
gamingOptions	オブジェクト	アプリのゲーム関連の設定を定義する 1 つのギャミングオプションリソースを含む配列。
hasExternalInAppProducts	boolean	アプリでユーザーが Microsoft Store コマースシステムの外部で購入できるかどうかを示します。詳細については、「 App 宣言」を参照してください。
meetAccessibilityGuidelines	boolean	アプリがアクセシビリティガイドラインを満たすようにテストされているかどうかを示します。詳細については、「 App 宣言」を参照してください。
notesForCertification	string	アプリの認定の脚注が含まれています。
applicationPackages	配列	申請の各パッケージに関する詳細を提供するオブジェクトが含まれています。詳細については、「アプリケーションパッケージ」セクションを参照してください。このメソッドを呼び出してアプリの申請を更新するとき、要求の本文では、これらのオブジェクトの値 fileName、fileStatus、minimumDirectXVersion、minimumSystemRam だけが必須です。他の値はパートナーセンターによって設定されます。
packageDeliveryOptions	object	申請の段階的なパッケージのロールアウトと必須の更新の設定が含まれています。詳しくは、「パッケージの配信オプションオブジェクト」をご覧ください。
enterpriseLicensing	string	ライセンス値の 1 つアプリのエンタープライズライセンス動作を示す値です。
allowMicrosftDecideAppAvailabilityToFutureDeviceFamilies	boolean	Microsoft が将来の Windows 10 および Windows 11 デバイスファミリで使用できるアプリをできるかどうかを示します。
allowTargetFutureDeviceFamilies	boolean	アプリが将来の Windows 10 および Windows 11 デバイスファミリをターゲットにできるかどうかを示します。
トレーラー	配列	アプリ一覧のビデオトレーラーを表す最大 trailer リソースを含む配列。

要求の例

次の例では、アプリの申請を更新する方法を示します。

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": []
}

回答

次の例は、このメソッドが正常に呼び出された場合の JSON 応答本文を示しています。応答本文には、更新された申請に関する情報が含まれています。応答本文内の値について詳しくは、アプリの申請のリソースをご覧ください。

{
  "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": []
}

エラーコード

要求を正常に完了できない場合、次の HTTP エラーコードのいずれかが応答に含まれます。

エラーコード	Description
400	要求が無効なため、申請を更新できませんでした。
409	アプリの現在の状態が原因で、申請を更新できませんでした。または、アプリで、現在 Microsoft Store 申請 API でサポートされていないパートナーセンター機能が使用されています。

次の方法で共有

アプリの申請の更新

前提条件

要求

要求ヘッダー

要求パラメーター

要求本文

要求の例

回答

エラーコード

フィードバック

フィードバック

その他のリソース

次の方法で共有

アプリの申請の更新

前提条件

要求

要求ヘッダー

要求パラメーター

要求本文

要求の例

回答

エラー コード

関連トピック

フィードバック

フィードバック

その他のリソース

エラーコード