reportRoot: getTeamsDeviceUsageUserDetail
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
ユーザーごとに、Microsoft Teams デバイスの使用状況の詳細を取得します。
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
| アクセス許可の種類 | アクセス許可 (特権の小さいものから大きいものへ) |
|---|---|
| 委任 (職場または学校アカウント) | Reports.Read.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 |
| アプリケーション | Reports.Read.All |
注: アプリがユーザーに代わってサービス使用状況レポートを読み取ることができるように委任されたアクセス許可を付与するには、テナント管理者がユーザーに適切な Azure Active Directory 制限付き管理者ロールを割り当てる必要があります。 詳細については、「Microsoft 365 利用状況レポートを読み込むための API 用の承認」を参照してください。
HTTP 要求
GET /reports/getTeamsDeviceUsageUserDetail(period='{period_value}')
GET /reports/getTeamsDeviceUsageUserDetail(date='{date_value}')
関数パラメーター
要求 URL に、次のうちの 1 つのパラメーターと有効な値を指定します。
| パラメーター | 型 | 説明 |
|---|---|---|
| period | 文字列 | レポートを集計する期間の長さを指定します。 {period_value} でサポートされている値は、次のとおりです。 D7``D30``D90``D180 これらの値は、D n の形式 (n はレポートを集計する日数) に従います。 |
| date | 日付 | 何らかのアクティビティを実行したユーザーを表示する日付を指定します。 {date_value} は YYYY-MM-DD の形式にします。 このレポートは過去 28 日間しか使用できないため、{date_value} はその範囲の日付である必要があります。 |
メモ： URL で ピリオド または 日付 を設定する必要があります。
オプションのクエリ パラメーター
このメソッドは、応答をカスタマイズするための $format、$top、$skipToken の OData クエリ パラメーターをサポートします。 既定の出力の種類は .text/csv ただし、出力の種類を指定する場合は、OData $format クエリ パラメーターの設定 text/csv または application/json設定を使用できます。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {トークン}。必須。 |
応答
CSV
成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found 応答が返されます。 その URL は、応答の Location ヘッダー内にあります。
事前認証されたダウンロード URL は、短期間 (数分) のみ有効で、Authorization ヘッダーを必要としません。
この CSV ファイルには、次の列ヘッダーがあります。
- レポートの更新日
- User Id
- ユーザー プリンシパル名
- 最後のアクティビティ日付
- 削除済み
- 削除日
- Web の使用
- Windows スマートフォンの使用
- iOS の使用
- Mac の使用
- Android スマートフォンの使用
- Windows の使用
- 使用済み Chrome OS
- 使用済み Linux
- ライセンスが付与されています
- レポート期間
JSON
成功した場合、このメソッドは 200 OK 応答コードと応答本文の JSON オブジェクトを返します。
この要求の既定のページ サイズは 2,000 項目です。
例
例 1: CSV 出力
CSV を出力する例を次に示します。
要求
要求の例を次に示します。
GET https://graph.microsoft.com/beta/reports/getTeamsDeviceUsageUserDetail(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 Id,User Principal Name,Last Activity Date,Is Deleted,Deleted Date,Used Web,Used Windows Phone,Used iOS,Used Mac,Used Android Phone,Used Windows,Used Chrome OS,Used Linux,Is Licensed,Report Period
例 2: JSON 出力
JSON を返す例を次に示します。
要求
要求の例を次に示します。
GET https://graph.microsoft.com/beta/reports/getTeamsDeviceUsageUserDetail(period='D7')?$format=application/json
応答
応答の例を次に示します。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 374
{
"value": [
{
"reportRefreshDate": "2017-09-01",
"userId": "userId-value",
"userPrincipalName": "userPrincipalName-value",
"isLicensed": true,
"lastActivityDate": "2017-09-01",
"isDeleted": false,
"deletedDate": null,
"usedWeb": false,
"usedWindowsPhone": false,
"usediOS": true,
"usedMac": false,
"usedAndroidPhone": false,
"usedWindows": true,
"usedChromeOS": false,
"usedLinux": false,
"reportPeriod": "7"
}
]
}
フィードバック
フィードバックの送信と表示