アプリのパッケージ フライトの取得

  • [アーティクル]

パートナー センター アカウントに登録されているアプリのパッケージ フライトの一覧を取得するには、Microsoft Store 申請 API のこのメソッドを使用します。 パッケージ フライトについて詳しくは、「パッケージ フライト」をご覧ください。

前提条件

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

  • Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。

要求

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

認証方法 要求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationId}/listflights

要求ヘッダー

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

要求パラメーター

名前 種類 内容 必須
applicationId string パッケージ フライトを取得するアプリのストア ID です。 ストア ID について詳しくは、「アプリ ID の詳細の表示」をご覧ください。 はい
top int 要求で返される項目の数 (つまり、返されるパッケージ フライトの数)。 クエリで指定した値よりアカウントのパッケージ フライトの数が多い場合、応答本文には、データの次のページを要求するためにメソッド URI に追加できる相対 URI パスが含まれます。 いいえ
skip int 残りの項目を返す前にクエリでバイパスする項目の数。 データ セットを操作するには、このパラメーターを使用します。 たとえば、top = 10 と skip = 0 は、1 から 10 の項目を取得し、top=10 と skip=10 は 11 から 20 の項目を取得するという具合です。 No

[要求本文]

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

要求の例

次の例は、アプリのすべてのパッケージ フライトを一覧表示する方法を示しています。

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listflights HTTP/1.1
Authorization: Bearer <your access token>

次の例は、アプリの 1 番目のパッケージ フライトを表示する方法を示しています。

GET https://manage.devcenter.microsoft.com/v1.0/my/applications/9NBLGGH4R315/listflights?top=1 HTTP/1.1
Authorization: Bearer <your access token>

Response

次の例は、合計 3 個のパッケージ フライトがあるアプリの、1 番目のパッケージ フライトに対する要求が成功した場合に返される JSON 応答本文を示しています。 応答本文の値について詳しくは、次のセクションをご覧ください。

{
  "value": [
    {
      "flightId": "7bfc11d5-f710-47c5-8a98-e04bb5aad310",
      "friendlyName": "myflight",
      "lastPublishedFlightSubmission": {
        "id": "1152921504621086517",
        "resourceLocation": "flights/7bfc11d5-f710-47c5-8a98-e04bb5aad310/submissions/1152921504621086517"
      },
      "pendingFlightSubmission": {
        "id": "1152921504621215786",
        "resourceLocation": "flights/7bfc11d5-f710-47c5-8a98-e04bb5aad310/submissions/1152921504621215786"
      },
      "groupIds": [
        "1152921504606962205"
      ],
      "rankHigherThan": "Non-flighted submission"
    }
  ],
  "totalCount": 3
}

応答本文

値 種類 説明
@nextLink string データの追加ページが存在する場合、この文字列には、データの次のページを要求するために、ベースとなる https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI に追加できる相対パスが含まれます。 たとえば、最初の要求本文の top パラメーターが 2 に設定されていて、アプリには 4 個のパッケージ フライトが存在する場合、応答本文には、applications/{applicationid}/listflights/?skip=2&top=2 という @nextLink 値が含まれます。これは、次の 2 個のパッケージ フライトを要求するために、https://manage.devcenter.microsoft.com/v1.0/my/applications/{applicationid}/listflights/?skip=2&top=2 を呼び出すことができることを示しています。
value array 指定されたアプリのパッケージ フライトに関する情報を提供するオブジェクトの配列。 各オブジェクトのデータについて詳しくは、「フライト リソース」をご覧ください。
totalCount int クエリのデータ結果の行の合計数 (つまり、指定されたアプリのパッケージ フライトの合計数)。

エラー コード

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

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