リスト パッケージ

重要

/beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。

テナントで使用可能なすべてのパッケージの一覧を取得します。

重要

パッケージ管理 API にアクセスするには、Microsoft Agent 365 ライセンスが必要です。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) CopilotPackages.Read.All CopilotPackages.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション CopilotPackages.Read.All CopilotPackages.ReadWrite.All

HTTP 要求

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages

要求ヘッダー

名前 説明
Authorization Bearer {token}. 必須。 認証と認可についての詳細をご覧ください。

オプションのクエリ パラメーター

このメソッドでは、応答をカスタマイズするために $filterOData クエリ パラメーター がサポートされています。 次のプロパティは、 $filter OData クエリ パラメーターでサポートされます。 $filter クエリ パラメーターの使用例については、「例」を参照してください。

パラメーター 型 説明
supportedHosts string サポートされているホストでフィルター処理 (Copilot、 Outlook、 Teams、 M365)
elementTypes string 要素の種類でフィルター処理 (Bots、 DeclarativeAgent、 CustomEngineAgent)
lastModifiedDateTime 日付型 ge またはle
platform string プラットフォームでフィルター処理 (Copilot Studio、 Microsoft 365 Copilot Agent Builder)
requestStatus copilotPackageRequestStatus pending を使用して要求の状態でフィルター処理します (「要求プロパティでフィルター処理する」を参照)
requestType copilotPackageRequestType 要求の種類でフィルター処理します ( 「要求プロパティでフィルター処理する」を参照)

要求プロパティでフィルター処理

requestStatus プロパティと requestType プロパティは、organization内のユーザーがパッケージに対して送信した要求を記述します。 いずれかのプロパティでフィルター処理すると、ユーザーが要求したパッケージが返されます。

フィルター処理されていない GET /copilot/admin/catalog/packages 動作は変更されません。

次のフィルター式がサポートされています。

  • requestStatus eq 'pending'これにより、開いている要求キューが選択されます。 他の requestStatus メンバーはフィルターでサポートされていません。
  • publish、activate、access、または update メンバーのいずれかとrequestTypeでの単一eq比較。 unknownFutureValue Sentinel メンバーではフィルター処理しないでください。
  • これら 2 つの比較は and と結びつきました。
  • これらの比較のいずれかまたは両方が lastModifiedDateTime 境界と組み合わされたもの。 一方の ge バインド、1 つの le バインド、またはその両方を指定して、包括範囲を表します。

and接続詞は任意の順序で書くことができます。

lastModifiedDateTime バインドはパッケージのlastModifiedDateTime値に適用されます。これは、そのプロパティに対して返される値と同じです。 ユーザーが要求を送信したタイミングではフィルター処理されません。 lastModifiedDateTime値がないパッケージは、境界が存在する間は一致しません。

lastModifiedDateTime でのフィルター処理自体は通常のカタログ動作であり、要求キューは返されません。

以下はサポートされておらず、 400 Bad Requestを返します。

  • 要求プロパティを supportedHosts、 elementTypes、または platform と組み合わせる。
  • lastModifiedDateTime、または同じ方向にバインドされた複数のlastModifiedDateTime (2 つのge境界など) の eq、gt、またはlt演算子。
  • or、ne、および contains 演算子。
  • $count リクエスト フィルターを含みます。

要求プロパティは並べ替えできません。

requestType requestStatus は進化可能な列挙型であるため、新しいバージョンのサービスではクライアントが認識しないメンバーを返すことができます。 詳細については、「 進化可能な列挙型での将来のメンバーの処理」を参照してください。

フィルター処理されたコレクションのページング

ページングはサーバー主導であるため、各ページに含まれるエントリの数はサービスによって決定されます。 @odata.nextLinkを不透明な URL として扱う: クエリ オプションを追加または変更することなく、返されたとおりに要求します。

重要

ページングされた応答の場合は、継続シグナルとして @odata.nextLink を使用します。 不透明な @odata.nextLink がなくなるまで要求を続行します。 @odata.nextLinkが存在する場合は、応答本文から完了を推測しないでください。

要求プロパティでフィルター処理する要求への応答には、 @odata.count プロパティは含まれません。 詳細については、アプリで Microsoft Graph データをページングするを参照してください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文の copilotPackage オブジェクトのコレクションを返します。

例

例 1: すべてのパッケージを一覧表示する

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-56bc-505a-3d42-156df75a4xxy",
      "displayName": "Diligent Teams Document Uploader",
      "type": "external",
      "shortDescription": "Allows direct upload of documents from Microsoft Office into Diligent Teams for sharing",
      "isBlocked": false,
      "supportedHosts": ["outlook", "word", "excel", "powerPoint"],
      "lastModifiedDateTime": "2023-11-20T19:02:02.241Z",
      "publisher": "Diligent Corporation",
      "availableTo": "all",
      "deployedTo": "none",
      "elementTypes": ["officeAddIn"],
      "platform": "web",
      "version": "1.0.0",
      "manifestVersion": "1.1",
      "manifestId": "diligent-teams-uploader",
      "appId": "aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
      "assetId": "asset-00001"
    }
  ]
}

例 2: サポートされているホストでフィルター処理されたパッケージの一覧表示

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=supportedHosts/any(h:h eq 'Word')

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=supportedHosts/any(h:h eq 'Word')
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-cb65-505a-3d42-156df75a4xxy",
      "displayName": "Contoso Document Formatter",
      "type": "external",
      "shortDescription": "Formats Word documents according to company style guide",
      "isBlocked": false,
      "supportedHosts": ["Word"],
      "lastModifiedDateTime": "2025-10-06T00:07:20.1467852Z",
      "availableTo": "all",
      "deployedTo": "all"
    }
  ]
}

例 3: 要素の種類でフィルター処理された一覧パッケージ

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=elementTypes/any(h:h eq 'OfficeAddIns')

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=elementTypes/any(h:h eq 'OfficeAddIns')
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-505a-3492-9871-134df75a4xxy",
      "displayName": "Northwind Traders Account Lookup",
      "type": "external",
      "shortDescription": "Look up customer account details in Outlook and add them to email",
      "isBlocked": false,
      "supportedHosts": ["Outlook"],
      "lastModifiedDateTime": "2025-10-06T00:07:20.1467852Z",
      "availableTo": "all",
      "deployedTo": "all"
    }
  ]
}

例 4: 最終更新日時でパッケージを一覧表示する

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=lastModifiedDateTime ge 2026-01-01T00:00:00.0000000Z

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=lastModifiedDateTime ge 2026-01-01T00:00:00.0000000Z
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-56bc-505a-3d42-156df75a4xxy",
      "displayName": "Contoso HR Agent",
      "type": "custom",
      "shortDescription": "Agent that can answer HR questions",
      "isBlocked": false,
      "supportedHosts": ["Copilot"],
      "lastModifiedDateTime": "2026-01-06T00:07:20.1467852Z",
      "availableTo": "all",
      "deployedTo": "all"
    }
  ]
}

例 5: すべてのエージェントを一覧表示する

すべてのエージェントを一覧表示するには、次を含む supportedHosts のフィルターを使用します Copilot

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=supportedHosts/any(h:h eq 'Copilot')

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=supportedHosts/any(h:h eq 'Copilot')
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-56bc-505a-3d42-156df75a4xxy",
      "displayName": "Contoso HR Agent",
      "type": "custom",
      "shortDescription": "Agent that can answer HR questions",
      "isBlocked": false,
      "supportedHosts": ["Copilot"],
      "lastModifiedDateTime": "2026-01-06T00:07:20.1467852Z",
      "availableTo": "all",
      "deployedTo": "all"
    }
  ]
}

例 6: ユーザーが要求したパッケージを一覧表示する

要求

次の例は、未処理の要求を含むパッケージを返す要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=requestStatus eq 'pending'

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=requestStatus eq 'pending'
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-56bc-505a-3d42-156df75a4xxy",
      "displayName": "Contoso HR Agent",
      "type": "custom",
      "shortDescription": "Agent that can answer HR questions",
      "isBlocked": false,
      "supportedHosts": ["Copilot"],
      "lastModifiedDateTime": "2026-08-06T00:07:20.1467852Z",
      "availableTo": "none",
      "deployedTo": "none",
      "requestType": "publish",
      "requestStatus": "pending"
    },
    {
      "id": "P_38cd4yy2-71de-4f6b-9c05-284ef86b5zzt",
      "displayName": "Northwind Traders Account Lookup",
      "type": "external",
      "shortDescription": "Look up customer account details in Outlook and add them to email",
      "isBlocked": false,
      "supportedHosts": ["Outlook"],
      "lastModifiedDateTime": "2026-08-11T18:22:04.5510000Z",
      "availableTo": "some",
      "deployedTo": "some",
      "requestType": "update",
      "requestStatus": "pending"
    }
  ]
}

例 7: ユーザーが公開を要求したパッケージのリスト

要求

次の例は、ユーザーが公開を要求したパッケージのみを返す要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=requestType eq 'publish'

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=requestType eq 'publish'
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-56bc-505a-3d42-156df75a4xxy",
      "displayName": "Contoso HR Agent",
      "type": "custom",
      "shortDescription": "Agent that can answer HR questions",
      "isBlocked": false,
      "supportedHosts": ["Copilot"],
      "lastModifiedDateTime": "2026-08-06T00:07:20.1467852Z",
      "availableTo": "none",
      "deployedTo": "none",
      "requestType": "publish",
      "requestStatus": "pending"
    }
  ]
}

例 8: 両方の要求フィルターを組み合わせる

要求

次の例は、2 つの要求プロパティを and と組み合わせた要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=requestStatus eq 'pending' and requestType eq 'publish'

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=requestStatus eq 'pending' and requestType eq 'publish'
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-56bc-505a-3d42-156df75a4xxy",
      "displayName": "Contoso HR Agent",
      "type": "custom",
      "shortDescription": "Agent that can answer HR questions",
      "isBlocked": false,
      "supportedHosts": ["Copilot"],
      "lastModifiedDateTime": "2026-08-06T00:07:20.1467852Z",
      "availableTo": "none",
      "deployedTo": "none",
      "requestType": "publish",
      "requestStatus": "pending"
    }
  ]
}

例 9: 保留中の要求を一覧表示する lastModifiedDateTime

要求

次の例は、 lastModifiedDateTime 値が日付以降であるオープン要求を含むパッケージを返す要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=requestStatus eq 'pending' and lastModifiedDateTime ge 2026-08-10T00:00:00.0000000Z

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=requestStatus eq 'pending' and lastModifiedDateTime ge 2026-08-10T00:00:00.0000000Z
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_38cd4yy2-71de-4f6b-9c05-284ef86b5zzt",
      "displayName": "Northwind Traders Account Lookup",
      "type": "external",
      "shortDescription": "Look up customer account details in Outlook and add them to email",
      "isBlocked": false,
      "supportedHosts": ["Outlook"],
      "lastModifiedDateTime": "2026-08-11T18:22:04.5510000Z",
      "availableTo": "some",
      "deployedTo": "some",
      "requestType": "update",
      "requestStatus": "pending"
    }
  ]
}

例 10: lastModifiedDateTime 範囲内の要求の種類を一覧表示する

要求

次の例は、 lastModifiedDateTime 値が包括的範囲内にあるパッケージに限定して、ユーザーが公開を要求したパッケージを返す要求を示しています。

GET https://graph.microsoft.com/v1.0/copilot/admin/catalog/packages?$filter=requestType eq 'publish' and lastModifiedDateTime ge 2026-08-01T00:00:00.0000000Z and lastModifiedDateTime le 2026-08-31T23:59:59.9999999Z

GET https://graph.microsoft.com/beta/copilot/admin/catalog/packages?$filter=requestType eq 'publish' and lastModifiedDateTime ge 2026-08-01T00:00:00.0000000Z and lastModifiedDateTime le 2026-08-31T23:59:59.9999999Z
応答

次の例は応答を示しています。 ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "P_19ae1zz1-56bc-505a-3d42-156df75a4xxy",
      "displayName": "Contoso HR Agent",
      "type": "custom",
      "shortDescription": "Agent that can answer HR questions",
      "isBlocked": false,
      "supportedHosts": ["Copilot"],
      "lastModifiedDateTime": "2026-08-06T00:07:20.1467852Z",
      "availableTo": "none",
      "deployedTo": "none",
      "requestType": "publish",
      "requestStatus": "pending"
    }
  ]
}
  • 最終更新: