reportRoot: getFormsUserActivityUserDetail

  • [アーティクル]

名前空間: microsoft.graph

重要

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

ユーザーが実行したフォーム アクティビティの詳細を示すレポートを取得します。

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

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

アクセス許可

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

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

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

HTTP 要求

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

関数パラメーター

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

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

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

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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。

要求本文

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

応答

CSV

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

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

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

  • レポートの更新日
  • レポート期間
  • 作成されたカウント
  • 応答された数

JSON

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

例

例 1: CSV 出力

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

要求

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

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

応答

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

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 Activity Date, Report Period, Created Count, Responded Count

例 2: JSON 出力

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

要求

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

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

応答

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

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

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

{
    "@odata.nextLink": "https://graph.microsoft.com/graph/beta/data/72f988bf86f141af91ab2d7cd011db47/Microsoft.O365Reporting.getFormsUserActivityUserDetail(period='D7')?$format=application/json&$skiptoken=MDowOlczc2lkRzlyWlc0aU9pSXJVa2xFT241TlN6QmFRVXB5UTNnd2EyTkJRVUZCUVVGQlFVTkJQVDBqVWxRNk1pTlVVa002TWlOSlUxWTZNaU5KUlU4Nk5qVTFOamNpTENKeVlXNW5aU0k2ZXlKdGFXNGlPaUl3TlVNeFJFWkdSa1pHUmtaR1F5SXNJbTFoZUNJNklrWkdJbjE5WFE",

    "value": [
        {
            "reportRefreshDate": "2022-06-08",
            "userPrincipalName": "EFED463AC35A1609AB43FB40E61E94E8",
            "lastActivityDate": "",
            "formsUsageUserDetailsByPeriod": [
                {
                    "reportPeriod": 7,
                    "createdCount": 0,
                    "respondedCount": 0
                }
            ]
        }
    ]
}