reportRoot: getMailboxUsageDetail

[アーティクル]
01/12/2022

名前空間: 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/getMailboxUsageDetail(period='{period_value}')

関数パラメーター

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

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

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

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須。

応答

CSV

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

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

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

レポートの更新日
ユーザープリンシパル名
表示名
削除済み
削除日
作成日
最後のアクティビティ日付
アイテム数
使用済みストレージ (バイト)
警告表示クォータ (バイト)
送信禁止クォータ (バイト)
送受信禁止クォータ (バイト)
削除済みのアイテム数
削除済みアイテムのサイズ (バイト)
削除済みアイテムクォータ (バイト)
アーカイブあり
レポート期間

JSON

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

この要求の既定のページサイズは 200 アイテムです。

例

CSV

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

要求

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

GET https://graph.microsoft.com/beta/reports/getMailboxUsageDetail(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,User Principal Name,Display Name,Is Deleted,Deleted Date,Created Date,Last Activity Date,Item Count,Storage Used (Byte),Issue Warning Quota (Byte),Prohibit Send Quota (Byte),Prohibit Send/Receive Quota (Byte),Deleted Item Count,Deleted Item Size (Byte),Deleted Item Quota (Byte),Has Archive,Report Period

JSON

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

要求

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

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

応答

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

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

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

{
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "userPrincipalName": "userPrincipalName-value", 
      "displayName": "displayName-value", 
      "isDeleted": false, 
      "deletedDate": null, 
      "createdDate": "2016-03-30", 
      "lastActivityDate": "2017-09-01", 
      "itemCount": 138481, 
      "storageUsedInBytes": 10414748704, 
      "deletedItemCount": 138481,
      "deletedItemSizeInBytes": 10414748704, 
      "deletedItemQuota": 107374182400,
      "hasArchive": true,
      "issueWarningQuotaInBytes": 10522698752, 
      "prohibitSendQuotaInBytes": 10630040576, 
      "prohibitSendReceiveQuotaInBytes": 10737418240, 
      "reportPeriod": "7"
    }
  ]
}

reportRoot: getMailboxUsageDetail

アクセス許可

HTTP 要求

関数パラメーター

要求ヘッダー

応答

CSV

JSON

例

CSV

要求

応答

JSON

要求

応答

フィードバック