すべてのアプリの取得
パートナー センター アカウントに登録されているアプリのデータを取得するには、Microsoft Store 申請 API の次のメソッドを使用します。
前提条件
このメソッドを使うには、最初に次の作業を行う必要があります。
- Microsoft Store 申請 API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
- このメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。
要求
このメソッドの構文は次のとおりです。 ヘッダーと要求本文の使用例と説明については、次のセクションをご覧ください。
| 認証方法 | 要求 URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/applications |
要求ヘッダー
| Header | 型 | 説明 |
|---|---|---|
| 承認 | string | 必須。 Bearer<トークン> という形式の Azure AD アクセス トークン。 |
要求パラメーター
このメソッドでは、要求パラメーターはすべてオプションです。 このメソッドをパラメーターなしで呼び出すと、応答には、アカウントに登録されている最初の 10 個のアプリのデータが含まれます。
| パラメーター | 型 | 内容 | 必須 |
|---|---|---|---|
| top | int | 要求で返される項目の数 (つまり、返されるアプリの数)。 クエリで指定した値よりアカウントのアプリの数が多い場合、応答本文には、データの次のページを要求するためにメソッド URI に追加できる相対 URI パスが含まれます。 | いいえ |
| skip | int | 残りの項目を返す前にクエリでバイパスする項目の数。 データ セットを操作するには、このパラメーターを使用します。 たとえば、top = 10 と skip = 0 は、1 から 10 の項目を取得し、top=10 と skip=10 は 11 から 20 の項目を取得するという具合です。 | No |
[要求本文]
このメソッドでは要求本文を指定しないでください。
要求の例
次の例は、アカウントに登録されている最初の 10 個のアプリを取得する方法を示しています。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications HTTP/1.1
Authorization: Bearer <your access token>
次の例は、アカウントに登録するすべてのアプリに関する情報を取得する方法を示しています。 まず、上位 10 個のアプリを取得します。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=10 HTTP/1.1
Authorization: Bearer <your access token>
次に、{@nextlink} が null であるか、または応答に存在しなくなるまで GET https://manage.devcenter.microsoft.com/v1.0/my/{@nextLink} を再帰的に呼び出します。 次に例を示します。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=20&top=10 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=30&top=10 HTTP/1.1
Authorization: Bearer <your access token>
アカウントに存在するアプリの合計数が既にわかっている場合は、その数を top パラメーターで渡すだけで、すべてのアプリに関する情報を取得できます。
GET https://manage.devcenter.microsoft.com/v1.0/my/applications?top=23 HTTP/1.1
Authorization: Bearer <your access token>
Response
次の例は、合計 21 個のアプリがある開発者アカウントに登録されている、最初の 10 個のアプリに対する要求が成功した場合に返される JSON 応答本文を示しています。 簡潔にするために、この例では、要求によって返される最初の 2 つのアプリのデータのみが示されています。 応答本文の値について詳しくは、次のセクションをご覧ください。
{
"@nextLink": "applications?skip=10&top=10",
"value": [
{
"id": "9NBLGGH4R315",
"primaryName": "Contoso sample app",
"packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp_ng6try80pwt52",
"packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp",
"publisherName": "CN=…",
"firstPublishedDate": "2016-03-11T01:32:11.0747851Z",
"pendingApplicationSubmission": {
"id": "1152921504621134883",
"resourceLocation": "applications/9NBLGGH4R315/submissions/1152921504621134883"
}
},
{
"id": "9NBLGGH29DM8",
"primaryName": "Contoso sample app 2",
"packageFamilyName": "5224ContosoDeveloper.ContosoSampleApp2_ng6try80pwt52",
"packageIdentityName": "5224ContosoDeveloper.ContosoSampleApp2",
"publisherName": "CN=…",
"firstPublishedDate": "2016-03-12T01:49:11.0747851Z",
"lastPublishedApplicationSubmission": {
"id": "1152921504621225621",
"resourceLocation": "applications/9NBLGGH29DM8/submissions/1152921504621225621"
}
// Next 8 apps are omitted for brevity ...
}
],
"totalCount": 21
}
応答本文
| 値 | 種類 | 説明 |
|---|---|---|
| value | array | アカウントに登録されている各アプリについての情報が含まれるオブジェクトの配列。 各オブジェクトのデータについて詳しくは、「アプリケーション リソース」をご覧ください。 |
| @nextLink | string | データの追加ページが存在する場合、この文字列には、データの次のページを要求するために、ベースとなる https://manage.devcenter.microsoft.com/v1.0/my/ 要求 URI に追加できる相対パスが含まれます。 たとえば、最初の要求本文の top パラメーターが 10 に設定されていて、アカウントには 20 個のアプリが登録されている場合、応答本文には、applications?skip=10&top=10 という @nextLink 値が含まれます。これは、次の 10 個のアプリを要求するために、https://manage.devcenter.microsoft.com/v1.0/my/applications?skip=10&top=10 を呼び出すことができることを示しています。 |
| totalCount | int | クエリの結果データ内の行の総数 (つまり、自分のアカウントに登録されているアプリの合計数)。 |
エラー コード
要求を正常に完了できない場合、次の HTTP エラー コードのいずれかが応答に含まれます。
| エラー コード | 説明 |
|---|---|
| 404 | アプリが見つかりませんでした。 |
| 409 | アプリで、現在 Microsoft Store 申請 API でサポートされていないパートナー センター機能が使用されています。 |