reportRoot: getM365AppUserDetail

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

名前空間: microsoft.graph

重要

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

ユーザーが使用したアプリとプラットフォームの詳細を示すレポートを取得します。

メモ： さまざまなレポートビューと名前の詳細については、「Microsoft 365 レポート - Microsoft 365 Apps使用法」を参照してください。

アクセス許可

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

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

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

HTTP 要求

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

関数パラメーター

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

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

メモ： URL を設定するか period 、URL date で設定する必要があります。

オプションのクエリパラメーター

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

要求ヘッダー

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

要求本文

このメソッドには、要求本文を指定しません。

応答

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

CSV

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

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

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

レポートの更新日
ユーザープリンシパル名
最終アクティブ化日
最後のアクティビティ日付
レポート期間
Windows
Mac
Mobile
Web
Outlook
Word
Excel
PowerPoint
OneNote
Teams
Outlook (Windows)
Word (Windows)
Excel (Windows)
PowerPoint (Windows)
OneNote (Windows)
Teams (Windows)
Outlook (Mac)
Word (Mac)
Excel (Mac)
PowerPoint (Mac)
OneNote (Mac)
Teams (Mac)
Outlook (Mobile)
Word (モバイル)
Excel (Mobile)
PowerPoint (Mobile)
OneNote (Mobile)
Teams (モバイル)
Outlook (Web)
Word (Web)
Excel (Web)
PowerPoint (Web)
OneNote (Web)
Teams (Web)

JSON

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

この要求の既定のページサイズは 200 項目です。

例

例 1: CSV 出力

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

要求

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

GET https://graph.microsoft.com/beta/reports/getM365AppUserDetail(period='D7')?$format=text/csv


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var stream = await graphClient.Reports
    .GetM365AppUserDetail("D7")
    .Request()
    .GetAsync();

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用できるすべての種類、プロパティ、API はサポートされていません。 SDK を使用してベータ API にアクセスする方法の詳細については、「Microsoft Graph SDK とベータ API を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
    authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getM365AppUserDetail(period='D7')')
    .version('beta')
    .get();

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/reports/getM365AppUserDetail(period='D7')?$format=text/csv"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        MSGraphStream *stream = [[MSGraphStream alloc] initWithData:data error:&nserror];

}];

[meDataTask execute];

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

InputStream stream = graphClient.customRequest("/reports/getM365AppUserDetail(period='D7')", InputStream.class)
    .buildRequest()
    .get();

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

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

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,Last Activation Date,Last Activity Date,Report Period,Windows,Mac,Mobile,Web,Outlook,Word,Excel,PowerPoint,OneNote,Teams,Outlook (Windows),Word (Windows),Excel (Windows),PowerPoint (Windows),OneNote (Windows),Teams (Windows),Outlook (Mac),Word (Mac),Excel (Mac),PowerPoint (Mac),OneNote (Mac),Teams (Mac),Outlook (Mobile),Word (Mobile),Excel (Mobile),PowerPoint (Mobile),OneNote (Mobile),Teams (Mobile),Outlook (Web),Word (Web),Excel (Web),PowerPoint (Web),OneNote (Web),Teams (Web)

例 2: JSON 出力

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

要求

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

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


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var stream = await graphClient.Reports
    .GetM365AppUserDetail("D7")
    .Request()
    .GetAsync();

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
    authProvider,
};

const client = Client.init(options);

let stream = await client.api('/reports/getM365AppUserDetail(period='D7')')
    .version('beta')
    .get();

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/reports/getM365AppUserDetail(period='D7')?$format=application/json"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        MSGraphStream *stream = [[MSGraphStream alloc] initWithData:data error:&nserror];

}];

[meDataTask execute];

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

InputStream stream = graphClient.customRequest("/reports/getM365AppUserDetail(period='D7')", InputStream.class)
    .buildRequest()
    .get();

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

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

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

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

{
  "@odata.nextLink": "https://graph.microsoft.com/beta/reports/getM365AppUserDetail(period='D7')?$format=application/json&$skiptoken=AAAAA",
  "value": [
    {
      "reportRefreshDate": "2020-06-30",
      "userPrincipalName": "admin@contoso.com",
      "lastActivationDate": "2020-05-22",
      "lastActivityDate": "2020-06-30",
      "details": [
        {
          "reportPeriod": 7,
          "windows": true,
          "mac": false,
          "mobile": true,
          "web": false,
          "outlook": false,
          "word": false,
          "excel": false,
          "powerPoint": false,
          "oneNote": false,
          "teams": true,
          "outlookWindows": false,
          "wordWindows": false,
          "excelWindows": false,
          "powerPointWindows": false,
          "oneNoteWindows": false,
          "teamsWindows": true,
          "outlookMac": false,
          "wordMac": false,
          "excelMac": false,
          "powerPointMac": false,
          "oneNoteMac": false,
          "teamsMac": false,
          "outlookMobile": false,
          "wordMobile": false,
          "excelMobile": false,
          "powerPointMobile": false,
          "oneNoteMobile": false,
          "teamsMobile": true,
          "outlookWeb": false,
          "wordWeb": false,
          "excelWeb": false,
          "powerPointWeb": false,
          "oneNoteWeb": false,
          "teamsWeb": true
        }
      ]
    }
  ]
}

reportRoot: getM365AppUserDetail

アクセス許可

HTTP 要求

関数パラメーター

オプションのクエリ パラメーター

要求ヘッダー

要求本文

応答

CSV

JSON

例

例 1: CSV 出力

要求

応答

例 2: JSON 出力

要求

応答

フィードバック

オプションのクエリパラメーター