reportRoot: getYammerDeviceUsageUserDetail function

[アーティクル]
10/31/2023

名前空間: microsoft.graph

ユーザー別の Yammer デバイス使用状況に関する詳細を取得します。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	❌	❌	❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校アカウント)	Reports.Read.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	Reports.Read.All	注意事項なし。

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

HTTP 要求

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

関数パラメーター

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

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

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
If-None-Match	この要求ヘッダーが含まれている場合、指定された eTag がファイルの現在のタグに一致すると、`304 Not Modified` 応答コードが返されます。省略可能。

応答

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

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

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

レポートの更新日
ユーザープリンシパル名
表示名
ユーザーの状態
状態変更日付
最後のアクティビティ日付
Web の使用
Windows スマートフォンの使用
Android スマートフォンの使用
iPhone の使用
IPad の使用
その他の使用
レポート期間

例

例 1: getYammerDeviceUsageUserDetail by period

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/reports/getYammerDeviceUsageUserDetail(period='D7')


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetYammerDeviceUsageUserDetailWithPeriod("{period}").GetAsync();


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc reports get-yammer-device-usage-user-detail-with-period get --period {period-id}



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



period := "{period}"
graphClient.Reports().GetYammerDeviceUsageUserDetailWithPeriod(&period).Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getYammerDeviceUsageUserDetailWithPeriod("{period}").get();


const options = {
	authProvider,
};

const client = Client.init(options);

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


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->reports()->getYammerDeviceUsageUserDetailWithPeriod('{period}', )->get()->wait();

Snippet not available


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.reports.get_yammer_device_usage_user_detail_with_period("{period}").get()

応答

次の例は応答を示しています。

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,User State,State Change Date,Last Activity Date,Used Web,Used Windows Phone,Used Android Phone,Used iPhone,Used iPad,Used Others,Report Period

例 2: getYammerDeviceUsageUserDetail by date

要求

パラメーターを date 指定して呼び出された場合、レポートの範囲は指定された日付の使用状況になります。

GET https://graph.microsoft.com/v1.0/reports/getYammerDeviceUsageUserDetail(date='2018-03-05')


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Reports.GetYammerDeviceUsageUserDetailWithDate(new Date(DateTime.Parse("{date}"))).GetAsync();


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc reports get-yammer-device-usage-user-detail-with-date get --date {date-id}



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



date := {date}
graphClient.Reports().GetYammerDeviceUsageUserDetailWithDate(&date).Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.reports().getYammerDeviceUsageUserDetailWithDate(LocalDate.parse("{date}")).get();

Snippet not available


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->reports()->getYammerDeviceUsageUserDetailWithDate(new Date('{date}'))->get()->wait();


Import-Module Microsoft.Graph.Reports

Get-MgReportYammerDeviceUsageUserDetail


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.reports.get_yammer_device_usage_user_detail_with_date("{date}").get()

応答