アプリのアドオンの取得

  • [アーティクル]

パートナー センター アカウントに登録されているアプリのアドオンの一覧を取得するには、Microsoft Store 申請 API のこのメソッドを使用します。

前提条件

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

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

要求

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

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

要求ヘッダー

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/listinappproducts HTTP/1.1
Authorization: Bearer <your access token>

次の例は、アプリの最初の 10 個のアドオンを一覧表示する方法を示しています。

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

Response

次の例は、合計 53 個のアドオンがあるアプリの、最初の 10 個のアドオンに対する要求が成功した場合に返される JSON 応答本文を示しています。 簡潔にするために、この例では、要求によって返される最初の 3 つのアドオンのデータのみが示されています。 応答本文の値について詳しくは、次のセクションをご覧ください。

{
  "@nextLink": "applications/9NBLGGH4R315/listinappproducts/?skip=10&top=10",
  "value": [
    {
      "inAppProductId": "9NBLGGH4TNMP"
    },
    {
      "inAppProductId": "9NBLGGH4TNMN"
    },
    {
      "inAppProductId": "9NBLGGH4TNNR"
    },
    // Next 7 add-ons  are omitted for brevity ...
  ],
  "totalCount": 53
}

応答本文

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

エラー コード

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

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