reportRoot: getOffice365GroupsActivityDetail

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

名前空間: microsoft.graph

重要

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

グループ別のグループMicrosoft 365詳細を取得します。

注: さまざまなレポートビューと名前の詳細については、「Microsoft 365 - Microsoft 365」を参照してください。

アクセス許可

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

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

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

HTTP 要求

GET /reports/getOffice365GroupsActivityDetail(period='{period_value}')
GET /reports/getOffice365GroupsActivityDetail(date={date_value})

関数パラメーター

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

パラメーター	種類	説明
period	文字列	レポートを集計する期間の長さを指定します。 {period_value} でサポートされている値は D7、D30、D90、D180 です。これらの値は、D n の形式 (n はレポートを集計する日数) に従います。
date	日付	何らかのアクティビティを実行したユーザーを表示する日付を指定します。 {date_value} は YYYY-MM-DD の形式にします。このレポートは、過去 30 日間のみ利用可能であり、{date_value} はその範囲内の日付である必要があります。

注: URL に期間または日付を設定する必要があります。

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

要求ヘッダー

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

応答

CSV

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

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

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

レポートの更新日
グループ表示名
削除済み
所有者のプリンシパル名
最後のアクティビティ日付
グループの種類
メンバー数
外部メンバー数
Exchange の受信メール数
SharePoint のアクティブなファイル数
Yammer に投稿されたメッセージ数
Yammer の開封済みメッセージ数
Yammer で「いいね!」されたメッセージ数
Exchange メールボックスのアイテム合計数
使用済み Exchange メールボックスストレージ (バイト)
SharePoint の合計ファイル数
SharePoint の使用済みサイトストレージ (バイト)
グループ ID
レポート期間

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

Yammer に投稿されたメッセージ数
Yammer の開封済みメッセージ数
Yammer で「いいね!」されたメッセージ数

JSON

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

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

yammerPostedMessageCount
yammerReadMessageCount
yammerLikedMessageCount

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

例

CSV

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

要求

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

GET https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityDetail(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,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Member Count,External Member Count,Exchange Received Email Count,SharePoint Active File Count,Yammer Posted Message Count,Yammer Read Message Count,Yammer Liked Message Count,Exchange Mailbox Total Item Count,Exchange Mailbox Storage Used (Byte),SharePoint Total File Count,SharePoint Site Storage Used (Byte),Group Id,Report Period

JSON

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

要求

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

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

応答

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

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

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365GroupsActivityDetail)", 
  "value": [
    {
      "groupId": "0003cf63-7ff3-4471-b24b-50ffbfb8b5d2",
      "reportRefreshDate": "2017-09-01", 
      "groupDisplayName": "groupDisplayName-value", 
      "isDeleted": false, 
      "ownerPrincipalName": "ownerDisplayName-value", 
      "lastActivityDate": "2017-08-31", 
      "groupType": "Private", 
      "memberCount": 5, 
      "externalMemberCount": 0, 
      "exchangeReceivedEmailCount": 341, 
      "sharePointActiveFileCount": 0, 
      "yammerPostedMessageCount": 0, 
      "yammerReadMessageCount": 0, 
      "yammerLikedMessageCount": 0, 
      "exchangeMailboxTotalItemCount": 343, 
      "exchangeMailboxStorageUsedInBytes": 3724609, 
      "sharePointTotalFileCount": 0, 
      "sharePointSiteStorageUsedInBytes": 0, 
      "reportPeriod": "30"
    }
  ]
}

reportRoot: getOffice365GroupsActivityDetail

アクセス許可

HTTP 要求

関数パラメーター

要求ヘッダー

応答

CSV

JSON

例

CSV

要求

応答

JSON

要求

応答

フィードバック