アプリの申請の更新
既存のアプリの申請を更新するには、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 | アプリのカテゴリとサブカテゴリを指定する文字列です。 カテゴリとサブカテゴリは、アンダースコア "_" で 1 つの文字列に連結します (例: BooksAndReference_EReader)。 |
価格 | object | アプリの価格情報を含むオブジェクトです。 詳しくは、「価格リソース」セクションをご覧ください。 |
参照可能範囲 | string | アプリの可視性です。 次のいずれかの値を指定できます。
|
targetPublishMode | string | 申請の公開モードです。 次のいずれかの値を指定できます。
|
targetPublishDate | string | targetPublishMode が SpecificDate に設定されている場合、ISO 8601 形式での申請の公開日です。 |
listings | object | キーと値のペアのディクショナリです。各キーは国コード、各値はアプリの登録情報を含む登録情報リソース オブジェクトです。 |
hardwarePreferences | array | アプリのハードウェアの基本設定を定義する文字列の配列です。 次のいずれかの値を指定できます。
|
automaticBackupEnabled | boolean | OneDrive への自動バックアップにアプリのデータを含めることができるかどうかを示します。 詳しくは、「アプリの宣言」をご覧ください。 |
canInstallOnRemovableMedia | boolean | ユーザーがアプリをリムーバブル記憶域にインストールできるかどうかを示します。 詳しくは、「アプリの宣言」をご覧ください。 |
isGameDvrEnabled | boolean | アプリのゲーム録画が有効になっているかどうかを示します。 |
gamingOptions | object | アプリのゲーム関連の設定を定義する 1 つのゲーム オプション リソースを格納する配列です。 |
hasExternalInAppProducts | boolean | ユーザーが Microsoft Store コマース システムを使わないで購入することをアプリが許可するかどうかを示します。 詳しくは、「アプリの宣言」をご覧ください。 |
meetAccessibilityGuidelines | boolean | アプリがアクセシビリティ ガイドラインを満たことをテストされているかどうかを示します。 詳しくは、「アプリの宣言」をご覧ください。 |
notesForCertification | string | アプリの認定の注意書きが含まれます。 |
applicationPackages | array | 申請の各パッケージに関する詳細を提供するオブジェクトが含まれています。 詳しくは、「アプリ パッケージ」セクションをご覧ください。 このメソッドを呼び出してアプリの申請を更新するとき、要求の本文では、これらのオブジェクトの値 fileName、fileStatus、minimumDirectXVersion、minimumSystemRam だけが必須です。 他の値はパートナー センターによって設定されます。 |
packageDeliveryOptions | object | 申請の段階的なパッケージのロールアウトと必須の更新の設定が含まれています。 詳しくは、「パッケージの配信オプション オブジェクト」をご覧ください。 |
enterpriseLicensing | string | アプリのエンタープライズ ライセンス動作を示すエンタープライズ ライセンス値のいずれかです。 |
allowMicrosftDecideAppAvailabilityToFutureDeviceFamilies | boolean | Microsoft が将来のWindows 10およびWindows 11デバイス ファミリでアプリを使用できるかどうかを示します。 |
allowTargetFutureDeviceFamilies | boolean | アプリが将来のWindows 10とWindows 11デバイス ファミリをターゲットにできるかどうかを示します。 |
trailers | array | アプリの登録情報用のビデオ トレーラーを表すトレーラー リソースを格納する配列です。格納できるトレーラー リソースの数には上限があります。 |
要求の例
次の例は、アプリの申請を更新する方法を示しています。
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 応答本文を示しています。 応答本文には、更新された申請に関する情報が含まれています。 応答本文内の値について詳しくは、アプリの申請のリソースをご覧ください。
{
"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 エラー コードのいずれかが応答に含まれます。
エラー コード | 説明 |
---|---|
400 | 要求が無効なため、申請を更新できませんでした。 |
409 | アプリの現在の状態が原因で、申請を更新できませんでした。または、アプリで、現在 Microsoft Store 申請 API でサポートされていないパートナー センター機能が使用されています。 |
関連トピック
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示