reportRoot: getSharePointSiteUsageDetailreportRoot: getSharePointSiteUsageDetail

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

SharePoint サイトの使用状況に関する詳細を取得します。Get details about SharePoint site usage.

注: 別のレポートのビューとレポート名についての詳細は、「Office 365 レポート: SharePoint サイトの使用状況」を参照してください。Note: For details about different report views and names, see Office 365 Reports - SharePoint site 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

HTTP 要求HTTP request

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

関数パラメーターFunction parameters

要求 URL に、次のうちの 1 つのパラメーターと有効な値を指定します。In the request URL, provide one of the following parameters 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.
datedate 日付Date 何らかのアクティビティを実行したユーザーを表示する日付を指定します。Specifies the date for which you would like to view the users who performed any activity. {date_value} は YYYY-MM-DD の形式にします。{date_value} must have a format of YYYY-MM-DD. このレポートは、過去 30 日間のみ利用可能であり、{date_value} はその範囲内の日付である必要があります。As this report is only available for the past 30 days, {date_value} should be a date from that range.

注: URL に期間または日付を設定する必要があります。Note: You need to set either period or date in the URL.

このメソッドは、応答をカスタマイズするための $format$top$skipTokenOData クエリ パラメーターをサポートします。This method supports the $format, $top, and $skipToken OData query parameters 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 set to text/csv or application/json.

要求ヘッダーRequest headers

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

応答Response

CSVCSV

成功すると、レポートの事前認証されたダウンロード URL にリダイレクトする 302 Found 応答が返されます。If successful, this method 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
  • サイト IdSite Id
  • サイトの URLSite URL
  • 所有者の表示名Owner Display Name
  • 削除済みIs Deleted
  • 最後のアクティビティ日付Last Activity Date
  • ファイル数File Count
  • アクティブなファイル数Active File Count
  • ページ ビューの数Page View Count
  • アクセスしたページ数Visited Page Count
  • 使用済みストレージ (バイト)Storage Used (Byte)
  • 割り当て済みストレージ (バイト)Storage Allocated (Byte)
  • ルート Web テンプレートRoot Web Template
  • 所有者のプリンシパル名Owner Principal Name
  • レポート期間Report Period

JSONJSON

成功した場合、このメソッド200 OKは応答コードと、応答本文で**Sharepointsite使い方詳細** オブジェクトを返します。If successful, this method returns a 200 OK response code and a sharePointSiteUsageDetail object in the response body.

この要求の既定のページサイズは200アイテムです。The default page size for this request is 200 items.

Example

CSVCSV

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

要求Request

要求の例を次に示します。The following is an example of the request.

GET https://graph.microsoft.com/beta/reports/getSharePointSiteUsageDetail(period='D7')?$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,Site Id,Site URL,Owner Display Name,Is Deleted,Last Activity Date,File Count,Active File Count,Page View Count,Visited Page Count,Storage Used (Byte),Storage Allocated (Byte),Root Web Template,Owner Principal Name,Report Period

JSONJSON

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

要求Request

要求の例を次に示します。The following is an example of the request.

GET https://graph.microsoft.com/beta/reports/getSharePointSiteUsageDetail(period='D7')?$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: 484

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.sharePointSiteUsageDetail)", 
  "value": [
    {
      "reportRefreshDate": "2017-09-01", 
      "siteId": "siteId-value", 
      "siteUrl": "siteUrl-value", 
      "ownerDisplayName": "ownerDisplayName-value", 
      "ownerPrincipalName": "ownerPrincipalName-value", 
      "isDeleted": false, 
      "lastActivityDate": "2017-09-01", 
      "fileCount": 170, 
      "activeFileCount": 25, 
      "pageViewCount": 7, 
      "visitedPageCount": 3, 
      "storageUsedInBytes": 63442116, 
      "storageAllocatedInBytes": 2748779094400, 
      "rootWebTemplate": "Publishing Site", 
      "reportPeriod": "7"
    }
  ]
}