アプリの申請の管理
Microsoft Store 申請 API には、段階的なパッケージのロールアウトなど、アプリの申請を管理するために使用できるメソッドが用意されています。 Microsoft Store 申請 API の概要については、「Microsoft Store サービスを使用した申請の作成と管理」をご覧ください。この API を使用するための前提条件などの情報があります。
重要
Microsoft Store 申請 API を使ってアプリの提出を作成する場合、申請にさらに変更を加えるには、必ずパートナー センターではなく API のみを使用してください。 最初に API を使って作成した申請を、パートナー センターを使って変更した場合、API を使ってその申請を変更またはコミットすることができなくなります。 場合によっては、申請がエラー状態のままになり、申請プロセスを進めることができなくなります。 この場合、申請を削除して新しい申請を作成する必要があります。
重要
この API を使用して、ビジネス向け Microsoft Storeと教育機関向け Microsoft Storeを通じてボリューム購入の申請を発行したり、LOB アプリの申請を企業に直接発行したりすることはできません。 このようなシナリオでは、どちらの場合もパートナー センターを使って申請を公開する必要があります。
アプリの申請を管理するためのメソッド
アプリの申請を取得、作成、更新、コミット、または削除するには、次のメソッドを使用します。 これらのメソッドを使用するには、アプリをお客様自身のパートナー センター アカウントに用意し、まずパートナー センターでそのアプリの申請を 1 つ作成しておく必要があります。 詳細については、前提条件を参照してください。
Method | URI | 説明 |
---|---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} | 既存のアプリ申請を取得する |
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status | 既存のアプリ申請の状態を取得する |
投稿 | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions | 新しいアプリの申請を作成する |
PUT | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} | 既存のアプリの申請を更新する |
投稿 | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit | 新しいアプリまたは更新されたアプリの申請をコミットする |
DELETE | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} | アプリの申請の削除 |
アプリの申請の作成
アプリの申請を作成するには、このプロセスに従います。
Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
Note
評価情報が完了した、少なくとも 1 つの完了した申請がアプリに既に存在することを確認します。
Azure AD のアクセス トークンを取得します。 このアクセス トークンを Microsoft Store 申請 API のメソッドに渡す必要があります。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
Microsoft Store 申請 API で次のメソッドを実行して アプリの申請を作成します。 このメソッドによって、新しい申請が作成され、審査中になります。これは、前回発行した申請のコピーです。
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions
応答本文には、新しい申請の ID、申請用の関連ファイル (アプリ パッケージ、登録情報の画像、トレーラー ファイルなど) を Azure Blob Storage にアップロードするための共有アクセス署名 (SAS) URI、および新しい申請のすべてのデータ (登録情報や価格情報など) が含まれたアプリの申請リソースが含まれています。
Note
SAS URI では、アカウント キーを必要とせずに、Azure Storage 内のセキュリティで保護されたリソースにアクセスできます。 SAS URI の背景情報と Azure Blob Storage での SAS URI の使用については、「Shared Access Signatures、第 1 部: SAS モデルについて」と「Shared Access Signature、第 2 部: BLOB ストレージでの SAS の作成と使用」を参照してください。
申請用に新しいパッケージ、一覧表示イメージ、またはトレーラー ファイルを追加する場合は、アプリ パッケージ 準備し アプリのスクリーンショット、画像、およびトレーラーを します。 これらのファイルをすべて ZIP アーカイブに追加します。
app 申請新しい申請に必要な変更を含むデータを修正し、次のメソッドを実行してアプリの申請を更新します。
PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}
Note
申請用に新しいファイルを追加する場合は、ZIP アーカイブ内のこれらのファイルの名前と相対パスを参照するように申請データを更新してください。
申請用に新しいパッケージ、登録情報の画像、またはトレーラー ファイルを追加する場合は、上記で呼び出した POST メソッドの応答本文に含まれていた SAS URI を使用して、ZIP アーカイブを Azure Blob Storage にアップロードします。 さまざまなプラットフォームでこれを行うために使用できる、次のようなさまざまな Azure ライブラリがあります。
次の C# コード例は、.NET 用 Azure Storage クライアント ライブラリの CloudBlockBlob クラスを使って ZIP アーカイブを Azure Blob Storage にアップロードする方法を示しています。 この例では、ZIP アーカイブが既にストリーム オブジェクトに書き込まれていることを前提としています。
string sasUrl = "https://productingestionbin1.blob.core.windows.net/ingestion/26920f66-b592-4439-9a9d-fb0f014902ec?sv=2014-02-14&sr=b&sig=usAN0kNFNnYE2tGQBI%2BARQWejX1Guiz7hdFtRhyK%2Bog%3D&se=2016-06-17T20:45:51Z&sp=rwl"; Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob blockBob = new Microsoft.WindowsAzure.Storage.Blob.CloudBlockBlob(new System.Uri(sasUrl)); await blockBob.UploadFromStreamAsync(stream);
次のメソッドを実行して アプリの申請をコミットします。 これで、申請が完了し、更新がアカウントに適用されていることがパートナー センターに通知されます。
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit
次のメソッドを実行してコミットの状態を確認し、アプリの申請の状態を 取得します。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status
申請の状態を確認するには、応答本文の status の値を確認します。 この値が CommitStarted から PreProcessing (要求が成功した場合) または CommitFailed (要求でエラーが発生した場合) に変わっています。 エラーがある場合は、statusDetails フィールドにエラーについての詳細情報が含まれています。
コミットが正常に処理されると、インジェストのために申請がストアに送信されます。 上記のメソッドを使うか、パートナー センターのダッシュボードから、申請の進行状況を引き続き監視できます。
段階的なパッケージのロールアウトを管理するための方法
Windows 10 および Windows 11 では、アプリの申請で更新されたパッケージをアプリの顧客の割合に徐々にロールアウトできます。 これにより、特定のパッケージのフィードバックと分析データを監視して、更新プログラムをより広範にロールアウトする前に確実に更新プログラムを確認できます。 公開された申請のロールアウト率を変更 (または更新を停止) できます。新しい申請を作成する必要はありません。 パートナー センターで段階的なパッケージのロールアウトの有効化と管理を行う方法などについて詳しくは、この記事をご覧ください。
アプリの申請に対して段階的なパッケージのロールアウトをプログラムで有効にするには、Microsoft Store 申請 API のメソッドを使用して、次のプロセスに従います。
- アプリの申請を作成するか既存のアプリ申請を取得。
- 応答データで、 packageRollout リソースを見つけ、 isPackageRollout フィールドを true に設定し、 packageRolloutPercentage フィールドを、更新されたパッケージを取得するアプリの顧客の割合に設定します。
- 更新されたアプリ申請データを update a app submission メソッドに渡します。
アプリの申請に対して段階的なパッケージのロールアウトが有効になった後は、次の方法を使用して、段階的なロールアウトをプログラムで取得、更新、停止、または最終処理できます。
Method | URI | 説明 |
---|---|---|
GET | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout | アプリの申請に関する段階的なロールアウト情報を取得する |
投稿 | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage | アプリの申請の段階的なロールアウト率を更新する |
投稿 | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout | アプリの申請の段階的なロールアウトを停止する |
投稿 | https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout | アプリの申請の段階的なロールアウトを完了する |
アプリの申請を管理するためのコード例
次の記事では、いくつかの異なるプログラミング言語でアプリの申請を作成する方法を示す詳細なコード例を示します。
- C# のコード例: アプリ、アドオン、およびフライトの申請
- C# のコード例: ゲーム オプションおよびトレーラーを含むアプリの申請
- Java のコード例: アプリ、アドオン、およびフライトの申請
- Java のコード例: ゲーム オプションおよびトレーラーを含むアプリの申請
- Python のコード例: アプリ、アドオン、およびフライトの申請
- Python のコード例: ゲーム オプションおよびトレーラーを含むアプリの申請
StoreBroker PowerShell モジュール
Microsoft Store 申請 API を直接呼び出す代わりに、API の上にコマンド ライン インターフェイスを実装するオープンソースの PowerShell モジュールも用意されています。 このモジュールは、StoreBroker と呼ばれています。 このモジュールを使うと、Microsoft Store 申請 API を直接呼び出さずに、コマンド ラインからアプリ、フライト、アドオンの申請を管理できます。また、ソースを参照して、この API を呼び出す方法の例を確認することもできます。 StoreBroker モジュールは、多くのファースト パーティ アプリケーションをストアに申請する主要な方法として Microsoft 内で積極的に使っています。
詳しくは、GitHub の StoreBroker に関するページをご覧ください。
データ リソース
アプリの申請を管理するための Microsoft Store 申請 API メソッドでは、次の JSON データ リソースが使用されます。
アプリの申請リソース
このリソースでは、アプリの申請について説明します。
{
"id": "1152921504621243540",
"applicationCategory": "BooksAndReference_EReader",
"pricing": {
"trialPeriod": "FifteenDays",
"marketSpecificPricings": {},
"sales": [],
"priceId": "Tier2",
"isAdvancedPricingModel": true
},
"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",
"description": "Main page",
"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": "Uploaded",
"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": []
}
このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
id | string | 申請 ID。 この ID は、アプリの申請の作成、すべてのアプリのの取得、アプリのの取得をする要求の応答データで使用できます。 アプリの申請をパートナー センターで作成した場合、この ID は、パートナー センターの申請ページの URL でも確認できます。 |
applicationCategory | string | アプリの カテゴリまたはサブカテゴリ を指定する文字列。 カテゴリとサブカテゴリは、 BooksAndReference_EReaderなど、アンダースコア '_' 文字を持つ 1 つの文字列に結合されます。 |
価格 | オブジェクト | アプリの価格情報を含む 価格の高いリソース 。 |
visibility | string | アプリの可視性。 次のいずれかの値を指定できます。
|
targetPublishMode | string | 申請の公開モードです。 次のいずれかの値を指定できます。
|
targetPublishDate | string | targetPublishMode が SpecificDate に設定されている場合、ISO 8601 形式での申請の公開日です。 |
listings | オブジェクト | キーと値のペアのディクショナリ。各キーは国コードで、各値はアプリの一覧情報を含む リストリソース です。 |
hardwarePreferences | 配列 | アプリの ハードウェアの基本設定 を定義する文字列の配列。 次のいずれかの値を指定できます。
|
automaticBackupEnabled | boolean | Windows が OneDrive への自動バックアップにアプリのデータを含めることができるかどうかを示します。 詳細については、「 App 宣言」を参照してください。 |
canInstallOnRemovableMedia | boolean | ユーザーがアプリをリムーバブル 記憶域にインストールできるかどうかを示します。 詳細については、「 App 宣言」を参照してください。 |
isGameDvrEnabled | boolean | アプリに対してゲーム録画が有効になっているかどうかを示します。 |
gamingOptions | 配列 | アプリのゲーム関連の設定を定義する 1 つの ギャミング オプション リソース を含む配列。 |
hasExternalInAppProducts | boolean | アプリでユーザーが Microsoft Store コマース システムの外部で購入できるかどうかを示します。 詳細については、「 App 宣言」を参照してください。 |
meetAccessibilityGuidelines | boolean | アプリがアクセシビリティ ガイドラインを満たすようにテストされているかどうかを示します。 詳細については、「 App 宣言」を参照してください。 |
notesForCertification | string | アプリの認定の脚注が含まれています。 |
status | string | 申請の状態。 次のいずれかの値を指定できます。
|
statusDetails | object | エラーに関する情報など、申請のステータスに関する追加情報が保持されるステータスの詳細に関するリソースです。 |
fileUploadUrl | string | 申請のパッケージのアップロードに使用する共有アクセス署名 (SAS) URI です。 新しいパッケージの追加、画像の一覧表示、または提出用のトレーラー ファイルを行う場合は、パッケージと画像を含む ZIP アーカイブをこの URI にアップロードします。 詳細については、「 アプリの申請を作成する」を参照してください。 |
applicationPackages | 配列 | 申請内の各パッケージの詳細を提供する アプリケーション パッケージ リソース の配列。 |
packageDeliveryOptions | オブジェクト | パッケージ配信オプション リソース申請の段階的なパッケージのロールアウトと必須の更新設定が含まれています。 |
enterpriseLicensing | string | ライセンス値の 1 つアプリのエンタープライズ ライセンス動作を示す値です。 |
allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies | boolean | Microsoft が将来の Windows 10 および Windows 11 デバイス ファミリで使用できるアプリを できるかどうかを示します。 |
allowTargetFutureDeviceFamilies | オブジェクト | キーと値のペアのディクショナリ。各キーは Windows 10 および Windows 11 デバイス ファミリであり 各値は、アプリが指定したデバイス ファミリをターゲットにできるかどうかを示すブール値です。 |
friendlyName | string | パートナー センターに表示される申請のフレンドリ名です。 この値は、申請を作成するときに生成されます。 |
トレーラー | 配列 | アプリ一覧のビデオ トレーラーを表す最大 15 trailer リソース を含む配列。 |
価格リソース
このリソースには、アプリの価格情報が含まれています。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
trialPeriod | string | アプリの試用期間を指定する文字列。 次のいずれかの値を指定できます。
|
marketSpecificPricings | object | キーと値のペアのディクショナリです。各キーは 2 文字の ISO 3166-1 alpha-2 の国コードで、各値は価格帯です。 これらの項目は、特定の市場でのアプリの カスタム価格を表します。 このディクショナリに含まれる項目は、指定された市場の priceId の値によって指定されている基本価格を上書きします。 |
営業 | array | 削除されました。 アプリの販売情報を含む セール リソース の配列。 |
priceId | string | アプリのベース価格を指定する価格レベル。 |
isAdvancedPricingModel | boolean | true の場合、開発者アカウントは 0.99 USD ~ 1999.99 USD の拡張された価格セットにアクセスできます。 false の場合、開発者アカウントは 0.99 USD ~ 999.99 USD の元の価格帯セットにアクセスできます。 各種価格帯について詳しくは、「価格帯」をご覧ください。 注 このフィールドは読み取り専用です。 |
セール リソース
このリソースには、アプリの販売情報が含まれています。
重要
Sale リソースはサポートされなくなりました。現在、Microsoft Store 申請 API を使用してアプリ申請の販売データを取得または変更することはできません。 今後、Microsoft Store 申請 API を更新して、アプリ申請の販売情報にプログラムでアクセスする新しい方法を導入する予定です。
- GET メソッドを呼び出してアプリの申請を取得した後sales値は空になります。 引き続きパートナー センターを使って、アプリの申請のセール データを取得することができます。
- PUT メソッドを呼び出してアプリの申請を更新するとsales値の情報は無視されます。 引き続きパートナー センターを使って、アプリの申請のセール データを変更することができます。
このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
name | string | セールの名前です。 |
basePriceId | string | セールの基本価格として使用する価格帯です。 |
startDate | string | ISO 8601 形式で表したセールの開始日です。 |
endDate | string | ISO 8601 形式で表したセールの終了日です。 |
marketSpecificPricings | object | キーと値のペアのディクショナリです。各キーは 2 文字の ISO 3166-1 alpha-2 の国コードで、各値は価格帯です。 これらの項目は、特定の市場でのアプリの カスタム価格を表します。 このディクショナリに含まれる項目は、指定された市場の basePriceId の値によって指定されている基本価格を上書きします。 |
登録情報リソース
このリソースには、アプリの一覧情報が含まれています。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
baseListing | オブジェクト | ベースの一覧アプリの情報。すべてのプラットフォームの既定の登録情報を定義します。 |
platformOverrides | オブジェクト | キーと値のペアのディクショナリ。各キーはリスト情報をオーバーライドするプラットフォームを識別する文字列であり、各値は ベースの一覧 リソース (説明からタイトルまでの値のみを含む) であり、指定されたプラットフォームでオーバーライドするリスト情報を指定します。 キーには、次の値を指定できます。
|
ベース リスト リソース
このリソースには、アプリのベース リスト情報が含まれています。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
copyrightAndTrademarkInfo | string | 省略可能な copyright または商標情報。 |
keywords | 配列 | アプリを検索結果に表示するのに役立つ keyword の配列。 |
licenseTerms | string | アプリの省略可能な ライセンス条項 。 |
privacyPolicy | string | この値は廃止されています。 アプリのプライバシー ポリシーの URL を設定または変更するには、パートナー センターのプロパティ ページを使用する必要があります。 この値は、申請 API の呼び出しから省略できます。 この値を設定すると、無視されます。 |
supportContact | string | この値は廃止されています。 アプリのサポート連絡先の URL やメール アドレスを設定または変更するには、パートナー センターのプロパティ ページを使用する必要があります。 この値は、申請 API の呼び出しから省略できます。 この値を設定すると、無視されます。 |
websiteUrl | string | この値は廃止されています。 アプリの Web ページの URL を設定または変更するには、パートナー センターのプロパティ ページを使用する必要があります。 この値は、申請 API の呼び出しから省略できます。 この値を設定すると、無視されます。 |
description | string | アプリ一覧の 説明 。 |
features | 配列 | アプリの features を一覧表示する最大 20 個の文字列の配列。 |
releaseNotes | string | アプリの リリースノート 。 |
images | 配列 | アプリ一覧の イメージとアイコン リソースの配列。 |
recommendedHardware | 配列 | アプリの で推奨されるハードウェア構成 を一覧表示する最大 11 個の文字列の配列。 |
minimumHardware | string | アプリの minimum ハードウェア構成 を一覧表示する最大 11 個の文字列の配列。 |
タイトル | string | アプリの一覧のタイトル。 |
shortDescription | string | ゲームにのみ使用されます。 この説明は、Xbox One のゲーム ハブの Information セクションに表示され、お客様がゲームの詳細を理解するのに役立ちます。 |
shortTitle | string | あなたの製品名の短いバージョン。 提供された場合、この短い名前は、製品のフルタイトルの代わりに、Xbox Oneの様々な場所(インストール中、成果など)に現れる可能性がある。 |
sortTitle | string | 製品が異なる方法でアルファベット順に表示される場合は、ここで別のバージョンを入力できます。 これにより、顧客は検索時に製品をより迅速に見つけることができます。 |
voiceTitle | string | 提供された場合、キネクトまたはヘッドセットを使用する場合、Xbox Oneのオーディオエクスペリエンスで使用できる製品の別称。 |
devStudio | string | リストに Developed by フィールドを含める場合は、この値を指定します。 ( 発行者 フィールドには、 devStudio 値を指定したかどうかにかかわらず、アカウントに関連付けられている発行元の表示名が一覧表示されます。 |
イメージ リソース
このリソースには、アプリの一覧の画像とアイコンのデータが含まれています。 アプリの一覧の画像とアイコンの詳細については、「 App のスクリーンショットと画像を参照してください。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
fileName | string | 申請用にアップロードした ZIP アーカイブ内のイメージ ファイルの名前。 |
fileStatus | string | イメージ ファイルの状態。 次のいずれかの値を指定できます。
|
ID | string | イメージの ID。 この値はパートナー センターによって提供されます。 |
description | string | イメージの説明。 |
imageType | string | イメージの種類を示します。 現在、次の文字列がサポートされています。
|
ゲーム オプション リソース
このリソースには、アプリのゲーム関連の設定が含まれています。 このリソースの値は、パートナー センターの申請のゲーム設定に対応します。
{
"gamingOptions": [
{
"genres": [
"Games_ActionAndAdventure",
"Games_Casino"
],
"isLocalMultiplayer": true,
"isLocalCooperative": true,
"isOnlineMultiplayer": false,
"isOnlineCooperative": false,
"localMultiplayerMinPlayers": 2,
"localMultiplayerMaxPlayers": 12,
"localCooperativeMinPlayers": 2,
"localCooperativeMaxPlayers": 12,
"isBroadcastingPrivilegeGranted": true,
"isCrossPlayEnabled": false,
"kinectDataForExternal": "Enabled"
}
],
}
このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
ジャンル | 配列 | ゲームのジャンルを記述する次の文字列の 1 つ以上の配列。
|
isLocalMultiplayer | boolean | ゲームがローカル マルチプレイヤーをサポートしているかどうかを示します。 |
isLocalCooperative | boolean | ゲームがローカル協力をサポートしているかどうかを示します。 |
isOnlineMultiplayer | boolean | ゲームがオンライン マルチプレイヤーをサポートしているかどうかを示します。 |
isOnlineCooperative | boolean | ゲームがオンライン協力をサポートしているかどうかを示します。 |
localMultiplayerMinPlayers | int | ローカル マルチプレイヤーでゲームがサポートするプレイヤーの最小数を指定します。 |
localMultiplayerMaxPlayers | int | ローカル マルチプレイヤーでゲームがサポートするプレイヤーの最大数を指定します。 |
localCooperativeMinPlayers | int | ゲームがローカル協力に対してサポートするプレイヤーの最小数を指定します。 |
localCooperativeMaxPlayers | int | ゲームがローカル協力に対してサポートするプレイヤーの最大数を指定します。 |
isBroadcastingPrivilegeGranted | boolean | ゲームがブロードキャストをサポートしているかどうかを示します。 |
isCrossPlayEnabled | boolean | ゲームが Windows 10 と Windows 11 PC と Xbox のプレイヤー間のマルチプレイヤー セッションをサポートしているかどうかを示します。 |
kinectDataForExternal | string | ゲームが Kinect データを収集して外部サービスに送信できるかどうかを示す次のいずれかの文字列値。
|
Note
gamingOptions リソースは、Microsoft Store 申請 API が開発者に最初にリリースされた後、2017 年 5 月に追加されました。 このリソースが導入される前に申請 API を使用してアプリの申請を作成し、この申請がまだ進行中の場合、申請が正常にコミットされるか削除されるまで、このリソースはアプリの申請に対して null になります。 gamingOptionsリソースがアプリの申請に使用できない場合、Application リソースのhasAdvancedListingPermissionフィールドget an app メソッドによって返されます。
ステータスの詳細に関するリソース
このリソースには、申請の状態についての追加情報が保持されます。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
エラー | object | 申請のエラーの詳細が保持されるステータスの詳細リソースの配列です。 |
warnings | object | 申請の警告の詳細が保持されるステータスの詳細リソースの配列です。 |
certificationReports | object | 申請の認定レポート データへのアクセスを提供する認定レポート リソースです。 認定されなかった場合に、これらのレポートから詳しい情報を知ることができます。 |
ステータスの詳細に関するリソース
このリソースには、申請に関連するエラーや警告についての追加情報が保持されます。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
code | string | エラーや警告の種類を説明する申請ステータス コードです。 |
details | string | 問題についての詳細が含まれるメッセージです。 |
アプリケーション パッケージ リソース
このリソースには、申請のアプリ パッケージに関する詳細が含まれています。
{
"applicationPackages": [
{
"fileName": "contoso_app.appx",
"fileStatus": "Uploaded",
"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"
]
}
],
}
このリソースには、次の値があります。
Note
update アプリの申請メソッドを呼び出す場合、要求本文には、fileName、fileStatus、minimumDirectXVersion、および minimumSystemRam 値のみが必要です。 他の値はパートナー センターによって設定されます。
値 | 種類 | 説明 |
---|---|---|
fileName | string | パッケージの名前です。 |
fileStatus | string | パッケージの状態。 次のいずれかの値を指定できます。
|
ID | string | パッケージを一意に識別する ID。 この値はパートナー センターによって提供されます。 |
version | string | アプリ パッケージのバージョン。 詳細については、「 Package のバージョン番号付けを参照してください。 |
アーキテクチャ | string | パッケージのアーキテクチャ (ARM など)。 |
言語 | 配列 | アプリがサポートする言語の言語コードの配列。 詳細については、サポートされる言語 を参照してください。 |
capabilities | 配列 | パッケージに必要な機能の配列。 機能の詳細については、「 App capability 宣言」を参照してください。 |
minimumDirectXVersion | string | アプリ パッケージでサポートされている DirectX の最小バージョン。 これは、Windows 8.x を対象とするアプリに対してのみ設定できます。 他の OS バージョンを対象とするアプリの場合、 update a app submission メソッドを呼び出すときにこの値が存在する必要がありますが、指定した値は無視されます。 次のいずれかの値を指定できます。
|
minimumSystemRam | string | アプリ パッケージに必要な最小 RAM。 これは、Windows 8.x を対象とするアプリに対してのみ設定できます。 他の OS バージョンを対象とするアプリの場合、 update a app submission メソッドを呼び出すときにこの値が存在する必要がありますが、指定した値は無視されます。 次のいずれかの値を指定できます。
|
targetDeviceFamilies | 配列 | パッケージが対象とするデバイス ファミリを表す文字列の配列。 この値は、Windows 10 を対象とするパッケージにのみ使用されます。以前のリリースを対象とするパッケージの場合、この値の値は None です。 現在、次のデバイス ファミリ文字列は Windows 10 および Windows 11 パッケージでサポートされています。 {0} は Windows 10 または Windows 11 のバージョン文字列 (10.0.10240.0、10.0.10586.0、10.0.14393.0 など) です。
|
id="certification-report-resource"
認定レポート リソース
このリソースは、申請の認定レポート データへのアクセスを提供します。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
date | string | ISO 8601 形式で表された、レポートが生成された日付と時刻です。 |
reportUrl | string | レポートにアクセスできる URL です。 |
パッケージ配信オプション リソース
このリソースには、申請の段階的なパッケージのロールアウトと必須の更新設定が含まれています。
{
"packageDeliveryOptions": {
"packageRollout": {
"isPackageRollout": false,
"packageRolloutPercentage": 0,
"packageRolloutStatus": "PackageRolloutNotStarted",
"fallbackSubmissionId": "0"
},
"isMandatoryUpdate": false,
"mandatoryUpdateEffectiveDate": "1601-01-01T00:00:00.0000000Z"
},
}
このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
packageRollout | オブジェクト | 申請の段階的なパッケージ ロールアウト設定を含む パッケージ ロールアウト リソース 。 |
isMandatoryUpdate | boolean | この申請のパッケージを、アプリの更新プログラムの自己インストールに必須として扱うかどうかを示します。 アプリの更新プログラムを自己インストールするための必須パッケージの詳細については、「 アプリのパッケージ更新プログラムをダウンロードしてインストールするを参照してください。 |
mandatoryUpdateEffectiveDate | 日付 | この申請のパッケージが必須になる日時 (ISO 8601 形式と UTC タイム ゾーン)。 |
パッケージ ロールアウト リソース
このリソースには、申請の段階的な パッケージロールアウト設定 が含まれています。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
isPackageRollout | boolean | 申請に対して段階的なパッケージ ロールアウトが有効になっているかどうかを示します。 |
packageRolloutPercentage | float | 段階的なロールアウトでパッケージを受け取るユーザーの割合。 |
packageRolloutStatus | string | 段階的なパッケージロールアウトの状態を示す次のいずれかの文字列。
|
fallbackSubmissionId | string | 段階的なロールアウト パッケージを取得しないお客様が受け取る申請の ID。 |
Note
packageRolloutStatus と fallbackSubmissionId の値はパートナー センターで割り当てられます。これらの値は、開発者が設定する値ではありません。 これらの値を要求本文に含める場合、これらの値は無視されます。
Trailers リソース
このリソースは、アプリの一覧のビデオ トレーラーを表します。 このリソースの値は、パートナー センターの申請のトレーラー オプションに対応します。
app 申請リソース内の trailers 配列に最大 15 個のトレーラー リソースを追加できます。 提出用のトレーラー ビデオ ファイルとサムネイル 画像をアップロードするには、これらのファイルをパッケージを含む同じ ZIP アーカイブに追加し、申請の画像を一覧表示してから、この ZIP アーカイブを申請の Shared Access Signature (SAS) URI にアップロードします。 ZIP アーカイブを SAS URI にアップロードする方法の詳細については、「 アプリの申請を作成する」を参照してください。
{
"trailers": [
{
"id": "1158943556954955699",
"videoFileName": "Trailers\\ContosoGameTrailer.mp4",
"videoFileId": "1159761554639123258",
"trailerAssets": {
"en-us": {
"title": "Contoso Game",
"imageList": [
{
"fileName": "Images\\ContosoGame-Thumbnail.png",
"id": "1155546904097346923",
"description": "This is a still image from the video."
}
]
}
}
}
]
}
このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
id | string | トレーラーの ID。 この値はパートナー センターによって提供されます。 |
videoFileName | string | 申請のファイルを含む ZIP アーカイブ内の予告編ビデオ ファイルの名前。 |
videoFileId | string | 予告編ビデオ ファイルの ID。 この値はパートナー センターによって提供されます。 |
trailerAssets | オブジェクト | キーと値のペアのディクショナリ。各キーは言語コードであり、各値はトレーラー用の追加のロケール固有の資産を含む の資産リソース です。 サポートされている言語コードの詳細については、「 サポートされている言語」を参照してください。 |
Note
trailers リソースは、Microsoft Store 申請 API が開発者に最初にリリースされた後、2017 年 5 月に追加されました。 このリソースが導入される前に申請 API を使用してアプリの申請を作成し、この申請がまだ進行中の場合、申請が正常にコミットされるか削除されるまで、このリソースはアプリの申請に対して null になります。 trailersリソースがアプリの申請に使用できない場合、get an app メソッドによって返される Application リソースの hasAdvancedListingPermission フィールドは false です。
トレーラー資産リソース
このリソースには、 trailer リソースで定義されているトレーラー用の追加のロケール固有の資産が含まれています。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
肩書き | string | トレーラーのローカライズされたタイトル。 ユーザーがトレーラーを全画面表示モードで再生すると、タイトルが表示されます。 |
imageList | 配列 | トレーラーのサムネイル画像を提供する 1 つの image リソースを含む配列。 この配列には、 image リソースを 1 つだけ含めることができます。 |
イメージ リソース (トレーラー用)
このリソースでは、トレーラーのサムネイル画像について説明します。 このリソースには、次の値があります。
値 | 種類 | 説明 |
---|---|---|
fileName | string | 申請用にアップロードした ZIP アーカイブ内のサムネイル画像ファイルの名前。 |
ID | string | サムネイル画像の ID。 この値はパートナー センターによって提供されます。 |
description | string | サムネイル画像の説明。 この値はメタデータのみであり、ユーザーには表示されません。 |
列挙型
これらのメソッドでは、次の列挙型が使用されます。
価格レベル
次の値は、アプリ申請の pricing リソース リソースで使用可能な価格レベルを表します。
Value | 説明 |
---|---|
ベース | 価格レベルは設定されていません。アプリの基本価格を使用します。 |
NotAvailable | アプリは、指定されたリージョンでは使用できません。 |
Free | このアプリは無料です。 |
Tierxxx | Tierxxxx の形式で、アプリの価格レベルを指定する文字列。 現在のところ、次の範囲の価格帯がサポートされています。 各価格帯に関連付けられた市場固有の価格を含む、開発者アカウントで利用可能な価格帯の詳しい表を参照するには、パートナー センターでいずれかのアプリ申請の[価格と使用可能状況] ページにアクセスし、[市場と特別価格] セクションで [view table] (表を表示) リンクをクリックします (一部の開発者アカウントでは、このリンクは [Pricing] (価格) セクションにあります)。 |
エンタープライズ ライセンスの値
次の値は、アプリの組織のライセンス動作を表します。 これらのオプションの詳細については、「 Organizational ライセンス オプションを参照してください。
Note
申請 API を使用してアプリの申請の組織のライセンス オプションを構成することはできますが、この API を使用して、ビジネス向け Microsoft Storeと教育機関向け Microsoft Storeを通じてボリューム購入の申請を発行することはできません。 ビジネス向け Microsoft Store for Business や教育機関向け Microsoft Store に申請を公開するには、パートナー センターを使う必要があります。
Value | 説明 |
---|---|
なし | ストアマネージド (オンライン) ボリューム ライセンスを使用する企業では、アプリを使用できるようにしないでください。 |
オンライン | ストアマネージド (オンライン) ボリューム ライセンスを使用する企業がアプリを利用できるようにします。 |
OnlineAndOffline | ストア管理 (オンライン) ボリューム ライセンスを持つ企業がアプリを利用できるようにすると共に、切断された (オフラインの) ライセンスを使用してアプリを企業が利用できるようにします。 |
申請の状態コード
次の値は、申請の状態コードを表します。
値 | 説明 |
---|---|
なし | コードが指定されていません。 |
InvalidArchive | パッケージが含まれる ZIP アーカイブは無効であるか、認識できないアーカイブ形式です。 |
MissingFiles | ZIP アーカイブに、申請データで指定されているすべてのファイルが含まれていないか、ファイルのアーカイブ内の場所が正しくありません。 |
PackageValidationFailed | 申請の 1 つ以上のパッケージを検証できませんでした。 |
InvalidParameterValue | 要求本文に含まれるパラメーターの 1 つが無効です。 |
InvalidOperation | 実行された操作は無効です。 |
InvalidState | 実行された操作は、パッケージ フライトの現在の状態では無効です。 |
ResourceNotFound | 指定されたパッケージ フライトは見つかりませんでした。 |
ServiceError | 内部サービス エラーのため、要求を処理できませんでした。 もう一度要求を行ってください。 |
ListingOptOutWarning | 開発者が以前の申請の登録情報を削除しているか、パッケージによってサポートされる登録情報を含めていませんでした。 |
ListingOptInWarning | 開発者が登録情報を追加しました。 |
UpdateOnlyWarning | 開発者が、更新サポートしかないものを挿入しようとしています。 |
その他 | 申請が非認識または未分類の状態です。 |
PackageValidationWarning | パッケージ検証プロセスの結果、警告が生成されました。 |