申請の作成と管理Create and manage submissions

使用して、 Microsoft Store 送信 APIまたは組織のパートナー センター アカウントのフライトをプログラムによってクエリを実行し、アプリ、アドオン、およびパッケージのサブミッションを作成します。Use the Microsoft Store submission API to programmatically query and create submissions for apps, add-ons and package flights for your or your organization's Partner Center account. この API は、アカウントで多数のアプリやアドオンを管理していて、それらのアセットの申請プロセスを自動化して最適化する必要がある場合に役立ちます。This API is useful if your account manages many apps or add-ons, and you want to automate and optimize the submission process for these assets. この API は、Azure Active Directory (Azure AD) を使って、アプリまたはサービスからの呼び出しを認証します。This API uses Azure Active Directory (Azure AD) to authenticate the calls from your app or service.

この手順では、Microsoft Store 申請 API を使う場合のプロセスについて詳しく説明します。The following steps describe the end-to-end process of using the Microsoft Store submission API:

  1. すべての前提条件を完了したことを確認します。Make sure that you have completed all the prerequisites.
  2. Microsoft Store 申請 API のメソッドを呼び出す前に、Azure AD アクセス トークンを取得する必要があります。Before you call a method in the Microsoft Store submission API, obtain an Azure AD access token. トークンを取得した後、Microsoft Store 申請 API の呼び出しでこのトークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain a token, you have 60 minutes to use this token in calls to the Microsoft Store submission API before the token expires. トークンの有効期限が切れた後は、新しいトークンを生成できます。After the token expires, you can generate a new token.
  3. Microsoft Store 申請 API を呼び出しますCall the Microsoft Store submission API.

重要

この API を使用して、アプリの提出を作成すると、パッケージ、転送中、またはアドオンのパートナー センターではなく、API の使用によってのみ、送信をこれ以上を変更することを確認してがあります。If you use this API to create a submission for an app, package flight, or add-on, be sure to make further changes to the submission only by using the API, rather than in Partner Center. パートナー センターを使用して API を使用して作成した元の送信を変更する場合は、変更、または API を使用して送信をコミットすることはできなくなります。If you use Partner Center to change a submission that you originally created by using the API, you will no longer be able to change or commit that submission by using the API. 場合によっては、申請がエラー状態のままになり、申請プロセスを進めることができなくなります。In some cases, the submission could be left in an error state where it cannot proceed in the submission process. この場合、申請を削除して新しい申請を作成する必要があります。If this occurs, you must delete the submission and create a new submission.

重要

この API を使って、ビジネス向け Microsoft Store や教育機関向け Microsoft Store でのボリューム購入の申請を公開したり、LOB アプリの申請を直接企業に発行したりすることはできません。You cannot use this API to publish submissions for volume purchases through the Microsoft Store for Business and Microsoft Store for Education or to publish submissions for LOB apps directly to enterprises. 使用する必要がありますの両方のシナリオには、パートナー センターで、送信を発行します。For both of these scenarios, you must use publish the submission in Partner Center.

注意

この API は、アプリの必須更新プログラムや Store で管理されるコンシューマブルなアドオンを使うアプリまたはアドオンでは使用できません。This API cannot be used with apps or add-ons that use mandatory app updates and Store-managed consumable add-ons. このような機能のいずれかを使用するアプリまたはアドオンで Microsoft Store 申請 API を使うと、API から 409 エラー コードが返されます。If you use the Microsoft Store submission API with an app or add-on that uses one of these features, the API will return a 409 error code. この場合は、パートナー センターを使用して、アプリまたはアドオンの送信を管理する必要があります。In this case, you must use Partner Center to manage the submissions for the app or add-on.

手順 1:Microsoft Store 送信 API を使用するための前提条件Step 1: Complete prerequisites for using the Microsoft Store submission API

Microsoft Store 申請 API を呼び出すコードの作成を開始する前に、次の前提条件が満たされていることを確認します。Before you start writing code to call the Microsoft Store submission API, make sure that you have completed the following prerequisites.

  • ユーザー (またはユーザーの組織) は、Azure AD ディレクトリと、そのディレクトリに対する全体管理者のアクセス許可を持っている必要があります。You (or your organization) must have an Azure AD directory and you must have Global administrator permission for the directory. Office 365 または Microsoft の他のビジネス サービスを既に使っている場合は、既に Azure AD ディレクトリをお持ちです。If you already use Office 365 or other business services from Microsoft, you already have Azure AD directory. それ以外の場合は、追加料金なしにパートナー センターで新しい Azure AD を作成できます。Otherwise, you can create a new Azure AD in Partner Center for no additional charge.

  • 必要がありますをパートナー センター アカウントを Azure AD アプリケーションに関連付けるし、ID、クライアント ID とキー、テナントを取得します。You must associate an Azure AD application with your Partner Center account and obtain your tenant ID, client ID and key. これらの値は、Microsoft Store 申請 API の呼び出しで使用する Azure AD アクセス トークンを取得するために必要です。You need these values to obtain an Azure AD access token, which you will use in calls to the Microsoft Store submission API.

  • Microsoft Store 申請 API で使うアプリを準備します。Prepare your app for use with the Microsoft Store submission API:

    • パートナー センターでも、アプリがまだ存在しない場合は、まずパートナー センターで名前を予約して、アプリを作成するします。If your app does not yet exist in Partner Center, you must create your app by reserving its name in Partner Center. Microsoft Store 送信 API を使用して、パートナー センターでアプリを作成することはできません。作成して、パートナー センターで作業する必要がありますし、その後することができます、API を使用してアプリにアクセスし、その申請をプログラムで作成します。You cannot use the Microsoft Store submission API to create an app in Partner Center; you must work in Partner Center to create it, and then after that you can use the API to access the app and programmatically create submissions for it. ただし、API を使うと、アプリの申請を作成する前に、アドオンとパッケージ フライトをプログラムで作成できます。However, you can use the API to programmatically create add-ons and package flights before you create submissions for them.

    • この API を使用して、特定のアプリの提出を作成する前にする必要がありますパートナー センターでアプリの 1 つのサブミッションを作成する、応答を含む、評価期間を表すアンケートです。Before you can create a submission for a given app using this API, you must first create one submission for the app in Partner Center, including answering the age ratings questionnaire. この操作の実行後、API を使ってこのアプリの新しい申請をプログラムで作成できるようになります。After you do this, you will be able to programmatically create new submissions for this app using the API. アドオンの申請またはパッケージ フライトの申請を作成しなくても、このような申請に API を使うことができます。You do not need to create an add-on submission or package flight submission before using the API for those types of submissions.

    • アプリの申請を作成または更新するときにアプリ パッケージを追加する必要がある場合は、アプリ パッケージを準備します。If you are creating or updating an app submission and you need to include an app package, prepare the app package.

    • アプリの申請を作成または更新するときにストア登録情報用のスクリーンショットまたは画像を含める必要がある場合は、アプリのスクリーンショットと画像を準備します。If you are creating or updating an app submission and you need to include screenshots or images for the Store listing, prepare the app screenshots and images.

    • アドオンの申請を作成または更新するときにアイコンを含める必要がある場合は、アイコンを準備します。If you are creating or updating an add-on submission and you need to include an icon, prepare the icon.

Azure AD アプリケーションをパートナー センター アカウントに関連付ける方法How to associate an Azure AD application with your Partner Center account

Microsoft Store 送信 API を使用する前に、Azure AD アプリケーションをパートナー センター アカウントに関連付けるテナント ID と、アプリケーションのクライアント ID を取得、キーを生成してください。Before you can use the Microsoft Store submission API, you must associate an Azure AD application with your Partner Center account, retrieve the tenant ID and client ID for the application and generate a key. Azure AD アプリケーションは、Microsoft Store 申請 API の呼び出し元のアプリまたはサービスを表します。The Azure AD application represents the app or service from which you want to call the Microsoft Store submission API. テナント ID、クライアント ID、およびキーは、API に渡す Azure AD アクセス トークンを取得するために必要です。You need the tenant ID, client ID and key to obtain an Azure AD access token that you pass to the API.

注意

この作業を行うのは一度だけです。You only need to perform this task one time. テナント ID、クライアント ID、キーがあれば、新しい Azure AD アクセス トークンの作成が必要になったときに、いつでもそれらを再利用できます。After you have the tenant ID, client ID and key, you can reuse them any time you need to create a new Azure AD access token.

  1. パートナー センターの、組織の Azure AD ディレクトリと、組織のパートナー センター アカウントを関連付けるします。In Partner Center, associate your organization's Partner Center account with your organization's Azure AD directory.

  2. [次へ]、ユーザーページで、アカウント設定パートナー センターの「して Azure AD アプリケーションを追加アプリを使用してサービスを表すパートナー センター アカウント用のサブミッションにアクセスします。Next, from the Users page in the Account settings section of Partner Center, add the Azure AD application that represents the app or service that you will use to access submissions for your Partner Center account. このアプリケーションに必ずマネージャー ロールを割り当てます。Make sure you assign this application the Manager role. アプリケーションが存在しない場合、Azure AD ディレクトリで実行できますを新規作成パートナー センターで Azure AD アプリケーションします。If the application doesn't exist yet in your Azure AD directory, you can create a new Azure AD application in Partner Center.

  3. [ユーザー] ページに戻り、Azure AD アプリケーションの名前をクリックしてアプリケーション設定に移動し、 [テナント ID][クライアント ID] の値を書き留めます。Return to the Users page, click the name of your Azure AD application to go to the application settings, and copy down the Tenant ID and Client ID values.

  4. [新しいキーの追加] をクリックします。Click Add new key. 次の画面で、 [キー] の値を書き留めます。On the following screen, copy down the Key value. このページから離れると、この情報に再度アクセスすることはできません。You won't be able to access this info again after you leave this page. 詳しくは、「Azure AD アプリケーションのキーを管理する方法」をご覧ください。For more information, see Manage keys for an Azure AD application.

手順 2:Azure AD アクセス トークンの取得Step 2: Obtain an Azure AD access token

Microsoft Store 申請 API のいずれかのメソッドを呼び出す前に、まず API の各メソッドの Authorization ヘッダーに渡す Azure AD アクセス トークンを取得する必要があります。Before you call any of the methods in the Microsoft Store submission API, you must first obtain an Azure AD access token that you pass to the Authorization header of each method in the API. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れた後は、トークンを更新してそれ以降の API 呼び出しで引き続き使用できます。After the token expires, you can refresh the token so you can continue to use it in further calls to the API.

アクセス トークンを取得するには、「クライアント資格情報を使用したサービス間の呼び出し」の手順に従って、HTTP POST を https://login.microsoftonline.com/<tenant_id>/oauth2/token エンドポイントに送信します。To obtain the access token, follow the instructions in Service to Service Calls Using Client Credentials to send an HTTP POST to the https://login.microsoftonline.com/<tenant_id>/oauth2/token endpoint. 要求の例を次に示します。Here is a sample request.

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

テナント_id POST URI の値とクライアント_idクライアント_シークレットパラメーター、テナントの指定ID、クライアント ID、前のセクションで、パートナー センターから取得したアプリケーションのキー。For the tenant_id value in the POST URI and the client_id and client_secret parameters, specify the tenant ID, client ID and the key for your application that you retrieved from Partner Center in the previous section. resource パラメーターには、https://manage.devcenter.microsoft.com を指定します。For the resource parameter, you must specify https://manage.devcenter.microsoft.com.

アクセス トークンの有効期限が切れた後は、この手順に従って更新できます。After your access token expires, you can refresh it by following the instructions here.

C#、Java、または Python コードを使ってアクセス トークンを取得する方法を示す例については、Microsoft Store 申請 API のコード例をご覧ください。For examples that demonstrate how to obtain an access token by using C#, Java, or Python code, see the Microsoft Store submission API code examples.

手順 3:Microsoft Store 送信 API を使用して、Step 3: Use the Microsoft Store submission API

Azure AD アクセス トークンを取得したら、Microsoft Store 申請 API のメソッドを呼び出すことができます。After you have an Azure AD access token, you can call methods in the Microsoft Store submission API. この API には、アプリ、アドオン、パッケージ フライトのシナリオにグループ化される多くのメソッドが含まれています。The API includes many methods that are grouped into scenarios for apps, add-ons, and package flights. 申請を作成または更新するには、通常、Microsoft Store 申請 API の複数のメソッドを特定の順序で呼び出します。To create or update submissions, you typically call multiple methods in the Microsoft Store submission API in a specific order. 各シナリオと各メソッドの構文について詳しくは、次の表の記事をご覧ください。For information about each scenario and the syntax of each method, see the articles in the following table.

注意

アクセス トークンを取得した後、Microsoft Store 申請 API のメソッドを呼び出すことができるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to call methods in the Microsoft Store submission API before the token expires.

シナリオScenario 説明Description
アプリApps パートナー センター アカウントに登録され、アプリ用のサブミッションを作成するすべてのアプリのデータを取得します。Retrieve data for all the apps that are registered to your Partner Center account and create submissions for apps. これらのメソッドについて詳しくは、次の記事をご覧ください。For more information about these methods, see the following articles:
アドオンAdd-ons アプリのアドオンを取得、作成、または削除した後、そのアドオンの申請を取得、作成、または削除します。Get, create, or delete add-ons for your apps, and then get, create, or delete submissions for the add-ons. これらのメソッドについて詳しくは、次の記事をご覧ください。For more information about these methods, see the following articles:
パッケージ フライトPackage flights アプリのパッケージ フライトを取得、作成、または削除した後、パッケージ フライトの申請を取得、作成、または削除します。Get, create, or delete package flights for your apps, and then get, create, or delete submissions for the package flights. これらのメソッドについて詳しくは、次の記事をご覧ください。For more information about these methods, see the following articles:

コード例Code examples

次の記事では、さまざまなプログラミング言語で Microsoft Store 申請 API を使用する方法を示す詳しいコード例を紹介します。The following articles provide detailed code examples that demonstrate how to use the Microsoft Store submission API in several different programming languages:

StoreBroker PowerShell モジュールStoreBroker PowerShell module

Microsoft Store 申請 API を直接呼び出す代わりに、API の上にコマンド ライン インターフェイスを実装するオープンソースの PowerShell モジュールも用意されています。As an alternative to calling the Microsoft Store submission API directly, we also provide an open-source PowerShell module which implements a command-line interface on top of the API. このモジュールは、StoreBroker と呼ばれています。This module is called StoreBroker. このモジュールを使うと、Microsoft Store 申請 API を直接呼び出さずに、コマンド ラインからアプリ、フライト、アドオンの申請を管理できます。また、ソースを参照して、この API を呼び出す方法の例を確認することもできます。You can use this module to manage your app, flight, and add-on submissions from the command line instead of calling the Microsoft Store submission API directly, or you can simply browse the source to see more examples for how to call this API. StoreBroker モジュールは、多くのファースト パーティ アプリケーションをストアに申請する主要な方法として Microsoft 内で積極的に使っています。The StoreBroker module is actively used within Microsoft as the primary way that many first-party applications are submitted to the Store.

詳しくは、GitHub の StoreBroker に関するページをご覧ください。For more information, see our StoreBroker page on GitHub.

トラブルシューティングTroubleshooting

問題Issue 解決方法Resolution
PowerShell から Microsoft Store 申請 API を呼び出した後、ConvertFrom-Json コマンドレットを使って API の応答データを JSON 形式から PowerShell オブジェクトに変換し、ConvertTo-Json コマンドレットを使ってもう一度 JSON 形式に変換すると、応答データが破損します。After calling the Microsoft Store submission API from PowerShell, the response data for the API is corrupted if you convert it from JSON format to a PowerShell object using the ConvertFrom-Json cmdlet and then back to JSON format using the ConvertTo-Json cmdlet. 既定では、ConvertTo-Json コマンドレットの -Depth パラメーターは、2 レベルのオブジェクトに設定されます。これは、Microsoft Store 申請 API から返される JSON オブジェクトの大半にとって浅すぎます。By default, the -Depth parameter for the ConvertTo-Json cmdlet is set to 2 levels of objects, which is too shallow for most of the JSON objects that are returned by the Microsoft Store submission API. ConvertTo-Json コマンドレットを呼び出すときは、 -Depth パラメーターを大きい値 (たとえば 20) に設定します。When you call the ConvertTo-Json cmdlet, set the -Depth parameter to a larger number, such as 20.

追加のヘルプAdditional help

Microsoft Store 申請 API について質問がある場合や、この API を使った申請の管理に関してサポートが必要な場合は、次のリソースを使ってください。If you have questions about the Microsoft Store submission API or need assistance managing your submissions with this API, use the following resources:

  • Microsoft のフォーラムで質問します。Ask your questions on our forums.
  • 参照してください、サポート ページとパートナー センターのサポート オプションのいずれかを要求します。Visit our support page and request one of the assisted support options for Partner Center. 問題の種類とカテゴリを選択するよう求められた場合は、 [App submission and certification] (アプリの申請と認定) と [Submitting an app] (アプリの申請) をそれぞれ選択します。If you are prompted to choose a problem type and category, choose App submission and certification and Submitting an app, respectively.