次の方法で共有

アドオンの申請を管理する

Microsoft Store 申請 API には、アプリのアドオン (アプリ内製品または IAP とも呼ばれます) の申請を管理するために使用できるメソッドが用意されています。 API を使用するための前提条件など、Microsoft Store 申請 API の概要については、「Microsoft Store サービスを使用した申請の作成と管理」を参照してください。

Von Bedeutung

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

アドオンの申請を管理する方法

アドオンの申請を取得、作成、更新、コミット、または削除するには、次のメソッドを使用します。 これらの方法を使用する前に、パートナー センター アカウントにアドオンが既に存在している必要があります。 パートナー センターでアドオンを作成するには、 その製品の種類と製品 ID を定義 するか、「 アドオンの管理」で説明されている Microsoft Store 申請 API メソッドを使用します。

メソッド URI（統一リソース識別子） 説明
取得する https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{id}/submissions/{submissionId} 既存のアドオン申請を取得する
取得する https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{id}/submissions/{submissionId}/status 既存のアドオン申請の状態を取得する
投稿 https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{id}/submissions 新しいアドオン申請を作成する
配置する https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{id}/submissions/{submissionId} 既存のアドオン申請を更新する
投稿 https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{id}/submissions/{submissionId}/commit 新規または更新されたアドオンの申請をコミットする
削除 https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{id}/submissions/{submissionId} アドオン申請の を削除する

アドオンの申請を作成する

アドオンの申請を作成するには、このプロセスに従います。

  1. まだ行っていない場合は、「 Microsoft Store サービスを使用して申請を作成および管理する」で説明されている前提条件を満たしてください。これには、Azure AD アプリケーションをパートナー センター アカウントに関連付け、クライアント ID とキーを取得する方法が含まれます。 これは 1 回だけ行う必要があります。クライアント ID とキーを取得したら、新しい Azure AD アクセス トークンを作成する必要がある場合は、いつでもそれらを再利用できます。

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

  3. Microsoft Store 申請 API で次のメソッドを実行します。 このメソッドは、新しい進行中の申請を作成します。これは、最後に発行された申請のコピーです。 詳細については、「 アドオンの申請を作成する」を参照してください。

    POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{id}/submissions

    応答本文には、新しい 申請 の ID、Azure Blob Storage への申請のアドオン アイコンをアップロードするための Shared Access Signature (SAS) URI、および新しい申請のすべてのデータ (一覧や価格情報など) が含まれるアドオン申請リソースが含まれています。

    注

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

  4. 申請に新しいアイコンを追加する場合は、 アイコンを準備 して ZIP アーカイブに追加します。

  5. 新しい申請に必要な変更を加えて アドオンの申請 データを更新し、次のメソッドを実行して申請を更新します。 詳細については、「 アドオンの申請を更新する」を参照してください。

    PUT https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{id}/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/inappproducts/{id}/submissions/{submissionId}/commit

  8. 次のメソッドを実行して、コミットの状態を確認します。 詳細については、「 アドオンの申請の状態を取得する」を参照してください。

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

    申請の状態を確認するには、応答本文で 状態 値を確認します。 この値は、CommitStarted から、要求が成功した場合には PreProcessing に、要求にエラーがある場合には CommitFailed に変更される必要があります。 エラーがある場合は、statusDetails フィールドにエラーの詳細が含まれます。

  9. コミットが正常に完了すると、申請はインジェストのためにストアに送信されます。 前の方法を使用するか、パートナー センターにアクセスして、申請の進行状況を引き続き監視できます。

コード例

次の記事では、いくつかの異なるプログラミング言語でアドオン申請を作成する方法を示す詳細なコード例を示します。

StoreBroker PowerShell モジュール

Microsoft Store 申請 API を直接呼び出す代わりに、API の上にコマンド ライン インターフェイスを実装するオープンソースの PowerShell モジュールも用意されています。 このモジュールは StoreBrokerと呼ばれています。 このモジュールを使用すると、Microsoft Store 申請 API を直接呼び出す代わりに、コマンド ラインからアプリ、フライト、アドオンの申請を管理できます。また、ソースを参照するだけで、この API を呼び出す方法の他の例を確認することもできます。 StoreBroker モジュールは、多くのファーストパーティ アプリケーションがストアに送信される主な方法として、Microsoft 内で積極的に使用されています。

詳細については、GitHubの StoreBroker ページを参照してください。

データ リソース

アドオンの申請を管理するための Microsoft Store 申請 API メソッドでは、次の JSON データ リソースが使用されます。

アドオン申請リソース

このリソースでは、アドオンの申請について説明します。

{
  "id": "1152921504621243680",
  "contentType": "EMagazine",
  "keywords": [
    "books"
  ],
  "lifetime": "FiveDays",
  "listings": {
    "en": {
      "description": "English add-on description",
      "icon": {
        "fileName": "add-on-en-us-listing2.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (English)"
    },
    "ru": {
      "description": "Russian add-on description",
      "icon": {
        "fileName": "add-on-ru-listing.png",
        "fileStatus": "Uploaded"
      },
      "title": "Add-on Title (Russian)"
    }
  },
  "pricing": {
    "marketSpecificPricings": {
      "RU": "Tier3",
      "US": "Tier4",
    },
    "sales": [],
    "priceId": "Free",
    "isAdvancedPricingModel": true
  },
  "targetPublishDate": "2016-03-15T05:10:58.047Z",
  "targetPublishMode": "Immediate",
  "tag": "SampleTag",
  "visibility": "Public",
  "status": "PendingCommit",
  "statusDetails": {
    "errors": [
      {
        "code": "None",
        "details": "string"
      }
    ],
    "warnings": [
      {
        "code": "ListingOptOutWarning",
        "details": "You have removed listing language(s): []"
      }
    ],
    "certificationReports": [
      {
      }
    ]
  },
  "fileUploadUrl": "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",
  "friendlyName": "Submission 2"
}

このリソースの値は次のとおりです。

価値 タイプ 説明
身分証明書 ひも 申請の ID。 この ID は、 アドオンの申請の作成、すべてのアドオンの 取得、およびアドオンの 取得を要求する応答データで使用できます。 パートナー センターで作成された申請の場合、この ID はパートナー センターの申請ページの URL でも使用できます。
コンテンツタイプ ひも アドオンで提供されるコンテンツ の の種類。 次のいずれかの値を指定できます。
  • 未設定
  • 本のダウンロード
  • イーマガジン
  • 電子新聞
  • ミュージックダウンロード
  • MusicStream
  • OnlineDataStorage
  • ビデオダウンロード
  • VideoStream
  • アスプ
  • オンラインダウンロード
キーワード 配列 アドオンに される最大 10 個の キーワードを含む文字列の配列。 アプリでは、これらのキーワードを使用してアドオンのクエリを実行できます。
寿命 ひも アドオンの有効期間。 次のいずれかの値を指定できます。
  • 絶えず
  • ワンデー
  • ThreeDays
  • FiveDays
  • OneWeek
  • TwoWeeks
  • 1ヶ月
  • 二ヶ月
  • 3か月
  • シックスマンス
  • 一年
一覧 オブジェクト キーと値のペアのディクショナリ。各キーは 2 文字の ISO 3166-1 alpha-2 国コードであり、各値はアドオンの一覧情報を含む リスト リソース です。
価格設定 オブジェクト 追加機能の価格情報を含む価格リソース。
ターゲットパブリッシュモード ひも 提出物の公開モード。 次のいずれかの値を指定できます。
  • 直ちに
  • マニュアル
  • 特定の日付
目標公開日 ひも targetPublishMode が SpecificDate に設定されている場合の、ISO 8601 形式の申請の発行日。
タグ ひも アドオンの カスタム開発者データ (この情報は以前に タグと呼ばれています)。
視認性 ひも アドオンの可視性。 次のいずれかの値を指定できます。
  • 隠れた
  • パブリック
  • 非公開
  • 未設定
ステータス ひも 申請の状態。 次のいずれかの値を指定できます。
  • 無し
  • 取り消し済み
  • コミット待ち
  • コミット開始
  • コミットに失敗しました
  • 公開待ち
  • 出版
  • 公開済み
  • 公開に失敗しました
  • 前処理
  • 前処理に失敗しました
  • 証明
  • 認証に失敗しました
  • リリース
  • リリースに失敗しました
ステータス詳細 オブジェクト 状態の詳細リソース は、申請状況の詳細情報を含むものであり、エラーに関する情報などが含まれています。
fileUploadUrl ひも 申請のパッケージをアップロードするための Shared Access Signature (SAS) URI。 申請に新しいパッケージを追加する場合は、パッケージを含む ZIP アーカイブをこの URI にアップロードします。 詳細については、「 アドオンの申請を作成する」を参照してください。
フレンドリーネーム ひも パートナー センターに示すように、申請のフレンドリ名。 この値は、申請を作成するときに自動的に生成されます。

リソースの一覧表示

このリソースには、アドオンの 一覧情報が含まれています。 このリソースの値は次のとおりです。

価値 タイプ 説明
説明 ひも アドオン一覧の説明。
アイコン オブジェクト アドオン リストのアイコンのデータを含むアイコンリソース。
タイトル ひも アドオンリストのタイトル。

アイコン リソース

このリソースには、アドオン リストのアイコン データが含まれています。 このリソースの値は次のとおりです。

価値 タイプ 説明
ファイル名 ひも 申請用にアップロードした ZIP アーカイブ内のアイコン ファイルの名前。 アイコンは、正確に 300 x 300 ピクセルを測定する .png ファイルである必要があります。
ファイルステータス ひも アイコン ファイルの状態。 次のいずれかの値を指定できます。
  • 無し
  • アップロード待機中
  • アップロード
  • 削除予定

価格情報源

このリソースには、アドオンの価格情報が含まれています。 このリソースの値は次のとおりです。

価値 タイプ 説明
市場特定価格設定 オブジェクト キーと値のペアのディクショナリ。各キーは 2 文字の ISO 3166-1 alpha-2 国コードであり、各値は価格レベルです。 これらの項目は、 特定の市場でのアドオンのカスタム価格を表します。 このディクショナリ内のすべての項目は、指定された市場の priceId 値で指定された基本価格をオーバーライドします。
売上 配列 非推奨。 アドオンの売上情報を含む 販売リソース の配列。
priceId ひも アドオンの 基本価格 を指定する 価格レベルの。
高度な価格設定モデルかどうか ブーリアン が trueの場合、開発者アカウントは、0.99 USD から 1999.99 USD までの拡張された価格帯にアクセスできます。 が falseの場合、あなたの開発者アカウントは .99 USD から 999.99 USD の元の価格レベルのセットにアクセスできます。 さまざまなレベルの詳細については、価格レベルを参照してください。

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

販売リソース

このリソースには、アドオンの販売情報が含まれています。

Von Bedeutung

Sale リソースはサポートされなくなりました。現在、Microsoft Store 申請 API を使用してアドオン申請の販売データを取得または変更することはできません。 今後、Microsoft Store 申請 API を更新して、アドオン申請の販売情報にプログラムでアクセスする新しい方法を導入する予定です。

  • GET メソッドを呼び出 してアドオンの申請を取得すると、 売上 値は空になります。 パートナー センターを引き続き使用して、アドオン申請の販売データを取得できます。
  • PUT メソッドを呼び出 してアドオンの申請を更新する場合、 売上 値の情報は無視されます。 パートナー センターを引き続き使用して、アドオン申請の販売データを変更できます。

このリソースの値は次のとおりです。

価値 タイプ 説明
名前 ひも セールの名前です。
basePriceId ひも 販売の基本価格として使用する 価格レベルは です。
開始日 ひも ISO 8601 形式での販売の開始日。
終了日 ひも ISO 8601 形式での販売の終了日。
市場特定価格設定 オブジェクト キーと値のペアのディクショナリ。各キーは 2 文字の ISO 3166-1 alpha-2 国コードであり、各値は価格レベルです。 これらの項目は、 特定の市場でのアドオンのカスタム価格を表します。 このディクショナリ内のすべての項目は、指定された市場の basePriceId 値で指定された基本価格をオーバーライドします。

ステータス詳細のリソース

このリソースには、申請の状態に関する追加の詳細が含まれています。 このリソースの値は次のとおりです。

価値 タイプ 説明
エラー オブジェクト 送信のエラー詳細を含む状態詳細リソース の配列。
警告 オブジェクト 送信に関する警告の詳細を含む状態詳細リソース の配列。
認証レポート オブジェクト 申請のための認定レポート データへのアクセスを提供する、認定レポートリソースの配列。 認定に失敗した場合は、これらのレポートを調べて詳細を確認できます。

状態の詳細リソース

このリソースには、申請に関連するエラーまたは警告に関する追加情報が含まれています。 このリソースの値は次のとおりです。

価値 タイプ 説明
コード ひも エラーまたは警告の種類を記述する 送信状態コード。
詳細 ひも 問題の詳細を示すメッセージ。

認定レポート リソース

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

価値 タイプ 説明
日付 ひも レポートが生成された日付と時刻 (ISO 8601 形式)。
レポートURL ひも レポートにアクセスできる URL。

列挙体

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

価格レベル

次の値は、アドオン申請の 価格リソース で使用可能な価格レベルを表します。

価値 説明
拠点 価格レベルは設定されていません。アドオンの基本価格を使用します。
利用できません アドオンは、指定したリージョンでは使用できません。
無料 アドオンは無料です。
階層xxxx アドオンの価格帯を指定する文字列は、レベルxxxxの形式です。 現在、次の価格レベルの範囲がサポートされています。

  • isAdvancedPricingModel の値が trueの場合、価格リソース でアカウントに使用可能な価格レベルは Tier1012 - Tier1424となります。
  • isAdvancedPricingModel の値が falseの場合、価格リソース でアカウントに使用可能な価格レベルの値は Tier2 - Tier96です。
各レベルに関連付けられている市場固有の価格など、開発者アカウントで使用可能な価格レベルの完全な表を表示するには、パートナー センターでアプリの申請の 価格と可用性の ページに移動し、市場とカスタム価格 セクションの 表示テーブル リンクをクリックします (一部の開発者アカウントの場合は、 このリンクは、価格 セクション) にあります。

提出ステータスコード

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

価値 説明
無し コードが指定されませんでした。
無効なアーカイブ パッケージを含む ZIP アーカイブが無効であるか、認識されないアーカイブ形式です。
MissingFiles ZIP アーカイブには、提出データに一覧表示されたすべてのファイルが含まれていないか、アーカイブ内の間違った場所にあります。
パッケージの検証に失敗しました 申請内の 1 つ以上のパッケージの検証に失敗しました。
無効なパラメータ値 要求本文のパラメーターの 1 つが無効です。
無効な操作 試行した操作が無効です。
無効な状態 試行した操作は、パッケージ フライトの現在の状態に対して無効です。
リソースが見つかりません 指定されたパッケージ フライトが見つかりませんでした。
サービスエラー 内部サービス エラーにより、要求が成功できませんでした。 要求をもう一度試してください。
リスティング対象外警告 開発者は、以前の申請から一覧を削除したか、パッケージでサポートされている一覧情報を含めませんでした。
リスティング参加警告 開発者が一覧を追加しました。
アップデートのみの警告 開発者は、更新プログラムのサポートのみを持つものを挿入しようとしています。
その他 申請が認識されない状態または未分類の状態です。
パッケージ検証警告 パッケージの検証プロセスで警告が発生しました。