次の方法で共有

reportRoot: getMicrosoft365CopilotUserCountSummary

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

指定した期間のMicrosoft 365 Copilotのアクティブおよび有効なユーザーの集計数を取得します。

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

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

アクセス許可

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

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

重要

アプリがユーザーに代わってサービス使用状況レポートを読み取ることができるように委任されたアクセス許可を持つ場合、テナント管理者は、次のMicrosoft Entra ID制限された管理者ロールのいずれかをユーザーに割り当てる必要があります。

  • 社内管理者
  • Exchange 管理者
  • SharePoint 管理者
  • Lync 管理者
  • Teams サービス管理者
  • Teams 通信管理者
  • グローバル閲覧者
  • 使用状況の概要レポート閲覧者
  • レポート閲覧者

詳細については、「 Microsoft 365 使用状況レポートを読み取るための API の承認」を参照してください。

HTTP 要求

GET /reports/getMicrosoft365CopilotUserCountSummary(period='{period_value}')

関数パラメーター

要求 URL で、次のクエリ パラメーターに値を指定します。

パラメーター 型 説明
period String 集計された使用状況を報告する前の日数。 サポートされる値は、 D7、 D30、 D90、 D180、 ALLです。 最初の 4 つの値は Dn という形式に従います。n は、データを集計する日数を表します。 ALL は、7 日、30 日、90 日、180 日間の使用状況を報告することを示します。

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

このメソッドは、応答をカスタマイズするために $formatOData クエリ パラメーター をサポートします。 既定の出力の種類は application/json。 ただし、出力の種類を指定する場合は、OData $format クエリ パラメーターを使用して、既定の出力を text/csv または application/json に設定できます。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

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

応答

CSV

成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found 応答が返されます。 その URL は、応答の Location ヘッダー内にあります。

事前認証されたダウンロード URL は短時間 (数分) のみ有効であり、 Authorization ヘッダーは必要ありません。

この CSV ファイルには、次の列ヘッダーがあります。

  • レポートの更新日
  • レポート期間
  • アプリが有効なユーザー
  • すべてのアプリのアクティブ ユーザー
  • 有効なユーザーのMicrosoft Teams
  • アクティブ ユーザーのMicrosoft Teams
  • 有効なユーザーのWord
  • アクティブ ユーザーのWord
  • 有効なユーザーのPowerPoint
  • アクティブ ユーザーのPowerPoint
  • Outlook 対応ユーザー
  • Outlook Active Users
  • Excel 対応ユーザー
  • Excel Active Users
  • OneNote 対応ユーザー
  • OneNote Active Users
  • 有効なユーザーのLoop
  • アクティブ ユーザーのLoop
  • Copilot チャットが有効なユーザー
  • Copilot チャットのアクティブ ユーザー

JSON

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

例

例 1: CSV 出力

次の例では、CSV ファイルの URL を出力します。

要求

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

GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUserCountSummary(period='D7')?$format=text/csv

応答

次の例は応答を示しています。

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

302 応答の Location ヘッダー内の CSV ファイルには、次のスキーマがあります。

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,Report Period,Any App Enabled Users,Any App Active Users,Microsoft Teams Enabled Users,Microsoft Teams Active Users  ,Word Enabled Users,Word Active Users,PowerPoint Enabled Users,PowerPoint Active Users,Outlook Enabled Users,Outlook Active Users,Excel Enabled Users,Excel Active Users,OneNote Enabled Users,OneNote Active Users,Loop Enabled Users,Loop Active Users,Copilot Chat Enabled Users,Copilot Chat Active Users

例 2: JSON 出力

次の例では、JSON データを返します。

要求

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

GET https://graph.microsoft.com/beta/reports/getMicrosoft365CopilotUserCountSummary(period='D7')?$format=application/json

応答

次の例は応答を示しています。

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

{
    "value": [
        {
            "reportRefreshDate": "2024-08-20",
            "adoptionByProduct": [
                {
                    "reportPeriod": 7,
                    "anyAppEnabledUsers": 359229,
                    "anyAppActiveUsers": 165115,
                    "microsoftTeamsEnabledUsers": 359096,
                    "microsoftTeamsActiveUsers": 123341,
                    "wordEnabledUsers": 359096,
                    "wordActiveUsers": 21459,
                    "powerPointEnabledUsers": 359096,
                    "powerPointActiveUsers": 8530,
                    "outlookEnabledUsers": 359096,
                    "outlookActiveUsers": 37270,
                    "excelEnabledUsers": 359096,
                    "excelActiveUsers": 6709,
                    "oneNoteEnabledUsers": 359096,
                    "oneNoteActiveUsers": 1660,
                    "loopEnabledUsers": 359096,
                    "loopActiveUsers": 1345,
                    "copilotChatEnabledUsers": 359096,
                    "copilotChatActiveUsers": 65480
                }
            ]
        }
    ]
}