Share via


パッケージ フライトの申請に関するロールアウトの情報を取得する

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

前提条件

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

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

要求

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

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

要求ヘッダー

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

要求パラメーター

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

[要求本文]

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

要求の例

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

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

Response

次の例は、段階的なパッケージのロールアウトが有効になっているパッケージ フライトの申請に対して、このメソッドが正常に呼び出された場合の JSON 応答本文を示しています。 応答本文の値について詳しくは、「パッケージのロールアウトのリソース」をご覧ください。

{
    "isPackageRollout": true,
    "packageRolloutPercentage": 25.0,
    "packageRolloutStatus": "PackageRolloutInProgress",
    "fallbackSubmissionId": "1212922684621243058"
}

パッケージ フライトの申請で段階的なパッケージのロールアウトが有効になっていない場合は、次の応答の本文が返されます。

{
    "isPackageRollout": false,
    "packageRolloutPercentage": 0.0,
    "packageRolloutStatus": "PackageRolloutNotStarted",
    "fallbackSubmissionId": "0"
}

エラー コード

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

エラー コード 説明
404 パッケージ フライトの申請は見つかりませんでした。
409 指定されたパッケージ フライトについてのパッケージ フライトの申請ではないか、Microsoft Store 申請 API で現在サポートされていないパートナー センター機能がアプリで使用されています。