reportRoot: getOffice365ServicesUserCounts

[アーティクル]
06/01/2021

名前空間: microsoft.graph

重要

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

アクティビティの種類とサービス別のユーザー数を取得します。

注: 各レポートのビューとレポート名の詳細については、「Microsoft 365 レポート:　アクティブなユーザー」を参照してください。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校アカウント)	Reports.Read.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Reports.Read.All

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

HTTP 要求

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

関数パラメーター

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

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

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

要求ヘッダー

名前	説明
Authorization	ベアラー {トークン}。必須。

応答

CSV

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

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

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

レポートの更新日
Exchange アクティブ
Exchange 非アクティブ
OneDrive アクティブ
OneDrive 非アクティブ
SharePoint アクティブ
SharePoint 非アクティブ
Skype For Business アクティブ
Skype For Business 非アクティブ
Yammer アクティブ
Yammer 非アクティブ
Teams アクティブ
Teams 非アクティブ
Office 365Active
Office 365非アクティブ
レポート期間

21Vianet が運営する中国の Microsoft Graphでは、次の列はサポートされていません。

Yammer アクティブ
Yammer 非アクティブ
Teams アクティブ
Teams 非アクティブ

JSON

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

office365ServicesUserCounts オブジェクトの次のプロパティは、21Vianet が運営する中国の Microsoft Graphではサポートされていません。

yammerActive
yammerInactive
teamsActive
teamsInactive

例

CSV

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

要求

要求の例を次に示します。

GET https://graph.microsoft.com/beta/reports/getOffice365ServicesUserCounts(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,Exchange Active,Exchange Inactive,OneDrive Active,OneDrive Inactive,SharePoint Active,SharePoint Inactive,Skype For Business Active,Skype For Business Inactive,Yammer Active,Yammer Inactive,Teams Active,Teams Inactive,Office 365 Active,Office 365 Inactive,Report Period

JSON

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

要求

要求の例を次に示します。

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

応答

応答の例を次に示します。

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365ServicesUserCounts)", 
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "exchangeActive": 2591, 
      "exchangeInactive": 1426, 
      "oneDriveActive": 1800, 
      "oneDriveInactive": 2451, 
      "sharePointActive": 2286, 
      "sharePointInactive": 1815, 
      "skypeForBusinessActive": 2463, 
      "skypeForBusinessInactive": 1947, 
      "yammerActive": 473, 
      "yammerInactive": 2526, 
      "teamsActive": 846, 
      "teamsInactive": 1960, 
      "office365Active": 2791,
      "office365Inactive": 503,
      "reportPeriod": "7"
    }
  ]
}

reportRoot: getOffice365ServicesUserCounts

アクセス許可

HTTP 要求

関数パラメーター

要求ヘッダー

応答

CSV

JSON

例

CSV

要求

応答

JSON

要求

応答

フィードバック