reportRoot: getM365AppPlatformUserCountsreportRoot: getM365AppPlatformUserCounts

名前空間: microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph のバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。Use of these APIs in production applications is not supported. API が v2.0 で利用できるかどうかを確認するには、 バージョン セレクターを使用します。To determine whether an API is available in v1.0, use the Version selector.

各プラットフォーム (Windows、Mac、web、およびモバイル) について、すべてのアプリにわたるアクティブユーザーの傾向を示すレポートを取得します。Get a report that provides the trend of active users across all apps for each platform – Windows, Mac, web, and mobile - in your organization.

注: さまざまなレポートのビューと名前の詳細については、「 microsoft 365 reports-microsoft 365 Apps usage」を参照してください。Note: For details about different report views and names, see Microsoft 365 reports - Microsoft 365 Apps usage.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校アカウント)Delegated (work or school account) Reports.Read.AllReports.Read.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Reports.Read.AllReports.Read.All

注: 委任されたアクセス許可を使用して、ユーザーの代わりにアプリがサービス利用状況レポートを読み取ることができるようにするには、テナント管理者がユーザーに適切な Azure AD 制限付き管理者ロールを割り当てる必要があります。Note: For delegated permissions to allow apps to read service usage reports on behalf of a user, the tenant administrator must have assigned the user the appropriate Azure AD limited administrator role. 詳細については、「 Microsoft 365 の使用状況レポートを読み取るための api の承認」を参照してください。For details, see Authorization for APIs to read Microsoft 365 usage reports.

HTTP 要求HTTP request

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

関数パラメーターFunction parameters

要求 URL に、次のパラメーターと有効な値を指定します。In the request URL, provide the following parameter with a valid value.

パラメーターParameter Type 説明Description
periodperiod 文字列string レポートを集計する期間の長さを指定します。Specifies the length of time over which the report is aggregated. {Period_value} に対してサポートされている値は、、、 D7 D30 D90 、および D180 です。The supported values for {period_value} are: D7, D30, D90, and D180. これらの値は、Dn の形式 (n はレポートを集計する日数) に従います。These values follow the format Dn where n represents the number of days over which the report is aggregated. 必須。Required.

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

このメソッドでは、応答をカスタマイズするための $format OData クエリ パラメーターをサポートします。This method supports the $format OData query parameter to customize the response. 既定の出力の種類は、text/csv です。The default output type is text/csv. ただし、出力の種類を指定する場合は、OData クエリパラメーターを使用して、 $format text/csv または application/json に既定の出力を設定できます。However, if you want to specify the output type, you can use the OData $format query parameter to set the default output to text/csv or application/json.

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body with this method.

応答Response

成功した場合、このメソッドは応答 200 OK コードと、応答本文で report オブジェクトを返します。If successful, this method returns a 200 OK response code and a report object in the response body. レポートデータは、 reportオブジェクトのcontentプロパティに含まれています。Report data is contained in the content property of the report object.

CSVCSV

成功した場合、 content プロパティを要求すると、 302 Found レポートの事前認証されたダウンロード URL にリダイレクトする応答が返されます。If successful, requesting the content property returns a 302 Found response that redirects to a preauthenticated download URL for the report. その URL は、応答の Location ヘッダー内にあります。That URL can be found in the Location header in the response.

事前認証されたダウンロード URL は、短期間 (数分) のみ有効で、Authorization ヘッダーを必要としません。Preauthenticated download URLs are only valid for a short period of time (a few minutes) and do not require an Authorization header.

この CSV ファイルには、次の列ヘッダーがあります。The CSV file has the following headers for columns:

  • レポートの更新日Report Refresh Date
  • レポート期間Report Period
  • レポート日付Report Date
  • OutlookOutlook
  • WordWord
  • ExcelExcel
  • PowerPointPowerPoint
  • OneNoteOneNote
  • TeamsTeams

JSONJSON

成功した場合、 content プロパティを要求すると、応答 200 OK コードと、応答本文で JSON オブジェクトが返されます。If successful, requesting the content property returns a 200 OK response code and a JSON object in response body.

Examples

例 1: CSV 出力Example 1: CSV output

CSV を出力する例を次に示します。The following is an example that outputs CSV.

要求Request

コンテンツプロパティを取得する要求の例を次に示します。The following is an example of the request to get the content property.

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

応答Response

応答の例を次に示します。The following is an example of the response.

HTTP/1.1 302 Found
Content-Type: text/plain
Location: https://reports.office.com/data/download/JDFKdf2_eJXKS034dbc7e0t__XDe

302 リダイレクトに従うと、ダウンロードされる CSV ファイルは次のスキーマを持つことになります。Follow the 302 redirection and the CSV file that downloads will have the following schema.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

Report Refresh Date,Report Period,Report Date,Windows,Mac,Mobile,Web

例 2: JSON 出力Example 2: JSON output

次の例は、JSON を返します。The following is an example that returns JSON.

要求Request

コンテンツプロパティを取得する要求の例を次に示します。The following is an example of the request to get the content property.

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

応答Response

応答の例を次に示します。The following is an example of the response.

注: 読みやすくするために、ここに示す応答オブジェクトは短くされている場合があります。実際の呼び出しからは、すべてのプロパティが返されます。Note: The response object shown here might be shortened for readability. All the properties will be returned from an actual call.

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
        }
      ]
    }
  ]
}