アプリの申請の管理

Microsoft Store 申請 API には、段階的なパッケージのロールアウトなど、アプリの申請を管理するために使用できるメソッドが用意されています。 Microsoft Store 申請 API の概要については、「Microsoft Store サービスを使用した申請の作成と管理」をご覧ください。この API を使用するための前提条件などの情報があります。

重要

Microsoft Store 申請 API を使ってアプリの提出を作成する場合、申請にさらに変更を加えるには、必ずパートナー センターではなく API のみを使用してください。 最初に API を使って作成した申請を、パートナー センターを使って変更した場合、API を使ってその申請を変更またはコミットすることができなくなります。 場合によっては、申請がエラー状態のままになり、申請プロセスを進めることができなくなります。 この場合、申請を削除して新しい申請を作成する必要があります。

重要

この API を使って、ビジネス向け Microsoft Store や教育機関向け Microsoft Store でのボリューム購入の申請を公開したり、LOB アプリの申請を直接企業に発行したりすることはできません。 このようなシナリオでは、どちらの場合もパートナー センターを使って申請を公開する必要があります。

アプリの申請を管理するためのメソッド

アプリの申請を取得、作成、更新、コミット、または削除するには、次のメソッドを使用します。 これらのメソッドを使用するには、アプリをお客様自身のパートナー センター アカウントに用意し、まずパートナー センターでそのアプリの申請を 1 つ作成しておく必要があります。 詳細については、前提条件を参照してください。

認証方法 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 既存のアプリの申請の状態を取得します
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions 新しいアプリの申請を作成します
PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId} 既存のアプリの申請を更新します
POST 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} アプリの申請の削除

アプリの申請の作成

アプリの申請を作成するには、次のプロセスに従います。

  1. Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。

    注意

    年齢区分の情報を含む 1 つ以上の申請がアプリで既に完了していることを確認します。

  2. Azure AD のアクセス トークンを取得します。 このアクセス トークンを Microsoft Store 申請 API のメソッドに渡す必要があります。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。

  3. Microsoft Store 申請 API の次のメソッドを実行して、アプリの申請を作成します。 このメソッドによって、新しい申請が作成され、審査中になります。これは、前回発行した申請のコピーです。

    POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions
    

    応答本文には、新しい申請の ID、申請用の関連ファイル (アプリ パッケージ、登録情報の画像、トレーラー ファイルなど) を Azure Blob Storage にアップロードするための共有アクセス署名 (SAS) URI、および新しい申請のすべてのデータ (登録情報や価格情報など) が含まれたアプリの申請リソースが含まれています。

    注意

    SAS URI では、アカウント キーを必要とせずに、Azure Storage 内のセキュリティで保護されたリソースにアクセスできます。 SAS URI の背景情報と Azure Blob Storage での SAS URI の使用については、「Shared Access Signatures、第 1 部: SAS モデルについて」と「Shared Access Signature、第 2 部: BLOB ストレージでの SAS の作成と使用」を参照してください。

  4. 申請用に新しいパッケージ、登録情報の画像、またはトレーラー ファイルを追加する場合は、アプリのパッケージを準備し、アプリのスクリーンショット、画像、およびトレーラーを準備します。 これらのファイルをすべてまとめて ZIP アーカイブに追加します。

  5. 新しい申請用に必要な変更を行ってアプリの申請データを修正し、次のメソッドを実行してアプリの申請を更新します。

    PUT https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}
    

    注意

    申請用に新しいファイルを追加する場合、ZIP アーカイブ内の新しいファイルの名前と相対パスを参照するように、申請データを更新してください。

  6. 申請用に新しいパッケージ、登録情報の画像、またはトレーラー ファイルを追加する場合は、上記で呼び出した 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);
    
  7. 次のメソッドを実行して、アプリの申請をコミットします。 これで、申請が完了し、更新がアカウントに適用されていることがパートナー センターに通知されます。

    POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/commit
    
  8. 次のメソッドを実行してアプリの申請の状態を取得して、コミット状態を確認します。

    GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/status
    

    申請の状態を確認するには、応答本文の status の値を確認します。 この値が CommitStarted から PreProcessing (要求が成功した場合) または CommitFailed (要求でエラーが発生した場合) に変わっています。 エラーがある場合は、statusDetails フィールドにエラーについての詳細情報が含まれています。

  9. コミットが正常に処理されると、インジェストのために申請がストアに送信されます。 上記のメソッドを使うか、パートナー センターのダッシュボードから、申請の進行状況を引き続き監視できます。

段階的なパッケージのロールアウトを管理するためのメソッド

アプリの申請で更新されたパッケージを、アプリの Windows 10 のユーザーの一部に、段階的にロールアウトできます。 これにより、更新に確信が持てるよう、特定のパッケージのフィードバックと分析データを監視してから、より広くロールアウトできます。 新しい申請を作成することなく、公開された申請のロールアウトの割合を変更する (または更新を停止する) ことができます。 パートナー センターで段階的なパッケージのロールアウトの有効化と管理を行う方法などについて詳しくは、この記事をご覧ください。

アプリの申請の段階的なパッケージのロールアウトをプログラムによって有効化するには、Microsoft Store 申請 API のメソッドを使用して、次の手順に従います。

  1. アプリの申請を作成するか、既存のアプリの申請を取得します。
  2. 応答データで、packageRollout リソースを探し、[isPackageRollout] フィールドを [true] に設定し、[packageRolloutPercentage] フィールドに、アプリのユーザーが更新されたパッケージを取得する割合を設定します。
  3. アプリの申請の更新のメソッドに、更新されたアプリの申請データを渡します。

アプリの申請の段階的なパッケージのロールアウトが有効化された後、段階的なロールアウトをプログラムで取得、更新、停止、または完了するには、次のメソッドを使用できます。

認証方法 URI 説明
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/packagerollout アプリの申請の段階的なロールアウトの情報を取得します
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/updatepackagerolloutpercentage アプリの申請の段階的なロールアウトの割合を更新します
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/haltpackagerollout アプリの申請の段階的なロールアウトを停止します
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/submissions/{submissionId}/finalizepackagerollout アプリの申請の段階的なロールアウトを完了します

アプリの申請を管理するためのコード例

次の記事では、さまざまなプログラミング言語でアプリの申請を作成する方法を説明する詳しいコード例を紹介します。

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 アプリのカテゴリとサブカテゴリを指定する文字列です。 カテゴリとサブカテゴリは、アンダースコア "_" で 1 つの文字列に連結します (例: BooksAndReference_EReader)。
価格 object アプリの価格設定情報が保持される価格リソースです。
参照可能範囲 string アプリの可視性です。 次のいずれかの値を指定できます。
  • [非表示]
  • パブリック
  • プライベート
  • NotSet
targetPublishMode string 申請の公開モードです。 次のいずれかの値を指定できます。
  • 即時
  • 手動
  • SpecificDate
targetPublishDate string targetPublishMode が SpecificDate に設定されている場合、ISO 8601 形式での申請の公開日です。
listings object キーと値のペアのディクショナリです。各キーは国コード、各値はアプリの登録情報を含む登録情報リソース オブジェクトです。
hardwarePreferences array アプリのハードウェアの基本設定を定義する文字列の配列です。 次のいずれかの値を指定できます。
  • Touch
  • キーボード
  • マウス
  • カメラ
  • NfcHce
  • Nfc
  • BluetoothLE
  • テレフォニー
automaticBackupEnabled boolean OneDrive への自動バックアップにアプリのデータを含めることができるかどうかを示します。 詳しくは、「アプリの宣言」をご覧ください。
canInstallOnRemovableMedia boolean ユーザーがアプリをリムーバブル記憶域にインストールできるかどうかを示します。 詳しくは、「アプリの宣言」をご覧ください。
isGameDvrEnabled boolean アプリのゲーム録画が有効になっているかどうかを示します。
gamingOptions array アプリのゲーム関連の設定を定義する 1 つのゲーム オプション リソースを格納する配列です。
hasExternalInAppProducts boolean ユーザーが Microsoft Store コマース システムを使わないで購入することをアプリが許可するかどうかを示します。 詳しくは、「アプリの宣言」をご覧ください。
meetAccessibilityGuidelines boolean アプリがアクセシビリティ ガイドラインを満たことをテストされているかどうかを示します。 詳しくは、「アプリの宣言」をご覧ください。
notesForCertification string アプリの認定の注意書きが含まれます。
status string 申請の状態。 次のいずれかの値を指定できます。
  • なし
  • Canceled
  • PendingCommit
  • CommitStarted
  • CommitFailed
  • PendingPublication
  • 発行
  • 公開済み
  • PublishFailed
  • PreProcessing
  • PreProcessingFailed
  • 認定資格
  • CertificationFailed
  • リリース
  • ReleaseFailed
statusDetails object エラーに関する情報など、申請のステータスに関する追加情報が保持されるステータスの詳細に関するリソースです。
fileUploadUrl string 申請のパッケージのアップロードに使用する共有アクセス署名 (SAS) URI です。 申請用に新しいパッケージ、登録情報の画像、またはトレーラー ファイルを追加する場合は、パッケージと画像を含む ZIP アーカイブをこの URI にアップロードします。 詳しくは、「アプリの申請の作成」をご覧ください。
applicationPackages array 申請の各パッケージに関する詳細を提供するアプリケーション パッケージ リソースの配列です。
packageDeliveryOptions object 申請の段階的なパッケージのロールアウトと必須の更新の設定が含まれたパッケージ配布オプション リソースです。
enterpriseLicensing string アプリのエンタープライズ ライセンス動作を示すエンタープライズ ライセンス値のいずれかです。
allowMicrosoftDecideAppAvailabilityToFutureDeviceFamilies boolean アプリを将来の Windows 10 デバイス ファミリで利用できるようにすることを Microsoft が許可されているかどうかを示すします。
allowTargetFutureDeviceFamilies object キーと値のペアのディクショナリです。各キーは Windows 10 デバイス ファミリ を表し、各値は指定されたデバイス ファミリをアプリがターゲットにできるかどうかを示すブール値です。
friendlyName string パートナー センターに表示される申請のフレンドリ名です。 この値は、申請を作成するときに生成されます。
trailers array アプリの登録情報用のビデオ トレーラーを表すトレーラー リソースを 15 個まで格納する配列です。

価格リソース

このリソースにはアプリの価格設定情報が保持されます。 このリソースには、次の値があります。

種類 説明
trialPeriod string アプリの試用期間を示す文字列です。 次のいずれかの値を指定できます。
  • NoFreeTrial
  • OneDay
  • TrialNeverExpires
  • SevenDays
  • FifteenDays
  • ThirtyDays
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 の元の価格帯セットにアクセスできます。 各種価格帯について詳しくは、「価格帯」をご覧ください。

このフィールドは読み取り専用です。

セール リソース

このリソースにはアプリのセール情報が保持されます。

重要

セール リソースはサポートを終了しました。現在、Microsoft Store 申請 API を使ってアプリの申請の販売データを取得または変更することはできません。 将来的には、Microsoft Store 申請 API を更新して、アプリの申請のセール情報にプログラムでアクセスする新しい方法を導入する予定です。

  • アプリの申請を取得する GET メソッドを呼び出すと、セール リソースは空になります。 引き続きパートナー センターを使って、アプリの申請のセール データを取得することができます。
  • アプリの申請を更新する PUT メソッドを呼び出すとき、セールの値に含まれた情報は無視されます。 引き続きパートナー センターを使って、アプリの申請のセール データを変更することができます。

このリソースには、次の値があります。

種類 説明
name string セールの名前です。
basePriceId string セールの基本価格として使用する価格帯です。
startDate string ISO 8601 形式で表したセールの開始日です。
endDate string ISO 8601 形式で表したセールの終了日です。
marketSpecificPricings object キーと値のペアのディクショナリです。各キーは 2 文字の ISO 3166-1 alpha-2 の国コードで、各値は価格帯です。 これらの項目は、特定の市場でのアプリのカスタム価格を表します。 このディクショナリに含まれる項目は、指定された市場の basePriceId の値によって指定されている基本価格を上書きします。

登録情報リソース

このリソースにはアプリの登録情報が保持されます。 このリソースには、次の値があります。

種類 説明
baseListing object アプリの基本の登録情報です。これはすべてのプラットフォームで既定の登録情報となります。
platformOverrides object キーと値のペアのディクショナリです。各キーは、登録情報を上書きするプラットフォームを示す文字列を表し、各値は、指定されたプラットフォームで上書きする登録情報を示す基本の登録情報リソース (description から title までの値のみが保持されています) を表します。 キーには次の値を設定できます。
  • Unknown
  • Windows80
  • Windows81
  • WindowsPhone71
  • WindowsPhone80
  • WindowsPhone81

基本の登録情報リソース

このリソースにはアプリの基本の登録情報が保持されます。 このリソースには、次の値があります。

種類 説明
copyrightAndTrademarkInfo string (省略可能) 著作権や商標の情報です。
keywords array 結果にアプリが表示される確率を高めるキーワードの配列です。
licenseTerms string アプリのライセンス条項 (省略可能) です。
privacyPolicy string この値は今後は使用しません。 アプリのプライバシー ポリシーの URL を設定または変更するには、パートナー センターのプロパティ ページを使用する必要があります。 この値は、申請 API の呼び出しから省略することができます。 この値を設定しても無視されます。
supportContact string この値は今後は使用しません。 アプリのサポート連絡先の URL やメール アドレスを設定または変更するには、パートナー センターのプロパティ ページを使用する必要があります。 この値は、申請 API の呼び出しから省略することができます。 この値を設定しても無視されます。
websiteUrl string この値は今後は使用しません。 アプリの Web ページの URL を設定または変更するには、パートナー センターのプロパティ ページを使用する必要があります。 この値は、申請 API の呼び出しから省略することができます。 この値を設定しても無視されます。
description string アプリの登録情報の説明です。
features array アプリの機能を示す最大 20 個の文字列の配列です。
releaseNotes string アプリのリリース ノートです。
images array アプリの登録情報の画像とアイコンのリソースの配列です。
recommendedHardware array アプリの推奨されるハードウェア構成を示す最大 11 個の文字列の配列です。
minimumHardware string アプリの最小ハードウェア構成を示す最大 11 個の文字列の配列です。
title string アプリの登録情報のタイトルです。
shortDescription string ゲームにのみ使用されます。 この説明は、Xbox One のゲーム ハブにある [情報] セクションに表示され、ユーザーがどのようなゲームかを理解するのに役立ちます。
shortTitle string 製品の名前の短いバージョン。 指定した場合、Xbox One のさまざまな場所 (インストール時や [実績] など) で製品のフル タイトルの代わりにこの短い名前が表示されることがあります。
sortTitle string 製品のアルファベット表記が複数ある場合、ここに別のバージョンを入力できます。 これにより、ユーザーが検索したときに製品がすばやく見つかるようになる可能性があります。
voiceTitle string Kinect やヘッドセットを使うときに Xbox One のオーディオ エクスペリエンスで使われる、製品の代替名 (ある場合)。
devStudio string 登録情報に [Developed by] (開発元) フィールドを含める必要がある場合はこの値を指定します (devStudio 値の指定とは関係なく、[公開元] フィールドにはアカウントに関連付けられた発行者の表示名が示されます)。

画像リソース

このリソースにはアプリの登録情報の画像とアイコンのデータが保持されます。 アプリの登録情報の画像とアイコンについて詳しくは、「アプリのスクリーンショットと画像」をご覧ください。 このリソースには、次の値があります。

種類 説明
fileName string 申請用にアップロードした ZIP アーカイブに含まれている画像ファイルの名前です。
fileStatus string 画像ファイルの状態です。 次のいずれかの値を指定できます。
  • なし
  • PendingUpload
  • アップロード完了
  • PendingDelete
id string 画像の ID です。 この値はパートナー センターによって提供されます。
description string 画像の説明です。
imageType string 画像の種類を示します。 現在サポートされている文字列は次のとおりです。

スクリーンショット画像:

  • Screenshot (デスクトップのスクリーンショットにはこの値を使用します)
  • MobileScreenshot
  • XboxScreenshot
  • SurfaceHubScreenshot
  • HoloLensScreenshot

店舗のロゴ:

  • StoreLogo9x16
  • StoreLogoSquare
  • Icon (1:1 の 300 x 300 ピクセルのロゴにはこの値を使用します)

プロモーション画像:

  • PromotionalArt16x9
  • PromotionalArtwork2400X1200

Xbox イメージ:

  • XboxBrandedKeyArt
  • XboxTitledHeroArt
  • XboxFeaturedPromotionalArt

省略可能なプロモーション 画像:

  • SquareIcon358X358
  • BackgroundImage1000X800
  • PromotionalArtwork414X180

ゲーム オプション リソース

このリソースにはアプリのゲーム関連の設定が保持されます。 このリソースの値は、パートナー センターの申請のゲーム設定に対応します。

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

このリソースには、次の値があります。

種類 説明
ジャンル array ゲームのジャンルを説明する次の 1 つ以上の文字列の配列です。
  • Games_ActionAndAdventure
  • Games_CardAndBoard
  • Games_Casino
  • Games_Educational
  • Games_FamilyAndKids
  • Games_Fighting
  • Games_Music
  • Games_Platformer
  • Games_PuzzleAndTrivia
  • Games_RacingAndFlying
  • Games_RolePlaying
  • Games_Shooter
  • Games_Simulation
  • Games_Sports
  • Games_Strategy
  • Games_Word
isLocalMultiplayer boolean ゲームでローカル マルチプレイヤーがサポートされているかどうかを示します。
isLocalCooperative boolean ゲームでローカル協力プレイがサポートされているかどうかを示します。
isOnlineMultiplayer boolean ゲームでオンライン マルチプレイヤーがサポートされているかどうかを示します。
isOnlineCooperative boolean ゲームでオンライン協力プレイがサポートされているかどうかを示します。
localMultiplayerMinPlayers int ゲームでサポートされるローカル マルチプレイヤーの最小プレイヤー数を指定します。
localMultiplayerMaxPlayers int ゲームでサポートされるローカル マルチプレイヤーの最大プレイヤー数を指定します。
localCooperativeMinPlayers int ゲームでサポートされるローカル協力プレイの最小プレイヤー数を指定します。
localCooperativeMaxPlayers int ゲームでサポートされるローカル協力プレイの最大プレイヤー数を指定します。
isBroadcastingPrivilegeGranted boolean ゲームでブロードキャストがサポートされているかどうかを示します。
isCrossPlayEnabled boolean ゲームで Windows 10 PC と Xbox のプレイヤー間でのマルチプレイヤー セッションがサポートされているかどうかを示します。
kinectDataForExternal string 次の各文字列値は、ゲームで Kinect データを収集し、外部サービスに送信できるかどうかを示します。
  • NotSet
  • Unknown
  • Enabled
  • 無効

注意

gamingOptions リソースは、Microsoft Store 申請 API が開発者向けに最初にリリースされた後、2017 年 5 月に追加されました。 このリソースが導入される前に申請 API を通じててアプリの申請を作成し、その申請がまだ審査中の場合、申請を正常にコミットするか削除するまで、アプリの申請に対するこのリソースは null になります。 アプリの申請で gamingOptions リソースが利用できない場合、アプリの取得メソッドから返されるアプリケーション リソースhasAdvancedListingPermission フィールドは false になります。

ステータスの詳細に関するリソース

このリソースには、申請の状態についての追加情報が保持されます。 このリソースには、次の値があります。

種類 説明
エラー 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"
      ]
    }
  ],
}

このリソースには、次の値があります。

注意

アプリの申請の更新のメソッドを呼び出す場合、要求本文に必要なのは、このオブジェクトの fileNamefileStatusminimumDirectXVersionminimumSystemRam の値のみです。 他の値はパートナー センターによって設定されます。

種類 説明
fileName string パッケージの名前です。
fileStatus string パッケージの状態です。 次のいずれかの値を指定できます。
  • なし
  • PendingUpload
  • アップロード完了
  • PendingDelete
id string パッケージを一意に識別する ID です。 この値はパートナー センターによって提供されます。
version string アプリ パッケージのバージョンです。 詳しくは、「パッケージ バージョンの番号付け」をご覧ください。
アーキテクチャ string パッケージのアーキテクチャ (ARM など) です。
languages array アプリがサポートする言語の言語コードの配列です。 詳細については、サポートされている言語に関するページを参照してください。
capabilities array パッケージに必要な機能の配列です。 機能について詳しくは、「アプリ機能の宣言」をご覧ください。
minimumDirectXVersion string アプリ パッケージによってサポートされる DirectX の最小バージョンです。 Windows 8.x をターゲットとするアプリでのみ設定できます。 その他の OS バージョンをターゲットとするアプリの場合、アプリの申請の更新メソッドの呼び出し時にはこの値が存在している必要がありますが、指定した値は無視されます。 次のいずれかの値を指定できます。
  • なし
  • DirectX93
  • DirectX100
minimumSystemRam string アプリ パッケージに必要な RAM の最小サイズです。 Windows 8.x をターゲットとするアプリでのみ設定できます。 その他の OS バージョンをターゲットとするアプリの場合、アプリの申請の更新メソッドの呼び出し時にはこの値が存在している必要がありますが、指定した値は無視されます。 次のいずれかの値を指定できます。
  • なし
  • Memory2GB
targetDeviceFamilies array パッケージがターゲットにするデバイス ファミリを表す文字列の配列です。 この値は Windows 10 をターゲットにするパッケージにしか使用できません。以前のリリースをターゲットにするパッケージでは、この値は None になります。 Windows 10 パッケージでは、現在、次のデバイス ファミリ文字列がサポートされます。{0} は Windows 10 のバージョン文字列で、10.0.10240.0、10.0.10586.0、10.0.14393.0 などになります。
  • Windows.Universal min version {0}
  • Windows.Desktop min version {0}
  • Windows.Mobile min version {0}
  • Windows.Xbox min version {0}
  • Windows.Holographic min version {0}

認定レポート リソース

このリソースは、申請の認定レポート データへのアクセスを提供します。 このリソースには、次の値があります。

種類 説明
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 object 申請の段階的なパッケージのロールアウトの設定が含まれたパッケージのロールアウトのリソースです。
isMandatoryUpdate boolean この申請のパッケージを自己インストールのアプリの更新のために必須として扱うかどうかを指定します。 自己インストールのアプリの更新のために必須なパッケージについて詳しくは、「アプリのパッケージの更新をダウンロードしてインストールする」をご覧ください。
mandatoryUpdateEffectiveDate 日付 この申請のパッケージが必須となる日時 (ISO 8601 形式、UTC タイムゾーン)。

パッケージのロールアウトのリソース

このリソースには、申請の段階的なパッケージのロールアウトの設定が含まれています。 このリソースには、次の値があります。

種類 説明
isPackageRollout boolean 申請の段階的なパッケージのロールアウトが有効化されているかどうかを示します。
packageRolloutPercentage float 段階的なロールアウトでパッケージを受信するユーザーの割合。
packageRolloutStatus string 段階的なパッケージのロールアウトの状態を示す、次の文字列のいずれかです。
  • PackageRolloutNotStarted
  • PackageRolloutInProgress
  • PackageRolloutComplete
  • PackageRolloutStopped
fallbackSubmissionId string 段階的なロールアウトのパッケージを入手しないユーザーが受信する申請のID。

注意

packageRolloutStatusfallbackSubmissionId の値はパートナー センターで割り当てられます。これらの値は、開発者が設定する値ではありません。 これらの値を要求本文に含めると、これらの値は無視されます。

トレーラー リソース

このリソースは、アプリの登録情報のビデオ トレーラーを表します。 このリソースの値は、パートナー センターの申請のトレーラー オプションに対応します。

アプリの申請リソースtrailers 配列には最大 15 個のトレーラー リソースを追加できます。 申請用のトレーラー ビデオ ファイルとサムネイル画像をアップロードするには、申請用のパッケージと登録情報の画像が含まれているものと同一の ZIP アーカイブにこれらのファイルを追加し、この ZIP アーカイブを申請用の共有アクセス署名 (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 object キーと値のペアのディクショナリです。各キーは言語コードであり、各値はトレーラーの追加のロケール固有アセットを含むトレーラー アセット リソースです。 サポートされている言語コードについて詳しくは、「サポートされている言語」をご覧ください。

注意

trailers リソースは、Microsoft Store 申請 API が開発者向けに最初にリリースされた後、2017 年 5 月に追加されました。 このリソースが導入される前に申請 API を通じててアプリの申請を作成し、その申請がまだ審査中の場合、申請を正常にコミットするか削除するまで、アプリの申請に対するこのリソースは null になります。 アプリの申請で trailers リソースが利用できない場合、アプリの取得メソッドから返されるアプリケーション リソースhasAdvancedListingPermission フィールドは false になります。

トレーラー アセット リソース

このリソースには、トレーラー リソースで定義されているトレーラー用の追加のロケール固有アセットが保持されます。 このリソースには、次の値があります。

種類 説明
title string トレーラーのローカライズされたタイトルです。 タイトルは、ユーザーがトレーラーを全画面表示モードで再生すると表示されます。
imageList array 1 つの画像リソースが含まれた配列で、トレーラーのサムネイル画像を提供します。 この配列には 1 つの画像リソースのみを含めることができます。

画像リソース (トレーラー用)

このリソースは、トレーラーのサムネイル画像を記述しています。 このリソースには、次の値があります。

種類 説明
fileName string 申請用にアップロードした ZIP アーカイブに含まれているサムネイル画像ファイルの名前です。
id string サムネイル画像の ID です。 この値はパートナー センターによって提供されます。
description string サムネイル画像の説明です。 この値はメタデータのみです。ユーザーには表示されません。

列挙型

これらのメソッドでは、次の列挙型が使用されます。

価格レベル

次の値は、価格リソースにおける、アプリの申請に利用できる価格帯を表します。

説明
ベース 価格帯が設定されていない場合、アプリの基本価格が使用されます。
NotAvailable アプリは指定された地域で提供されていません。
Free このアプリは無料です。
Tierxxx アプリの価格帯を指定する文字列 (Tierxxxx の形式)。 現在のところ、次の範囲の価格帯がサポートされています。

  • 価格リソースisAdvancedPricingModel 値が true の場合、アカウントで利用可能な価格帯値は Tier1012 - Tier1424 です。
  • 価格リソースisAdvancedPricingModel 値が false の場合、アカウントで利用可能な価格帯値は Tier2 - Tier96 です。
各価格帯に関連付けられた市場固有の価格を含む、開発者アカウントで利用可能な価格帯の詳しい表を参照するには、パートナー センターでいずれかのアプリ申請の[価格と使用可能状況] ページにアクセスし、[市場と特別価格] セクションで [view table] (表を表示) リンクをクリックします (一部の開発者アカウントでは、このリンクは [Pricing] (価格) セクションにあります)。

エンタープライズ ライセンス値

次の値は、アプリに対する組織のライセンス動作を表します。 これらのオプションについて詳しくは、「組織のライセンス オプション」をご覧ください。

注意

アプリに対する組織のライセンス オプションは申請 API を通じて構成できますが、この API を使ってビジネス向け Microsoft Store や教育機関向け Microsoft Store でのボリューム購入の申請を公開することはできません。 ビジネス向け Microsoft Store for Business や教育機関向け Microsoft Store に申請を公開するには、パートナー センターを使う必要があります。

説明
なし ストアで管理される (オンラインの) ボリューム ライセンスがある企業に、アプリの利用を許可しません。
オンライン ストアで管理される (オンラインの) ボリューム ライセンスがある企業に、アプリの利用を許可します。
OnlineAndOffline ストアで管理される (オンラインの) ボリューム ライセンスがある企業にアプリの利用を許可し、未接続状態 (オフライン) のライセンスのある企業にアプリの利用を許可します。

申請の状態コード

次の値は、申請の状態コードを表します。

説明
なし コードが指定されていません。
InvalidArchive パッケージが含まれる ZIP アーカイブは無効であるか、認識できないアーカイブ形式です。
MissingFiles ZIP アーカイブに、申請データで指定されているすべてのファイルが含まれていないか、ファイルのアーカイブ内の場所が正しくありません。
PackageValidationFailed 申請の 1 つ以上のパッケージを検証できませんでした。
InvalidParameterValue 要求本文に含まれるパラメーターの 1 つが無効です。
InvalidOperation 実行された操作は無効です。
InvalidState 実行された操作は、パッケージ フライトの現在の状態では無効です。
ResourceNotFound 指定されたパッケージ フライトは見つかりませんでした。
ServiceError 内部サービス エラーのため、要求を処理できませんでした。 もう一度要求を行ってください。
ListingOptOutWarning 開発者が以前の申請の登録情報を削除しているか、パッケージによってサポートされる登録情報を含めていませんでした。
ListingOptInWarning 開発者が登録情報を追加しました。
UpdateOnlyWarning 開発者が、更新サポートしかないものを挿入しようとしています。
その他 申請が非認識または未分類の状態です。
PackageValidationWarning パッケージ検証プロセスの結果、警告が生成されました。