パッケージ フライトの取得Get a package flight

Microsoft Store 送信 API でこのメソッドを使用して、パートナー センター アカウントに登録されているアプリのパッケージのフライト データを取得します。Use this method in the Microsoft Store submission API to get data for a package flight for an app that is registered to your Partner Center account.

前提条件Prerequisites

このメソッドを使うには、最初に次の作業を行う必要があります。To use this method, you need to first do the following:

  • Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。Obtain an Azure AD access token to use in the request header for this method. アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。After you obtain an access token, you have 60 minutes to use it before it expires. トークンの有効期限が切れたら新しいトークンを取得できます。After the token expires, you can obtain a new one.

要求Request

このメソッドの構文は次のとおりです。This method has the following syntax. ヘッダーと要求本文の使用例と説明については、次のセクションをご覧ください。See the following sections for usage examples and descriptions of the header and request body.

メソッドMethod 要求 URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/flights/{flightId}

要求ヘッダーRequest header

HeaderHeader 種類Type 説明Description
AuthorizationAuthorization stringstring 必須。Required. Bearer <トークン> という形式の Azure AD アクセス トークン。The Azure AD access token in the form Bearer <token>.

要求パラメーターRequest parameters

名前Name 種類Type 説明Description
applicationIdapplicationId stringstring 必須。Required. 取得するパッケージ フライトが含まれるアプリのストア ID。The Store ID of the app that contains the package flight you want to get. アプリの Store ID は、パートナー センターで使用できます。The Store ID for the app is available in Partner Center.
flightIdflightId stringstring 必須。Required. 取得するパッケージ フライトの ID。The ID of the package flight to get. この ID は、パッケージ フライトの作成要求とアプリのパッケージ フライトの取得要求の応答データで確認できます。This ID is available in the response data for requests to create a package flight and get package flights for an app. パートナー センターで作成されたフライトはこの ID はパートナー センターでのフライトのページの URL で使用できるも。For a flight that was created in Partner Center, this ID is also available in the URL for the flight page in Partner Center.

要求本文Request body

このメソッドでは要求本文を指定しないでください。Do not provide a request body for this method.

要求の例Request example

次の例は、ストア ID 値が 9WZDNCRD91MD で、アプリの ID が 43e448df-97c9-4a43-a0bc-2a445e736bcd であるパッケージ フライトに関する情報を取得する方法を示しています。The following example demonstrates how to retrieve information about a package flight with the ID 43e448df-97c9-4a43-a0bc-2a445e736bcd for an app with the Store ID value 9WZDNCRD91MD.

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

応答Response

次の例は、このメソッドが正常に呼び出された場合の JSON 応答本文を示しています。The following example demonstrates the JSON response body for a successful call to this method. 応答本文の値について詳しくは、次のセクションをご覧ください。For more details about the values in the response body, see the following sections.

{
  "flightId": "43e448df-97c9-4a43-a0bc-2a445e736bcd",
  "friendlyName": "myflight",
  "lastPublishedFlightSubmission": {
    "id": "1152921504621086517",
    "resourceLocation": "flights/43e448df-97c9-4a43-a0bc-2a445e736bcd/submissions/1152921504621086517"
  },
  "pendingFlightSubmission": {
    "id": "115292150462124364",
    "resourceLocation": "flights/43e448df-97c9-4a43-a0bc-2a445e736bcd/submissions/1152921504621243647"
  },
  "groupIds": [
    "0"
  ],
  "rankHigherThan": "671c2857-725e-4faf-9e9e-ea1191ef879c"
}

応答本文Response body

ValueValue 種類Type 説明Description
flightIdflightId stringstring パッケージ フライトの ID。The ID for the package flight. この値は、パートナー センターによって提供されます。This value is supplied by Partner Center.
friendlyNamefriendlyName stringstring 開発者によって指定されているパッケージ フライトの名前。The name of the package flight, as specified by the developer.
lastPublishedFlightSubmissionlastPublishedFlightSubmission オブジェクトobject パッケージ フライトの最後に公開された申請に関する情報を提供するオブジェクト。An object that provides information about the last published submission for the package flight. 詳しくは、以下の「申請オブジェクト」セクションをご覧ください。For more information, see the Submission object section below.
pendingFlightSubmissionpendingFlightSubmission オブジェクトobject パッケージ フライトの現在保留中の申請に関する情報を提供するオブジェクト。An object that provides information about the current pending submission for the package flight. 詳しくは、以下の「申請オブジェクト」セクションをご覧ください。For more information, see the Submission object section below.
groupIdsgroupIds arrayarray パッケージ フライトに関連付けられているフライト グループの ID を含む文字列の配列。An array of strings that contain the IDs of the flight groups that are associated with the package flight. フライト グループについて詳しくは、「パッケージ フライト」をご覧ください。For more information about flight groups, see Package flights.
rankHigherThanrankHigherThan stringstring 現在のパッケージ フライトの次に低位のパッケージ フライトのフレンドリ名。The friendly name of the package flight that is ranked immediately lower than the current package flight. フライト グループのランク付けについて詳しくは、「パッケージ フライト」をご覧ください。For more information about ranking flight groups, see Package flights.

申請オブジェクトSubmission object

応答本文の lastPublishedFlightSubmissionpendingFlightSubmission の値には、パッケージ フライトの申請に関するリソース情報を提供するオブジェクトが含まれています。The lastPublishedFlightSubmission and pendingFlightSubmission values in the response body contain objects that provide resource information about a submission for the package flight. これらのオブジェクトには、次の値があります。These objects have the following values.

ValueValue 種類Type 説明Description
idid stringstring 申請 ID。The ID of the submission.
resourceLocationresourceLocation stringstring 申請の完全なデータを取得するために基本 https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI に付加できる相対パス。A relative path that you can append to the base https://manage.devcenter.microsoft.com/v1.0/my/ request URI to retrieve the complete data for the submission.

エラー コードError codes

要求を正常に完了できない場合、次の HTTP エラー コードのいずれかが応答に含まれます。If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

エラー コードError code 説明Description
400400 要求が無効です。The request is invalid.
404404 指定されたパッケージ フライトは見つかりませんでした。The specified package flight could not be found.
409409 アプリはパートナー センター機能を使用する現在サポートされていません、Microsoft Store 送信 APIします。The app uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.