reportRoot: getEmailAppUsageUserCounts

命名空间：microsoft.graph

获取使用任意电子邮件应用连接到 Exchange Online 的唯一用户数。

注意：有关不同报表视图和名称的详细信息，请参阅 Microsoft 365 报表 - Email应用使用情况。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	Reports.Read.All	不可用。
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用	Reports.Read.All	不可用。

注意：对于允许应用代表用户读取服务使用情况报告的委派权限，租户管理员必须向用户分配适当的Microsoft Entra受限管理员角色。 有关更多详细信息，请参阅授权 API 读取 Microsoft 365 使用情况报告。

HTTP 请求

GET /reports/getEmailAppUsageUserCounts(period='{period_value}')

函数参数

在请求 URL 中，提供以下参数的有效值。

参数	类型	说明
period	string	指定在多长时间内聚合报表。 受支持的 {period_value} 值为：D7、D30、D90 和 D180。 这些值采用格式 Dn，其中 n 表示在多少天内聚合报表。 必需。

请求标头

名称	说明
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
If-None-Match	如果包含此请求头，且提供的 eTag 与文件中的当前标记一致，返回的是 304 Not Modified 响应代码。 可选。

响应

如果成功，此方法返回 302 Found 响应，以重定向到报表的预先验证的下载 URL。 可以在响应的 Location 头中找到此 URL。

预先验证的下载 URL 的有效时间很短（几分钟），不需要 Authorization 头。

CSV 文件包含下面的列标题。

• 报表刷新日期
• Mail for Mac
• Outlook for Mac
• Outlook for Windows
• Outlook for Mobile
• 适用于移动设备的其他应用
• Outlook for Web
• POP3 应用
• IMAP4 应用
• SMTP 应用
• 报表日期
• 报表周期

示例

请求

以下示例显示了一个请求。

HTTP

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

C#

// 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.GetEmailAppUsageUserCountsWithPeriod("{period}").GetAsync();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

CLI

mgc reports get-email-app-usage-user-counts-with-period get --period {period-id}

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
period := "{period}"
graphClient.Reports().GetEmailAppUsageUserCountsWithPeriod(&period).Get(context.Background(), nil)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.Reports

Get-MgReportEmailAppUsageUserCount -Period $periodId 

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.reports.get_email_app_usage_user_counts_with_period("{period}").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,Mail For Mac,Outlook For Mac,Outlook For Windows,Outlook For Mobile,Other For Mobile,Outlook For Web,POP3 App,IMAP4 App,SMTP App,Report Date,Report Period