Microsoft Store 申請 API を使用して、お客様または組織のパートナー センター アカウントのアプリ、アドオン、パッケージ フライトの申請をプログラムで照会および作成します。 この API は、アカウントが多数のアプリやアドオンを管理していて、これらの資産の申請プロセスを自動化して最適化する場合に便利です。 この API は、Azure Active Directory (Azure AD) を使用して、アプリまたはサービスからの呼び出しを認証します。
次の手順では、Microsoft Store 申請 API を使用するエンド ツー エンドのプロセスについて説明します。
- すべての 前提条件を完了していることを確認してください。
- Microsoft Store 申請 API でメソッドを呼び出す前に、azure AD アクセス トークンを取得
。 トークンを取得した後、トークンの有効期限が切れる前に、Microsoft Store 申請 API の呼び出しでこのトークンを使用するには 60 分かかります。 トークンの有効期限が切れた後、新しいトークンを生成できます。 - Microsoft Store 申請 APIを呼び出します。
Von Bedeutung
この API を使用してアプリ、パッケージ フライト、またはアドオンの申請を作成する場合は、パートナー センターではなく、API を使用してのみ申請をさらに変更してください。 パートナー センターを使用して API を使用して最初に作成した申請を変更する場合、API を使用してその申請を変更またはコミットできなくなります。 場合によっては、申請がエラー状態のままになり、送信プロセスで続行できない場合があります。 この場合は、申請を削除し、新しい申請を作成する必要があります。
Von Bedeutung
この API を使用して、ビジネス向け Microsoft Store および教育機関向け Microsoft Store を通じて
注
この API は、必須のアプリ更新プログラムとストアで管理される消耗品アドオンを使用するアプリまたはアドオンでは使用できません。 これらの機能のいずれかを使用するアプリまたはアドオンで Microsoft Store 申請 API を使用する場合、API は 409 エラー コードを返します。 この場合、パートナー センターを使用してアプリまたはアドオンの申請を管理する必要があります。
注
この API は、価格バージョン 2 上のアプリやアドオンでは使用できません。 [価格と可用性] ページの [価格] セクションに [市場ごとの価格の確認] ボタンがある場合、製品は価格バージョン 2 にあります。 価格バージョン 2 上のアプリまたはアドオンで Microsoft Store 申請 API を使用すると、API は価格パーツの不明なレベルを返します。 この API を引き続き使用して、 価格と可用性以外のモジュールを更新できます。
手順 1: Microsoft Store 申請 API を使用するための前提条件を満たす
Microsoft Store 申請 API を呼び出すコードの記述を開始する前に、次の前提条件を満たしていることを確認してください。
自分 (または組織) は Azure AD ディレクトリを持っている必要があり、ディレクトリの 全体管理者 アクセス許可が必要です。 Microsoft 365 または Microsoft の他のビジネス サービスを既に使用している場合は、Azure AD ディレクトリが既にあります。 それ以外の場合は、パートナー センター で新しい Azure AD を追加料金なしで作成
。 Azure AD アプリケーションをパートナー センター アカウント に関連付け、テナント ID、クライアント ID、キーを取得
必要があります。 これらの値は、Microsoft Store 申請 API の呼び出しで使用する Azure AD アクセス トークンを取得するために必要です。 Microsoft Store 申請 API で使用するアプリを準備します。
パートナー センターにアプリがまだ存在しない場合は、パートナー センターでその名前を予約してアプリを作成
必要があります。 Microsoft Store 申請 API を使用してパートナー センターでアプリを作成することはできません。パートナー センターで作成する必要があります。その後、API を使用してアプリにアクセスし、プログラムによってアプリの申請を作成できます。 ただし、API を使用して、アドオンとパッケージ フライトをプログラムで作成してから、それらの申請を作成できます。 この API を使用して特定のアプリの申請を作成するには、まず、パートナー センターでアプリの申請を 1 つ作成
必要があります。これには、 年齢区分 アンケートへの回答も含まれます。 これを行うと、API を使用して、このアプリの新しい申請をプログラムで作成できるようになります。 これらの種類の申請に API を使用する前に、アドオン申請またはパッケージ フライトの申請を作成する必要はありません。アプリの申請を作成または更新しており、アプリ パッケージを含める必要がある場合は、アプリ パッケージを準備。
アプリの申請を作成または更新していて、ストア登録情報のスクリーンショットや画像を含める必要がある場合は、アプリのスクリーンショットと画像を準備 。
アドオンの申請を作成または更新していて、アイコンを含める必要がある場合は、アイコンを準備。
Azure AD アプリケーションをパートナー センター アカウントに関連付ける方法
Microsoft Store 申請 API を使用する前に、Azure AD アプリケーションをパートナー センター アカウントに関連付け、アプリケーションのテナント ID とクライアント ID を取得し、キーを生成する必要があります。 Azure AD アプリケーションは、Microsoft Store 申請 API を呼び出すアプリまたはサービスを表します。 API に渡す Azure AD アクセス トークンを取得するには、テナント ID、クライアント ID、キーが必要です。
注
このタスクは 1 回だけ実行する必要があります。 テナント ID、クライアント ID、およびキーを取得したら、新しい Azure AD アクセス トークンを作成する必要がある場合は、いつでもそれらを再利用できます。
パートナー センターで、 組織のパートナー センター アカウントを組織の Azure AD ディレクトリに関連付けます。
次に、パートナー センターの [
アカウント設定] セクションの [ユーザー ] ページから、パートナー センター アカウントの申請にアクセスするために使用するアプリまたはサービスを表す Azure AD アプリケーション を追加。 このアプリケーションを マネージャー ロールに割り当てるようにします。 アプリケーションが Azure AD ディレクトリにまだ存在しない場合は、パートナー センターで新しい Azure AD アプリケーションを作成 。 [ユーザー] ページに戻り、Azure AD アプリケーションの名前をクリックしてアプリケーション設定に移動し、テナント ID とクライアント ID の値をコピーします。
をクリックして、新しいキーを追加します。 次の画面で、 キー の値をコピーします。 このページを離れると、この情報に再度アクセスできなくなります。 詳細については、「 Azure AD アプリケーションのキーの管理」を参照してください。
手順 2: Azure AD アクセス トークンを取得する
Microsoft Store 申請 API のいずれかのメソッドを呼び出す前に、まず、API 内の各メソッドの Authorization ヘッダーに渡す Azure AD アクセス トークンを取得する必要があります。 アクセス トークンを取得すると、有効期限が切れるまで 60 分かかります。 トークンの有効期限が切れた後は、トークンを更新して、API のそれ以降の呼び出しで引き続き使用できるようにします。
アクセス トークンを取得するには、「クライアント資格情報を使用したサービス間呼び出し の指示に従って、https://login.microsoftonline.com/<tenant_id>/oauth2/token エンドポイントに HTTP POST を送信します。 要求の例を次に示します。
POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8
grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://manage.devcenter.microsoft.com
POST URI の tenant_id 値と、client_id パラメーターと client_secret パラメーターに、前のセクションでパートナー センターから取得したアプリケーションのテナント ID、クライアント ID、キーを指定します。
リソース パラメーターには、https://manage.devcenter.microsoft.comを指定する必要があります。
アクセス トークンの有効期限が切れた後、同じ HTTP 呼び出しをもう一度行うことで、新しいトークンをフェッチできます。
C#、Java、または Python コードを使用してアクセス トークンを取得する方法を示す例については、Microsoft Store 申請 API コード例を参照してください。
手順 3: Microsoft Store 申請 API を使用する
Azure AD アクセス トークンを取得したら、Microsoft Store 申請 API でメソッドを呼び出すことができます。 API には、アプリ、アドオン、パッケージ フライトのシナリオにグループ化された多くのメソッドが含まれています。 申請を作成または更新するには、通常、Microsoft Store 申請 API の複数のメソッドを特定の順序で呼び出します。 各シナリオと各メソッドの構文については、次の表の記事を参照してください。
注
アクセス トークンを取得した後、トークンの有効期限が切れる前に、Microsoft Store 申請 API でメソッドを呼び出すのに 60 分かかります。
| シナリオ | 説明 |
|---|---|
| アプリ | パートナー センター アカウントに登録されているすべてのアプリのデータを取得し、アプリの申請を作成します。 これらのメソッドの詳細については、次の記事を参照してください。 |
| アドオン | アプリのアドオンを取得、作成、または削除した後、アドオンの申請を取得、作成、または削除します。 これらのメソッドの詳細については、次の記事を参照してください。 |
| パッケージ フライト | アプリのパッケージ フライトを取得、作成、または削除した後、パッケージ フライトの申請を取得、作成、または削除します。 これらのメソッドの詳細については、次の記事を参照してください。 |
コード例
次の記事では、いくつかの異なるプログラミング言語で Microsoft Store 申請 API を使用する方法を示す詳細なコード例を示します。
- C# サンプル: アプリ、アドオン、フライトの申請
- C# サンプル: ゲーム オプションと予告編を含むアプリの申請
- Java サンプル: アプリ、アドオン、フライトの申請
- Java サンプル: ゲーム オプションとトレーラーを使用したアプリの申請
- Python サンプル: アプリ、アドオン、フライトの申請
- Python サンプル: ゲーム オプションと予告編を含むアプリの申請
StoreBroker PowerShell モジュール
Microsoft Store 申請 API を直接呼び出す代わりに、API の上にコマンド ライン インターフェイスを実装するオープンソースの PowerShell モジュールも用意されています。 このモジュールは StoreBrokerと呼ばれています。 このモジュールを使用すると、Microsoft Store 申請 API を直接呼び出す代わりに、コマンド ラインからアプリ、フライト、アドオンの申請を管理できます。また、ソースを参照するだけで、この API を呼び出す方法の他の例を確認することもできます。 StoreBroker モジュールは、多くのファーストパーティ アプリケーションがストアに送信される主な方法として、Microsoft 内で積極的に使用されています。
詳細については、GitHubの
トラブルシューティング
| 問題点 | 解決策 |
|---|---|
| PowerShell から Microsoft Store 申請 API を呼び出した後、ConvertFrom-Json コマンドレットを使用して JSON 形式から PowerShell オブジェクトに変換した後、ConvertTo-Json コマンドレットを使用して JSON 形式に戻すと、API の応答データが破損します。 | 既定では、ConvertTo-Json コマンドレットの -Depth パラメーターは 2 レベルのオブジェクトに設定されます。これは、Microsoft Store 申請 API によって返されるほとんどの JSON オブジェクトには浅すぎます。 ConvertTo-Json コマンドレットを呼び出すときは、-Depth パラメーターを 20 などの大きな数値に設定します。 |
その他のヘルプ
Microsoft Store 申請 API に関する質問がある場合、またはこの API を使用した申請の管理に関するサポートが必要な場合は、次のリソースを使用します。
- 私たちの フォーラムであなたの質問をしてください.
- サポート ページ にアクセスし、パートナー センターのサポート オプションのいずれかを要求してください。 問題の種類とカテゴリの選択を求められた場合は、アプリの申請と認定 を選択し、アプリの送信を選択します。
関連トピック
- アプリ データの を取得する
- アプリの申請の管理
- アドオン の管理
- アドオン申請の管理
- パッケージ フライトの を管理する
- パッケージ フライトの申請を管理する