[アーティクル]
10/31/2023
7 人の共同作成者
フィードバック
この記事の内容
名前空間: microsoft.graph
organization内のプラットフォーム (Windows、Mac、Web、モバイル) ごとに、すべてのアプリにわたるアクティブ ユーザーの傾向を示すレポートを取得します。
メモ: さまざまなレポート ビューと名前の詳細については、「管理センターの Microsoft 365 レポート - Microsoft 365 Apps使用状況 」を参照してください。
この API は、次の国内クラウド展開 で使用できます。
グローバル サービス
米国政府機関 L4
米国政府機関 L5 (DOD)
21Vianet が運営する中国
✅
❌
❌
❌
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ 、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類 」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください 。
アクセス許可の種類
最小特権アクセス許可
特権の高いアクセス許可
委任 (職場または学校アカウント)
Reports.Read.All
注意事項なし。
委任 (個人用 Microsoft アカウント)
サポートされていません。
サポートされていません。
アプリケーション
Reports.Read.All
注意事項なし。
メモ: アプリがユーザーに代わってサービス使用状況レポートを読み取ることができるように委任されたアクセス許可を付与するには、テナント管理者がユーザーに適切なMicrosoft Entra制限付き管理者ロールを割り当てる必要があります。 詳細については、「Microsoft 365 利用状況レポートを読み込むための API 用の承認 」を参照してください。
HTTP 要求
GET /reports/getM365AppPlatformUserCounts(period='{period_value}')
関数パラメーター
要求 URL に、次のパラメーターと有効な値を指定します。
パラメーター
型
説明
period
文字列
レポートを集計する期間の長さを指定します。 {period_value} でサポートされる値は、 D7
、 D30
、 D90
、および D180
です。 これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。 必須。
オプションのクエリ パラメーター
このメソッドは、OData クエリ パラメーター を$format
サポートして応答をカスタマイズします。 既定の出力の種類は です text/csv
。 ただし、出力の種類を指定する場合は、OData $format
クエリ パラメーターを使用して、既定の出力を または application/json
にtext/csv
設定できます。
名前
説明
Authorization
ベアラー {token}。 必須です。 認証と承認 の詳細については、こちらをご覧ください。
要求本文
このメソッドには、要求本文を指定しません。
応答
CSV
成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found
応答が返されます。 その URL は、応答の Location
ヘッダー内にあります。
事前認証されたダウンロード URL は、短期間 (数分) のみ有効で、Authorization
ヘッダーを必要としません。
この CSV ファイルには、次の列ヘッダーがあります。
レポートの更新日
レポート期間
レポート日付
Windows
Mac
Mobile
Web
JSON
成功した場合、このメソッドは 200 OK
応答コードと JSON オブジェクトを応答本文で返します。
例
例 1: CSV 出力
CSV を出力する例を次に示します。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/reports/getM365AppPlatformUserCounts(period='D7')?$format=text/csv
// 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.GetM365AppPlatformUserCountsWithPeriod("{period}").GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Format = "text/csv";
});
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc reports get-m365-app-platform-user-counts-with-period get --period {period-id}
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphreports "github.com/microsoftgraph/msgraph-sdk-go/reports"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestFormat := "text/csv"
requestParameters := &graphreports.ReportsGetM365AppPlatformUserCounts(period='{period}')RequestBuilderGetQueryParameters{
Format: &requestFormat,
}
configuration := &graphreports.ReportsGetM365AppPlatformUserCounts(period='{period}')RequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
period := "{period}"
graphClient.Reports().GetM365AppPlatformUserCountsWithPeriod(&period).Get(context.Background(), configuration)
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
graphClient.reports().getM365AppPlatformUserCountsWithPeriod("{period}").get(requestConfiguration -> {
requestConfiguration.queryParameters.format = "text/csv";
});
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
let stream = await client.api('/reports/getM365AppPlatformUserCounts(period='D7')')
.get();
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Reports\GetM365AppPlatformUserCounts(period='{period}')\GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetRequestConfiguration();
$queryParameters = GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->format = "text/csv";
$requestConfiguration->queryParameters = $queryParameters;
$graphServiceClient->reports()->getM365AppPlatformUserCountsWithPeriod('{period}', )->get($requestConfiguration)->wait();
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
from msgraph import GraphServiceClient
from msgraph.generated.reports.get_m365_app_platform_user_counts(period='{period}').get_m365_app_platform_user_counts_with_period_request_builder import GetM365AppPlatformUserCountsWithPeriodRequestBuilder
graph_client = GraphServiceClient(credentials, scopes)
query_params = GetM365AppPlatformUserCountsWithPeriodRequestBuilder.GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetQueryParameters(
format = "text/csv",
)
request_configuration = GetM365AppPlatformUserCountsWithPeriodRequestBuilder.GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)
await graph_client.reports.get_m365_app_platform_user_counts_with_period("{period}").get(request_configuration = request_configuration)
プロジェクトに 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,Report Period,Report Date,Windows,Mac,Mobile,Web
例 2: JSON 出力
JSON を返す例を次に示します。
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/v1.0/reports/getM365AppPlatformUserCounts(period='D7')?$format=application/json
// 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.GetM365AppPlatformUserCountsWithPeriod("{period}").GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Format = "application/json";
});
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc reports get-m365-app-platform-user-counts-with-period get --period {period-id}
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphreports "github.com/microsoftgraph/msgraph-sdk-go/reports"
//other-imports
)
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)
requestFormat := "application/json"
requestParameters := &graphreports.ReportsGetM365AppPlatformUserCounts(period='{period}')RequestBuilderGetQueryParameters{
Format: &requestFormat,
}
configuration := &graphreports.ReportsGetM365AppPlatformUserCounts(period='{period}')RequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
period := "{period}"
graphClient.Reports().GetM365AppPlatformUserCountsWithPeriod(&period).Get(context.Background(), configuration)
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
graphClient.reports().getM365AppPlatformUserCountsWithPeriod("{period}").get(requestConfiguration -> {
requestConfiguration.queryParameters.format = "application/json";
});
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
let stream = await client.api('/reports/getM365AppPlatformUserCounts(period='D7')')
.get();
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Reports\GetM365AppPlatformUserCounts(period='{period}')\GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetRequestConfiguration();
$queryParameters = GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->format = "application/json";
$requestConfiguration->queryParameters = $queryParameters;
$graphServiceClient->reports()->getM365AppPlatformUserCountsWithPeriod('{period}', )->get($requestConfiguration)->wait();
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
from msgraph import GraphServiceClient
from msgraph.generated.reports.get_m365_app_platform_user_counts(period='{period}').get_m365_app_platform_user_counts_with_period_request_builder import GetM365AppPlatformUserCountsWithPeriodRequestBuilder
graph_client = GraphServiceClient(credentials, scopes)
query_params = GetM365AppPlatformUserCountsWithPeriodRequestBuilder.GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetQueryParameters(
format = "application/json",
)
request_configuration = GetM365AppPlatformUserCountsWithPeriodRequestBuilder.GetM365AppPlatformUserCountsWithPeriodRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)
await graph_client.reports.get_m365_app_platform_user_counts_with_period("{period}").get(request_configuration = request_configuration)
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 156
{
"value": [
{
"reportRefreshDate": "2020-06-30",
"reportPeriod": 7,
"userCounts": [
{
"reportDate": "2020-06-30",
"windows": 1445,
"mac": 146,
"mobile": 1131,
"web": 1080
}
]
}
]
}