次の方法で共有

reportRoot: getEmailAppUsageAppsUserCounts

  • [アーティクル]

名前空間: microsoft.graph

重要

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

メール アプリごとの、それぞれ別個のユーザーの数を取得します。

手記： さまざまなレポート ビューと名前の詳細については、「 Microsoft 365 レポート - メール アプリの使用状況」を参照してください。

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

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

アクセス許可

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

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

注: アプリがユーザーの代わりにサービス使用状況レポートを読み取ることができるように委任されたアクセス許可の場合、テナント管理者はユーザーに適切な Microsoft Entra ID 制限付き管理者ロールを割り当てる必要があります。 詳細については、「Microsoft 365 利用状況レポートを読み込むための API 用の承認」を参照してください。

HTTP 要求

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

関数パラメーター

要求 URL に、次のパラメーターと有効な値を指定します。

パラメーター 種類 説明
period 文字列 レポートを集計する期間の長さを指定します。 {period_value} でサポートされている値は D7、D30、D90、D180 です。 これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。 必須。

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

要求ヘッダー

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

応答

CSV

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

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

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

  • レポートの更新日
  • Mail For Mac
  • Outlook For Mac
  • Outlook For Windows
  • Outlook For Mobile
  • Other For Mobile
  • Outlook For Web
  • POP3 アプリ
  • IMAP4 アプリ
  • SMTP アプリ
  • レポート期間

JSON

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

例

CSV

CSV を出力する例を次に示します。

要求

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

GET https://graph.microsoft.com/beta/reports/getEmailAppUsageAppsUserCounts(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 リダイレクトに従うと、ダウンロードされる CSV ファイルは次のスキーマを持つことになります。

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

Report Refresh Date,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Period

JSON

JSON を返す例を次に示します。

要求

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

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

応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "mailForMac": 4, 
      "outlookForMac": 105, 
      "outlookForWindows": 1589, 
      "outlookForMobile": 1116, 
      "otherForMobile": 485, 
      "outlookForWeb": 753, 
      "pop3App": 0, 
      "imap4App": 0, 
      "smtpApp": 0, 
      "reportPeriod": "7"
    }
  ]
}