reportRoot: getOffice365GroupsActivityCounts
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
グループ ワークロード全体のグループ活動の数を取得します。
手記: さまざまなレポート ビューと名前の詳細については、「 Microsoft 365 レポート - Microsoft 365 グループ」を参照してください。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ❌ | ❌ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Reports.Read.All | 注意事項なし。 |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | Reports.Read.All | 注意事項なし。 |
注: アプリがユーザーの代わりにサービス使用状況レポートを読み取ることができるように委任されたアクセス許可の場合、テナント管理者はユーザーに適切な Microsoft Entra ID 制限付き管理者ロールを割り当てる必要があります。 詳細については、「 Microsoft 365 使用状況レポートを読み取るための API の承認」を参照してください。
HTTP 要求
GET /reports/getOffice365GroupsActivityCounts(period='{period_value}')
関数パラメーター
要求 URL に、次のパラメーターと有効な値を指定します。
パラメーター | 種類 | 説明 |
---|---|---|
period | 文字列 | レポートを集計する期間の長さを指定します。 {period_value} でサポートされている値は D7、D30、D90、D180 です。 これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。 必須。 |
このメソッドは、応答をカスタマイズするために $format
OData クエリ パラメーター をサポートします。 既定の出力の種類は text/csv です。 ただし、出力の種類を指定する場合は、テキスト/csv または application/json に設定された OData $format クエリ パラメーターを使用できます。
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
応答
CSV
成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found
応答が返されます。 その URL は、応答の Location
ヘッダー内にあります。
事前認証されたダウンロード URL は短時間 (数分) のみ有効であり、 Authorization
ヘッダーは必要ありません。
この CSV ファイルには、次の列ヘッダーがあります。
- レポートの更新日
- 受信した Exchange の電子メール
- 投稿された Yammer メッセージ
- 読み取られた Yammer メッセージ
- 「いいね!」された Yammer メッセージ
- Teams チャネル メッセージ
- Teams 会議の開催
- レポート日付
- レポート期間
21Vianet が運営する Microsoft Graph China では、次の列はサポートされていません。
- 投稿された Yammer メッセージ
- 読み取られた Yammer メッセージ
- 「いいね!」された Yammer メッセージ
- Teams チャネル メッセージ
- Teams 会議の開催
JSON
成功した場合、このメソッドは 200 OK
応答コードと、応答本文の office365GroupsActivityCounts オブジェクトを返します。
office365GroupsActivityCounts オブジェクトの次のプロパティは、21Vianet が運営する Microsoft Graph China ではサポートされていません。
- yammerMessagesPosted
- yammerMessagesRead
- yammerMessagesLiked
- teamsChannelMessages
- teamsMeetingsOrganized
例
CSV
CSV を出力する例を次に示します。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityCounts(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 Emails Received,Yammer Messages Posted,Yammer Messages Read,Yammer Messages Liked,Teams Channel Messages,Teams Meetings Organized,Report Date,Report Period
JSON
JSON を返す例を次に示します。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/reports/getOffice365GroupsActivityCounts(period='D7')?$format=application/json
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 310
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.office365GroupsActivityCounts)",
"value": [
{
"reportRefreshDate": "2017-09-01",
"exchangeEmailsReceived": 0,
"yammerMessagesPosted": 0,
"yammerMessagesRead": 0,
"yammerMessagesLiked": 0,
"teamsChannelMessages": 0,
"teamsMeetingsOrganized": 0,
"reportDate": "2017-09-01",
"reportPeriod": "7"
}
]
}