logoNext.js 日本語
ドキュメントブログ学習
はじめに/API リファレンス/関数/generateMetadata

MetadataオブジェクトとgenerateMetadataオプション

このページでは、generateMetadataと静的metadataオブジェクトを使用したすべての設定ベースのメタデータオプションについて説明します。

import { Metadata } from 'next'

// 静的メタデータ
export const metadata: Metadata = {
  title: '...',
}

// または動的メタデータ
export async function generateMetadata({ params }) {
  return {
    title: '...',
  }
}
// 静的メタデータ
export const metadata = {
  title: '...',
}

// または動的メタデータ
export async function generateMetadata({ params }) {
  return {
    title: '...',
  }
}

知っておくと良いこと:

  • metadataオブジェクトとgenerateMetadata関数のエクスポートはServer Componentsでのみサポートされています。
  • 同じルートセグメントからmetadataオブジェクトとgenerateMetadata関数の両方をエクスポートすることはできません。

metadataオブジェクト

静的メタデータを定義するには、layout.jsまたはpage.jsファイルからMetadataオブジェクトをエクスポートします。

import { Metadata } from 'next'

export const metadata: Metadata = {
  title: '...',
  description: '...',
}

export default function Page() {}
export const metadata = {
  title: '...',
  description: '...',
}

export default function Page() {}

サポートされているオプションの完全なリストについては、Metadataフィールドを参照してください。

generateMetadata関数

現在のルートパラメータ、外部データ、または親セグメントのmetadataなど、動的な情報に依存する動的メタデータは、Metadataオブジェクトを返すgenerateMetadata関数をエクスポートすることで設定できます。

import { Metadata, ResolvingMetadata } from 'next'

type Props = {
  params: { id: string }
  searchParams: { [key: string]: string | string[] | undefined }
}

export async function generateMetadata(
  { params, searchParams }: Props,
  parent: ResolvingMetadata
): Promise<Metadata> {
  // ルートパラメータを読み取る
  const id = params.id

  // データを取得
  const product = await fetch(`https://.../${id}`).then((res) => res.json())

  // オプションで親メタデータにアクセスして拡張（置換ではなく）
  const previousImages = (await parent).openGraph?.images || []

  return {
    title: product.title,
    openGraph: {
      images: ['/some-specific-page-image.jpg', ...previousImages],
    },
  }
}

export default function Page({ params, searchParams }: Props) {}
export async function generateMetadata({ params, searchParams }, parent) {
  // ルートパラメータを読み取る
  const id = params.id

  // データを取得
  const product = await fetch(`https://.../${id}`).then((res) => res.json())

  // オプションで親メタデータにアクセスして拡張（置換ではなく）
  const previousImages = (await parent).openGraph?.images || []

  return {
    title: product.title,
    openGraph: {
      images: ['/some-specific-page-image.jpg', ...previousImages],
    },
  }
}

export default function Page({ params, searchParams }) {}

パラメータ

generateMetadata関数は以下のパラメータを受け取ります:

  • props - 現在のルートのパラメータを含むオブジェクト:

    • params - generateMetadataが呼び出されたセグメントまでの動的ルートパラメータオブジェクトを含むオブジェクト。例:

      ルートURLparams
      app/shop/[slug]/page.js/shop/1{ slug: '1' }
      app/shop/[tag]/[item]/page.js/shop/1/2{ tag: '1', item: '2' }
      app/shop/[...slug]/page.js/shop/1/2{ slug: ['1', '2'] }

    • searchParams - 現在のURLの検索パラメータを含むオブジェクト。例:

      URLsearchParams
      /shop?a=1{ a: '1' }
      /shop?a=1&b=2{ a: '1', b: '2' }
      /shop?a=1&a=2{ a: ['1', '2'] }

  • parent - 親ルートセグメントから解決されたメタデータのPromise。

戻り値

generateMetadataは、1つ以上のメタデータフィールドを含むMetadataオブジェクトを返す必要があります。

知っておくと良いこと:

  • メタデータがランタイム情報に依存しない場合は、generateMetadataではなく静的metadataオブジェクトを使用して定義する必要があります。
  • fetchリクエストは、generateMetadata、generateStaticParams、レイアウト、ページ、およびServer Components間で同じデータに対して自動的にメモ化されます。fetchが利用できない場合は、Reactのcacheを使用できます。
  • searchParamsはpage.jsセグメントでのみ利用可能です。
  • Next.jsのredirect()およびnotFound()メソッドもgenerateMetadata内で使用できます。

Metadataフィールド

title

title属性はドキュメントのタイトルを設定するために使用されます。文字列またはオプションのテンプレートオブジェクトとして定義できます。

文字列

layout.js | page.js
export const metadata = {
  title: 'Next.js',
}
<head> output
<title>Next.js</title>

テンプレートオブジェクト

import { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    template: '...',
    default: '...',
    absolute: '...',
  },
}
export const metadata = {
  title: {
    default: '...',
    template: '...',
    absolute: '...',
  },
}
デフォルト

title.defaultは、titleを定義していない子ルートセグメントにフォールバックタイトルを提供するために使用できます。

app/layout.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    default: 'Acme',
  },
}
app/about/page.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {}

// 出力: <title>Acme</title>
テンプレート

title.templateは、子ルートセグメントで定義されたtitlesにプレフィックスまたはサフィックスを追加するために使用できます。

import { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    template: '%s | Acme',
    default: 'Acme', // テンプレートを作成する際はデフォルトが必要
  },
}
export const metadata = {
  title: {
    template: '%s | Acme',
    default: 'Acme', // テンプレートを作成する際はデフォルトが必要
  },
}
import { Metadata } from 'next'

export const metadata: Metadata = {
  title: 'About',
}

// 出力: <title>About | Acme</title>
export const metadata = {
  title: 'About',
}

// 出力: <title>About | Acme</title>

知っておくと良いこと:

  • title.templateは、定義されたセグメントではなく、子ルートセグメントに適用されます。つまり:

    • title.templateを追加する際はtitle.defaultが必須です。
    • layout.jsで定義されたtitle.templateは、同じルートセグメントのpage.jsで定義されたtitleには適用されません。
    • page.jsで定義されたtitle.templateは効果がありません。ページは常に終端セグメントであるためです（子ルートセグメントを持ちません）。

  • ルートがtitleまたはtitle.defaultを定義していない場合、title.templateは効果がありません。

絶対

title.absoluteは、親セグメントで設定されたtitle.templateを無視するタイトルを提供するために使用できます。

import { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    template: '%s | Acme',
  },
}
export const metadata = {
  title: {
    template: '%s | Acme',
  },
}
import { Metadata } from 'next'

export const metadata: Metadata = {
  title: {
    absolute: 'About',
  },
}

// 出力: <title>About</title>
export const metadata = {
  title: {
    absolute: 'About',
  },
}

// 出力: <title>About</title>

知っておくと良いこと:

  • layout.js

    • title（文字列）とtitle.defaultは、子セグメント（自身のtitleを定義していない）のデフォルトタイトルを定義します。存在する場合、最も近い親セグメントのtitle.templateを拡張します。
    • title.absoluteは、子セグメントのデフォルトタイトルを定義します。親セグメントのtitle.templateを無視します。
    • title.templateは、子セグメントの新しいタイトルテンプレートを定義します。

  • page.js

    • ページが自身のタイトルを定義していない場合、最も近い親の解決済みタイトルが使用されます。
    • title（文字列）は、ルートのタイトルを定義します。存在する場合、最も近い親セグメントのtitle.templateを拡張します。
    • title.absoluteは、ルートタイトルを定義します。親セグメントのtitle.templateを無視します。
    • title.templateはpage.jsでは効果がありません。ページは常にルートの終端セグメントであるためです。

description

layout.js | page.js
export const metadata = {
  description: 'The React Framework for the Web',
}
<head> output
<meta name="description" content="The React Framework for the Web" />

基本フィールド

layout.js | page.js
export const metadata = {
  generator: 'Next.js',
  applicationName: 'Next.js',
  referrer: 'origin-when-cross-origin',
  keywords: ['Next.js', 'React', 'JavaScript'],
  authors: [{ name: 'Seb' }, { name: 'Josh', url: 'https://nextjs.org' }],
  colorScheme: 'dark',
  creator: 'Jiachi Liu',
  publisher: 'Sebastian Markbåge',
  formatDetection: {
    email: false,
    address: false,
    telephone: false,
  },
}
<head> output
<meta name="application-name" content="Next.js" />
<meta name="author" content="Seb" />
<link rel="author" href="https://nextjs.org" />
<meta name="author" content="Josh" />
<meta name="generator" content="Next.js" />
<meta name="keywords" content="Next.js,React,JavaScript" />
<meta name="referrer" content="origin-when-cross-origin" />
<meta name="color-scheme" content="dark" />
<meta name="creator" content="Jiachi Liu" />
<meta name="publisher" content="Sebastian Markbåge" />
<meta name="format-detection" content="telephone=no, address=no, email=no" />

metadataBase

metadataBaseは、完全修飾URLを必要とするmetadataフィールドにベースURLプレフィックスを設定する便利なオプションです。

  • metadataBaseにより、現在のルートセグメント以下で定義されたURLベースのmetadataフィールドで、絶対URLの代わりに相対パスを使用できます。
  • フィールドの相対パスは、metadataBaseと組み合わされて完全修飾URLを形成します。
  • 設定されていない場合、metadataBaseはデフォルト値で自動的に設定されます。
layout.js | page.js
export const metadata = {
  metadataBase: new URL('https://acme.com'),
  alternates: {
    canonical: '/',
    languages: {
      'en-US': '/en-US',
      'de-DE': '/de-DE',
    },
  },
  openGraph: {
    images: '/og-image.png',
  },
}
<head> output
<link rel="canonical" href="https://acme.com" />
<link rel="alternate" hreflang="en-US" href="https://acme.com/en-US" />
<link rel="alternate" hreflang="de-DE" href="https://acme.com/de-DE" />
<meta property="og:image" content="https://acme.com/og-image.png" />

知っておくと良いこと:

  • metadataBaseは通常、すべてのルートにわたってURLベースのmetadataフィールドを適用するためにルートapp/layout.jsで設定されます。
  • 絶対URLを必要とするすべてのURLベースのmetadataフィールドは、metadataBaseオプションで設定できます。
  • metadataBaseにはサブドメイン（例: https://app.acme.com）またはベースパス（例: https://acme.com/start/from/here）を含めることができます。
  • metadataフィールドが絶対URLを提供する場合、metadataBaseは無視されます。
  • metadataBaseを設定せずにURLベースのmetadataフィールドで相対パスを使用すると、ビルドエラーが発生します。
  • Next.jsは、metadataBase（例: https://acme.com/）と相対フィールド（例: /path）の間の重複するスラッシュを単一のスラッシュ（例: https://acme.com/path）に正規化します。

デフォルト値

設定されていない場合、metadataBaseにはデフォルト値があります

  • VERCEL_URLが検出された場合: https://${process.env.VERCEL_URL}、それ以外の場合はhttp://localhost:${process.env.PORT || 3000}にフォールバックします。
  • デフォルトを上書きする場合、URLを計算するために環境変数を使用することをお勧めします。これにより、ローカル開発、ステージング、および本番環境のURLを設定できます。

URL構成

URL構成は、デフォルトのディレクトリトラバーサルセマンティクスよりも開発者の意図を優先します。

  • metadataBaseとmetadataフィールド間の末尾のスラッシュは正規化されます。
  • metadataフィールドの「絶対」パス（通常はURLパス全体を置き換える）は、「相対」パス（metadataBaseの末尾から開始）として扱われます。

例えば、以下のmetadataBaseがある場合:

import { Metadata } from 'next'

export const metadata: Metadata = {
  metadataBase: new URL('https://acme.com'),
}
export const metadata = {
  metadataBase: new URL('https://acme.com'),
}

上記のmetadataBaseを継承し、独自の値を設定するmetadataフィールドは次のように解決されます:

metadataフィールド解決されたURL
/https://acme.com
./https://acme.com
paymentshttps://acme.com/payments
/paymentshttps://acme.com/payments
./paymentshttps://acme.com/payments
../paymentshttps://acme.com/payments
https://beta.acme.com/paymentshttps://beta.acme.com/payments

openGraph

layout.js | page.js
export const metadata = {
  openGraph: {
    title: 'Next.js',
    description: 'ウェブのためのReactフレームワーク',
    url: 'https://nextjs.org',
    siteName: 'Next.js',
    images: [
      {
        url: 'https://nextjs.org/og.png',
        width: 800,
        height: 600,
      },
      {
        url: 'https://nextjs.org/og-alt.png',
        width: 1800,
        height: 1600,
        alt: 'カスタム代替テキスト',
      },
    ],
    locale: 'en_US',
    type: 'website',
  },
}
<head> output
<meta property="og:title" content="Next.js" />
<meta property="og:description" content="ウェブのためのReactフレームワーク" />
<meta property="og:url" content="https://nextjs.org/" />
<meta property="og:site_name" content="Next.js" />
<meta property="og:locale" content="en_US" />
<meta property="og:image:url" content="https://nextjs.org/og.png" />
<meta property="og:image:width" content="800" />
<meta property="og:image:height" content="600" />
<meta property="og:image:url" content="https://nextjs.org/og-alt.png" />
<meta property="og:image:width" content="1800" />
<meta property="og:image:height" content="1600" />
<meta property="og:image:alt" content="カスタム代替テキスト" />
<meta property="og:type" content="website" />
layout.js | page.js
export const metadata = {
  openGraph: {
    title: 'Next.js',
    description: 'ウェブのためのReactフレームワーク',
    type: 'article',
    publishedTime: '2023-01-01T00:00:00.000Z',
    authors: ['Seb', 'Josh'],
  },
}
<head> output
<meta property="og:title" content="Next.js" />
<meta property="og:description" content="ウェブのためのReactフレームワーク" />
<meta property="og:type" content="article" />
<meta property="article:published_time" content="2023-01-01T00:00:00.000Z" />
<meta property="article:author" content="Seb" />
<meta property="article:author" content="Josh" />

知っておくと便利:

  • Open Graph画像にはファイルベースのメタデータAPIを使用すると便利です。設定エクスポートと実際のファイルを同期させる必要がなく、ファイルベースのAPIが自動的に正しいメタデータを生成します。

robots

import type { Metadata } from 'next'

export const metadata: Metadata = {
  robots: {
    index: false,
    follow: true,
    nocache: true,
    googleBot: {
      index: true,
      follow: false,
      noimageindex: true,
      'max-video-preview': -1,
      'max-image-preview': 'large',
      'max-snippet': -1,
    },
  },
}
<head> output
<meta name="robots" content="noindex, follow, nocache" />
<meta
  name="googlebot"
  content="index, nofollow, noimageindex, max-video-preview:-1, max-image-preview:large, max-snippet:-1"
/>

icons

知っておくと便利: 可能であれば、アイコンにはファイルベースのメタデータAPIを使用することをお勧めします。設定エクスポートと実際のファイルを同期させる必要がなく、ファイルベースのAPIが自動的に正しいメタデータを生成します。

layout.js | page.js
export const metadata = {
  icons: {
    icon: '/icon.png',
    shortcut: '/shortcut-icon.png',
    apple: '/apple-icon.png',
    other: {
      rel: 'apple-touch-icon-precomposed',
      url: '/apple-touch-icon-precomposed.png',
    },
  },
}
<head> output
<link rel="shortcut icon" href="/shortcut-icon.png" />
<link rel="icon" href="/icon.png" />
<link rel="apple-touch-icon" href="/apple-icon.png" />
<link
  rel="apple-touch-icon-precomposed"
  href="/apple-touch-icon-precomposed.png"
/>
layout.js | page.js
export const metadata = {
  icons: {
    icon: [{ url: '/icon.png' }, new URL('/icon.png', 'https://example.com')],
    shortcut: ['/shortcut-icon.png'],
    apple: [
      { url: '/apple-icon.png' },
      { url: '/apple-icon-x3.png', sizes: '180x180', type: 'image/png' },
    ],
    other: [
      {
        rel: 'apple-touch-icon-precomposed',
        url: '/apple-touch-icon-precomposed.png',
      },
    ],
  },
}
<head> output
<link rel="shortcut icon" href="/shortcut-icon.png" />
<link rel="icon" href="/icon.png" />
<link rel="apple-touch-icon" href="/apple-icon.png" />
<link
  rel="apple-touch-icon-precomposed"
  href="/apple-touch-icon-precomposed.png"
/>
<link rel="icon" href="https://example.com/icon.png" />
<link
  rel="apple-touch-icon"
  href="/apple-icon-x3.png"
  sizes="180x180"
  type="image/png"
/>

知っておくと便利: msapplication-*メタタグはMicrosoft EdgeのChromiumビルドではサポートされなくなったため、もはや必要ありません。

themeColor

theme-colorについて詳しく学びましょう。

シンプルなテーマカラー

layout.js | page.js
export const metadata = {
  themeColor: 'black',
}
<head> output
<meta name="theme-color" content="black" />

メディア属性付き

layout.js | page.js
export const metadata = {
  themeColor: [
    { media: '(prefers-color-scheme: light)', color: 'cyan' },
    { media: '(prefers-color-scheme: dark)', color: 'black' },
  ],
}
<head> output
<meta name="theme-color" media="(prefers-color-scheme: light)" content="cyan" />
<meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />

manifest

Web Application Manifest仕様で定義されているウェブアプリケーションマニフェスト。

layout.js | page.js
export const metadata = {
  manifest: 'https://nextjs.org/manifest.json',
}
<head> output
<link rel="manifest" href="https://nextjs.org/manifest.json" />

twitter

Twitterカードマークアップリファレンスについて詳しく学びましょう。

layout.js | page.js
export const metadata = {
  twitter: {
    card: 'summary_large_image',
    title: 'Next.js',
    description: 'ウェブのためのReactフレームワーク',
    siteId: '1467726470533754880',
    creator: '@nextjs',
    creatorId: '1467726470533754880',
    images: ['https://nextjs.org/og.png'],
  },
}
<head> output
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site:id" content="1467726470533754880" />
<meta name="twitter:creator" content="@nextjs" />
<meta name="twitter:creator:id" content="1467726470533754880" />
<meta name="twitter:title" content="Next.js" />
<meta name="twitter:description" content="ウェブのためのReactフレームワーク" />
<meta name="twitter:image" content="https://nextjs.org/og.png" />
layout.js | page.js
export const metadata = {
  twitter: {
    card: 'app',
    title: 'Next.js',
    description: 'ウェブのためのReactフレームワーク',
    siteId: '1467726470533754880',
    creator: '@nextjs',
    creatorId: '1467726470533754880',
    images: {
      url: 'https://nextjs.org/og.png',
      alt: 'Next.jsロゴ',
    },
    app: {
      name: 'twitter_app',
      id: {
        iphone: 'twitter_app://iphone',
        ipad: 'twitter_app://ipad',
        googleplay: 'twitter_app://googleplay',
      },
      url: {
        iphone: 'https://iphone_url',
        ipad: 'https://ipad_url',
      },
    },
  },
}
<head> output
<meta name="twitter:site:id" content="1467726470533754880" />
<meta name="twitter:creator" content="@nextjs" />
<meta name="twitter:creator:id" content="1467726470533754880" />
<meta name="twitter:title" content="Next.js" />
<meta name="twitter:description" content="ウェブのためのReactフレームワーク" />
<meta name="twitter:card" content="app" />
<meta name="twitter:image" content="https://nextjs.org/og.png" />
<meta name="twitter:image:alt" content="Next.jsロゴ" />
<meta name="twitter:app:name:iphone" content="twitter_app" />
<meta name="twitter:app:id:iphone" content="twitter_app://iphone" />
<meta name="twitter:app:id:ipad" content="twitter_app://ipad" />
<meta name="twitter:app:id:googleplay" content="twitter_app://googleplay" />
<meta name="twitter:app:url:iphone" content="https://iphone_url" />
<meta name="twitter:app:url:ipad" content="https://ipad_url" />
<meta name="twitter:app:name:ipad" content="twitter_app" />
<meta name="twitter:app:name:googleplay" content="twitter_app" />

viewport

知っておくと便利: viewportメタタグは以下のデフォルト値で自動的に設定されます。通常、デフォルト設定で十分なため、手動での設定は不要です。ただし、完全性のために情報を提供しています。

layout.js | page.js
export const metadata = {
  viewport: {
    width: 'device-width',
    initialScale: 1,
    maximumScale: 1,
  },
}
<head> output
<meta
  name="viewport"
  content="width=device-width, initial-scale=1, maximum-scale=1"
/>

verification

layout.js | page.js
export const metadata = {
  verification: {
    google: 'google',
    yandex: 'yandex',
    yahoo: 'yahoo',
    other: {
      me: ['my-email', 'my-link'],
    },
  },
}
<head> output
<meta name="google-site-verification" content="google" />
<meta name="y_key" content="yahoo" />
<meta name="yandex-verification" content="yandex" />
<meta name="me" content="my-email" />
<meta name="me" content="my-link" />

appleWebApp

layout.js | page.js
export const metadata = {
  itunes: {
    appId: 'myAppStoreID',
    appArgument: 'myAppArgument',
  },
  appleWebApp: {
    title: 'Apple Web App',
    statusBarStyle: 'black-translucent',
    startupImage: [
      '/assets/startup/apple-touch-startup-image-768x1004.png',
      {
        url: '/assets/startup/apple-touch-startup-image-1536x2008.png',
        media: '(device-width: 768px) and (device-height: 1024px)',
      },
    ],
  },
}
<head> output
<meta
  name="apple-itunes-app"
  content="app-id=myAppStoreID, app-argument=myAppArgument"
/>
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="apple-mobile-web-app-title" content="Apple Web App" />
<link
  href="/assets/startup/apple-touch-startup-image-768x1004.png"
  rel="apple-touch-startup-image"
/>
<link
  href="/assets/startup/apple-touch-startup-image-1536x2008.png"
  media="(device-width: 768px) and (device-height: 1024px)"
  rel="apple-touch-startup-image"
/>
<meta
  name="apple-mobile-web-app-status-bar-style"
  content="black-translucent"
/>

alternates

layout.js | page.js
export const metadata = {
  alternates: {
    canonical: 'https://nextjs.org',
    languages: {
      'en-US': 'https://nextjs.org/en-US',
      'de-DE': 'https://nextjs.org/de-DE',
    },
    media: {
      'only screen and (max-width: 600px)': 'https://nextjs.org/mobile',
    },
    types: {
      'application/rss+xml': 'https://nextjs.org/rss',
    },
  },
}
<head> output
<link rel="canonical" href="https://nextjs.org" />
<link rel="alternate" hreflang="en-US" href="https://nextjs.org/en-US" />
<link rel="alternate" hreflang="de-DE" href="https://nextjs.org/de-DE" />
<link
  rel="alternate"
  media="only screen and (max-width: 600px)"
  href="https://nextjs.org/mobile"
/>
<link
  rel="alternate"
  type="application/rss+xml"
  href="https://nextjs.org/rss"
/>
layout.js | page.js
export const metadata = {
  appLinks: {
    ios: {
      url: 'https://nextjs.org/ios',
      app_store_id: 'app_store_id',
    },
    android: {
      package: 'com.example.android/package',
      app_name: 'app_name_android',
    },
    web: {
      url: 'https://nextjs.org/web',
      should_fallback: true,
    },
  },
}
<head> output
<meta property="al:ios:url" content="https://nextjs.org/ios" />
<meta property="al:ios:app_store_id" content="app_store_id" />
<meta property="al:android:package" content="com.example.android/package" />
<meta property="al:android:app_name" content="app_name_android" />
<meta property="al:web:url" content="https://nextjs.org/web" />
<meta property="al:web:should_fallback" content="true" />

archives

歴史的な価値のある記録、文書、その他の資料のコレクションを記述します（出典）。

layout.js | page.js
export const metadata = {
  archives: ['https://nextjs.org/13'],
}
<head> output
<link rel="archives" href="https://nextjs.org/13" />

assets

layout.js | page.js
export const metadata = {
  assets: ['https://nextjs.org/assets'],
}
<head> output
<link rel="assets" href="https://nextjs.org/assets" />

bookmarks

layout.js | page.js
export const metadata = {
  bookmarks: ['https://nextjs.org/13'],
}
<head> output
<link rel="bookmarks" href="https://nextjs.org/13" />

category

layout.js | page.js
export const metadata = {
  category: 'technology',
}
<head> output
<meta name="category" content="technology" />

other

すべてのメタデータオプションは組み込みのサポートでカバーされるべきですが、サイト固有のカスタムメタデータタグや、新しくリリースされたメタデータタグがある場合があります。otherオプションを使用して、任意のカスタムメタデータタグをレンダリングできます。

layout.js | page.js
export const metadata = {
  other: {
    custom: 'meta',
  },
}
<head> output
<meta name="custom" content="meta" />

サポートされていないメタデータ

以下のメタデータタイプは現在組み込みでサポートされていません。ただし、レイアウトやページ内で直接レンダリングすることは可能です。

メタデータ推奨方法
<meta http-equiv="...">redirect()、ミドルウェア、セキュリティヘッダー を使用して適切なHTTPヘッダーを設定
<base>レイアウトまたはページ内で直接タグをレンダリング
<noscript>レイアウトまたはページ内で直接タグをレンダリング
<style>Next.jsでのスタイリング を参照
<script>スクリプトの使用方法 を参照
<link rel="stylesheet" />スタイルシートをレイアウトまたはページ内で直接import
<link rel="preload />ReactDOM preloadメソッド を使用
<link rel="preconnect" />ReactDOM preconnectメソッド を使用
<link rel="dns-prefetch" />ReactDOM prefetchDNSメソッド を使用

リソースヒント

<link>要素には、外部リソースが必要になる可能性があることをブラウザにヒントするためのrelキーワードがいくつかあります。ブラウザはこの情報を使用して、キーワードに応じたプリロード最適化を適用します。

メタデータAPIはこれらのヒントを直接サポートしていませんが、新しいReactDOMメソッドを使用してドキュメントの<head>に安全に挿入できます。

'use client'

import ReactDOM from 'react-dom'

export function PreloadResources() {
  ReactDOM.preload('...', { as: '...' })
  ReactDOM.preconnect('...', { crossOrigin: '...' })
  ReactDOM.prefetchDNS('...')

  return null
}
'use client'

import ReactDOM from 'react-dom'

export function PreloadResources() {
  ReactDOM.preload('...', { as: '...' })
  ReactDOM.preconnect('...', { crossOrigin: '...' })
  ReactDOM.prefetchDNS('...')

  return null
}

ページレンダリング（ブラウザ）ライフサイクルの早い段階でリソースの読み込みを開始します。MDNドキュメント。

ReactDOM.preload(href: string, options: { as: string })
<head> output
<link rel="preload" href="..." as="..." />

オリジンへの接続を事前に開始します。MDNドキュメント。

ReactDOM.preconnect(href: string, options?: { crossOrigin?: string })
<head> output
<link rel="preconnect" href="..." crossorigin />

リソースが要求される前にドメイン名の解決を試みます。MDNドキュメント。

ReactDOM.prefetchDNS(href: string)
<head> output
<link rel="dns-prefetch" href="..." />

知っておくと便利:

  • これらのメソッドは現在、クライアントコンポーネントでのみサポートされており、初期ページロード時にはサーバーサイドレンダリング (SSR) されます。
  • next/font、next/image、next/scriptなどのNext.js組み込み機能は、関連するリソースヒントを自動的に処理します。
  • React 18.3にはまだReactDOM.preload、ReactDOM.preconnect、ReactDOM.preconnectDNSの型定義が含まれていません。型エラーを回避するために// @ts-ignoreを一時的な解決策として使用できます。

型

Metadata型を使用してメタデータに型安全性を追加できます。組み込みのTypeScriptプラグインをIDEで使用している場合、型を手動で追加する必要はありませんが、明示的に追加することも可能です。

metadataオブジェクト

import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: 'Next.js',
}

generateMetadata関数

通常の関数

import type { Metadata } from 'next'

export function generateMetadata(): Metadata {
  return {
    title: 'Next.js',
  }
}

非同期関数

import type { Metadata } from 'next'

export async function generateMetadata(): Promise<Metadata> {
  return {
    title: 'Next.js',
  }
}

セグメントプロパティ付き

import type { Metadata } from 'next'

type Props = {
  params: { id: string }
  searchParams: { [key: string]: string | string[] | undefined }
}

export function generateMetadata({ params, searchParams }: Props): Metadata {
  return {
    title: 'Next.js',
  }
}

export default function Page({ params, searchParams }: Props) {}

親メタデータ付き

import type { Metadata, ResolvingMetadata } from 'next'

export async function generateMetadata(
  { params, searchParams }: Props,
  parent: ResolvingMetadata
): Promise<Metadata> {
  return {
    title: 'Next.js',
  }
}

JavaScriptプロジェクト

JavaScriptプロジェクトでは、JSDocを使用して型安全性を追加できます。

/** @type {import("next").Metadata} */
export const metadata = {
  title: 'Next.js',
}

バージョン履歴

バージョン変更内容
v13.2.0metadataとgenerateMetadataが導入されました。

メタデータファイル

メタデータファイル規約に関する API ドキュメント。

generateImageMetadata

1つのメタデータAPI特殊ファイルで複数の画像を生成する方法について学びます。

generateStaticParams

generateStaticParams 関数の API リファレンス