コンテンツにスキップ
API ReferenceFunctionsuseReportWebVitals

useReportWebVitals

useReportWebVitals フックを使用すると、Core Web Vitals をレポートでき、分析サービスと組み合わせて使用できます。

useReportWebVitals に渡された新しい関数は、それまでに利用可能なメトリクスとともに呼び出されます。重複したデータのレポートを防ぐために、コールバック関数の参照が変更されないようにしてください（以下のコード例を参照）。

app/_components/web-vitals.js
'use client'
 
import { useReportWebVitals } from 'next/web-vitals'
 
const logWebVitals = (metric) => {
  console.log(metric)
}
 
export function WebVitals() {
  useReportWebVitals(logWebVitals)
 
  return null
}
app/layout.js
import { WebVitals } from './_components/web-vitals'
 
export default function Layout({ children }) {
  return (
    <html>
      <body>
        <WebVitals />
        {children}
      </body>
    </html>
  )
}

useReportWebVitals フックは 'use client' ディレクティブを必要とするため、最もパフォーマンスの高いアプローチは、ルートレイアウトがインポートする別のコンポーネントを作成することです。これにより、クライアント境界は WebVitals コンポーネントに限定されます。

useReportWebVitals

フックの引数として渡される metric オブジェクトには、いくつかのプロパティが含まれています。

  • id: 現在のページロードのコンテキストにおけるメトリクスのユニークな識別子。
  • name: パフォーマンスメトリクスの名前。可能な値としては、Webアプリケーション固有のWeb Vitalsメトリクス（TTFB、FCP、LCP、FID、CLS）の名前が含まれます。
  • delta: メトリクスの現在の値と以前の値との差。値は通常ミリ秒単位で、時間の経過に伴うメトリクス値の変化を表します。
  • entries: メトリクスに関連付けられたPerformance Entriesの配列。これらのエントリは、メトリクスに関連するパフォーマンスイベントの詳細情報を提供します。
  • navigationType: メトリクス収集をトリガーしたナビゲーションのタイプを示します。可能な値には、"navigate"、"reload"、"back_forward"、"prerender" が含まれます。
  • rating: メトリクス値の定性的な評価で、パフォーマンスの評価を提供します。可能な値は "good"、"needs-improvement"、"poor" です。この評価は通常、メトリクス値を、許容範囲内または最適ではないパフォーマンスを示す事前定義されたしきい値と比較することによって決定されます。
  • value: パフォーマンスエントリの実際の値または期間（通常はミリ秒単位）。この値は、メトリクスによって追跡されているパフォーマンスの側面を定量的に測定します。値のソースは、測定されている特定のメトリクスに依存し、さまざまなPerformance APIから取得される可能性があります。

Web Vitals

Web Vitals は、ウェブページのユーザーエクスペリエンスを捉えることを目的とした有用なメトリクスのセットです。以下の Web Vitals がすべて含まれています。

これらのメトリクスのすべての結果は、name プロパティを使用して処理できます。

app/components/web-vitals.tsx
'use client'
 
import { useReportWebVitals } from 'next/web-vitals'
 
type ReportWebVitalsCallback = Parameters<typeof useReportWebVitals>[0]
 
const handleWebVitals: ReportWebVitalsCallback = (metric) => {
  switch (metric.name) {
    case 'FCP': {
      // handle FCP results
    }
    case 'LCP': {
      // handle LCP results
    }
    // ...
  }
}
 
export function WebVitals() {
  useReportWebVitals(handleWebVitals)
}

結果を外部システムに送信する

サイトの実際のユーザーパフォーマンスを測定および追跡するために、結果を任意のエンドポイントに送信できます。例：

function postWebVitals(metrics) {
  const body = JSON.stringify(metric)
  const url = 'https://example.com/analytics'
 
  // Use `navigator.sendBeacon()` if available, falling back to `fetch()`.
  if (navigator.sendBeacon) {
    navigator.sendBeacon(url, body)
  } else {
    fetch(url, { body, method: 'POST', keepalive: true })
  }
}
 
useReportWebVitals(postWebVitals)

知っておくと便利: Google Analytics を使用する場合、id 値を使用すると、メトリクスの分布を手動で構築できます（パーセンタイルなどを計算するため）。

useReportWebVitals(metric => {
  // Use `window.gtag` if you initialized Google Analytics as this example:
  // https://github.com/vercel/next.js/blob/canary/examples/with-google-analytics
  window.gtag('event', metric.name, {
    value: Math.round(metric.name === 'CLS' ? metric.value * 1000 : metric.value), // values must be integers
    event_label: metric.id, // id unique to current page load
    non_interaction: true, // avoids affecting bounce rate.
  });
}

Google Analytics への結果送信 について続きを読む。