フライトの申請に関するロールアウトを完了する

  • [アーティクル]

パッケージ フライトの申請に関するパッケージのロールアウトを完了するには、Microsoft Store 申請 API の以下のメソッドを使います。 Microsoft Store 申請 API を使ったパッケージ フライトの申請の作成プロセスについて詳しくは、「パッケージ フライトの申請の管理」をご覧ください。

前提条件

このメソッドを使うには、最初に次の作業を行う必要があります。

  • Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
  • パートナー センターでアプリの申請を作成します。 この操作は、パートナー センターで実行するか、アプリの申請の作成メソッドを使って実行することができます。
  • 申請に関する段階的なパッケージのロールアウトを有効にします。 この操作は、パートナー センターで実行するか、Microsoft Store 申請 API を使って実行することができます。

要求

このメソッドの構文は次のとおりです。 ヘッダーと要求のパラメーターの使用例と説明については、以下のセクションをご覧ください。

認証方法 要求 URI
POST https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/flights/{flightId}/submissions/{submissionId}/finalizepackagerollout

要求ヘッダー

Header Type 説明
承認 string 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。

要求パラメーター

名前 Type 説明
applicationId string 必須。 完了するパッケージのロールアウトの対象となるパッケージ フライトの申請が含まれているアプリのストア ID です。 ストア ID について詳しくは、「アプリ ID の詳細の表示」をご覧ください。
flightId string 必須。 完了するパッケージのロールアウトの対象となる申請が含まれているパッケージ フライトの ID です。 この ID は、パッケージ フライトの作成要求とアプリのパッケージ フライトの取得要求の応答データで確認できます。 フライトをパートナー センターで作成した場合、この ID は、パートナー センターのフライト ページの URL でも確認できます。
submissionId string 必須。 完了するパッケージのロールアウトの対象となる申請の ID です。 この ID は、パッケージ フライトの申請の作成要求に対する応答データで確認できます。 アプリの申請をパートナー センターで作成した場合、この ID は、パートナー センターの申請ページの URL でも確認できます。

[要求本文]

このメソッドでは要求本文を指定しないでください。

要求の例

パッケージ フライトの申請に関するパッケージのロールアウトを完了する方法の例を次に示します。

POST https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/flights/43e448df-97c9-4a43-a0bc-2a445e736bcd/submissions/1152921504621243680/finalizepackagerollout HTTP/1.1
Authorization: Bearer <your access token>

Response

次の例は、このメソッドが正常に呼び出された場合の JSON 応答本文を示しています。 応答本文の値について詳しくは、「パッケージのロールアウトのリソース」をご覧ください。

{
    "isPackageRollout": true,
    "packageRolloutPercentage": 100.0,
    "packageRolloutStatus": "PackageRolloutComplete",
    "fallbackSubmissionId": "1212922684621243058"
}

エラー コード

要求を正常に完了できない場合、次の HTTP エラー コードのいずれかが応答に含まれます。

エラー コード 説明
404 パッケージ フライトの申請は見つかりませんでした。
409 このコードは、次のエラーのいずれかを示します。

  • 申請が、段階的なロールアウト操作に対して有効な状態になっていません (このメソッドを呼び出す前に、申請を公開し、packageRolloutStatus の値を PackageRolloutInProgress に設定する必要があります)。
  • 申請が、指定されたアプリに属していません。
  • Microsoft Store 申請 API で現在サポートされていないパートナー センター機能がアプリで使用されています。